class Aws::S3::MultipartUploadPart
Public Class Methods
@overload def initialize(bucket_name
, object_key
, multipart_upload_id
, part_number
, options = {})
@param [String] bucket_name @param [String] object_key @param [String] multipart_upload_id @param [Integer] part_number @option options [Client] :client
@overload def initialize(options = {})
@option options [required, String] :bucket_name @option options [required, String] :object_key @option options [required, String] :multipart_upload_id @option options [required, Integer] :part_number @option options [Client] :client
# File lib/aws-sdk-s3/multipart_upload_part.rb, line 28 def initialize(*args) options = Hash === args.last ? args.pop.dup : {} @bucket_name = extract_bucket_name(args, options) @object_key = extract_object_key(args, options) @multipart_upload_id = extract_multipart_upload_id(args, options) @part_number = extract_part_number(args, options) @data = options.delete(:data) @client = options.delete(:client) || Client.new(options) @waiter_block_warned = false end
Public Instance Methods
@return [String]
# File lib/aws-sdk-s3/multipart_upload_part.rb, line 42 def bucket_name @bucket_name end
@return [Client]
# File lib/aws-sdk-s3/multipart_upload_part.rb, line 82 def client @client end
@example Request syntax with placeholder values
multipart_upload_part.copy_from({ copy_source: "CopySource", # required copy_source_if_match: "CopySourceIfMatch", copy_source_if_modified_since: Time.now, copy_source_if_none_match: "CopySourceIfNoneMatch", copy_source_if_unmodified_since: Time.now, copy_source_range: "CopySourceRange", sse_customer_algorithm: "SSECustomerAlgorithm", sse_customer_key: "SSECustomerKey", sse_customer_key_md5: "SSECustomerKeyMD5", copy_source_sse_customer_algorithm: "CopySourceSSECustomerAlgorithm", copy_source_sse_customer_key: "CopySourceSSECustomerKey", copy_source_sse_customer_key_md5: "CopySourceSSECustomerKeyMD5", request_payer: "requester", # accepts requester expected_bucket_owner: "AccountId", expected_source_bucket_owner: "AccountId", })
@param [Hash] options ({}) @option options [required, String] :copy_source
Specifies the source object for the copy operation. You specify the value in one of two formats, depending on whether you want to access the source object through an [access point][1]\: * For objects not accessed through an access point, specify the name of the source bucket and key of the source object, separated by a slash (/). For example, to copy the object `reports/january.pdf` from the bucket `awsexamplebucket`, use `awsexamplebucket/reports/january.pdf`. The value must be URL encoded. * For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as accessed through the access point, in the format `arn:aws:s3:<Region>:<account-id>:accesspoint/<access-point-name>/object/<key>`. For example, to copy the object `reports/january.pdf` through access point `my-access-point` owned by account `123456789012` in Region `us-west-2`, use the URL encoding of `arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf`. The value must be URL encoded. <note markdown="1"> Amazon S3 supports copy operations using access points only when the source and destination buckets are in the same Amazon Web Services Region. </note> Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format `arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/object/<key>`. For example, to copy the object `reports/january.pdf` through outpost `my-outpost` owned by account `123456789012` in Region `us-west-2`, use the URL encoding of `arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf`. The value must be URL encoded. To copy a specific version of an object, append `?versionId=<version-id>` to the value (for example, `awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893`). If you don't specify a version ID, Amazon S3 copies the latest version of the source object. [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html
@option options [String] :copy_source_if_match
Copies the object if its entity tag (ETag) matches the specified tag.
@option options [Time,DateTime,Date,Integer,String] :copy_source_if_modified_since
Copies the object if it has been modified since the specified time.
@option options [String] :copy_source_if_none_match
Copies the object if its entity tag (ETag) is different than the specified ETag.
@option options [Time,DateTime,Date,Integer,String] :copy_source_if_unmodified_since
Copies the object if it hasn't been modified since the specified time.
@option options [String] :copy_source_range
The range of bytes to copy from the source object. The range value must use the form bytes=first-last, where the first and last are the zero-based byte offsets to copy. For example, bytes=0-9 indicates that you want to copy the first 10 bytes of the source. You can copy a range only if the source object is greater than 5 MB.
@option options [String] :sse_customer_algorithm
Specifies the algorithm to use to when encrypting the object (for example, AES256).
@option options [String] :sse_customer_key
Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the `x-amz-server-side-encryption-customer-algorithm` header. This must be the same encryption key specified in the initiate multipart upload request.
@option options [String] :sse_customer_key_md5
Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.
@option options [String] :copy_source_sse_customer_algorithm
Specifies the algorithm to use when decrypting the source object (for example, AES256).
@option options [String] :copy_source_sse_customer_key
Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object. The encryption key provided in this header must be one that was used when the source object was created.
@option options [String] :copy_source_sse_customer_key_md5
Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.
@option options [String] :request_payer
Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from requester pays buckets, see [Downloading Objects in Requestor Pays Buckets][1] in the *Amazon S3 User Guide*. [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
@option options [String] :expected_bucket_owner
The account ID of the expected destination bucket owner. If the destination bucket is owned by a different account, the request will fail with an HTTP `403 (Access Denied)` error.
@option options [String] :expected_source_bucket_owner
The account ID of the expected source bucket owner. If the source bucket is owned by a different account, the request will fail with an HTTP `403 (Access Denied)` error.
@return [Types::UploadPartCopyOutput]
# File lib/aws-sdk-s3/multipart_upload_part.rb, line 335 def copy_from(options = {}) options = options.merge( bucket: @bucket_name, key: @object_key, upload_id: @multipart_upload_id, part_number: @part_number ) resp = @client.upload_part_copy(options) resp.data end
@raise [NotImplementedError] Raises when {#data_loaded?} is `false`. @return [Types::Part]
Returns the data for this {MultipartUploadPart}.
# File lib/aws-sdk-s3/multipart_upload_part.rb, line 97 def data load unless @data @data end
@return [Boolean]
Returns `true` if this resource is loaded. Accessing attributes or {#data} on an unloaded resource will trigger a call to {#load}.
# File lib/aws-sdk-s3/multipart_upload_part.rb, line 105 def data_loaded? !!@data end
Entity tag returned when the part was uploaded. @return [String]
# File lib/aws-sdk-s3/multipart_upload_part.rb, line 69 def etag data[:etag] end
@deprecated @api private
# File lib/aws-sdk-s3/multipart_upload_part.rb, line 423 def identifiers { bucket_name: @bucket_name, object_key: @object_key, multipart_upload_id: @multipart_upload_id, part_number: @part_number } end
Date and time at which the part was uploaded. @return [Time]
# File lib/aws-sdk-s3/multipart_upload_part.rb, line 63 def last_modified data[:last_modified] end
@raise [NotImplementedError] @api private
# File lib/aws-sdk-s3/multipart_upload_part.rb, line 88 def load msg = "#load is not implemented, data only available via enumeration" raise NotImplementedError, msg end
@return [MultipartUpload]
# File lib/aws-sdk-s3/multipart_upload_part.rb, line 412 def multipart_upload MultipartUpload.new( bucket_name: @bucket_name, object_key: @object_key, id: @multipart_upload_id, client: @client ) end
@return [String]
# File lib/aws-sdk-s3/multipart_upload_part.rb, line 52 def multipart_upload_id @multipart_upload_id end
@return [String]
# File lib/aws-sdk-s3/multipart_upload_part.rb, line 47 def object_key @object_key end
@return [Integer]
# File lib/aws-sdk-s3/multipart_upload_part.rb, line 57 def part_number @part_number end
Size in bytes of the uploaded part data. @return [Integer]
# File lib/aws-sdk-s3/multipart_upload_part.rb, line 75 def size data[:size] end
@example Request syntax with placeholder values
multipart_upload_part.upload({ body: source_file, content_length: 1, content_md5: "ContentMD5", sse_customer_algorithm: "SSECustomerAlgorithm", sse_customer_key: "SSECustomerKey", sse_customer_key_md5: "SSECustomerKeyMD5", request_payer: "requester", # accepts requester expected_bucket_owner: "AccountId", })
@param [Hash] options ({}) @option options [String, StringIO, File] :body
Object data.
@option options [Integer] :content_length
Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically.
@option options [String] :content_md5
The base64-encoded 128-bit MD5 digest of the part data. This parameter is auto-populated when using the command from the CLI. This parameter is required if object lock parameters are specified.
@option options [String] :sse_customer_algorithm
Specifies the algorithm to use to when encrypting the object (for example, AES256).
@option options [String] :sse_customer_key
Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the `x-amz-server-side-encryption-customer-algorithm header`. This must be the same encryption key specified in the initiate multipart upload request.
@option options [String] :sse_customer_key_md5
Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.
@option options [String] :request_payer
Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from requester pays buckets, see [Downloading Objects in Requestor Pays Buckets][1] in the *Amazon S3 User Guide*. [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
@option options [String] :expected_bucket_owner
The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP `403 (Access Denied)` error.
@return [Types::UploadPartOutput]
# File lib/aws-sdk-s3/multipart_upload_part.rb, line 398 def upload(options = {}) options = options.merge( bucket: @bucket_name, key: @object_key, upload_id: @multipart_upload_id, part_number: @part_number ) resp = @client.upload_part(options) resp.data end
@deprecated Use [Aws::S3::Client] wait_until
instead
Waiter polls an API operation until a resource enters a desired state.
@note The waiting operation is performed on a copy. The original resource
remains unchanged.
## Basic Usage
Waiter will polls until it is successful, it fails by entering a terminal state, or until a maximum number of attempts are made.
# polls in a loop until condition is true resource.wait_until(options) {|resource| condition}
## Example
instance.wait_until(max_attempts:10, delay:5) do |instance| instance.state.name == 'running' end
## Configuration
You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. The waiting condition is set by passing a block to {#wait_until}:
# poll for ~25 seconds resource.wait_until(max_attempts:5,delay:5) {|resource|...}
## Callbacks
You can be notified before each polling attempt and before each delay. If you throw `:success` or `:failure` from these callbacks, it will terminate the waiter.
started_at = Time.now # poll for 1 hour, instead of a number of attempts proc = Proc.new do |attempts, response| throw :failure if Time.now - started_at > 3600 end # disable max attempts instance.wait_until(before_wait:proc, max_attempts:nil) {...}
## Handling Errors
When a waiter is successful, it returns the Resource
. When a waiter fails, it raises an error.
begin resource.wait_until(...) rescue Aws::Waiters::Errors::WaiterFailed # resource did not enter the desired state in time end
@yieldparam [Resource] resource to be used in the waiting condition.
@raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter
terminates because the waiter has entered a state that it will not transition out of, preventing success. yet successful.
@raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
encountered while polling for a resource that is not expected.
@raise [NotImplementedError] Raised when the resource does not
@option options [Integer] :max_attempts (10) Maximum number of attempts @option options [Integer] :delay (10) Delay between each attempt in seconds @option options [Proc] :before_attempt (nil) Callback invoked before each attempt @option options [Proc] :before_wait (nil) Callback invoked before each wait @return [Resource] if the waiter was successful
# File lib/aws-sdk-s3/multipart_upload_part.rb, line 189 def wait_until(options = {}, &block) self_copy = self.dup attempts = 0 options[:max_attempts] = 10 unless options.key?(:max_attempts) options[:delay] ||= 10 options[:poller] = Proc.new do attempts += 1 if block.call(self_copy) [:success, self_copy] else self_copy.reload unless attempts == options[:max_attempts] :retry end end Aws::Waiters::Waiter.new(options).wait({}) end
Private Instance Methods
# File lib/aws-sdk-s3/multipart_upload_part.rb, line 435 def extract_bucket_name(args, options) value = args[0] || options.delete(:bucket_name) case value when String then value when nil then raise ArgumentError, "missing required option :bucket_name" else msg = "expected :bucket_name to be a String, got #{value.class}" raise ArgumentError, msg end end
# File lib/aws-sdk-s3/multipart_upload_part.rb, line 457 def extract_multipart_upload_id(args, options) value = args[2] || options.delete(:multipart_upload_id) case value when String then value when nil then raise ArgumentError, "missing required option :multipart_upload_id" else msg = "expected :multipart_upload_id to be a String, got #{value.class}" raise ArgumentError, msg end end
# File lib/aws-sdk-s3/multipart_upload_part.rb, line 446 def extract_object_key(args, options) value = args[1] || options.delete(:object_key) case value when String then value when nil then raise ArgumentError, "missing required option :object_key" else msg = "expected :object_key to be a String, got #{value.class}" raise ArgumentError, msg end end
# File lib/aws-sdk-s3/multipart_upload_part.rb, line 468 def extract_part_number(args, options) value = args[3] || options.delete(:part_number) case value when Integer then value when nil then raise ArgumentError, "missing required option :part_number" else msg = "expected :part_number to be a Integer, got #{value.class}" raise ArgumentError, msg end end