DescribeInstanceProperties
An API operation used by the Systems Manager console to display information about Systems Manager managed nodes.
Request Syntax
{
"FiltersWithOperator": [
{
"Key": "string",
"Operator": "string",
"Values": [ "string" ]
}
],
"InstancePropertyFilterList": [
{
"key": "string",
"valueSet": [ "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.
- FiltersWithOperator
-
The request filters to use with the operator.
Type: Array of InstancePropertyStringFilter objects
Array Members: Minimum number of 1 item. Maximum number of 40 items.
Required: No
- InstancePropertyFilterList
-
An array of instance property filters.
Type: Array of InstancePropertyFilter objects
Array Members: Minimum number of 1 item. Maximum number of 40 items.
Required: No
- MaxResults
-
The maximum number of items to return for the 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 5. Maximum value of 1000.
Required: No
- NextToken
-
The token provided by a previous request to use to return the next set of properties.
Type: String
Required: No
Response Syntax
{
"InstanceProperties": [
{
"ActivationId": "string",
"AgentVersion": "string",
"Architecture": "string",
"AssociationOverview": {
"DetailedStatus": "string",
"InstanceAssociationStatusAggregatedCount": {
"string" : number
}
},
"AssociationStatus": "string",
"ComputerName": "string",
"IamRole": "string",
"InstanceId": "string",
"InstanceRole": "string",
"InstanceState": "string",
"InstanceType": "string",
"IPAddress": "string",
"KeyName": "string",
"LastAssociationExecutionDate": number,
"LastPingDateTime": number,
"LastSuccessfulAssociationExecutionDate": number,
"LaunchTime": number,
"Name": "string",
"PingStatus": "string",
"PlatformName": "string",
"PlatformType": "string",
"PlatformVersion": "string",
"RegistrationDate": number,
"ResourceType": "string",
"SourceId": "string",
"SourceType": "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.
- InstanceProperties
-
Properties for the managed instances.
Type: Array of InstanceProperty objects
- NextToken
-
The token for the next set of properties 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
- InvalidActivationId
-
The activation ID isn't valid. Verify that you entered the correct ActivationId or ActivationCode and try again.
HTTP Status Code: 400
- InvalidDocument
-
The specified SSM document doesn't exist.
HTTP Status Code: 400
- InvalidFilterKey
-
The specified key isn't valid.
HTTP Status Code: 400
- InvalidInstanceId
-
The following problems can cause this exception:
-
You don't have permission to access the managed node.
-
AWS Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.
-
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
-
The managed node isn't in a valid state. Valid states are:
Running,Pending,Stopped, andStopping. Invalid states are:Shutting-downandTerminated.
HTTP Status Code: 400
-
- InvalidInstancePropertyFilterValue
-
The specified filter value isn't valid.
HTTP Status Code: 400
- InvalidNextToken
-
The specified token isn't valid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
