View a markdown version of this page

Use DescribeInstanceAssociationsStatus with a CLI - AWS SDK Code Examples

There are more AWS SDK examples available in the AWS Doc SDK Examples GitHub repo.

Use DescribeInstanceAssociationsStatus with a CLI

The following code examples show how to use DescribeInstanceAssociationsStatus.

CLI
AWS CLI

To describe the status of an instance's associations

The following describe-instance-associations-status example shows details of the associations for an instance.

aws ssm describe-instance-associations-status \ --instance-id "i-1234567890abcdef0"

Output:

{ "InstanceAssociationStatusInfos": [ { "AssociationId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "Name": "AWS-GatherSoftwareInventory", "DocumentVersion": "1", "AssociationVersion": "1", "InstanceId": "i-1234567890abcdef0", "ExecutionDate": 1550501886.0, "Status": "Success", "ExecutionSummary": "1 out of 1 plugin processed, 1 success, 0 failed, 0 timedout, 0 skipped. ", "AssociationName": "Inventory-Association" }, { "AssociationId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "Name": "AWS-UpdateSSMAgent", "DocumentVersion": "1", "AssociationVersion": "1", "InstanceId": "i-1234567890abcdef0", "ExecutionDate": 1550505828.548, "Status": "Success", "DetailedStatus": "Success", "AssociationName": "UpdateSSMAgent" } ] }

For more information, see Working with associations in Systems Manager in the AWS Systems Manager User Guide.

PowerShell
Tools for PowerShell V4

Example 1: This example shows details of the associations for an instance.

Get-SSMInstanceAssociationsStatus -InstanceId "i-0000293ffd8c57862"

Output:

AssociationId : d8617c07-2079-4c18-9847-1655fc2698b0 DetailedStatus : Pending DocumentVersion : 1 ErrorCode : ExecutionDate : 2/20/2015 8:31:11 AM ExecutionSummary : temp_status_change InstanceId : i-0000293ffd8c57862 Name : AWS-UpdateSSMAgent OutputUrl : Status : Pending

Example 2: This example checks the instance association status for the given instance id and further, displays the execution status of those associations

Get-SSMInstanceAssociationsStatus -InstanceId i-012e3cb4df567e8aa | ForEach-Object {Get-SSMAssociationExecution -AssociationId .AssociationId}

Output:

AssociationId : 512a34a5-c678-1234-1234-12345678db9e AssociationVersion : 2 CreatedTime : 3/2/2019 8:53:29 AM DetailedStatus : ExecutionId : 512a34a5-c678-1234-1234-12345678db9e LastExecutionDate : 1/1/0001 12:00:00 AM ResourceCountByStatus : {Success=9} Status : Success
Tools for PowerShell V5

Example 1: This example shows details of the associations for an instance.

Get-SSMInstanceAssociationsStatus -InstanceId "i-0000293ffd8c57862"

Output:

AssociationId : d8617c07-2079-4c18-9847-1655fc2698b0 DetailedStatus : Pending DocumentVersion : 1 ErrorCode : ExecutionDate : 2/20/2015 8:31:11 AM ExecutionSummary : temp_status_change InstanceId : i-0000293ffd8c57862 Name : AWS-UpdateSSMAgent OutputUrl : Status : Pending

Example 2: This example checks the instance association status for the given instance id and further, displays the execution status of those associations

Get-SSMInstanceAssociationsStatus -InstanceId i-012e3cb4df567e8aa | ForEach-Object {Get-SSMAssociationExecution -AssociationId .AssociationId}

Output:

AssociationId : 512a34a5-c678-1234-1234-12345678db9e AssociationVersion : 2 CreatedTime : 3/2/2019 8:53:29 AM DetailedStatus : ExecutionId : 512a34a5-c678-1234-1234-12345678db9e LastExecutionDate : 1/1/0001 12:00:00 AM ResourceCountByStatus : {Success=9} Status : Success