command_invocations

Creates, updates, deletes, gets or lists a command_invocations resource.

Overview

Name	command_invocations
Type	Resource
Id	aws.ssm.command_invocations

Fields

The following fields are returned by SELECT queries:

get_command_invocation

Name	Datatype	Description
cloud_watch_output_config	object	Amazon CloudWatch Logs information where Systems Manager sent the command output.
command_id	string	The parent command ID of the invocation plugin.
comment	string	The comment text for the command.
document_name	string	The name of the document that was run. For example, AWS-RunShellScript. (pattern: <code>^[a-zA-Z0-9_-.]{3,128}$</code>)
document_version	string	The Systems Manager document (SSM document) version used in the request. (pattern: <code>([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$)</code>)
execution_elapsed_time	string	Duration since ExecutionStartDateTime. (pattern: <code>^([-]?\d{4}(?!\d{2}\b))((-?)((0[1-9]|1[0-2])(\3([12]\d|0[1-9]|3[01]))?|W([0-4]\d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]\d|[12]\d{2}|3([0-5]\d|6[1-6])))([T\s]((([01]\d|2[0-3])((:?)[0-5]\d)?|24:?00)([.,]\d(?!:))?)?(\17[0-5]\d([.,]\d)?)?([zZ]|([-])([01]\d|2[0-3]):?([0-5]\d)?)?)?)?$</code>)
execution_end_date_time	string	The date and time the plugin finished running. Date and time are written in ISO 8601 format. For example, June 7, 2017 is represented as 2017-06-7. The following sample Amazon Web Services CLI command uses the InvokedAfter filter. aws ssm list-commands --filters key=InvokedAfter,value=2017-06-07T00:00:00Z If the plugin hasn't started to run, the string is empty. (pattern: <code>^([-]?\d{4}(?!\d{2}\b))((-?)((0[1-9]|1[0-2])(\3([12]\d|0[1-9]|3[01]))?|W([0-4]\d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]\d|[12]\d{2}|3([0-5]\d|6[1-6])))([T\s]((([01]\d|2[0-3])((:?)[0-5]\d)?|24:?00)([.,]\d(?!:))?)?(\17[0-5]\d([.,]\d)?)?([zZ]|([-])([01]\d|2[0-3]):?([0-5]\d)?)?)?)?$</code>)
execution_start_date_time	string	The date and time the plugin started running. Date and time are written in ISO 8601 format. For example, June 7, 2017 is represented as 2017-06-7. The following sample Amazon Web Services CLI command uses the InvokedBefore filter. aws ssm list-commands --filters key=InvokedBefore,value=2017-06-07T00:00:00Z If the plugin hasn't started to run, the string is empty. (pattern: <code>^([-]?\d{4}(?!\d{2}\b))((-?)((0[1-9]|1[0-2])(\3([12]\d|0[1-9]|3[01]))?|W([0-4]\d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]\d|[12]\d{2}|3([0-5]\d|6[1-6])))([T\s]((([01]\d|2[0-3])((:?)[0-5]\d)?|24:?00)([.,]\d(?!:))?)?(\17[0-5]\d([.,]\d)?)?([zZ]|([-])([01]\d|2[0-3]):?([0-5]\d)?)?)?)?$</code>)
instance_id	string	The ID of the managed node targeted by the command. A managed node can be an Amazon Elastic Compute Cloud (Amazon EC2) instance, edge device, or on-premises server or VM in your hybrid environment that is configured for Amazon Web Services Systems Manager. (pattern: <code>(^i-(\w{8}|\w{17})$)|(^mi-\w{17}$)</code>)
plugin_name	string	The name of the plugin, or step name, for which details are reported. For example, aws:RunShellScript is a plugin.
response_code	integer	The error level response code for the plugin script. If the response code is -1, then the command hasn't started running on the managed node, or it wasn't received by the node.
standard_error_content	string	The first 8,000 characters written by the plugin to stderr. If the command hasn't finished running, then this string is empty.
standard_error_url	string	The URL for the complete text written by the plugin to stderr. If the command hasn't finished running, then this string is empty.
standard_output_content	string	The first 24,000 characters written by the plugin to stdout. If the command hasn't finished running, if ExecutionStatus is neither Succeeded nor Failed, then this string is empty.
standard_output_url	string	The URL for the complete text written by the plugin to stdout in Amazon Simple Storage Service (Amazon S3). If an S3 bucket wasn't specified, then this string is empty.
status	string	The status of this invocation plugin. This status can be different than StatusDetails. (Pending, InProgress, Delayed, Success, Cancelled, TimedOut, Failed, Cancelling)
status_details	string	A detailed status of the command execution for an invocation. 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 Amazon Web Services Systems Manager User Guide. StatusDetails can be one of the following values: Pending: The command hasn't been sent to the managed node. In Progress: The command has been sent to the managed node but hasn't reached a terminal state. Delayed: The system attempted to send the command to the target, but the target wasn't available. The managed node might not be available because of network issues, because the node was stopped, or for similar reasons. The system will try to send the command again. Success: The command or plugin ran successfully. This is a terminal state. Delivery Timed Out: The command wasn't delivered to the managed node before the delivery timeout expired. Delivery timeouts don't count against the parent command's MaxErrors limit, but they do contribute to whether the parent command status is Success or Incomplete. This is a terminal state. Execution Timed Out: The command started to run on the managed node, but the execution wasn't complete before the timeout expired. Execution timeouts count against the MaxErrors limit of the parent command. This is a terminal state. Failed: The command wasn't run successfully on the managed node. For a plugin, this indicates that the result code wasn't zero. For a command invocation, this indicates that the result code for one or more plugins wasn't zero. Invocation failures count against the MaxErrors limit of the parent command. This is a terminal state. Cancelled: The command was terminated before it was completed. This is a terminal state. Undeliverable: The command can't be delivered to the managed node. The node might not exist or might not be responding. Undeliverable invocations don't count against the parent command's MaxErrors limit and don't contribute to whether the parent command status is Success or Incomplete. This is a terminal state. Terminated: The parent command exceeded its MaxErrors limit and subsequent command invocations were canceled by the system. This is a terminal state.

