Class: Aws::Glacier::Types::ListJobsInput

Inherits:

Struct

• Object
• Struct
• Aws::Glacier::Types::ListJobsInput

Includes:

Structure

Defined in:

lib/aws-sdk-glacier/types.rb

Overview

Note:

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

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

Provides options for retrieving a job list for an Amazon Glacier vault.

Instance Attribute Summary

• #account_id ⇒ String

  The ‘AccountId` value is the AWS account ID of the account that owns the vault.

• #completed ⇒ String

  The state of the jobs to return.

• #limit ⇒ Integer

  The maximum number of jobs to be returned.

• #marker ⇒ String

  An opaque string used for pagination.

• #statuscode ⇒ String

  The type of job status to return.

• #vault_name ⇒ String

  The name of the vault.

Instance Attribute Details

#account_id ⇒ String

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)

# File 'lib/aws-sdk-glacier/types.rb', line 1829

class ListJobsInput < Struct.new(
  :account_id,
  :vault_name,
  :limit,
  :marker,
  :statuscode,
  :completed)
  include Aws::Structure
end

#completed ⇒ String

The state of the jobs to return. You can specify ‘true` or `false`.

Returns:

• (String)

# File 'lib/aws-sdk-glacier/types.rb', line 1829

class ListJobsInput < Struct.new(
  :account_id,
  :vault_name,
  :limit,
  :marker,
  :statuscode,
  :completed)
  include Aws::Structure
end

#limit ⇒ Integer

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

Returns:

• (Integer)

# File 'lib/aws-sdk-glacier/types.rb', line 1829

class ListJobsInput < Struct.new(
  :account_id,
  :vault_name,
  :limit,
  :marker,
  :statuscode,
  :completed)
  include Aws::Structure
end

#marker ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-glacier/types.rb', line 1829

class ListJobsInput < Struct.new(
  :account_id,
  :vault_name,
  :limit,
  :marker,
  :statuscode,
  :completed)
  include Aws::Structure
end

#statuscode ⇒ String

The type of job status to return. You can specify the following values: ‘InProgress`, `Succeeded`, or `Failed`.

Returns:

• (String)

# File 'lib/aws-sdk-glacier/types.rb', line 1829

class ListJobsInput < Struct.new(
  :account_id,
  :vault_name,
  :limit,
  :marker,
  :statuscode,
  :completed)
  include Aws::Structure
end

#vault_name ⇒ String

The name of the vault.

Returns:

• (String)

# File 'lib/aws-sdk-glacier/types.rb', line 1829

class ListJobsInput < Struct.new(
  :account_id,
  :vault_name,
  :limit,
  :marker,
  :statuscode,
  :completed)
  include Aws::Structure
end