Class: Aws::SSM::Types::GetCommandInvocationResult
- Inherits:
-
Struct
- Object
- Struct
- Aws::SSM::Types::GetCommandInvocationResult
- Includes:
- Aws::Structure
- Defined in:
- lib/aws-sdk-ssm/types.rb
Overview
Instance Attribute Summary collapse
-
#cloud_watch_output_config ⇒ Types::CloudWatchOutputConfig
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 executed.
-
#document_version ⇒ String
The SSM document version used in the request.
-
#execution_elapsed_time ⇒ String
Duration since ExecutionStartDateTime.
-
#execution_end_date_time ⇒ String
The date and time the plugin was finished executing.
-
#execution_start_date_time ⇒ String
The date and time the plugin started executing.
-
#instance_id ⇒ String
The ID of the managed instance targeted by the command.
-
#plugin_name ⇒ String
The name of the plugin for which you want detailed results.
-
#response_code ⇒ Integer
The error level response code for the plugin script.
-
#standard_error_content ⇒ String
The first 8,000 characters written by the plugin to stderr.
-
#standard_error_url ⇒ String
The URL for the complete text written by the plugin to stderr.
-
#standard_output_content ⇒ String
The first 24,000 characters written by the plugin to stdout.
-
#standard_output_url ⇒ String
The URL for the complete text written by the plugin to stdout in Amazon S3.
-
#status ⇒ String
The status of this invocation plugin.
-
#status_details ⇒ String
A detailed status of the command execution for an invocation.
Instance Attribute Details
#cloud_watch_output_config ⇒ Types::CloudWatchOutputConfig
CloudWatch Logs information where Systems Manager sent the command output.
5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 |
# File 'lib/aws-sdk-ssm/types.rb', line 5780 class GetCommandInvocationResult < Struct.new( :command_id, :instance_id, :comment, :document_name, :document_version, :plugin_name, :response_code, :execution_start_date_time, :execution_elapsed_time, :execution_end_date_time, :status, :status_details, :standard_output_content, :standard_output_url, :standard_error_content, :standard_error_url, :cloud_watch_output_config) include Aws::Structure end |
#command_id ⇒ String
The parent command ID of the invocation plugin.
5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 |
# File 'lib/aws-sdk-ssm/types.rb', line 5780 class GetCommandInvocationResult < Struct.new( :command_id, :instance_id, :comment, :document_name, :document_version, :plugin_name, :response_code, :execution_start_date_time, :execution_elapsed_time, :execution_end_date_time, :status, :status_details, :standard_output_content, :standard_output_url, :standard_error_content, :standard_error_url, :cloud_watch_output_config) include Aws::Structure end |
#comment ⇒ String
The comment text for the command.
5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 |
# File 'lib/aws-sdk-ssm/types.rb', line 5780 class GetCommandInvocationResult < Struct.new( :command_id, :instance_id, :comment, :document_name, :document_version, :plugin_name, :response_code, :execution_start_date_time, :execution_elapsed_time, :execution_end_date_time, :status, :status_details, :standard_output_content, :standard_output_url, :standard_error_content, :standard_error_url, :cloud_watch_output_config) include Aws::Structure end |
#document_name ⇒ String
The name of the document that was executed. For example, AWS-RunShellScript.
5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 |
# File 'lib/aws-sdk-ssm/types.rb', line 5780 class GetCommandInvocationResult < Struct.new( :command_id, :instance_id, :comment, :document_name, :document_version, :plugin_name, :response_code, :execution_start_date_time, :execution_elapsed_time, :execution_end_date_time, :status, :status_details, :standard_output_content, :standard_output_url, :standard_error_content, :standard_error_url, :cloud_watch_output_config) include Aws::Structure end |
#document_version ⇒ String
The SSM document version used in the request.
5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 |
# File 'lib/aws-sdk-ssm/types.rb', line 5780 class GetCommandInvocationResult < Struct.new( :command_id, :instance_id, :comment, :document_name, :document_version, :plugin_name, :response_code, :execution_start_date_time, :execution_elapsed_time, :execution_end_date_time, :status, :status_details, :standard_output_content, :standard_output_url, :standard_error_content, :standard_error_url, :cloud_watch_output_config) include Aws::Structure end |
#execution_elapsed_time ⇒ String
Duration since ExecutionStartDateTime.
5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 |
# File 'lib/aws-sdk-ssm/types.rb', line 5780 class GetCommandInvocationResult < Struct.new( :command_id, :instance_id, :comment, :document_name, :document_version, :plugin_name, :response_code, :execution_start_date_time, :execution_elapsed_time, :execution_end_date_time, :status, :status_details, :standard_output_content, :standard_output_url, :standard_error_content, :standard_error_url, :cloud_watch_output_config) include Aws::Structure end |
#execution_end_date_time ⇒ String
The date and time the plugin was finished executing. Date and time are written in ISO 8601 format. For example, June 7, 2017 is represented as 2017-06-7. The following sample AWS CLI command uses the ‘InvokedAfter` filter.
‘aws ssm list-commands –filters key=InvokedAfter,value=2017-06-07T00:00:00Z`
If the plugin has not started to execute, the string is empty.
5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 |
# File 'lib/aws-sdk-ssm/types.rb', line 5780 class GetCommandInvocationResult < Struct.new( :command_id, :instance_id, :comment, :document_name, :document_version, :plugin_name, :response_code, :execution_start_date_time, :execution_elapsed_time, :execution_end_date_time, :status, :status_details, :standard_output_content, :standard_output_url, :standard_error_content, :standard_error_url, :cloud_watch_output_config) include Aws::Structure end |
#execution_start_date_time ⇒ String
The date and time the plugin started executing. Date and time are written in ISO 8601 format. For example, June 7, 2017 is represented as 2017-06-7. The following sample AWS CLI command uses the ‘InvokedBefore` filter.
‘aws ssm list-commands –filters key=InvokedBefore,value=2017-06-07T00:00:00Z`
If the plugin has not started to execute, the string is empty.
5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 |
# File 'lib/aws-sdk-ssm/types.rb', line 5780 class GetCommandInvocationResult < Struct.new( :command_id, :instance_id, :comment, :document_name, :document_version, :plugin_name, :response_code, :execution_start_date_time, :execution_elapsed_time, :execution_end_date_time, :status, :status_details, :standard_output_content, :standard_output_url, :standard_error_content, :standard_error_url, :cloud_watch_output_config) include Aws::Structure end |
#instance_id ⇒ String
The ID of the managed instance targeted by the command. A managed instance can be an Amazon EC2 instance or an instance in your hybrid environment that is configured for Systems Manager.
5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 |
# File 'lib/aws-sdk-ssm/types.rb', line 5780 class GetCommandInvocationResult < Struct.new( :command_id, :instance_id, :comment, :document_name, :document_version, :plugin_name, :response_code, :execution_start_date_time, :execution_elapsed_time, :execution_end_date_time, :status, :status_details, :standard_output_content, :standard_output_url, :standard_error_content, :standard_error_url, :cloud_watch_output_config) include Aws::Structure end |
#plugin_name ⇒ String
The name of the plugin for which you want detailed results. For example, aws:RunShellScript is a plugin.
5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 |
# File 'lib/aws-sdk-ssm/types.rb', line 5780 class GetCommandInvocationResult < Struct.new( :command_id, :instance_id, :comment, :document_name, :document_version, :plugin_name, :response_code, :execution_start_date_time, :execution_elapsed_time, :execution_end_date_time, :status, :status_details, :standard_output_content, :standard_output_url, :standard_error_content, :standard_error_url, :cloud_watch_output_config) include Aws::Structure end |
#response_code ⇒ Integer
The error level response code for the plugin script. If the response code is -1, then the command has not started executing on the instance, or it was not received by the instance.
5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 |
# File 'lib/aws-sdk-ssm/types.rb', line 5780 class GetCommandInvocationResult < Struct.new( :command_id, :instance_id, :comment, :document_name, :document_version, :plugin_name, :response_code, :execution_start_date_time, :execution_elapsed_time, :execution_end_date_time, :status, :status_details, :standard_output_content, :standard_output_url, :standard_error_content, :standard_error_url, :cloud_watch_output_config) include Aws::Structure end |
#standard_error_content ⇒ String
The first 8,000 characters written by the plugin to stderr. If the command has not finished executing, then this string is empty.
5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 |
# File 'lib/aws-sdk-ssm/types.rb', line 5780 class GetCommandInvocationResult < Struct.new( :command_id, :instance_id, :comment, :document_name, :document_version, :plugin_name, :response_code, :execution_start_date_time, :execution_elapsed_time, :execution_end_date_time, :status, :status_details, :standard_output_content, :standard_output_url, :standard_error_content, :standard_error_url, :cloud_watch_output_config) include Aws::Structure end |
#standard_error_url ⇒ String
The URL for the complete text written by the plugin to stderr. If the command has not finished executing, then this string is empty.
5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 |
# File 'lib/aws-sdk-ssm/types.rb', line 5780 class GetCommandInvocationResult < Struct.new( :command_id, :instance_id, :comment, :document_name, :document_version, :plugin_name, :response_code, :execution_start_date_time, :execution_elapsed_time, :execution_end_date_time, :status, :status_details, :standard_output_content, :standard_output_url, :standard_error_content, :standard_error_url, :cloud_watch_output_config) include Aws::Structure end |
#standard_output_content ⇒ String
The first 24,000 characters written by the plugin to stdout. If the command has not finished executing, if ExecutionStatus is neither Succeeded nor Failed, then this string is empty.
5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 |
# File 'lib/aws-sdk-ssm/types.rb', line 5780 class GetCommandInvocationResult < Struct.new( :command_id, :instance_id, :comment, :document_name, :document_version, :plugin_name, :response_code, :execution_start_date_time, :execution_elapsed_time, :execution_end_date_time, :status, :status_details, :standard_output_content, :standard_output_url, :standard_error_content, :standard_error_url, :cloud_watch_output_config) include Aws::Structure end |
#standard_output_url ⇒ String
The URL for the complete text written by the plugin to stdout in Amazon S3. If an Amazon S3 bucket was not specified, then this string is empty.
5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 |
# File 'lib/aws-sdk-ssm/types.rb', line 5780 class GetCommandInvocationResult < Struct.new( :command_id, :instance_id, :comment, :document_name, :document_version, :plugin_name, :response_code, :execution_start_date_time, :execution_elapsed_time, :execution_end_date_time, :status, :status_details, :standard_output_content, :standard_output_url, :standard_error_content, :standard_error_url, :cloud_watch_output_config) include Aws::Structure end |
#status ⇒ String
The status of this invocation plugin. This status can be different than StatusDetails.
5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 |
# File 'lib/aws-sdk-ssm/types.rb', line 5780 class GetCommandInvocationResult < Struct.new( :command_id, :instance_id, :comment, :document_name, :document_version, :plugin_name, :response_code, :execution_start_date_time, :execution_elapsed_time, :execution_end_date_time, :status, :status_details, :standard_output_content, :standard_output_url, :standard_error_content, :standard_error_url, :cloud_watch_output_config) include Aws::Structure end |
#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 *AWS Systems Manager User Guide*. StatusDetails can be one of the following values:
-
Pending: The command has not been sent to the instance.
-
In Progress: The command has been sent to the instance but has not reached a terminal state.
-
Delayed: The system attempted to send the command to the target, but the target was not available. The instance might not be available because of network issues, the instance was stopped, etc. The system will try to deliver the command again.
-
Success: The command or plugin was executed successfully. This is a terminal state.
-
Delivery Timed Out: The command was not delivered to the instance before the delivery timeout expired. Delivery timeouts do not 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 execute on the instance, but the execution was not 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 executed successfully on the instance. For a plugin, this indicates that the result code was not zero. For a command invocation, this indicates that the result code for one or more plugins was not zero. Invocation failures count against the MaxErrors limit of the parent command. This is a terminal state.
-
Canceled: The command was terminated before it was completed. This is a terminal state.
-
Undeliverable: The command can’t be delivered to the instance. The instance 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.
[1]: docs.aws.amazon.com/systems-manager/latest/userguide/monitor-commands.html
5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 |
# File 'lib/aws-sdk-ssm/types.rb', line 5780 class GetCommandInvocationResult < Struct.new( :command_id, :instance_id, :comment, :document_name, :document_version, :plugin_name, :response_code, :execution_start_date_time, :execution_elapsed_time, :execution_end_date_time, :status, :status_details, :standard_output_content, :standard_output_url, :standard_error_content, :standard_error_url, :cloud_watch_output_config) include Aws::Structure end |