Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.LicenseManager.CreateToken

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a long-lived token.

A refresh token is a JWT token used to get an access token. With an access token, you can call AssumeRoleWithWebIdentity to get role credentials that you can use to call License Manager to manage the specified license.

Synopsis

data CreateToken = CreateToken' {
- tokenProperties :: Maybe [Text]
- roleArns :: Maybe [Text]
- expirationInDays :: Maybe Int
- licenseArn :: Text
- clientToken :: Text
}
newCreateToken :: Text -> Text -> CreateToken
createToken_tokenProperties :: Lens' CreateToken (Maybe [Text])
createToken_roleArns :: Lens' CreateToken (Maybe [Text])
createToken_expirationInDays :: Lens' CreateToken (Maybe Int)
createToken_licenseArn :: Lens' CreateToken Text
createToken_clientToken :: Lens' CreateToken Text
data CreateTokenResponse = CreateTokenResponse' {
- token :: Maybe Text
- tokenId :: Maybe Text
- tokenType :: Maybe TokenType
- httpStatus :: Int
}
newCreateTokenResponse :: Int -> CreateTokenResponse
createTokenResponse_token :: Lens' CreateTokenResponse (Maybe Text)
createTokenResponse_tokenId :: Lens' CreateTokenResponse (Maybe Text)
createTokenResponse_tokenType :: Lens' CreateTokenResponse (Maybe TokenType)
createTokenResponse_httpStatus :: Lens' CreateTokenResponse Int

Creating a Request

data CreateToken Source #

See: newCreateToken smart constructor.

Constructors

CreateToken'

Fields

tokenProperties :: Maybe [Text]
Data specified by the caller to be included in the JWT token. The data is mapped to the amr claim of the JWT token.
roleArns :: Maybe [Text]
Amazon Resource Name (ARN) of the IAM roles to embed in the token. License Manager does not check whether the roles are in use.
expirationInDays :: Maybe Int
Token expiration, in days, counted from token creation. The default is 365 days.
licenseArn :: Text
Amazon Resource Name (ARN) of the license. The ARN is mapped to the aud claim of the JWT token.
clientToken :: Text
Idempotency token, valid for 10 minutes.

Instances

Instances details

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

newCreateToken Source #

Arguments

:: Text	`$sel:licenseArn:CreateToken'`
-> Text	`$sel:clientToken: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:

$sel:tokenProperties:CreateToken', createToken_tokenProperties - Data specified by the caller to be included in the JWT token. The data is mapped to the amr claim of the JWT token.

$sel:roleArns:CreateToken', createToken_roleArns - Amazon Resource Name (ARN) of the IAM roles to embed in the token. License Manager does not check whether the roles are in use.

$sel:expirationInDays:CreateToken', createToken_expirationInDays - Token expiration, in days, counted from token creation. The default is 365 days.

$sel:licenseArn:CreateToken', createToken_licenseArn - Amazon Resource Name (ARN) of the license. The ARN is mapped to the aud claim of the JWT token.

$sel:clientToken:CreateToken', createToken_clientToken - Idempotency token, valid for 10 minutes.

Request Lenses

createToken_tokenProperties :: Lens' CreateToken (Maybe [Text]) Source #

Data specified by the caller to be included in the JWT token. The data is mapped to the amr claim of the JWT token.

createToken_roleArns :: Lens' CreateToken (Maybe [Text]) Source #

Amazon Resource Name (ARN) of the IAM roles to embed in the token. License Manager does not check whether the roles are in use.

createToken_expirationInDays :: Lens' CreateToken (Maybe Int) Source #

Token expiration, in days, counted from token creation. The default is 365 days.

createToken_licenseArn :: Lens' CreateToken Text Source #

Amazon Resource Name (ARN) of the license. The ARN is mapped to the aud claim of the JWT token.

createToken_clientToken :: Lens' CreateToken Text Source #

Idempotency token, valid for 10 minutes.

Destructuring the Response

data CreateTokenResponse Source #

See: newCreateTokenResponse smart constructor.

Constructors

CreateTokenResponse'
Fields token :: Maybe Text Refresh token, encoded as a JWT token. tokenId :: Maybe Text Token ID. tokenType :: Maybe TokenType Token type. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq CreateTokenResponse Source #
Instance details Defined in Amazonka.LicenseManager.CreateToken Methods (==) :: CreateTokenResponse -> CreateTokenResponse -> Bool # (/=) :: CreateTokenResponse -> CreateTokenResponse -> Bool #
Read CreateTokenResponse Source #
Instance details Defined in Amazonka.LicenseManager.CreateToken Methods readsPrec :: Int -> ReadS CreateTokenResponse # readList :: ReadS [CreateTokenResponse] # readPrec :: ReadPrec CreateTokenResponse # readListPrec :: ReadPrec [CreateTokenResponse] #
Show CreateTokenResponse Source #
Instance details Defined in Amazonka.LicenseManager.CreateToken Methods showsPrec :: Int -> CreateTokenResponse -> ShowS # show :: CreateTokenResponse -> String # showList :: [CreateTokenResponse] -> ShowS #
Generic CreateTokenResponse Source #
Instance details Defined in Amazonka.LicenseManager.CreateToken Associated Types type Rep CreateTokenResponse :: Type -> Type # Methods from :: CreateTokenResponse -> Rep CreateTokenResponse x # to :: Rep CreateTokenResponse x -> CreateTokenResponse #
NFData CreateTokenResponse Source #
Instance details Defined in Amazonka.LicenseManager.CreateToken Methods rnf :: CreateTokenResponse -> () #
type Rep CreateTokenResponse Source #
Instance details Defined in Amazonka.LicenseManager.CreateToken type Rep CreateTokenResponse = D1 ('MetaData "CreateTokenResponse" "Amazonka.LicenseManager.CreateToken" "libZSservicesZSamazonka-license-managerZSamazonka-license-manager" 'False) (C1 ('MetaCons "CreateTokenResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "token") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "tokenId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "tokenType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TokenType)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))