| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.Snowball.GetJobUnlockCode
Description
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.
Synopsis
- data GetJobUnlockCode = GetJobUnlockCode' {}
- newGetJobUnlockCode :: Text -> GetJobUnlockCode
- getJobUnlockCode_jobId :: Lens' GetJobUnlockCode Text
- data GetJobUnlockCodeResponse = GetJobUnlockCodeResponse' {
- unlockCode :: Maybe Text
- httpStatus :: Int
- newGetJobUnlockCodeResponse :: Int -> GetJobUnlockCodeResponse
- getJobUnlockCodeResponse_unlockCode :: Lens' GetJobUnlockCodeResponse (Maybe Text)
- getJobUnlockCodeResponse_httpStatus :: Lens' GetJobUnlockCodeResponse Int
Creating a Request
data GetJobUnlockCode Source #
See: newGetJobUnlockCode smart constructor.
Constructors
| GetJobUnlockCode' | |
Instances
Arguments
| :: Text | |
| -> GetJobUnlockCode |
Create a value of GetJobUnlockCode with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetJobUnlockCode, getJobUnlockCode_jobId - The ID for the job that you want to get the UnlockCode value for, for
example JID123e4567-e89b-12d3-a456-426655440000.
Request Lenses
getJobUnlockCode_jobId :: Lens' GetJobUnlockCode Text Source #
The ID for the job that you want to get the UnlockCode value for, for
example JID123e4567-e89b-12d3-a456-426655440000.
Destructuring the Response
data GetJobUnlockCodeResponse Source #
See: newGetJobUnlockCodeResponse smart constructor.
Constructors
| GetJobUnlockCodeResponse' | |
Fields
| |
Instances
newGetJobUnlockCodeResponse Source #
Create a value of GetJobUnlockCodeResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:unlockCode:GetJobUnlockCodeResponse', getJobUnlockCodeResponse_unlockCode - The UnlockCode value for the specified job. The UnlockCode value can
be accessed for up to 360 days after the job has been created.
$sel:httpStatus:GetJobUnlockCodeResponse', getJobUnlockCodeResponse_httpStatus - The response's http status code.
Response Lenses
getJobUnlockCodeResponse_unlockCode :: Lens' GetJobUnlockCodeResponse (Maybe Text) Source #
The UnlockCode value for the specified job. The UnlockCode value can
be accessed for up to 360 days after the job has been created.
getJobUnlockCodeResponse_httpStatus :: Lens' GetJobUnlockCodeResponse Int Source #
The response's http status code.