SSM / Client / get_command_invocation

get_command_invocation

SSM.Client.get_command_invocation(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.get_command_invocation(
    CommandId='string',
    InstanceId='string',
    PluginName='string'
)

Parameters:

• CommandId (string) –

  [REQUIRED]

  (Required) The parent command ID of the invocation plugin.

• InstanceId (string) –

  [REQUIRED]

  (Required) 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, and on-premises server or VM in your hybrid environment that is configured for Amazon Web Services Systems Manager.

• PluginName (string) –

  The name of the step for which you want detailed results. If the document contains only one step, you can omit the name and details for that step. If the document contains more than one step, you must specify the name of the step for which you want to view details. Be sure to specify the name of the step, not the name of a plugin like aws:RunShellScript.

  To find the PluginName, check the document content and find the name of the step you want details for. Alternatively, use ListCommandInvocations with the CommandId and Details parameters. The PluginName is the Name attribute of the CommandPlugin object in the CommandPlugins list.

Return type:

dict

Returns:

Response Syntax

{
    'CommandId': 'string',
    'InstanceId': 'string',
    'Comment': 'string',
    'DocumentName': 'string',
    'DocumentVersion': 'string',
    'PluginName': 'string',
    'ResponseCode': 123,
    'ExecutionStartDateTime': 'string',
    'ExecutionElapsedTime': 'string',
    'ExecutionEndDateTime': 'string',
    'Status': 'Pending'|'InProgress'|'Delayed'|'Success'|'Cancelled'|'TimedOut'|'Failed'|'Cancelling',
    'StatusDetails': 'string',
    'StandardOutputContent': 'string',
    'StandardOutputUrl': 'string',
    'StandardErrorContent': 'string',
    'StandardErrorUrl': 'string',
    'CloudWatchOutputConfig': {
        'CloudWatchLogGroupName': 'string',
        'CloudWatchOutputEnabled': True|False
    }
}

Response Structure

• (dict) –

  • CommandId (string) –

    The parent command ID of the invocation plugin.

  • InstanceId (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.

  • Comment (string) –

    The comment text for the command.

  • DocumentName (string) –

    The name of the document that was run. For example, AWS-RunShellScript.

  • DocumentVersion (string) –

    The Systems Manager document (SSM document) version used in the request.

  • PluginName (string) –

    The name of the plugin, or step name, for which details are reported. For example, aws:RunShellScript is a plugin.

  • ResponseCode (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.

  • ExecutionStartDateTime (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.

  • ExecutionElapsedTime (string) –

    Duration since ExecutionStartDateTime.

  • ExecutionEndDateTime (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.

  • Status (string) –

    The status of this invocation plugin. This status can be different than StatusDetails.

  • StatusDetails (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.

  • StandardOutputContent (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.

  • StandardOutputUrl (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.

  • StandardErrorContent (string) –

    The first 8,000 characters written by the plugin to stderr. If the command hasn’t finished running, then this string is empty.

  • StandardErrorUrl (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.

  • CloudWatchOutputConfig (dict) –

    Amazon CloudWatch Logs information where Systems Manager sent the command output.

    • CloudWatchLogGroupName (string) –

      The name of the CloudWatch Logs log group where you want to send command output. If you don’t specify a group name, Amazon Web Services 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.

Exceptions

• SSM.Client.exceptions.InternalServerError

• SSM.Client.exceptions.InvalidCommandId

• SSM.Client.exceptions.InvalidInstanceId

• SSM.Client.exceptions.InvalidPluginName

• SSM.Client.exceptions.InvocationDoesNotExist