Class: Aws::S3::Types::ListPartsRequest

Inherits:

Struct

• Object
• Struct
• Aws::S3::Types::ListPartsRequest

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-s3/types.rb

Overview

Note:

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

{
  bucket: "BucketName", # required
  key: "ObjectKey", # required
  max_parts: 1,
  part_number_marker: 1,
  upload_id: "MultipartUploadId", # required
  request_payer: "requester", # accepts requester
  expected_bucket_owner: "AccountId",
  sse_customer_algorithm: "SSECustomerAlgorithm",
  sse_customer_key: "SSECustomerKey",
  sse_customer_key_md5: "SSECustomerKeyMD5",
}

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:sse_customer_key]

Instance Attribute Summary

• #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.

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)

# File 'lib/aws-sdk-s3/types.rb', line 9827

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 bucket is owned by a different account, the request fails with the HTTP status code ‘403 Forbidden` (access denied).

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 9827

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.

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 9827

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.

Returns:

• (Integer)

# File 'lib/aws-sdk-s3/types.rb', line 9827

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.

Returns:

• (Integer)

# File 'lib/aws-sdk-s3/types.rb', line 9827

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

# File 'lib/aws-sdk-s3/types.rb', line 9827

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

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

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 9827

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

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

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 9827

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

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

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 9827

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.

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 9827

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