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.LicenseManager.CheckoutLicense

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Checks out the specified license.

If the account that created the license is the same that is performing the check out, you must specify the account as the beneficiary.

Synopsis

data CheckoutLicense = CheckoutLicense' {
- beneficiary :: Maybe Text
- nodeId :: Maybe Text
- productSKU :: Text
- checkoutType :: CheckoutType
- keyFingerprint :: Text
- entitlements :: [EntitlementData]
- clientToken :: Text
}
newCheckoutLicense :: Text -> CheckoutType -> Text -> Text -> CheckoutLicense
checkoutLicense_beneficiary :: Lens' CheckoutLicense (Maybe Text)
checkoutLicense_nodeId :: Lens' CheckoutLicense (Maybe Text)
checkoutLicense_productSKU :: Lens' CheckoutLicense Text
checkoutLicense_checkoutType :: Lens' CheckoutLicense CheckoutType
checkoutLicense_keyFingerprint :: Lens' CheckoutLicense Text
checkoutLicense_entitlements :: Lens' CheckoutLicense [EntitlementData]
checkoutLicense_clientToken :: Lens' CheckoutLicense Text
data CheckoutLicenseResponse = CheckoutLicenseResponse' {
- checkoutType :: Maybe CheckoutType
- entitlementsAllowed :: Maybe [EntitlementData]
- expiration :: Maybe Text
- issuedAt :: Maybe Text
- licenseArn :: Maybe Text
- licenseConsumptionToken :: Maybe Text
- nodeId :: Maybe Text
- signedToken :: Maybe Text
- httpStatus :: Int
}
newCheckoutLicenseResponse :: Int -> CheckoutLicenseResponse
checkoutLicenseResponse_checkoutType :: Lens' CheckoutLicenseResponse (Maybe CheckoutType)
checkoutLicenseResponse_entitlementsAllowed :: Lens' CheckoutLicenseResponse (Maybe [EntitlementData])
checkoutLicenseResponse_expiration :: Lens' CheckoutLicenseResponse (Maybe Text)
checkoutLicenseResponse_issuedAt :: Lens' CheckoutLicenseResponse (Maybe Text)
checkoutLicenseResponse_licenseArn :: Lens' CheckoutLicenseResponse (Maybe Text)
checkoutLicenseResponse_licenseConsumptionToken :: Lens' CheckoutLicenseResponse (Maybe Text)
checkoutLicenseResponse_nodeId :: Lens' CheckoutLicenseResponse (Maybe Text)
checkoutLicenseResponse_signedToken :: Lens' CheckoutLicenseResponse (Maybe Text)
checkoutLicenseResponse_httpStatus :: Lens' CheckoutLicenseResponse Int

Creating a Request

data CheckoutLicense Source #

See: newCheckoutLicense smart constructor.

Constructors

CheckoutLicense'
Fields beneficiary :: Maybe Text License beneficiary. nodeId :: Maybe Text Node ID. productSKU :: Text Product SKU. checkoutType :: CheckoutType Checkout type. keyFingerprint :: Text Key fingerprint identifying the license. entitlements :: [EntitlementData] License entitlements. clientToken :: Text Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Instances

Instances details

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

newCheckoutLicense Source #

Arguments

:: Text	`CheckoutLicense`
-> CheckoutType	`CheckoutLicense`
-> Text	`CheckoutLicense`
-> Text	`$sel:clientToken:CheckoutLicense'`
-> CheckoutLicense

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

CheckoutLicense, checkoutLicense_beneficiary - License beneficiary.

CheckoutLicense, checkoutLicense_nodeId - Node ID.

CheckoutLicense, checkoutLicense_productSKU - Product SKU.

CheckoutLicense, checkoutLicense_checkoutType - Checkout type.

CheckoutLicense, checkoutLicense_keyFingerprint - Key fingerprint identifying the license.

CheckoutLicense, checkoutLicense_entitlements - License entitlements.

