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

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 AbortMultipartUploadRequest data as a hash:

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bucketString

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

When using this API 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 operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

Returns:

  • (String)


122
123
124
125
126
127
128
129
130
# File 'gems/aws-sdk-s3/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_ownerString

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.

Returns:

  • (String)


122
123
124
125
126
127
128
129
130
# File 'gems/aws-sdk-s3/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

#keyString

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

Returns:

  • (String)


122
123
124
125
126
127
128
129
130
# File 'gems/aws-sdk-s3/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_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)


122
123
124
125
126
127
128
129
130
# File 'gems/aws-sdk-s3/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_idString

Upload ID that identifies the multipart upload.

Returns:

  • (String)


122
123
124
125
126
127
128
129
130
# File 'gems/aws-sdk-s3/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