Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . ssm ]

list-nodes¶

Description¶

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

Synopsis¶

  list-nodes
[--sync-name <value>]
[--filters <value>]
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options¶

--sync-name (string)

The name of the resource data sync to retrieve information about. Required for cross-account/cross-Region configurations. Optional for single account/single-Region configurations.

--filters (list)

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

(structure)

The filters for the operation.

Key -> (string)

The name of the filter.

Values -> (list)

A filter value supported by the specified key. For example, for the key PlatformType , supported values include Linux and Windows .

(string)

Type -> (string)

The type of filter operator.

Shorthand Syntax:

Key=string,Values=string,string,Type=string ...

JSON Syntax:

[
  {
    "Key": "AgentType"|"AgentVersion"|"ComputerName"|"InstanceId"|"InstanceStatus"|"IpAddress"|"ManagedStatus"|"PlatformName"|"PlatformType"|"PlatformVersion"|"ResourceType"|"OrganizationalUnitId"|"OrganizationalUnitPath"|"Region"|"AccountId",
    "Values": ["string", ...],
    "Type": "Equal"|"NotEqual"|"BeginWith"
  }
  ...
]

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command's output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command's output. If the total number of items available is more than the value specified, a NextToken is provided in the command's output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output¶

Nodes -> (list)

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

(structure)

Details about an individual managed node.

CaptureTime -> (timestamp)

The UTC timestamp for when the managed node data was last captured.

Id -> (string)

The ID of the managed node.

Owner -> (structure)

Information about the ownership of the managed node.

AccountId -> (string)

The ID of the Amazon Web Services account that owns the managed node.

OrganizationalUnitId -> (string)

The ID of the organization unit (OU) that the account is part of.

OrganizationalUnitPath -> (string)

The path for the organizational unit (OU) that owns the managed node. The path for the OU is built using the IDs of the organization, root, and all OUs in the path down to and including the OU. For example:

o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-ghi0-awsccccc/ou-jkl0-awsddddd/

Region -> (string)

The Amazon Web Services Region that a managed node was created in or assigned to.

NodeType -> (tagged union structure)

Information about the type of node.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: Instance.

Instance -> (structure)

Information about a specific managed node.

AgentType -> (string)

The type of agent installed on the node.

AgentVersion -> (string)

The version number of the agent installed on the node.

ComputerName -> (string)

The fully qualified host name of the managed node.

InstanceStatus -> (string)

The current status of the managed node.

IpAddress -> (string)

The IP address of the managed node.

ManagedStatus -> (string)

Indicates whether the node is managed by Systems Manager.

PlatformType -> (string)

The operating system platform type of the managed node.

PlatformName -> (string)

The name of the operating system platform running on your managed node.

PlatformVersion -> (string)

The version of the OS platform running on your managed node.

ResourceType -> (string)

The type of instance, either an EC2 instance or another supported machine type in a hybrid fleet.

NextToken -> (string)

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

Table Of Contents

Feedback

User Guide