DescribeEntitlements
Retrieves a list that describes one of more entitlements.
Request Syntax
{
"MaxResults": number,
"Name": "string",
"NextToken": "string",
"StackName": "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.
- MaxResults
-
The maximum size of each page of results.
Type: Integer
Required: No
- Name
-
The name of the entitlement.
Type: String
Pattern:
^[a-zA-Z0-9][a-zA-Z0-9_.-]{0,100}$Required: No
- NextToken
-
The pagination token used to retrieve the next page of results for this operation.
Type: String
Length Constraints: Minimum length of 1.
Required: No
- StackName
-
The name of the stack with which the entitlement is associated.
Type: String
Pattern:
^[a-zA-Z0-9][a-zA-Z0-9_.-]{0,100}$Required: Yes
Response Syntax
{
"Entitlements": [
{
"AppVisibility": "string",
"Attributes": [
{
"Name": "string",
"Value": "string"
}
],
"CreatedTime": number,
"Description": "string",
"LastModifiedTime": number,
"Name": "string",
"StackName": "string"
}
],
"NextToken": "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.
- Entitlements
-
The entitlements.
Type: Array of Entitlement objects
- NextToken
-
The pagination token used to retrieve the next page of results for this operation.
Type: String
Length Constraints: Minimum length of 1.
Errors
For information about the errors that are common to all actions, see Common Errors.
- EntitlementNotFoundException
-
The entitlement can't be found.
- Message
-
The error message in the exception.
HTTP Status Code: 400
- OperationNotPermittedException
-
The attempted operation is not permitted.
- Message
-
The error message in the exception.
HTTP Status Code: 400
- ResourceNotFoundException
-
The specified resource was not found.
- Message
-
The error message in the exception.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
