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 ]

describe-instance-properties¶

Description¶

An API operation used by the Systems Manager console to display information about Systems Manager managed nodes.

Synopsis¶

  describe-instance-properties
[--instance-property-filter-list <value>]
[--filters-with-operator <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¶

--instance-property-filter-list (list)

An array of instance property filters.

(structure)

Describes a filter for a specific list of managed nodes. You can filter node information by using tags. You specify tags by using a key-value mapping.

key -> (string)

The name of the filter.

valueSet -> (list)

The filter values.

(string)

Shorthand Syntax:

key=string,valueSet=string,string ...

JSON Syntax:

[
  {
    "key": "InstanceIds"|"AgentVersion"|"PingStatus"|"PlatformTypes"|"DocumentName"|"ActivationIds"|"IamRole"|"ResourceType"|"AssociationStatus",
    "valueSet": ["string", ...]
  }
  ...
]

--filters-with-operator (list)

The request filters to use with the operator.

(structure)

The filters to describe or get information about your managed nodes.

Key -> (string)

The filter key name to describe your managed nodes.

Values -> (list)

The filter key name to describe your managed nodes.

(string)

Operator -> (string)

The operator used by the filter call.

Shorthand Syntax:

Key=string,Values=string,string,Operator=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Values": ["string", ...],
    "Operator": "Equal"|"NotEqual"|"BeginWith"|"LessThan"|"GreaterThan"
  }
  ...
]

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

--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¶

InstanceProperties -> (list)

Properties for the managed instances.

(structure)

An object containing various properties of a managed node.

Name -> (string)

The value of the EC2 Name tag associated with the node. If a Name tag hasn't been applied to the node, this value is blank.

InstanceId -> (string)

The ID of the managed node.

InstanceType -> (string)

The instance type of the managed node. For example, t3.large.

InstanceRole -> (string)

The instance profile attached to the node. If an instance profile isn't attached to the node, this value is blank.

KeyName -> (string)

The name of the key pair associated with the node. If a key pair isnt't associated with the node, this value is blank.

InstanceState -> (string)

The current state of the node.

Architecture -> (string)

The CPU architecture of the node. For example, x86_64.

IPAddress -> (string)

The public IPv4 address assigned to the node. If a public IPv4 address isn't assigned to the node, this value is blank.

LaunchTime -> (timestamp)

The timestamp for when the node was launched.

PingStatus -> (string)

Connection status of the SSM Agent on the managed node.

LastPingDateTime -> (timestamp)

The date and time when the SSM Agent last pinged the Systems Manager service.

AgentVersion -> (string)

The version of SSM Agent running on your managed node.

PlatformType -> (string)

The operating system platform type of the managed node. For example, Windows.

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.

ActivationId -> (string)

The activation ID created by Systems Manager when the server or virtual machine (VM) was registered

IamRole -> (string)

The IAM role used in the hybrid activation to register the node with Systems Manager.

RegistrationDate -> (timestamp)

The date the node was registered with Systems Manager.

ResourceType -> (string)

The type of managed node.

ComputerName -> (string)

The fully qualified host name of the managed node.

AssociationStatus -> (string)

The status of the State Manager association applied to the managed node.

LastAssociationExecutionDate -> (timestamp)

The date the association was last run.

LastSuccessfulAssociationExecutionDate -> (timestamp)

The last date the association was successfully run.

AssociationOverview -> (structure)

Status information about the aggregated associations.

DetailedStatus -> (string)

Detailed status information about the aggregated associations.

InstanceAssociationStatusAggregatedCount -> (map)

The number of associations for the managed nodes.

key -> (string)

value -> (integer)

SourceId -> (string)

The ID of the source resource.

SourceType -> (string)

The type of the source resource.

NextToken -> (string)

The token for the next set of properties to return. Use this token to get the next set of results.

Table Of Contents

Feedback

User Guide