You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ListPartsRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  bucket: "BucketName", # required
  key: "ObjectKey", # required
  max_parts: 1,
  part_number_marker: 1,
  upload_id: "MultipartUploadId", # required
  request_payer: "requester", # accepts requester
  use_accelerate_endpoint: false,
}

Instance Attribute Summary collapse

Instance Attribute Details

#bucketString

Returns:

  • (String)

#keyString

Returns:

  • (String)

#max_partsInteger

Sets the maximum number of parts to return.

Returns:

  • (Integer)

    Sets the maximum number of parts to return.

#part_number_markerInteger

Specifies the part after which listing should begin. Only parts with higher part numbers will be listed.

Returns:

  • (Integer)

    Specifies the part after which listing should begin.

#request_payerString

Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

Possible values:

  • requester

Returns:

  • (String)

    Confirms that the requester knows that she or he will be charged for the request.

#upload_idString

Upload ID identifying the multipart upload whose parts are being listed.

Returns:

  • (String)

    Upload ID identifying the multipart upload whose parts are being listed.

#use_accelerate_endpointBoolean

When true, the "https://BUCKETNAME.s3-accelerate.amazonaws.com" endpoint will be used.

Returns: