CheckoutLicense
Checks out the specified license.
Note
If the account that created the license is the same that is performing the check out, you must specify the account as the beneficiary.
Request Syntax
{
"Beneficiary": "string",
"CheckoutType": "string",
"ClientToken": "string",
"Entitlements": [
{
"Name": "string",
"Unit": "string",
"Value": "string"
}
],
"KeyFingerprint": "string",
"NodeId": "string",
"ProductSKU": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- Beneficiary
-
License beneficiary.
Type: String
Required: No
- CheckoutType
-
Checkout type.
Type: String
Valid Values:
PROVISIONAL | PERPETUALRequired: Yes
- ClientToken
-
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
Type: String
Length Constraints: Maximum length of 2048.
Pattern:
\S+Required: Yes
- Entitlements
-
License entitlements.
Type: Array of EntitlementData objects
Required: Yes
- KeyFingerprint
-
Key fingerprint identifying the license.
Type: String
Required: Yes
- NodeId
-
Node ID.
Type: String
Required: No
- ProductSKU
-
Product SKU.
Type: String
Required: Yes
Response Syntax
{
"CheckoutType": "string",
"EntitlementsAllowed": [
{
"Name": "string",
"Unit": "string",
"Value": "string"
}
],
"Expiration": "string",
"IssuedAt": "string",
"LicenseArn": "string",
"LicenseConsumptionToken": "string",
"NodeId": "string",
"SignedToken": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- CheckoutType
-
Checkout type.
Type: String
Valid Values:
PROVISIONAL | PERPETUAL - EntitlementsAllowed
-
Allowed license entitlements.
Type: Array of EntitlementData objects
- Expiration
-
Date and time at which the license checkout expires.
Type: String
Length Constraints: Maximum length of 50.
Pattern:
^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|0[1-9]|[1-2][0-9])T(2[0-3]|[0-1][0-9]):([0-5][0-9]):([0-5][0-9])(\.[0-9]+)?(Z|[+-](?:2[ 0-3]|[0-1][0-9]):[0-5][0-9])+$ - IssuedAt
-
Date and time at which the license checkout is issued.
Type: String
Length Constraints: Maximum length of 50.
Pattern:
^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|0[1-9]|[1-2][0-9])T(2[0-3]|[0-1][0-9]):([0-5][0-9]):([0-5][0-9])(\.[0-9]+)?(Z|[+-](?:2[ 0-3]|[0-1][0-9]):[0-5][0-9])+$ - LicenseArn
-
Amazon Resource Name (ARN) of the checkout license.
Type: String
- LicenseConsumptionToken
-
License consumption token.
Type: String
- NodeId
-
Node ID.
Type: String
- SignedToken
-
Signed token.
Type: String
Length Constraints: Minimum length of 4096.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
Access to resource denied.
HTTP Status Code: 400
- AuthorizationException
-
The AWS user account does not have permission to perform the action. Check the IAM policy associated with this account.
HTTP Status Code: 400
- InvalidParameterValueException
-
One or more parameter values are not valid.
HTTP Status Code: 400
- NoEntitlementsAllowedException
-
There are no entitlements found for this license, or the entitlement maximum count is reached.
HTTP Status Code: 400
- RateLimitExceededException
-
Too many requests have been submitted. Try again after a brief wait.
HTTP Status Code: 400
- RedirectException
-
This is not the correct Region for the resource. Try again.
HTTP Status Code: 400
- ResourceNotFoundException
-
The resource cannot be found.
HTTP Status Code: 400
- ServerInternalException
-
The server experienced an internal error. Try again.
HTTP Status Code: 500
- UnsupportedDigitalSignatureMethodException
-
The digital signature method is unsupported. Try your request again.
HTTP Status Code: 400
- ValidationException
-
The provided input is not valid. Try your request again.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
