C# Class Amazon.Glacier.Model.ListJobsRequest

Container for the parameters to the ListJobs operation.

This operation lists jobs for a vault, including jobs that are in-progress and jobs that have recently finished.

NOTE: Amazon Glacier retains recently completed jobs for a period before deleting them; however, it eventually removes completed jobs. The output of completed jobs can be retrieved. Retaining completed jobs for a period of time after they have completed enables you to get a job output in the event you miss the job completion notification or your first attempt to download it fails. For example, suppose you start an archive retrieval job to download an archive. After the job completes, you start to download the archive but encounter a network error. In this scenario, you can retry and download the archive while the job exists.

To retrieve an archive or retrieve a vault inventory from Amazon Glacier, you first initiate a job, and after the job completes, you download the data. For an archive retrieval, the output is the archive data, and for an inventory retrieval, it is the inventory list. The List Job operation returns a list of these jobs sorted by job initiation time.

This List Jobs operation supports pagination. By default, this operation returns up to 1,000 jobs in the response. You should always check the response for a marker at which to continue the list; if there are no more items the marker is null . To return a list of jobs that begins at a specific job, set the marker request parameter to the value you obtained from a previous List Jobs request. You can also limit the number of jobs returned in the response by specifying the limit parameter in the request.

Additionally, you can filter the jobs list returned by specifying an optional statuscode (InProgress, Succeeded, or Failed) and completed (true, false) parameter. The statuscode allows you to specify that only jobs that match a specified status are returned. The completed parameter allows you to specify that only jobs in a specific completion state are returned.

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM) .

For the underlying REST API, go to List Jobs

Inheritance: AmazonGlacierRequest
Datei anzeigen Open project: aws/aws-sdk-net Class Usage Examples

Public Methods

Method Description
ListJobsRequest ( ) : System

Empty constructor used to set properties independently even when a simple constructor is available

ListJobsRequest ( string vaultName ) : System

Instantiates ListJobsRequest with the parameterized properties

ListJobsRequest ( string accountId, string vaultName ) : System

Instantiates ListJobsRequest with the parameterized properties

Private Methods

Method Description
IsSetAccountId ( ) : bool
IsSetCompleted ( ) : bool
IsSetLimit ( ) : bool
IsSetMarker ( ) : bool
IsSetStatuscode ( ) : bool
IsSetVaultName ( ) : bool

Method Details

ListJobsRequest() public method

Empty constructor used to set properties independently even when a simple constructor is available
public ListJobsRequest ( ) : System
return System

ListJobsRequest() public method

Instantiates ListJobsRequest with the parameterized properties
public ListJobsRequest ( string vaultName ) : System
vaultName string The name of the vault.
return System

ListJobsRequest() public method

Instantiates ListJobsRequest with the parameterized properties
public ListJobsRequest ( string accountId, string vaultName ) : System
accountId 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.
vaultName string The name of the vault.
return System