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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ListJobsInput as input to an Aws::Client method, you can use a vanilla 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 S3 Glacier vault.

Instance Attribute Summary collapse

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 S3 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) —

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

#completed ⇒ String

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

Returns:

  • (String) —

    The state of the jobs to return.

#limit ⇒ Integer

Returns:

  • (Integer)

#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) —

    An opaque string used for pagination.

#statuscode ⇒ String

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

Returns:

  • (String) —

    The type of job status to return.

#vault_name ⇒ String

The name of the vault.

Returns:

  • (String) —

    The name of the vault.