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

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

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 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
}

Instance Attribute Summary collapse

Instance Attribute Details

#bucketString

Returns:

  • (String)


4695
4696
4697
4698
4699
4700
4701
4702
4703
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4695

class ListPartsRequest < Struct.new(
  :bucket,
  :key,
  :max_parts,
  :part_number_marker,
  :upload_id,
  :request_payer)
  include Aws::Structure
end

#keyString

Returns:

  • (String)


4695
4696
4697
4698
4699
4700
4701
4702
4703
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4695

class ListPartsRequest < Struct.new(
  :bucket,
  :key,
  :max_parts,
  :part_number_marker,
  :upload_id,
  :request_payer)
  include Aws::Structure
end

#max_partsInteger

Sets the maximum number of parts to return.

Returns:

  • (Integer)


4695
4696
4697
4698
4699
4700
4701
4702
4703
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4695

class ListPartsRequest < Struct.new(
  :bucket,
  :key,
  :max_parts,
  :part_number_marker,
  :upload_id,
  :request_payer)
  include Aws::Structure
end

#part_number_markerInteger

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

Returns:

  • (Integer)


4695
4696
4697
4698
4699
4700
4701
4702
4703
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4695

class ListPartsRequest < Struct.new(
  :bucket,
  :key,
  :max_parts,
  :part_number_marker,
  :upload_id,
  :request_payer)
  include Aws::Structure
end

#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

Returns:

  • (String)


4695
4696
4697
4698
4699
4700
4701
4702
4703
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4695

class ListPartsRequest < Struct.new(
  :bucket,
  :key,
  :max_parts,
  :part_number_marker,
  :upload_id,
  :request_payer)
  include Aws::Structure
end

#upload_idString

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

Returns:

  • (String)


4695
4696
4697
4698
4699
4700
4701
4702
4703
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4695

class ListPartsRequest < Struct.new(
  :bucket,
  :key,
  :max_parts,
  :part_number_marker,
  :upload_id,
  :request_payer)
  include Aws::Structure
end