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

Class: Aws::Glacier::Types::UploadArchiveInput

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

{
  vault_name: "string", # required
  account_id: "string", # required
  archive_description: "string",
  checksum: "string",
  body: "data",
}

Provides options to add an archive to a 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)


2623
2624
2625
2626
2627
2628
2629
2630
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb', line 2623

class UploadArchiveInput < Struct.new(
  :vault_name,
  :account_id,
  :archive_description,
  :checksum,
  :body)
  include Aws::Structure
end

#archive_descriptionString

The optional description of the archive you are uploading.

Returns:

  • (String)


2623
2624
2625
2626
2627
2628
2629
2630
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb', line 2623

class UploadArchiveInput < Struct.new(
  :vault_name,
  :account_id,
  :archive_description,
  :checksum,
  :body)
  include Aws::Structure
end

#bodyIO

The data to upload.

Returns:

  • (IO)


2623
2624
2625
2626
2627
2628
2629
2630
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb', line 2623

class UploadArchiveInput < Struct.new(
  :vault_name,
  :account_id,
  :archive_description,
  :checksum,
  :body)
  include Aws::Structure
end

#checksumString

The SHA256 tree hash of the data being uploaded.

Returns:

  • (String)


2623
2624
2625
2626
2627
2628
2629
2630
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb', line 2623

class UploadArchiveInput < Struct.new(
  :vault_name,
  :account_id,
  :archive_description,
  :checksum,
  :body)
  include Aws::Structure
end

#vault_nameString

The name of the vault.

Returns:

  • (String)


2623
2624
2625
2626
2627
2628
2629
2630
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb', line 2623

class UploadArchiveInput < Struct.new(
  :vault_name,
  :account_id,
  :archive_description,
  :checksum,
  :body)
  include Aws::Structure
end