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.CheckoutBorrowLicense

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Checks out the specified license for offline use.

Synopsis

Creating a Request

data CheckoutBorrowLicense Source #

See: newCheckoutBorrowLicense smart constructor.

Constructors

CheckoutBorrowLicense'

Fields

checkoutMetadata :: Maybe [Metadata]
Information about constraints.
nodeId :: Maybe Text
Node ID.
licenseArn :: Text
Amazon Resource Name (ARN) of the license. The license must use the borrow consumption configuration.
entitlements :: [EntitlementData]
License entitlements. Partial checkouts are not supported.
digitalSignatureMethod :: DigitalSignatureMethod
Digital signature method. The possible value is JSON Web Signature (JWS) algorithm PS384. For more information, see RFC 7518 Digital Signature with RSASSA-PSS.
clientToken :: Text
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Instances

Instances details

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

newCheckoutBorrowLicense Source #

Arguments

:: Text	`CheckoutBorrowLicense`
-> DigitalSignatureMethod	`$sel:digitalSignatureMethod:CheckoutBorrowLicense'`
-> Text	`$sel:clientToken:CheckoutBorrowLicense'`
-> CheckoutBorrowLicense

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

CheckoutBorrowLicense, checkoutBorrowLicense_checkoutMetadata - Information about constraints.

CheckoutBorrowLicense, checkoutBorrowLicense_nodeId - Node ID.

CheckoutBorrowLicense, checkoutBorrowLicense_licenseArn - Amazon Resource Name (ARN) of the license. The license must use the borrow consumption configuration.

CheckoutBorrowLicense, checkoutBorrowLicense_entitlements - License entitlements. Partial checkouts are not supported.

$sel:digitalSignatureMethod:CheckoutBorrowLicense', checkoutBorrowLicense_digitalSignatureMethod - Digital signature method. The possible value is JSON Web Signature (JWS) algorithm PS384. For more information, see RFC 7518 Digital Signature with RSASSA-PSS.

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

Request Lenses

checkoutBorrowLicense_checkoutMetadata :: Lens' CheckoutBorrowLicense (Maybe [Metadata]) Source #

Information about constraints.

checkoutBorrowLicense_nodeId :: Lens' CheckoutBorrowLicense (Maybe Text) Source #

Node ID.

checkoutBorrowLicense_licenseArn :: Lens' CheckoutBorrowLicense Text Source #

Amazon Resource Name (ARN) of the license. The license must use the borrow consumption configuration.

checkoutBorrowLicense_entitlements :: Lens' CheckoutBorrowLicense [EntitlementData] Source #

License entitlements. Partial checkouts are not supported.

checkoutBorrowLicense_digitalSignatureMethod :: Lens' CheckoutBorrowLicense DigitalSignatureMethod Source #

Digital signature method. The possible value is JSON Web Signature (JWS) algorithm PS384. For more information, see RFC 7518 Digital Signature with RSASSA-PSS.

checkoutBorrowLicense_clientToken :: Lens' CheckoutBorrowLicense Text Source #

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

Destructuring the Response

data CheckoutBorrowLicenseResponse Source #

See: newCheckoutBorrowLicenseResponse smart constructor.

Constructors

CheckoutBorrowLicenseResponse'

Fields

