Class: Aws::S3::Types::AbortMultipartUploadRequest

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

Overview

Note:

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

{
  bucket: "BucketName", # required
  key: "ObjectKey", # required
  upload_id: "MultipartUploadId", # required
  request_payer: "requester", # accepts requester
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#bucket ⇒ String

The bucket name to which the upload was taking place.

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see [Using Access Points] in the *Amazon Simple Storage Service Developer Guide*.

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html

Returns:

  • (String) 


101
102
103
104
105
106
107
 
# File 'lib/aws-sdk-s3/types.rb', line 101

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

#key ⇒ String

Key of the object for which the multipart upload was initiated.

Returns:

  • (String) 


101
102
103
104
105
106
107
 
# File 'lib/aws-sdk-s3/types.rb', line 101

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

#request_payer ⇒ String

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*.

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

Returns:

  • (String) 


101
102
103
104
105
106
107
 
# File 'lib/aws-sdk-s3/types.rb', line 101

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

#upload_id ⇒ String

Upload ID that identifies the multipart upload.

Returns:

  • (String) 


101
102
103
104
105
106
107
 
# File 'lib/aws-sdk-s3/types.rb', line 101

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