list-commands¶
Description¶
Lists the commands requested by users of the AWS account.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
list-commands is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument.
When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: Commands
Synopsis¶
list-commands
[--command-id <value>]
[--instance-id <value>]
[--filters <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]
Options¶
--command-id (string)
(Optional) If provided, lists only the specified command.
--instance-id (string)
(Optional) Lists commands issued against this instance ID.
--filters (list)
(Optional) One or more filters. Use a filter to return a more specific list of results.
(structure)
Describes a command filter.
key -> (string)
The name of the filter.
value -> (string)
The filter value. Valid values for each filter key are as follows:
InvokedAfter : Specify a timestamp to limit your results. For example, specify
2018-07-07T00:00:00Zto see a list of command executions occurring July 7, 2018, and later.InvokedBefore : Specify a timestamp to limit your results. For example, specify
2018-07-07T00:00:00Zto see a list of command executions from before July 7, 2018.Status : Specify a valid command status to see a list of all command executions with that status. Status values you can specify include:
Pending
InProgress
Success
Cancelled
Failed
TimedOut
CancellingDocumentName : Specify name of the SSM document for which you want to see command execution results. For example, specify
AWS-RunPatchBaselineto see command executions that used this SSM document to perform security patching operations on instances.ExecutionStage : Specify one of the following values:
Executing: Returns a list of command executions that are currently still running.
Complete: Returns a list of command executions that have already completed.
Shorthand Syntax:
key=string,value=string ...
JSON Syntax:
[
{
"key": "InvokedAfter"|"InvokedBefore"|"Status"|"ExecutionStage"|"DocumentName",
"value": "string"
}
...
]
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.
--starting-token (string)
A token to specify where to start paginating. This is the
NextTokenfrom 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
NextTokenis provided in the command’s output. To resume pagination, provide theNextTokenvalue in thestarting-tokenargument of a subsequent command. Do not use theNextTokenresponse 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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
See ‘aws help’ for descriptions of global parameters.
Examples¶
Example 1: To get the status of a specific command
The following list-commands example retrieves and displays the status of the specified command.
aws ssm list-commands \
--command-id "0831e1a8-a1ac-4257-a1fd-c831bEXAMPLE"
Example 2: To get the status of commands requested after a specific date
The following list-commands example retrieves the details of commands requested after the specified date.
aws ssm list-commands \
--filter "key=InvokedAfter,value=2020-02-01T00:00:00Z"
Example 3: To list all commands requested in an AWS account
The following list-commands example lists all commands requested by users in the current AWS account and Region.
aws ssm list-commands
Output:
{
"Commands": [
{
"CommandId": "8bee3135-398c-4d31-99b6-e42d2EXAMPLE",
"DocumentName": "AWS-UpdateSSMAgent",
"DocumentVersion": "",
"Comment": "b48291dd-ba76-43e0-b9df-13e11ddaac26:6960febb-2907-4b59-8e1a-d6ce8EXAMPLE",
"ExpiresAfter": "2020-02-19T11:28:02.500000-08:00",
"Parameters": {},
"InstanceIds": [
"i-028ea792daEXAMPLE",
"i-02feef8c46EXAMPLE",
"i-038613f3f0EXAMPLE",
"i-03a530a2d4EXAMPLE",
"i-083b678d37EXAMPLE",
"i-0dee81debaEXAMPLE"
],
"Targets": [],
"RequestedDateTime": "2020-02-19T10:18:02.500000-08:00",
"Status": "Success",
"StatusDetails": "Success",
"OutputS3BucketName": "",
"OutputS3KeyPrefix": "",
"MaxConcurrency": "50",
"MaxErrors": "100%",
"TargetCount": 6,
"CompletedCount": 6,
"ErrorCount": 0,
"DeliveryTimedOutCount": 0,
"ServiceRole": "",
"NotificationConfig": {
"NotificationArn": "",
"NotificationEvents": [],
"NotificationType": ""
},
"CloudWatchOutputConfig": {
"CloudWatchLogGroupName": "",
"CloudWatchOutputEnabled": false
}
}
{
"CommandId": "e9ade581-c03d-476b-9b07-26667EXAMPLE",
"DocumentName": "AWS-FindWindowsUpdates",
"DocumentVersion": "1",
"Comment": "",
"ExpiresAfter": "2020-01-24T12:37:31.874000-08:00",
"Parameters": {
"KbArticleIds": [
""
],
"UpdateLevel": [
"All"
]
},
"InstanceIds": [],
"Targets": [
{
"Key": "InstanceIds",
"Values": [
"i-00ec29b21eEXAMPLE",
"i-09911ddd90EXAMPLE"
]
}
],
"RequestedDateTime": "2020-01-24T11:27:31.874000-08:00",
"Status": "Success",
"StatusDetails": "Success",
"OutputS3BucketName": "my-us-east-2-bucket",
"OutputS3KeyPrefix": "my-rc-output",
"MaxConcurrency": "50",
"MaxErrors": "0",
"TargetCount": 2,
"CompletedCount": 2,
"ErrorCount": 0,
"DeliveryTimedOutCount": 0,
"ServiceRole": "arn:aws:iam::111222333444:role/aws-service-role/ssm.amazonaws.com/AWSServiceRoleForAmazonSSM",
"NotificationConfig": {
"NotificationArn": "arn:aws:sns:us-east-2:111222333444:my-us-east-2-notification-arn",
"NotificationEvents": [
"All"
],
"NotificationType": "Invocation"
},
"CloudWatchOutputConfig": {
"CloudWatchLogGroupName": "",
"CloudWatchOutputEnabled": false
}
}
{
"CommandId": "d539b6c3-70e8-4853-80e5-0ce4fEXAMPLE",
"DocumentName": "AWS-RunPatchBaseline",
"DocumentVersion": "1",
"Comment": "",
"ExpiresAfter": "2020-01-24T12:21:04.350000-08:00",
"Parameters": {
"InstallOverrideList": [
""
],
"Operation": [
"Install"
],
"RebootOption": [
"RebootIfNeeded"
],
"SnapshotId": [
""
]
},
"InstanceIds": [],
"Targets": [
{
"Key": "InstanceIds",
"Values": [
"i-00ec29b21eEXAMPLE",
"i-09911ddd90EXAMPLE"
]
}
],
"RequestedDateTime": "2020-01-24T11:11:04.350000-08:00",
"Status": "Success",
"StatusDetails": "Success",
"OutputS3BucketName": "my-us-east-2-bucket",
"OutputS3KeyPrefix": "my-rc-output",
"MaxConcurrency": "50",
"MaxErrors": "0",
"TargetCount": 2,
"CompletedCount": 2,
"ErrorCount": 0,
"DeliveryTimedOutCount": 0,
"ServiceRole": "arn:aws:iam::111222333444:role/aws-service-role/ssm.amazonaws.com/AWSServiceRoleForAmazonSSM",
"NotificationConfig": {
"NotificationArn": "arn:aws:sns:us-east-2:111222333444:my-us-east-2-notification-arn",
"NotificationEvents": [
"All"
],
"NotificationType": "Invocation"
},
"CloudWatchOutputConfig": {
"CloudWatchLogGroupName": "",
"CloudWatchOutputEnabled": false
}
}
]
}
For more information, see Running Commands Using Systems Manager Run Command in the AWS Systems Manager User Guide.
Output¶
Commands -> (list)
(Optional) The list of commands requested by the user.
(structure)
Describes a command request.
CommandId -> (string)
A unique identifier for this command.
DocumentName -> (string)
The name of the document requested for execution.
DocumentVersion -> (string)
The SSM document version.
Comment -> (string)
User-specified information about the command, such as a brief description of what the command should do.
ExpiresAfter -> (timestamp)
If this time is reached and the command has not already started running, it will not run. Calculated based on the ExpiresAfter user input provided as part of the SendCommand API.
Parameters -> (map)
The parameter values to be inserted in the document when running the command.
key -> (string)
value -> (list)
(string)
InstanceIds -> (list)
The instance IDs against which this command was requested.
(string)
Targets -> (list)
An array of search criteria that targets instances using a Key,Value combination that you specify. Targets is required if you don’t provide one or more instance IDs in the call.
(structure)
An array of search criteria that targets instances using a Key,Value combination that you specify.
Supported formats include the following.
``Key=InstanceIds,Values=*instance-id-1* ,*instance-id-2* ,*instance-id-3* ``
``Key=tag:my-tag-key ,Values=*my-tag-value-1* ,*my-tag-value-2* ``
``Key=tag-key,Values=*my-tag-key-1* ,*my-tag-key-2* ``
(Maintenance window targets only) ``Key=resource-groups:Name,Values=*resource-group-name* ``
(Maintenance window targets only) ``Key=resource-groups:ResourceTypeFilters,Values=*resource-type-1* ,*resource-type-2* ``
For example:
Key=InstanceIds,Values=i-02573cafcfEXAMPLE,i-0471e04240EXAMPLE,i-07782c72faEXAMPLE
Key=tag:CostCenter,Values=CostCenter1,CostCenter2,CostCenter3
Key=tag-key,Values=Name,Instance-Type,CostCenter(Maintenance window targets only)
Key=resource-groups:Name,Values=ProductionResourceGroupThis example demonstrates how to target all resources in the resource group ProductionResourceGroup in your maintenance window.(Maintenance window targets only) ``Key=resource-groups:ResourceTypeFilters,Values=*AWS::EC2::INSTANCE* ,*AWS::EC2::VPC* `` This example demonstrates how to target only EC2 instances and VPCs in your maintenance window.
(State Manager association targets only)
Key=InstanceIds,Values=*This example demonstrates how to target all managed instances in the AWS Region where the association was created.For information about how to send commands that target instances using
Key,Valueparameters, see Targeting multiple instances in the AWS Systems Manager User Guide .Key -> (string)
User-defined criteria for sending commands that target instances that meet the criteria.
Values -> (list)
User-defined criteria that maps to
Key. For example, if you specifiedtag:ServerRole, you could specifyvalue:WebServerto run a command on instances that include EC2 tags ofServerRole,WebServer.(string)
RequestedDateTime -> (timestamp)
The date and time the command was requested.
Status -> (string)
The status of the command.
StatusDetails -> (string)
A detailed status of the command execution. StatusDetails includes more information than Status because it includes states resulting from error and concurrency control parameters. StatusDetails can show different results than Status. For more information about these statuses, see Understanding command statuses in the AWS Systems Manager User Guide . StatusDetails can be one of the following values:
Pending: The command has not been sent to any instances.
In Progress: The command has been sent to at least one instance but has not reached a final state on all instances.
Success: The command successfully ran on all invocations. This is a terminal state.
Delivery Timed Out: The value of MaxErrors or more command invocations shows a status of Delivery Timed Out. This is a terminal state.
Execution Timed Out: The value of MaxErrors or more command invocations shows a status of Execution Timed Out. This is a terminal state.
Failed: The value of MaxErrors or more command invocations shows a status of Failed. This is a terminal state.
Incomplete: The command was attempted on all instances and one or more invocations does not have a value of Success but not enough invocations failed for the status to be Failed. This is a terminal state.
Canceled: The command was terminated before it was completed. This is a terminal state.
Rate Exceeded: The number of instances targeted by the command exceeded the account limit for pending invocations. The system has canceled the command before running it on any instance. This is a terminal state.
OutputS3Region -> (string)
(Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Region of the S3 bucket.
OutputS3BucketName -> (string)
The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command.
OutputS3KeyPrefix -> (string)
The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command.
MaxConcurrency -> (string)
The maximum number of instances that are allowed to run the command at the same time. You can specify a number of instances, such as 10, or a percentage of instances, such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Running commands using Systems Manager Run Command in the AWS Systems Manager User Guide .
MaxErrors -> (string)
The maximum number of errors allowed before the system stops sending the command to additional targets. You can specify a number of errors, such as 10, or a percentage or errors, such as 10%. The default value is 0. For more information about how to use MaxErrors, see Running commands using Systems Manager Run Command in the AWS Systems Manager User Guide .
TargetCount -> (integer)
The number of targets for the command.
CompletedCount -> (integer)
The number of targets for which the command invocation reached a terminal state. Terminal states include the following: Success, Failed, Execution Timed Out, Delivery Timed Out, Canceled, Terminated, or Undeliverable.
ErrorCount -> (integer)
The number of targets for which the status is Failed or Execution Timed Out.
DeliveryTimedOutCount -> (integer)
The number of targets for which the status is Delivery Timed Out.
ServiceRole -> (string)
The IAM service role that Run Command uses to act on your behalf when sending notifications about command status changes.
NotificationConfig -> (structure)
Configurations for sending notifications about command status changes.
NotificationArn -> (string)
An Amazon Resource Name (ARN) for an Amazon Simple Notification Service (Amazon SNS) topic. Run Command pushes notifications about command status changes to this topic.
NotificationEvents -> (list)
The different events for which you can receive notifications. These events include the following: All (events), InProgress, Success, TimedOut, Cancelled, Failed. To learn more about these events, see Monitoring Systems Manager status changes using Amazon SNS notifications in the AWS Systems Manager User Guide .
(string)
NotificationType -> (string)
Command: Receive notification when the status of a command changes. Invocation: For commands sent to multiple instances, receive notification on a per-instance basis when the status of a command changes.
CloudWatchOutputConfig -> (structure)
CloudWatch Logs information where you want Systems Manager to send the command output.
CloudWatchLogGroupName -> (string)
The name of the CloudWatch log group where you want to send command output. If you don’t specify a group name, Systems Manager automatically creates a log group for you. The log group uses the following naming format: aws/ssm/SystemsManagerDocumentName .
CloudWatchOutputEnabled -> (boolean)
Enables Systems Manager to send command output to CloudWatch Logs.
TimeoutSeconds -> (integer)
The
TimeoutSecondsvalue specified for a command.
NextToken -> (string)
(Optional) The token for the next set of items to return. (You received this token from a previous call.)