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

Class: Aws::Glacier::Types::InitiateMultipartUploadInput

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 InitiateMultipartUploadInput data as a hash:

{
  account_id: "string", # required
  vault_name: "string", # required
  archive_description: "string",
  part_size: 1,
}

Provides options for initiating a multipart upload to an Amazon Glacier vault.

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)


1423
1424
1425
1426
1427
1428
1429
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb', line 1423

class InitiateMultipartUploadInput < Struct.new(
  :account_id,
  :vault_name,
  :archive_description,
  :part_size)
  include Aws::Structure
end

#archive_descriptionString

The archive description that you are uploading in parts.

The part size must be a megabyte (1024 KB) multiplied by a power of 2, for example 1048576 (1 MB), 2097152 (2 MB), 4194304 (4 MB), 8388608 (8 MB), and so on. The minimum allowable part size is 1 MB, and the maximum is 4 GB (4096 MB).

Returns:

  • (String)


1423
1424
1425
1426
1427
1428
1429
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb', line 1423

class InitiateMultipartUploadInput < Struct.new(
  :account_id,
  :vault_name,
  :archive_description,
  :part_size)
  include Aws::Structure
end

#part_sizeInteger

The size of each part except the last, in bytes. The last part can be smaller than this part size.

Returns:

  • (Integer)


1423
1424
1425
1426
1427
1428
1429
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb', line 1423

class InitiateMultipartUploadInput < Struct.new(
  :account_id,
  :vault_name,
  :archive_description,
  :part_size)
  include Aws::Structure
end

#vault_nameString

The name of the vault.

Returns:

  • (String)


1423
1424
1425
1426
1427
1428
1429
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb', line 1423

class InitiateMultipartUploadInput < Struct.new(
  :account_id,
  :vault_name,
  :archive_description,
  :part_size)
  include Aws::Structure
end