$sel:clientToken:CheckoutLicense', checkoutLicense_clientToken - Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Request Lenses

checkoutLicense_beneficiary :: Lens' CheckoutLicense (Maybe Text) Source #

License beneficiary.

checkoutLicense_nodeId :: Lens' CheckoutLicense (Maybe Text) Source #

Node ID.

checkoutLicense_productSKU :: Lens' CheckoutLicense Text Source #

Product SKU.

checkoutLicense_checkoutType :: Lens' CheckoutLicense CheckoutType Source #

Checkout type.

checkoutLicense_keyFingerprint :: Lens' CheckoutLicense Text Source #

Key fingerprint identifying the license.

checkoutLicense_entitlements :: Lens' CheckoutLicense [EntitlementData] Source #

License entitlements.

checkoutLicense_clientToken :: Lens' CheckoutLicense Text Source #

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Destructuring the Response

data CheckoutLicenseResponse Source #

See: newCheckoutLicenseResponse smart constructor.

Constructors

CheckoutLicenseResponse'

Fields

checkoutType :: Maybe CheckoutType
Checkout type.
entitlementsAllowed :: Maybe [EntitlementData]
Allowed license entitlements.
expiration :: Maybe Text
Date and time at which the license checkout expires.
issuedAt :: Maybe Text
Date and time at which the license checkout is issued.
licenseArn :: Maybe Text
Amazon Resource Name (ARN) of the checkout license.
licenseConsumptionToken :: Maybe Text
License consumption token.
nodeId :: Maybe Text
Node ID.
signedToken :: Maybe Text
Signed token.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic CheckoutLicenseResponse Source #
Instance details Defined in Amazonka.LicenseManager.CheckoutLicense Associated Types type Rep CheckoutLicenseResponse :: Type -> Type # Methods from :: CheckoutLicenseResponse -> Rep CheckoutLicenseResponse x # to :: Rep CheckoutLicenseResponse x -> CheckoutLicenseResponse #
Read CheckoutLicenseResponse Source #
Instance details Defined in Amazonka.LicenseManager.CheckoutLicense Methods readsPrec :: Int -> ReadS CheckoutLicenseResponse # readList :: ReadS [CheckoutLicenseResponse] # readPrec :: ReadPrec CheckoutLicenseResponse # readListPrec :: ReadPrec [CheckoutLicenseResponse] #
Show CheckoutLicenseResponse Source #
Instance details Defined in Amazonka.LicenseManager.CheckoutLicense Methods showsPrec :: Int -> CheckoutLicenseResponse -> ShowS # show :: CheckoutLicenseResponse -> String # showList :: [CheckoutLicenseResponse] -> ShowS #
NFData CheckoutLicenseResponse Source #
Instance details Defined in Amazonka.LicenseManager.CheckoutLicense Methods rnf :: CheckoutLicenseResponse -> () #
Eq CheckoutLicenseResponse Source #
Instance details Defined in Amazonka.LicenseManager.CheckoutLicense Methods (==) :: CheckoutLicenseResponse -> CheckoutLicenseResponse -> Bool # (/=) :: CheckoutLicenseResponse -> CheckoutLicenseResponse -> Bool #
type Rep CheckoutLicenseResponse Source #
Instance details Defined in Amazonka.LicenseManager.CheckoutLicense type Rep CheckoutLicenseResponse = D1 ('MetaData "CheckoutLicenseResponse" "Amazonka.LicenseManager.CheckoutLicense" "amazonka-license-manager-2.0-7MwrI8iJ3YaDRGRrldCApy" 'False) (C1 ('MetaCons "CheckoutLicenseResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "checkoutType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CheckoutType)) :: S1 ('MetaSel ('Just "entitlementsAllowed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EntitlementData]))) :: (S1 ('MetaSel ('Just "expiration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "issuedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "licenseArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "licenseConsumptionToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "nodeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "signedToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))