list_command_invocations

Name	Datatype	Description
cloud_watch_output_config	object	Configuration options for sending command output to Amazon CloudWatch Logs.
command_id	string	The command against which this invocation was requested.
command_plugins	array	Plugins processed by the command.
comment	string	User-specified information about the command, such as a brief description of what the command should do.
document_name	string	The document name that was requested for execution. (pattern: <code>^[a-zA-Z0-9_-.]{3,128}$</code>)
document_version	string	The Systems Manager document (SSM document) version. (pattern: <code>([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$)</code>)
instance_id	string	The managed node ID in which this invocation was requested. (pattern: <code>(^i-(\w{8}|\w{17})$)|(^mi-\w{17}$)</code>)
instance_name	string	The fully qualified host name of the managed node.
notification_config	object	Configurations for sending notifications about command status changes on a per managed node basis.
requested_date_time	string (date-time)	The time and date the request was sent to this managed node.
service_role	string	The Identity and Access Management (IAM) service role that Run Command, a tool in Amazon Web Services Systems Manager, uses to act on your behalf when sending notifications about command status changes on a per managed node basis.
standard_error_url	string	The URL to the plugin's StdErr file in Amazon Simple Storage Service (Amazon S3), if the S3 bucket was defined for the parent command. For an invocation, StandardErrorUrl is populated if there is just one plugin defined for the command, and the S3 bucket was defined for the command.
standard_output_url	string	The URL to the plugin's StdOut file in Amazon Simple Storage Service (Amazon S3), if the S3 bucket was defined for the parent command. For an invocation, StandardOutputUrl is populated if there is just one plugin defined for the command, and the S3 bucket was defined for the command.
status	string	Whether or not the invocation succeeded, failed, or is pending. (Pending, InProgress, Delayed, Success, Cancelled, TimedOut, Failed, Cancelling)
status_details	string	A detailed status of the command execution for each invocation (each managed node targeted by the command). 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 Amazon Web Services Systems Manager User Guide. StatusDetails can be one of the following values: Pending: The command hasn't been sent to the managed node. In Progress: The command has been sent to the managed node but hasn't reached a terminal state. Success: The execution of the command or plugin was successfully completed. This is a terminal state. Delivery Timed Out: The command wasn't delivered to the managed node before the delivery timeout expired. Delivery timeouts don't count against the parent command's MaxErrors limit, but they do contribute to whether the parent command status is Success or Incomplete. This is a terminal state. Execution Timed Out: Command execution started on the managed node, but the execution wasn't complete before the execution timeout expired. Execution timeouts count against the MaxErrors limit of the parent command. This is a terminal state. Failed: The command wasn't successful on the managed node. For a plugin, this indicates that the result code wasn't zero. For a command invocation, this indicates that the result code for one or more plugins wasn't zero. Invocation failures count against the MaxErrors limit of the parent command. This is a terminal state. Cancelled: The command was terminated before it was completed. This is a terminal state. Undeliverable: The command can't be delivered to the managed node. The managed node might not exist or might not be responding. Undeliverable invocations don't count against the parent command's MaxErrors limit and don't contribute to whether the parent command status is Success or Incomplete. This is a terminal state. Terminated: The parent command exceeded its MaxErrors limit and subsequent command invocations were canceled by the system. This is a terminal state. Delayed: The system attempted to send the command to the managed node but wasn't successful. The system retries again.
trace_output	string	Gets the trace output sent by the agent.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_command_invocation	select	region		Returns detailed information about command execution for an invocation or plugin. The Run Command API follows an eventual consistency model, due to the distributed nature of the system supporting the API. This means that the result of an API command you run that affects your resources might not be immediately visible to all subsequent commands you run. You should keep this in mind when you carry out an API command that immediately follows a previous API command. GetCommandInvocation only gives the execution status of a plugin in a document. To get the command execution status on a specific managed node, use ListCommandInvocations. To get the command execution status across managed nodes, use ListCommands.
list_command_invocations	select	region		An invocation is copy of a command sent to a specific managed node. A command can apply to one or more managed nodes. A command invocation applies to one managed node. For example, if a user runs SendCommand against three managed nodes, then a command invocation is created for each requested managed node ID. ListCommandInvocations provide status about command execution.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_command_invocation

Returns detailed information about command execution for an invocation or plugin. The Run Command API follows an eventual consistency model, due to the distributed nature of the system supporting the API. This means that the result of an API command you run that affects your resources might not be immediately visible to all subsequent commands you run. You should keep this in mind when you carry out an API command that immediately follows a previous API command. GetCommandInvocation only gives the execution status of a plugin in a document. To get the command execution status on a specific managed node, use ListCommandInvocations. To get the command execution status across managed nodes, use ListCommands.

SELECT
cloud_watch_output_config,
command_id,
comment,
document_name,
document_version,
execution_elapsed_time,
execution_end_date_time,
execution_start_date_time,
instance_id,
plugin_name,
response_code,
standard_error_content,
standard_error_url,
standard_output_content,
standard_output_url,
status,
status_details
FROM aws.ssm.command_invocations
WHERE region = '{{ region }}' -- required
;

list_command_invocations

An invocation is copy of a command sent to a specific managed node. A command can apply to one or more managed nodes. A command invocation applies to one managed node. For example, if a user runs SendCommand against three managed nodes, then a command invocation is created for each requested managed node ID. ListCommandInvocations provide status about command execution.

SELECT
cloud_watch_output_config,
command_id,
command_plugins,
comment,
document_name,
document_version,
instance_id,
instance_name,
notification_config,
requested_date_time,
service_role,
standard_error_url,
standard_output_url,
status,
status_details,
trace_output
FROM aws.ssm.command_invocations
WHERE region = '{{ region }}' -- required
;