DescribeActivations
Describes details about the activation, such as the date and time the activation was created, its expiration date, the AWS Identity and Access Management (IAM) role assigned to the managed nodes in the activation, and the number of nodes registered by using this activation.
Request Syntax
{
"Filters": [
{
"FilterKey": "string",
"FilterValues": [ "string" ]
}
],
"MaxResults": number,
"NextToken": "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.
- Filters
-
A filter to view information about your activations.
Type: Array of DescribeActivationsFilter objects
Required: No
- MaxResults
-
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 50.
Required: No
- NextToken
-
A token to start the list. Use this token to get the next set of results.
Type: String
Required: No
Response Syntax
{
"ActivationList": [
{
"ActivationId": "string",
"CreatedDate": number,
"DefaultInstanceName": "string",
"Description": "string",
"ExpirationDate": number,
"Expired": boolean,
"IamRole": "string",
"RegistrationLimit": number,
"RegistrationsCount": number,
"Tags": [
{
"Key": "string",
"Value": "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.
- ActivationList
-
A list of activations for your AWS account.
Type: Array of Activation objects
- NextToken
-
The token for the next set of items to return. Use this token to get the next set of results.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServerError
-
An error occurred on the server side.
HTTP Status Code: 500
- InvalidFilter
-
The filter name isn't valid. Verify that you entered the correct name and try again.
HTTP Status Code: 400
- InvalidNextToken
-
The specified token isn't valid.
HTTP Status Code: 400
Examples
Example
This example illustrates one usage of DescribeActivations.
Sample Request
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.DescribeActivations
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12
X-Amz-Date: 20240324T152059Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240324/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 2Sample Response
{
"ActivationList": [
{
"ActivationId": "e9136c70-ba7b-4d7d-8e31-174a7EXAMPLE",
"CreatedDate": 1581954699.792,
"Description": "Example",
"ExpirationDate": 1584316800,
"Expired": true,
"IamRole": "service-role/RoleForManagedInstances",
"RegistrationLimit": 5,
"RegistrationsCount": 1
}
]
}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
