AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the InitiateJob operation. This operation initiates a job of the specified type, which can be a select, an archival retrieval, or a vault retrieval. For more information about using this operation, see the documentation for the underlying REST API Initiate a Job.

Inheritance Hierarchy


Namespace: Amazon.Glacier.Model
Assembly: AWSSDK.Glacier.dll
Version: 3.x.y.z


public class InitiateJobRequest : AmazonGlacierRequest

The InitiateJobRequest type exposes the following members


Public Method InitiateJobRequest()

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

Public Method InitiateJobRequest(string, JobParameters)

Instantiates InitiateJobRequest with the parameterized properties

Public Method InitiateJobRequest(string, string, JobParameters)

Instantiates InitiateJobRequest with the parameterized properties


Public Property AccountId System.String

Gets and sets the property AccountId.

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.

Public Property JobParameters Amazon.Glacier.Model.JobParameters

Gets and sets the property JobParameters.

Provides options for specifying job information.

Public Property VaultName System.String

Gets and sets the property VaultName.

The name of the vault.


The example initiates an inventory-retrieval job for the vault named examplevault.

To initiate an inventory-retrieval job

var response = client.InitiateJob(new InitiateJobRequest 
    AccountId = "-",
    JobParameters = new JobParameters {
        Description = "My inventory job",
        Format = "CSV",
        SNSTopic = "arn:aws:sns:us-west-2:111111111111:Glacier-InventoryRetrieval-topic-Example",
        Type = "inventory-retrieval"
    VaultName = "examplevault"

string jobId = response.JobId;
string location = response.Location;


Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms