Class: Aws::S3::Types::ListPartsRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::S3::Types::ListPartsRequest
- Defined in:
- gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[:sse_customer_key]
Instance Attribute Summary collapse
-
#bucket ⇒ String
The name of the bucket to which the parts are being uploaded.
-
#expected_bucket_owner ⇒ String
The account ID of the expected bucket owner.
-
#key ⇒ String
Object key for which the multipart upload was initiated.
-
#max_parts ⇒ Integer
Sets the maximum number of parts to return.
-
#part_number_marker ⇒ Integer
Specifies the part after which listing should begin.
-
#request_payer ⇒ String
Confirms that the requester knows that they will be charged for the request.
-
#sse_customer_algorithm ⇒ String
The server-side encryption (SSE) algorithm used to encrypt the object.
-
#sse_customer_key ⇒ String
The server-side encryption (SSE) customer managed key.
-
#sse_customer_key_md5 ⇒ String
The MD5 server-side encryption (SSE) customer managed key.
-
#upload_id ⇒ String
Upload ID identifying the multipart upload whose parts are being listed.
Instance Attribute Details
#bucket ⇒ String
The name of the bucket to which the parts are being uploaded.
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 in the Amazon S3 User Guide.
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? in the Amazon S3 User Guide.
11248 11249 11250 11251 11252 11253 11254 11255 11256 11257 11258 11259 11260 11261 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 11248 class ListPartsRequest < Struct.new( :bucket, :key, :max_parts, :part_number_marker, :upload_id, :request_payer, :expected_bucket_owner, :sse_customer_algorithm, :sse_customer_key, :sse_customer_key_md5) SENSITIVE = [:sse_customer_key] 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).
11248 11249 11250 11251 11252 11253 11254 11255 11256 11257 11258 11259 11260 11261 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 11248 class ListPartsRequest < Struct.new( :bucket, :key, :max_parts, :part_number_marker, :upload_id, :request_payer, :expected_bucket_owner, :sse_customer_algorithm, :sse_customer_key, :sse_customer_key_md5) SENSITIVE = [:sse_customer_key] include Aws::Structure end |
#key ⇒ String
Object key for which the multipart upload was initiated.
11248 11249 11250 11251 11252 11253 11254 11255 11256 11257 11258 11259 11260 11261 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 11248 class ListPartsRequest < Struct.new( :bucket, :key, :max_parts, :part_number_marker, :upload_id, :request_payer, :expected_bucket_owner, :sse_customer_algorithm, :sse_customer_key, :sse_customer_key_md5) SENSITIVE = [:sse_customer_key] include Aws::Structure end |
#max_parts ⇒ Integer
Sets the maximum number of parts to return.
11248 11249 11250 11251 11252 11253 11254 11255 11256 11257 11258 11259 11260 11261 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 11248 class ListPartsRequest < Struct.new( :bucket, :key, :max_parts, :part_number_marker, :upload_id, :request_payer, :expected_bucket_owner, :sse_customer_algorithm, :sse_customer_key, :sse_customer_key_md5) SENSITIVE = [:sse_customer_key] include Aws::Structure end |
#part_number_marker ⇒ Integer
Specifies the part after which listing should begin. Only parts with higher part numbers will be listed.
11248 11249 11250 11251 11252 11253 11254 11255 11256 11257 11258 11259 11260 11261 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 11248 class ListPartsRequest < Struct.new( :bucket, :key, :max_parts, :part_number_marker, :upload_id, :request_payer, :expected_bucket_owner, :sse_customer_algorithm, :sse_customer_key, :sse_customer_key_md5) SENSITIVE = [:sse_customer_key] 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.
11248 11249 11250 11251 11252 11253 11254 11255 11256 11257 11258 11259 11260 11261 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 11248 class ListPartsRequest < Struct.new( :bucket, :key, :max_parts, :part_number_marker, :upload_id, :request_payer, :expected_bucket_owner, :sse_customer_algorithm, :sse_customer_key, :sse_customer_key_md5) SENSITIVE = [:sse_customer_key] include Aws::Structure end |
#sse_customer_algorithm ⇒ String
The server-side encryption (SSE) algorithm used to encrypt the object. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.
11248 11249 11250 11251 11252 11253 11254 11255 11256 11257 11258 11259 11260 11261 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 11248 class ListPartsRequest < Struct.new( :bucket, :key, :max_parts, :part_number_marker, :upload_id, :request_payer, :expected_bucket_owner, :sse_customer_algorithm, :sse_customer_key, :sse_customer_key_md5) SENSITIVE = [:sse_customer_key] include Aws::Structure end |
#sse_customer_key ⇒ String
The server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.
11248 11249 11250 11251 11252 11253 11254 11255 11256 11257 11258 11259 11260 11261 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 11248 class ListPartsRequest < Struct.new( :bucket, :key, :max_parts, :part_number_marker, :upload_id, :request_payer, :expected_bucket_owner, :sse_customer_algorithm, :sse_customer_key, :sse_customer_key_md5) SENSITIVE = [:sse_customer_key] include Aws::Structure end |
#sse_customer_key_md5 ⇒ String
The MD5 server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.
11248 11249 11250 11251 11252 11253 11254 11255 11256 11257 11258 11259 11260 11261 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 11248 class ListPartsRequest < Struct.new( :bucket, :key, :max_parts, :part_number_marker, :upload_id, :request_payer, :expected_bucket_owner, :sse_customer_algorithm, :sse_customer_key, :sse_customer_key_md5) SENSITIVE = [:sse_customer_key] include Aws::Structure end |
#upload_id ⇒ String
Upload ID identifying the multipart upload whose parts are being listed.
11248 11249 11250 11251 11252 11253 11254 11255 11256 11257 11258 11259 11260 11261 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 11248 class ListPartsRequest < Struct.new( :bucket, :key, :max_parts, :part_number_marker, :upload_id, :request_payer, :expected_bucket_owner, :sse_customer_algorithm, :sse_customer_key, :sse_customer_key_md5) SENSITIVE = [:sse_customer_key] include Aws::Structure end |