libZSservicesZSamazonka-snowballZSamazonka-snowball
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

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.

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

Creating a Request

data GetJobUnlockCode Source #

See: newGetJobUnlockCode smart constructor.

Constructors

GetJobUnlockCode' 

Fields

  • jobId :: Text

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

Instances

Instances details
Eq GetJobUnlockCode Source # 
Instance details

Defined in Amazonka.Snowball.GetJobUnlockCode

Read GetJobUnlockCode Source # 
Instance details

Defined in Amazonka.Snowball.GetJobUnlockCode

Show GetJobUnlockCode Source # 
Instance details

Defined in Amazonka.Snowball.GetJobUnlockCode

Generic GetJobUnlockCode Source # 
Instance details

Defined in Amazonka.Snowball.GetJobUnlockCode

Associated Types

type Rep GetJobUnlockCode :: Type -> Type #

NFData GetJobUnlockCode Source # 
Instance details

Defined in Amazonka.Snowball.GetJobUnlockCode

Methods

rnf :: GetJobUnlockCode -> () #

Hashable GetJobUnlockCode Source # 
Instance details

Defined in Amazonka.Snowball.GetJobUnlockCode

ToJSON GetJobUnlockCode Source # 
Instance details

Defined in Amazonka.Snowball.GetJobUnlockCode

AWSRequest GetJobUnlockCode Source # 
Instance details

Defined in Amazonka.Snowball.GetJobUnlockCode

Associated Types

type AWSResponse GetJobUnlockCode #

ToHeaders GetJobUnlockCode Source # 
Instance details

Defined in Amazonka.Snowball.GetJobUnlockCode

ToPath GetJobUnlockCode Source # 
Instance details

Defined in Amazonka.Snowball.GetJobUnlockCode

ToQuery GetJobUnlockCode Source # 
Instance details

Defined in Amazonka.Snowball.GetJobUnlockCode

type Rep GetJobUnlockCode Source # 
Instance details

Defined in Amazonka.Snowball.GetJobUnlockCode

type Rep GetJobUnlockCode = D1 ('MetaData "GetJobUnlockCode" "Amazonka.Snowball.GetJobUnlockCode" "libZSservicesZSamazonka-snowballZSamazonka-snowball" 'False) (C1 ('MetaCons "GetJobUnlockCode'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse GetJobUnlockCode Source # 
Instance details

Defined in Amazonka.Snowball.GetJobUnlockCode

newGetJobUnlockCode Source #

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:

$sel:jobId: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

  • unlockCode :: Maybe Text

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

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq GetJobUnlockCodeResponse Source # 
Instance details

Defined in Amazonka.Snowball.GetJobUnlockCode

Read GetJobUnlockCodeResponse Source # 
Instance details

Defined in Amazonka.Snowball.GetJobUnlockCode

Show GetJobUnlockCodeResponse Source # 
Instance details

Defined in Amazonka.Snowball.GetJobUnlockCode

Generic GetJobUnlockCodeResponse Source # 
Instance details

Defined in Amazonka.Snowball.GetJobUnlockCode

Associated Types

type Rep GetJobUnlockCodeResponse :: Type -> Type #

NFData GetJobUnlockCodeResponse Source # 
Instance details

Defined in Amazonka.Snowball.GetJobUnlockCode

type Rep GetJobUnlockCodeResponse Source # 
Instance details

Defined in Amazonka.Snowball.GetJobUnlockCode

type Rep GetJobUnlockCodeResponse = D1 ('MetaData "GetJobUnlockCodeResponse" "Amazonka.Snowball.GetJobUnlockCode" "libZSservicesZSamazonka-snowballZSamazonka-snowball" 'False) (C1 ('MetaCons "GetJobUnlockCodeResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "unlockCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

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.