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.

Returns the UnlockCode code value for the specified job. A particular UnlockCode value can be accessed for up to 90 days after the associated job has been created.

The UnlockCode value is a 29-character code with 25 alphanumeric characters and 4 hyphens. This code is used to decrypt the manifest file when it is passed along with the manifest to the Snowball through the Snowball client when the client is started for the first time.

As a best practice, we recommend that you don't save a copy of the UnlockCode in the same location as the manifest file for that job. Saving these separately helps prevent unauthorized parties from gaining access to the Snowball associated with that job.

Note:

For PCL this operation is only available in asynchronous form. Please refer to GetJobUnlockCodeAsync.

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

Syntax

C#
public abstract GetJobUnlockCodeResponse GetJobUnlockCode(
         GetJobUnlockCodeRequest request
)
Parameters
request
Type: Amazon.Snowball.Model.GetJobUnlockCodeRequest

Container for the necessary parameters to execute the GetJobUnlockCode service method.

Return Value
The response from the GetJobUnlockCode service method, as returned by Snowball.

Exceptions

ExceptionCondition
InvalidJobStateException The action can't be performed because the job's current state doesn't allow that action to be performed.
InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.

Examples

Returns the UnlockCode code value for the specified job. A particular UnlockCode value can be accessed for up to 90 days after the associated job has been created. The UnlockCode value is a 29-character code with 25 alphanumeric characters and 4 hyphens. This code is used to decrypt the manifest file when it is passed along with the manifest to the Snowball through the Snowball client when the client is started for the first time. As a best practice, we recommend that you don't save a copy of the UnlockCode in the same location as the manifest file for that job. Saving these separately helps prevent unauthorized parties from gaining access to the Snowball associated with that job.

To get the unlock code for a job you've created for AWS Snowball


var response = client.GetJobUnlockCode(new GetJobUnlockCodeRequest 
{
    JobId = "JID123e4567-e89b-12d3-a456-426655440000"
});

string unlockCode = response.UnlockCode;

            

Version Information

.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

See Also