class Amazonite::Ssm::GetCommandInvocationResult

Included Modules

Defined in:

ssm/get_command_invocation_result.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.new(command_id : String | Nil = nil, instance_id : String | Nil = nil, comment : String | Nil = nil, document_name : String | Nil = nil, document_version : String | Nil = nil, plugin_name : String | Nil = nil, response_code : Int32 | Nil = nil, execution_start_date_time : String | Nil = nil, execution_elapsed_time : String | Nil = nil, execution_end_date_time : String | Nil = nil, status : CommandInvocationStatus | Nil = nil, status_details : String | Nil = nil, standard_output_content : String | Nil = nil, standard_output_url : String | Nil = nil, standard_error_content : String | Nil = nil, standard_error_url : String | Nil = nil, cloud_watch_output_config : CloudWatchOutputConfig | Nil = nil) #

[View source]
def self.new(*, __pull_for_json_serializable pull : JSON::PullParser) #

[View source]

Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def cloud_watch_output_config : CloudWatchOutputConfig | Nil #

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


[View source]
def cloud_watch_output_config=(cloud_watch_output_config : CloudWatchOutputConfig | Nil) #

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


[View source]
def command_id : String | Nil #

The parent command ID of the invocation plugin.


[View source]
def command_id=(command_id : String | Nil) #

The parent command ID of the invocation plugin.


[View source]
def comment : String | Nil #

The comment text for the command.


[View source]
def comment=(comment : String | Nil) #

The comment text for the command.


[View source]
def document_name : String | Nil #

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


[View source]
def document_name=(document_name : String | Nil) #

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


[View source]
def document_version : String | Nil #

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


[View source]
def document_version=(document_version : String | Nil) #

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


[View source]
def execution_elapsed_time : String | Nil #

Duration since ExecutionStartDateTime.


[View source]
def execution_elapsed_time=(execution_elapsed_time : String | Nil) #

Duration since ExecutionStartDateTime.


[View source]
def execution_end_date_time : String | Nil #

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.


[View source]
def execution_end_date_time=(execution_end_date_time : String | Nil) #

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.


[View source]
def execution_start_date_time : String | Nil #

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.


[View source]
def execution_start_date_time=(execution_start_date_time : String | Nil) #

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.


[View source]
def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def instance_id : String | Nil #

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.


[View source]
def instance_id=(instance_id : String | Nil) #

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.


[View source]
def plugin_name : String | Nil #

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


[View source]
def plugin_name=(plugin_name : String | Nil) #

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


[View source]
def response_code : Int32 | Nil #

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.


[View source]
def response_code=(response_code : Int32 | Nil) #

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.


[View source]
def standard_error_content : String | Nil #

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


[View source]
def standard_error_content=(standard_error_content : String | Nil) #

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


[View source]
def standard_error_url : String | Nil #

The URL for the complete text written by the plugin to stderr. If the command hasn't finished running, then this string is empty.


[View source]
def standard_error_url=(standard_error_url : String | Nil) #

The URL for the complete text written by the plugin to stderr. If the command hasn't finished running, then this string is empty.


[View source]
def standard_output_content : String | Nil #

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.


[View source]
def standard_output_content=(standard_output_content : String | Nil) #

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.


[View source]
def standard_output_url : String | Nil #

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.


[View source]
def standard_output_url=(standard_output_url : String | Nil) #

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.


[View source]
def status : CommandInvocationStatus | Nil #

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


[View source]
def status=(status : CommandInvocationStatus | Nil) #

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


[View source]
def status_details : String | Nil #

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.


[View source]
def status_details=(status_details : String | Nil) #

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.


[View source]
def validate! : Nil #

[View source]