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

Class: Aws::Glacier::Types::ListPartsInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb

Overview

Note:

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

{
  account_id: "string", # required
  vault_name: "string", # required
  upload_id: "string", # required
  marker: "string",
  limit: 1,
}

Provides options for retrieving a list of parts of an archive that have been uploaded in a specific multipart upload.

Instance Attribute Summary collapse

Instance Attribute Details

#account_idString

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

Returns:

  • (String)


1595
1596
1597
1598
1599
1600
1601
1602
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb', line 1595

class ListPartsInput < Struct.new(
  :account_id,
  :vault_name,
  :upload_id,
  :marker,
  :limit)
  include Aws::Structure
end

#limitInteger

The maximum number of parts to be returned. The default limit is 1000. The number of parts returned might be fewer than the specified limit, but the number of returned parts never exceeds the limit.

Returns:

  • (Integer)


1595
1596
1597
1598
1599
1600
1601
1602
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb', line 1595

class ListPartsInput < Struct.new(
  :account_id,
  :vault_name,
  :upload_id,
  :marker,
  :limit)
  include Aws::Structure
end

#markerString

An opaque string used for pagination. This value specifies the part at which the listing of parts should begin. Get the marker value from the response of a previous List Parts response. You need only include the marker if you are continuing the pagination of results started in a previous List Parts request.

Returns:

  • (String)


1595
1596
1597
1598
1599
1600
1601
1602
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb', line 1595

class ListPartsInput < Struct.new(
  :account_id,
  :vault_name,
  :upload_id,
  :marker,
  :limit)
  include Aws::Structure
end

#upload_idString

The upload ID of the multipart upload.

Returns:

  • (String)


1595
1596
1597
1598
1599
1600
1601
1602
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb', line 1595

class ListPartsInput < Struct.new(
  :account_id,
  :vault_name,
  :upload_id,
  :marker,
  :limit)
  include Aws::Structure
end

#vault_nameString

The name of the vault.

Returns:

  • (String)


1595
1596
1597
1598
1599
1600
1601
1602
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb', line 1595

class ListPartsInput < Struct.new(
  :account_id,
  :vault_name,
  :upload_id,
  :marker,
  :limit)
  include Aws::Structure
end