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

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

Overview

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.

**Directory buckets** - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format ‘ Bucket_name.s3express-az_id.region.amazonaws.com`. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format ` bucket_base_name–az-id–x-s3` (for example, ` DOC-EXAMPLE-BUCKET–usw2-az1–x-s3`). For information about bucket naming restrictions, see [Directory bucket naming rules] in the *Amazon S3 User Guide*.

**Access points** - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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][2

in the *Amazon S3 User Guide*.

<note markdown=“1”> Access points and Object Lambda access points are not supported by directory buckets.

</note>

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

What is S3 on Outposts?][3

in the *Amazon S3 User Guide*.

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

Returns:

  • (String) 


146
147
148
149
150
151
152
153
154
155
 
# File 'lib/aws-sdk-s3/types.rb', line 146

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

#expected_bucket_owner ⇒ String

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code ‘403 Forbidden` (access denied).

Returns:

  • (String) 


146
147
148
149
150
151
152
153
154
155
 
# File 'lib/aws-sdk-s3/types.rb', line 146

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

#if_match_initiated_time ⇒ Time

If present, this header aborts an in progress multipart upload only if it was initiated on the provided timestamp. If the initiated timestamp of the multipart upload does not match the provided value, the operation returns a ‘412 Precondition Failed` error. If the initiated timestamp matches or if the multipart upload doesn’t exist, the operation returns a `204 Success (No Content)` response.

<note markdown=“1”> This functionality is only supported for directory buckets.

</note>

Returns:

  • (Time) 


146
147
148
149
150
151
152
153
154
155
 
# File 'lib/aws-sdk-s3/types.rb', line 146

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

#key ⇒ String

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

Returns:

  • (String) 


146
147
148
149
150
151
152
153
154
155
 
# File 'lib/aws-sdk-s3/types.rb', line 146

class AbortMultipartUploadRequest < Struct.new(
  :bucket,
  :key,
  :upload_id,
  :request_payer,
  :expected_bucket_owner,
  :if_match_initiated_time)
  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. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see [Downloading Objects in Requester Pays Buckets] in the *Amazon S3 User Guide*.

<note markdown=“1”> This functionality is not supported for directory buckets.

</note>

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

Returns:

  • (String) 


146
147
148
149
150
151
152
153
154
155
 
# File 'lib/aws-sdk-s3/types.rb', line 146

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

#upload_id ⇒ String

Upload ID that identifies the multipart upload.

Returns:

  • (String) 


146
147
148
149
150
151
152
153
154
155
 
# File 'lib/aws-sdk-s3/types.rb', line 146

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