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.

This method initiates an archive retieval job for the specified archive and returns back the job id. Once the job is complete

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginInitiateArchiveRetrievalJob and EndInitiateArchiveRetrievalJob.

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

Syntax

C# 
public Task<String> InitiateArchiveRetrievalJobAsync(
         String vaultName,
         String archiveId,
         InitiateArchiveRetrievalOptions options
)

Parameters

vaultName
Type: System.String

The name of the vault that contains the archive to initiate the job for.

archiveId
Type: System.String

The archive id that the download job will retrieve.

options
Type: Amazon.Glacier.Transfer.InitiateArchiveRetrievalOptions

Additional options that can be used for initiating archive retrieval.

Return Value


Type: Task<String>
The job id for the initiated job.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5