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

Class: Aws::Glacier::Types::InitiateJobInput

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

{
  account_id: "string", # required
  vault_name: "string", # required
  job_parameters: {
    format: "string",
    type: "string",
    archive_id: "string",
    description: "string",
    sns_topic: "string",
    retrieval_byte_range: "string",
    tier: "string",
    inventory_retrieval_parameters: {
      start_date: Time.now,
      end_date: Time.now,
      limit: "string",
      marker: "string",
    },
  },
}

Provides options for initiating 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)


1075
1076
1077
1078
1079
1080
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb', line 1075

class InitiateJobInput < Struct.new(
  :account_id,
  :vault_name,
  :job_parameters)
  include Aws::Structure
end

#job_parametersTypes::JobParameters

Provides options for specifying job information.



1075
1076
1077
1078
1079
1080
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb', line 1075

class InitiateJobInput < Struct.new(
  :account_id,
  :vault_name,
  :job_parameters)
  include Aws::Structure
end

#vault_nameString

The name of the vault.

Returns:

  • (String)


1075
1076
1077
1078
1079
1080
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb', line 1075

class InitiateJobInput < Struct.new(
  :account_id,
  :vault_name,
  :job_parameters)
  include Aws::Structure
end