get_job_unlock_code

get_job_unlock_code(**kwargs)

Returns the UnlockCode code value for the specified job. A particular UnlockCode value can be accessed for up to 360 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 Snow device through the Snowball client when the client is started for the first time. The only valid status for calling this API is WithCustomer as the manifest and Unlock code values are used for securing your device and should only be used when you have the device.

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 Snow device associated with that job.

See also: AWS API Documentation

Request Syntax

response = client.get_job_unlock_code(
    JobId='string'
)
Parameters
JobId (string) --

[REQUIRED]

The ID for the job that you want to get the UnlockCode value for, for example JID123e4567-e89b-12d3-a456-426655440000 .

Return type
dict
Returns
Response Syntax
{
    'UnlockCode': 'string'
}

Response Structure

  • (dict) --
    • UnlockCode (string) --

      The UnlockCode value for the specified job. The UnlockCode value can be accessed for up to 360 days after the job has been created.

Exceptions

  • Snowball.Client.exceptions.InvalidResourceException
  • Snowball.Client.exceptions.InvalidJobStateException

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.
response = client.get_job_unlock_code(
    JobId='JID123e4567-e89b-12d3-a456-426655440000',
)

print(response)

Expected Output:

{
    'UnlockCode': '12345-abcde-56789-fghij-01234',
    'ResponseMetadata': {
        '...': '...',
    },
}