GetJobUnlockCode
Important
End of support notice: On November 12, 2024, AWS will discontinue previous generation AWS Snowball devices, and both Snowcone devices (HDD and SDD). We will continue to support existing customers using these end-of-life devices until November 12, 2025. The latest generation AWS Snowball devices are available for all customers.
For more information, visit this blog post
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.
Request Syntax
{
"JobId": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- JobId
-
The ID for the job that you want to get the
UnlockCode
value for, for exampleJID123e4567-e89b-12d3-a456-426655440000
.Type: String
Length Constraints: Fixed length of 39.
Pattern:
(M|J)ID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}
Required: Yes
Response Syntax
{
"UnlockCode": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- UnlockCode
-
The
UnlockCode
value for the specified job. TheUnlockCode
value can be accessed for up to 360 days after the job has been created.Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
.*
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidJobStateException
-
The action can't be performed because the job's current state doesn't allow that action to be performed.
HTTP Status Code: 400
- InvalidResourceException
-
The specified resource can't be found. Check the information you provided in your last request, and try again.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: