ListNodesSummary
Generates a summary of managed instance/node metadata based on the filters and aggregators you specify. Results are grouped by the input aggregator you specify.
Request Syntax
{
"Aggregators": [
{
"Aggregators": [
"NodeAggregator"
],
"AggregatorType": "string",
"AttributeName": "string",
"TypeName": "string"
}
],
"Filters": [
{
"Key": "string",
"Type": "string",
"Values": [ "string" ]
}
],
"MaxResults": number,
"NextToken": "string",
"SyncName": "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.
- Aggregators
-
Specify one or more aggregators to return a count of managed nodes that match that expression. For example, a count of managed nodes by operating system.
Type: Array of NodeAggregator objects
Array Members: Minimum number of 1 item. Maximum number of 2 items.
Required: Yes
- Filters
-
One or more filters. Use a filter to generate a summary that matches your specified filter criteria.
Type: Array of NodeFilter objects
Array Members: Minimum number of 1 item. Maximum number of 5 items.
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
-
The token for the next set of items to return. (You received this token from a previous call.) The call also returns a token that you can specify in a subsequent call to get the next set of results.
Type: String
Required: No
- SyncName
-
The name of the resource data sync to retrieve information about. Required for cross-account/cross-Region configuration. Optional for single account/single-Region configurations.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Required: No
Response Syntax
{
"NextToken": "string",
"Summary": [
{
"string" : "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.
- NextToken
-
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
Type: String
- Summary
-
A collection of objects reporting information about your managed nodes, such as the count of nodes by operating system.
Type: Array of string to string maps
Array Members: Minimum number of 0 items. Maximum number of 50 items.
Map Entries: Minimum number of 0 items. Maximum number of 3 items.
Key Length Constraints: Minimum length of 1. Maximum length of 64.
Value Length Constraints: Minimum length of 0. Maximum length of 4096.
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
- InvalidAggregatorException
-
The specified aggregator isn't valid for the group type. Verify that the aggregator you provided is supported.
HTTP Status Code: 400
- 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
- ResourceDataSyncNotFoundException
-
The specified sync name wasn't found.
HTTP Status Code: 400
- UnsupportedOperationException
-
This operation is not supported for the current account. You must first enable the Systems Manager integrated experience in your account.
HTTP Status Code: 400
Examples
Example
This example illustrates one usage of ListNodesSummary.
Sample Request
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.ListNodesSummary
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: 20241119/25T150301Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240325/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 197
{
"SyncName": "AWS-QuickSetup-ManagedNode",
"Aggregators":
[
{"AggregatorType": "Count",
"TypeName": "Instance",
"AttributeName": "Region"}
],
"Filters":
[
{"Key": "InstanceStatus",
"Values":
["Active"],
"Type": "Equal"}
],
"MaxResults" : 2,
"NextToken": "A9lT8CAxj9aDFRi+MNA---truncated---oFq08IEXAMPLE"
}Example
This example illustrates one usage of ListNodesSummary.
Sample Response
{
"Summary": [
{
"Count": "26",
"Region": "us-east-1"
},
{
"Count": "7",
"Region": "us-east-2"
}
]
}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