checkoutMetadata :: Maybe [Metadata]
Information about constraints.
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 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 CheckoutBorrowLicenseResponse Source #
Instance details Defined in Amazonka.LicenseManager.CheckoutBorrowLicense Associated Types type Rep CheckoutBorrowLicenseResponse :: Type -> Type # Methods from :: CheckoutBorrowLicenseResponse -> Rep CheckoutBorrowLicenseResponse x # to :: Rep CheckoutBorrowLicenseResponse x -> CheckoutBorrowLicenseResponse #
Read CheckoutBorrowLicenseResponse Source #
Instance details Defined in Amazonka.LicenseManager.CheckoutBorrowLicense Methods readsPrec :: Int -> ReadS CheckoutBorrowLicenseResponse # readList :: ReadS [CheckoutBorrowLicenseResponse] # readPrec :: ReadPrec CheckoutBorrowLicenseResponse # readListPrec :: ReadPrec [CheckoutBorrowLicenseResponse] #
Show CheckoutBorrowLicenseResponse Source #
Instance details Defined in Amazonka.LicenseManager.CheckoutBorrowLicense Methods showsPrec :: Int -> CheckoutBorrowLicenseResponse -> ShowS # show :: CheckoutBorrowLicenseResponse -> String # showList :: [CheckoutBorrowLicenseResponse] -> ShowS #
NFData CheckoutBorrowLicenseResponse Source #
Instance details Defined in Amazonka.LicenseManager.CheckoutBorrowLicense Methods rnf :: CheckoutBorrowLicenseResponse -> () #
Eq CheckoutBorrowLicenseResponse Source #
Instance details Defined in Amazonka.LicenseManager.CheckoutBorrowLicense Methods (==) :: CheckoutBorrowLicenseResponse -> CheckoutBorrowLicenseResponse -> Bool # (/=) :: CheckoutBorrowLicenseResponse -> CheckoutBorrowLicenseResponse -> Bool #
type Rep CheckoutBorrowLicenseResponse Source #
Instance details Defined in Amazonka.LicenseManager.CheckoutBorrowLicense type Rep CheckoutBorrowLicenseResponse = D1 ('MetaData "CheckoutBorrowLicenseResponse" "Amazonka.LicenseManager.CheckoutBorrowLicense" "amazonka-license-manager-2.0-7MwrI8iJ3YaDRGRrldCApy" 'False) (C1 ('MetaCons "CheckoutBorrowLicenseResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "checkoutMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Metadata])) :: 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))))))

newCheckoutBorrowLicenseResponse Source #

Arguments

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

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

CheckoutBorrowLicense, checkoutBorrowLicenseResponse_checkoutMetadata - Information about constraints.

$sel:entitlementsAllowed:CheckoutBorrowLicenseResponse', checkoutBorrowLicenseResponse_entitlementsAllowed - Allowed license entitlements.

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

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

CheckoutBorrowLicense, checkoutBorrowLicenseResponse_licenseArn - Amazon Resource Name (ARN) of the license.

$sel:licenseConsumptionToken:CheckoutBorrowLicenseResponse', checkoutBorrowLicenseResponse_licenseConsumptionToken - License consumption token.

CheckoutBorrowLicense, checkoutBorrowLicenseResponse_nodeId - Node ID.

$sel:signedToken:CheckoutBorrowLicenseResponse', checkoutBorrowLicenseResponse_signedToken - Signed token.

$sel:httpStatus:CheckoutBorrowLicenseResponse', checkoutBorrowLicenseResponse_httpStatus - The response's http status code.

Response Lenses

checkoutBorrowLicenseResponse_checkoutMetadata :: Lens' CheckoutBorrowLicenseResponse (Maybe [Metadata]) Source #

Information about constraints.

checkoutBorrowLicenseResponse_entitlementsAllowed :: Lens' CheckoutBorrowLicenseResponse (Maybe [EntitlementData]) Source #

Allowed license entitlements.

checkoutBorrowLicenseResponse_expiration :: Lens' CheckoutBorrowLicenseResponse (Maybe Text) Source #

Date and time at which the license checkout expires.

checkoutBorrowLicenseResponse_issuedAt :: Lens' CheckoutBorrowLicenseResponse (Maybe Text) Source #

Date and time at which the license checkout is issued.

checkoutBorrowLicenseResponse_licenseArn :: Lens' CheckoutBorrowLicenseResponse (Maybe Text) Source #

Amazon Resource Name (ARN) of the license.

checkoutBorrowLicenseResponse_licenseConsumptionToken :: Lens' CheckoutBorrowLicenseResponse (Maybe Text) Source #

License consumption token.

checkoutBorrowLicenseResponse_nodeId :: Lens' CheckoutBorrowLicenseResponse (Maybe Text) Source #

Node ID.

checkoutBorrowLicenseResponse_signedToken :: Lens' CheckoutBorrowLicenseResponse (Maybe Text) Source #

Signed token.

checkoutBorrowLicenseResponse_httpStatus :: Lens' CheckoutBorrowLicenseResponse Int Source #

The response's http status code.