You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::S3::Types::CompleteMultipartUploadRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb

Overview

Note:

When making an API call, you may pass CompleteMultipartUploadRequest data as a hash:

{
  bucket: "BucketName", # required
  key: "ObjectKey", # required
  multipart_upload: {
    parts: [
      {
        etag: "ETag",
        part_number: 1,
      },
    ],
  },
  upload_id: "MultipartUploadId", # required
  request_payer: "requester", # accepts requester
}

Instance Attribute Summary collapse

Instance Attribute Details

#bucketString

Name of the bucket to which the multipart upload was initiated.

Returns:

  • (String)


957
958
959
960
961
962
963
964
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 957

class CompleteMultipartUploadRequest < Struct.new(
  :bucket,
  :key,
  :multipart_upload,
  :upload_id,
  :request_payer)
  include Aws::Structure
end

#keyString

Object key for which the multipart upload was initiated.

Returns:

  • (String)


957
958
959
960
961
962
963
964
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 957

class CompleteMultipartUploadRequest < Struct.new(
  :bucket,
  :key,
  :multipart_upload,
  :upload_id,
  :request_payer)
  include Aws::Structure
end

#multipart_uploadTypes::CompletedMultipartUpload

The container for the multipart upload request information.



957
958
959
960
961
962
963
964
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 957

class CompleteMultipartUploadRequest < Struct.new(
  :bucket,
  :key,
  :multipart_upload,
  :upload_id,
  :request_payer)
  include Aws::Structure
end

#request_payerString

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 in the Amazon S3 Developer Guide.

Returns:

  • (String)


957
958
959
960
961
962
963
964
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 957

class CompleteMultipartUploadRequest < Struct.new(
  :bucket,
  :key,
  :multipart_upload,
  :upload_id,
  :request_payer)
  include Aws::Structure
end

#upload_idString

ID for the initiated multipart upload.

Returns:

  • (String)


957
958
959
960
961
962
963
964
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 957

class CompleteMultipartUploadRequest < Struct.new(
  :bucket,
  :key,
  :multipart_upload,
  :upload_id,
  :request_payer)
  include Aws::Structure
end