Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

ListNodes

Takes in filters and returns a list of managed nodes matching the filter criteria.

Request Syntax


{
   "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.

Filters

One or more filters. Use a filter to return a more specific list of managed nodes.

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.)

Type: String

Required: No

SyncName

The name of the AWS managed resource data sync to retrieve information about.

For cross-account/cross-Region configurations, this parameter is required, and the name of the supported resource data sync is AWS-QuickSetup-ManagedNode.

For single account/single-Region configurations, the parameter is not required.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Required: No

Response Syntax


{
   "NextToken": "string",
   "Nodes": [ 
      { 
         "CaptureTime": number,
         "Id": "string",
         "NodeType": { ... },
         "Owner": { 
            "AccountId": "string",
            "OrganizationalUnitId": "string",
            "OrganizationalUnitPath": "string"
         },
         "Region": "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

Nodes

A list of managed nodes that match the specified filter criteria.

Type: Array of Node objects

Array Members: Minimum number of 0 items. Maximum number of 50 items.

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

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 ListNodes.

Sample Request


POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.ListNodes
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: 97

{
  "SyncName": "AWS-QuickSetup-ManagedNode",
  "Filters": [
    {
      "Key": "Region",
      "Values": [
        "us-east-2"
      ],
      "Type": "Equal"
    }
  ],
  "MaxResults": 1
}

Sample Response


{
  "NextToken": "A9lT8CAxj9aDFRi+MNA---truncated---oFq08IEXAMPLE",
  "Nodes": [
    {
      "CaptureTime": 2024-11-19T22:01:18,
      "Id": "i-0471e04240EXAMPLE",
      "NodeType": {
        "Instance": {
          "AgentType": "amazon-ssm-agent",
          "AgentVersion": "3.3.859.0",
          "ComputerName": "ip-192.0.2.0.ec2.internal",
          "InstanceStatus": "Active",
          "IpAddress": "192.0.2.0",
          "ManagedStatus": "Managed",
          "PlatformName": "Amazon Linux",
          "PlatformType": "Linux",
          "PlatformVersion": "2023",
          "ResourceType": "EC2Instance"
        }
      },
      "Owner": {
        "AccountId": "444455556666",
        "OrganizationalUnitId": "ou-b8dn-sEXAMPLE",
        "OrganizationalUnitPath": "r-b8dn/ou-b8dn-sEXAMPLE"
      },
      "Region": "us-east-2"
    }
  ]
}