Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetLicense

Gets detailed information about the specified license.

Request Syntax


{
   "LicenseArn": "string",
   "Version": "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.

LicenseArn

Amazon Resource Name (ARN) of the license.

Type: String

Length Constraints: Maximum length of 2048.

Pattern: ^arn:aws(-(cn|us-gov|iso-b|iso-c|iso-d))?:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$

Required: Yes

Version

License version.

Type: String

Required: No

Response Syntax


{
   "License": { 
      "Beneficiary": "string",
      "ConsumptionConfiguration": { 
         "BorrowConfiguration": { 
            "AllowEarlyCheckIn": boolean,
            "MaxTimeToLiveInMinutes": number
         },
         "ProvisionalConfiguration": { 
            "MaxTimeToLiveInMinutes": number
         },
         "RenewType": "string"
      },
      "CreateTime": "string",
      "Entitlements": [ 
         { 
            "AllowCheckIn": boolean,
            "MaxCount": number,
            "Name": "string",
            "Overage": boolean,
            "Unit": "string",
            "Value": "string"
         }
      ],
      "HomeRegion": "string",
      "Issuer": { 
         "KeyFingerprint": "string",
         "Name": "string",
         "SignKey": "string"
      },
      "LicenseArn": "string",
      "LicenseMetadata": [ 
         { 
            "Name": "string",
            "Value": "string"
         }
      ],
      "LicenseName": "string",
      "ProductName": "string",
      "ProductSKU": "string",
      "Status": "string",
      "Validity": { 
         "Begin": "string",
         "End": "string"
      },
      "Version": "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.

License

License details.

Type: License object

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

RateLimitExceededException

Too many requests have been submitted. Try again after a brief wait.

HTTP Status Code: 400

ServerInternalException

The server experienced an internal error. Try again.

HTTP Status Code: 500

ValidationException

The provided input is not valid. Try your request again.

HTTP Status Code: 400