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.AmplifyBackend.CreateToken

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Generates a one-time challenge code to authenticate a user into your Amplify Admin UI.

Synopsis

Creating a Request

data CreateToken Source #

See: newCreateToken smart constructor.

Constructors

CreateToken'
Fields appId :: Text The app ID.

Instances

Instances details

ToJSON CreateToken Source #
Instance details Defined in Amazonka.AmplifyBackend.CreateToken Methods toJSON :: CreateToken -> Value # toEncoding :: CreateToken -> Encoding # toJSONList :: [CreateToken] -> Value # toEncodingList :: [CreateToken] -> Encoding #
ToHeaders CreateToken Source #
Instance details Defined in Amazonka.AmplifyBackend.CreateToken Methods toHeaders :: CreateToken -> [Header] #
ToPath CreateToken Source #
Instance details Defined in Amazonka.AmplifyBackend.CreateToken Methods toPath :: CreateToken -> ByteString #
ToQuery CreateToken Source #
Instance details Defined in Amazonka.AmplifyBackend.CreateToken Methods toQuery :: CreateToken -> QueryString #
AWSRequest CreateToken Source #
Instance details Defined in Amazonka.AmplifyBackend.CreateToken Associated Types type AWSResponse CreateToken # Methods request :: (Service -> Service) -> CreateToken -> Request CreateToken # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateToken -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateToken))) #
Generic CreateToken Source #
Instance details Defined in Amazonka.AmplifyBackend.CreateToken Associated Types type Rep CreateToken :: Type -> Type # Methods from :: CreateToken -> Rep CreateToken x # to :: Rep CreateToken x -> CreateToken #
Read CreateToken Source #
Instance details Defined in Amazonka.AmplifyBackend.CreateToken Methods readsPrec :: Int -> ReadS CreateToken # readList :: ReadS [CreateToken] # readPrec :: ReadPrec CreateToken # readListPrec :: ReadPrec [CreateToken] #
Show CreateToken Source #
Instance details Defined in Amazonka.AmplifyBackend.CreateToken Methods showsPrec :: Int -> CreateToken -> ShowS # show :: CreateToken -> String # showList :: [CreateToken] -> ShowS #
NFData CreateToken Source #
Instance details Defined in Amazonka.AmplifyBackend.CreateToken Methods rnf :: CreateToken -> () #
Eq CreateToken Source #
Instance details Defined in Amazonka.AmplifyBackend.CreateToken Methods (==) :: CreateToken -> CreateToken -> Bool # (/=) :: CreateToken -> CreateToken -> Bool #
Hashable CreateToken Source #
Instance details Defined in Amazonka.AmplifyBackend.CreateToken Methods hashWithSalt :: Int -> CreateToken -> Int # hash :: CreateToken -> Int #
type AWSResponse CreateToken Source #
Instance details Defined in Amazonka.AmplifyBackend.CreateToken type AWSResponse CreateToken = CreateTokenResponse
type Rep CreateToken Source #
Instance details Defined in Amazonka.AmplifyBackend.CreateToken type Rep CreateToken = D1 ('MetaData "CreateToken" "Amazonka.AmplifyBackend.CreateToken" "amazonka-amplifybackend-2.0-KAbme26dIsGHSomQ2pZcRc" 'False) (C1 ('MetaCons "CreateToken'" 'PrefixI 'True) (S1 ('MetaSel ('Just "appId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newCreateToken Source #

Arguments

:: Text	`CreateToken`
-> CreateToken

Create a value of CreateToken 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:

CreateToken, createToken_appId - The app ID.

Request Lenses

createToken_appId :: Lens' CreateToken Text Source #

The app ID.

Destructuring the Response

data CreateTokenResponse Source #

See: newCreateTokenResponse smart constructor.

Constructors

CreateTokenResponse'
Fields appId :: Maybe Text The app ID. challengeCode :: Maybe Text One-time challenge code for authenticating into the Amplify Admin UI. sessionId :: Maybe Text A unique ID provided when creating a new challenge token. ttl :: Maybe Text The expiry time for the one-time generated token code. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateTokenResponse Source #
Instance details Defined in Amazonka.AmplifyBackend.CreateToken Associated Types type Rep CreateTokenResponse :: Type -> Type # Methods from :: CreateTokenResponse -> Rep CreateTokenResponse x # to :: Rep CreateTokenResponse x -> CreateTokenResponse #
Read CreateTokenResponse Source #
Instance details Defined in Amazonka.AmplifyBackend.CreateToken Methods readsPrec :: Int -> ReadS CreateTokenResponse # readList :: ReadS [CreateTokenResponse] # readPrec :: ReadPrec CreateTokenResponse # readListPrec :: ReadPrec [CreateTokenResponse] #
Show CreateTokenResponse Source #
Instance details Defined in Amazonka.AmplifyBackend.CreateToken Methods showsPrec :: Int -> CreateTokenResponse -> ShowS # show :: CreateTokenResponse -> String # showList :: [CreateTokenResponse] -> ShowS #
NFData CreateTokenResponse Source #
Instance details Defined in Amazonka.AmplifyBackend.CreateToken Methods rnf :: CreateTokenResponse -> () #
Eq CreateTokenResponse Source #
Instance details Defined in Amazonka.AmplifyBackend.CreateToken Methods (==) :: CreateTokenResponse -> CreateTokenResponse -> Bool # (/=) :: CreateTokenResponse -> CreateTokenResponse -> Bool #
type Rep CreateTokenResponse Source #
Instance details Defined in Amazonka.AmplifyBackend.CreateToken type Rep CreateTokenResponse = D1 ('MetaData "CreateTokenResponse" "Amazonka.AmplifyBackend.CreateToken" "amazonka-amplifybackend-2.0-KAbme26dIsGHSomQ2pZcRc" 'False) (C1 ('MetaCons "CreateTokenResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "appId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "challengeCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "sessionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "ttl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newCreateTokenResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateTokenResponse'`
-> CreateTokenResponse

Create a value of CreateTokenResponse 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:

CreateToken, createTokenResponse_appId - The app ID.

$sel:challengeCode:CreateTokenResponse', createTokenResponse_challengeCode - One-time challenge code for authenticating into the Amplify Admin UI.

$sel:sessionId:CreateTokenResponse', createTokenResponse_sessionId - A unique ID provided when creating a new challenge token.

$sel:ttl:CreateTokenResponse', createTokenResponse_ttl - The expiry time for the one-time generated token code.

$sel:httpStatus:CreateTokenResponse', createTokenResponse_httpStatus - The response's http status code.

Response Lenses

createTokenResponse_appId :: Lens' CreateTokenResponse (Maybe Text) Source #

The app ID.

createTokenResponse_challengeCode :: Lens' CreateTokenResponse (Maybe Text) Source #

One-time challenge code for authenticating into the Amplify Admin UI.

createTokenResponse_sessionId :: Lens' CreateTokenResponse (Maybe Text) Source #

A unique ID provided when creating a new challenge token.

createTokenResponse_ttl :: Lens' CreateTokenResponse (Maybe Text) Source #

The expiry time for the one-time generated token code.

createTokenResponse_httpStatus :: Lens' CreateTokenResponse Int Source #

The response's http status code.