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
  expected_bucket_owner: "AccountId",
}

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bucket ⇒ String

The bucket name to which the upload was taking place.

When using this action 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 action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see

Using access points][1

in the *Amazon S3 User Guide*.

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form ‘ AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see

Using Amazon S3 on Outposts][2

in the *Amazon S3 User Guide*.

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

Returns:

  • (String) 


122
123
124
125
126
127
128
129
130
 
# File 'lib/aws-sdk-s3/types.rb', line 122

class AbortMultipartUploadRequest < Struct.new(
  :bucket,
  :key,
  :upload_id,
  :request_payer,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end

#expected_bucket_owner ⇒ String

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code ‘403 Forbidden` (access denied).

Returns:

  • (String) 


122
123
124
125
126
127
128
129
130
 
# File 'lib/aws-sdk-s3/types.rb', line 122

class AbortMultipartUploadRequest < Struct.new(
  :bucket,
  :key,
  :upload_id,
  :request_payer,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end

#key ⇒ String

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

Returns:

  • (String) 


122
123
124
125
126
127
128
129
130
 
# File 'lib/aws-sdk-s3/types.rb', line 122

class AbortMultipartUploadRequest < Struct.new(
  :bucket,
  :key,
  :upload_id,
  :request_payer,
  :expected_bucket_owner)
  SENSITIVE = []
  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 Requester Pays Buckets] in the *Amazon S3 User Guide*.

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

Returns:

  • (String) 


122
123
124
125
126
127
128
129
130
 
# File 'lib/aws-sdk-s3/types.rb', line 122

class AbortMultipartUploadRequest < Struct.new(
  :bucket,
  :key,
  :upload_id,
  :request_payer,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end

#upload_id ⇒ String

Upload ID that identifies the multipart upload.

Returns:

  • (String) 


122
123
124
125
126
127
128
129
130
 
# File 'lib/aws-sdk-s3/types.rb', line 122

class AbortMultipartUploadRequest < Struct.new(
  :bucket,
  :key,
  :upload_id,
  :request_payer,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end