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

Class: Aws::Glacier::Types::GetJobOutputInput

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

{
  account_id: "string", # required
  vault_name: "string", # required
  job_id: "string", # required
  range: "string",
}

Provides options for downloading output of an Amazon Glacier job.

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)


676
677
678
679
680
681
682
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb', line 676

class GetJobOutputInput < Struct.new(
  :account_id,
  :vault_name,
  :job_id,
  :range)
  include Aws::Structure
end

#job_idString

The job ID whose data is downloaded.

Returns:

  • (String)


676
677
678
679
680
681
682
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb', line 676

class GetJobOutputInput < Struct.new(
  :account_id,
  :vault_name,
  :job_id,
  :range)
  include Aws::Structure
end

#rangeString

The range of bytes to retrieve from the output. For example, if you want to download the first 1,048,576 bytes, specify the range as bytes=0-1048575. By default, this operation downloads the entire output.

If the job output is large, then you can use a range to retrieve a portion of the output. This allows you to download the entire output in smaller chunks of bytes. For example, suppose you have 1 GB of job output you want to download and you decide to download 128 MB chunks of data at a time, which is a total of eight Get Job Output requests. You use the following process to download the job output:

  1. Download a 128 MB chunk of output by specifying the appropriate byte range. Verify that all 128 MB of data was received.

  2. Along with the data, the response includes a SHA256 tree hash of the payload. You compute the checksum of the payload on the client and compare it with the checksum you received in the response to ensure you received all the expected data.

  3. Repeat steps 1 and 2 for all the eight 128 MB chunks of output data, each time specifying the appropriate byte range.

  4. After downloading all the parts of the job output, you have a list of eight checksum values. Compute the tree hash of these values to find the checksum of the entire output. Using the DescribeJob API, obtain job information of the job that provided you the output. The response includes the checksum of the entire archive stored in Amazon Glacier. You compare this value with the checksum you computed to ensure you have downloaded the entire archive content with no errors.

Returns:

  • (String)


676
677
678
679
680
681
682
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb', line 676

class GetJobOutputInput < Struct.new(
  :account_id,
  :vault_name,
  :job_id,
  :range)
  include Aws::Structure
end

#vault_nameString

The name of the vault.

Returns:

  • (String)


676
677
678
679
680
681
682
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb', line 676

class GetJobOutputInput < Struct.new(
  :account_id,
  :vault_name,
  :job_id,
  :range)
  include Aws::Structure
end