Amazonka.LicenseManager.CheckoutLicense

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.

Creating a Request

data CheckoutLicense

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

ToJSON CheckoutLicense

Defined in Amazonka.LicenseManager.CheckoutLicense

Methods

toJSON :: CheckoutLicense -> Value

toEncoding :: CheckoutLicense -> Encoding

toJSONList :: [CheckoutLicense] -> Value

toEncodingList :: [CheckoutLicense] -> Encoding

ToHeaders CheckoutLicense

Defined in Amazonka.LicenseManager.CheckoutLicense

Methods

toHeaders :: CheckoutLicense -> [Header]

ToPath CheckoutLicense

Defined in Amazonka.LicenseManager.CheckoutLicense

Methods

toPath :: CheckoutLicense -> ByteString

ToQuery CheckoutLicense

Defined in Amazonka.LicenseManager.CheckoutLicense

Methods

toQuery :: CheckoutLicense -> QueryString

AWSRequest CheckoutLicense

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

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

Defined in Amazonka.LicenseManager.CheckoutLicense

Methods

readsPrec :: Int -> ReadS CheckoutLicense

readList :: ReadS [CheckoutLicense]

readPrec :: ReadPrec CheckoutLicense

readListPrec :: ReadPrec [CheckoutLicense]

Show CheckoutLicense

Defined in Amazonka.LicenseManager.CheckoutLicense

Methods

showsPrec :: Int -> CheckoutLicense -> ShowS

show :: CheckoutLicense -> String

showList :: [CheckoutLicense] -> ShowS

NFData CheckoutLicense

Defined in Amazonka.LicenseManager.CheckoutLicense

Methods

rnf :: CheckoutLicense -> ()

Eq CheckoutLicense

Defined in Amazonka.LicenseManager.CheckoutLicense

Methods

(==) :: CheckoutLicense -> CheckoutLicense -> Bool

(/=) :: CheckoutLicense -> CheckoutLicense -> Bool

Hashable CheckoutLicense

Defined in Amazonka.LicenseManager.CheckoutLicense

Methods

hashWithSalt :: Int -> CheckoutLicense -> Int

hash :: CheckoutLicense -> Int

type AWSResponse CheckoutLicense

Defined in Amazonka.LicenseManager.CheckoutLicense

type AWSResponse CheckoutLicense = CheckoutLicenseResponse

type Rep CheckoutLicense

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

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)

License beneficiary.

checkoutLicense_nodeId :: Lens' CheckoutLicense (Maybe Text)

Node ID.

checkoutLicense_productSKU :: Lens' CheckoutLicense Text

Product SKU.

checkoutLicense_checkoutType :: Lens' CheckoutLicense CheckoutType

Checkout type.

checkoutLicense_keyFingerprint :: Lens' CheckoutLicense Text

Key fingerprint identifying the license.

checkoutLicense_entitlements :: Lens' CheckoutLicense [EntitlementData]

License entitlements.

checkoutLicense_clientToken :: Lens' CheckoutLicense Text

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

Destructuring the Response

data CheckoutLicenseResponse

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

Generic CheckoutLicenseResponse

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

Defined in Amazonka.LicenseManager.CheckoutLicense

Methods

readsPrec :: Int -> ReadS CheckoutLicenseResponse

readList :: ReadS [CheckoutLicenseResponse]

readPrec :: ReadPrec CheckoutLicenseResponse

readListPrec :: ReadPrec [CheckoutLicenseResponse]

Show CheckoutLicenseResponse

Defined in Amazonka.LicenseManager.CheckoutLicense

Methods

showsPrec :: Int -> CheckoutLicenseResponse -> ShowS

show :: CheckoutLicenseResponse -> String

showList :: [CheckoutLicenseResponse] -> ShowS

NFData CheckoutLicenseResponse

Defined in Amazonka.LicenseManager.CheckoutLicense

Methods

rnf :: CheckoutLicenseResponse -> ()

Eq CheckoutLicenseResponse

Defined in Amazonka.LicenseManager.CheckoutLicense

Methods

(==) :: CheckoutLicenseResponse -> CheckoutLicenseResponse -> Bool

(/=) :: CheckoutLicenseResponse -> CheckoutLicenseResponse -> Bool

type Rep CheckoutLicenseResponse

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))))))

newCheckoutLicenseResponse

Arguments

:: Int

$sel:httpStatus:CheckoutLicenseResponse'

-> CheckoutLicenseResponse

Create a value of CheckoutLicenseResponse 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, checkoutLicenseResponse_checkoutType - Checkout type.

$sel:entitlementsAllowed:CheckoutLicenseResponse', checkoutLicenseResponse_entitlementsAllowed - Allowed license entitlements.

$sel:expiration:CheckoutLicenseResponse', checkoutLicenseResponse_expiration - Date and time at which the license checkout expires.

$sel:issuedAt:CheckoutLicenseResponse', checkoutLicenseResponse_issuedAt - Date and time at which the license checkout is issued.

CheckoutLicenseResponse, checkoutLicenseResponse_licenseArn - Amazon Resource Name (ARN) of the checkout license.

$sel:licenseConsumptionToken:CheckoutLicenseResponse', checkoutLicenseResponse_licenseConsumptionToken - License consumption token.

CheckoutLicense, checkoutLicenseResponse_nodeId - Node ID.

$sel:signedToken:CheckoutLicenseResponse', checkoutLicenseResponse_signedToken - Signed token.

$sel:httpStatus:CheckoutLicenseResponse', checkoutLicenseResponse_httpStatus - The response's http status code.

Response Lenses

checkoutLicenseResponse_checkoutType :: Lens' CheckoutLicenseResponse (Maybe CheckoutType)

Checkout type.

checkoutLicenseResponse_entitlementsAllowed :: Lens' CheckoutLicenseResponse (Maybe [EntitlementData])

Allowed license entitlements.

checkoutLicenseResponse_expiration :: Lens' CheckoutLicenseResponse (Maybe Text)

Date and time at which the license checkout expires.

checkoutLicenseResponse_issuedAt :: Lens' CheckoutLicenseResponse (Maybe Text)

Date and time at which the license checkout is issued.

checkoutLicenseResponse_licenseArn :: Lens' CheckoutLicenseResponse (Maybe Text)

Amazon Resource Name (ARN) of the checkout license.

checkoutLicenseResponse_licenseConsumptionToken :: Lens' CheckoutLicenseResponse (Maybe Text)

License consumption token.

checkoutLicenseResponse_nodeId :: Lens' CheckoutLicenseResponse (Maybe Text)

Node ID.

checkoutLicenseResponse_signedToken :: Lens' CheckoutLicenseResponse (Maybe Text)

Signed token.

checkoutLicenseResponse_httpStatus :: Lens' CheckoutLicenseResponse Int

The response's http status code.