Class: Aws::SSM::Types::GetCommandInvocationResult

Inherits:

Struct

Object
Struct
Aws::SSM::Types::GetCommandInvocationResult

show all

Defined in:: gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb

Overview

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#cloud_watch_output_config ⇒ Types::CloudWatchOutputConfig
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.
#document_version ⇒ String
The Systems Manager document (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 finished running.
#execution_start_date_time ⇒ String
The date and time the plugin started running.
#instance_id ⇒ String
The ID of the managed node targeted by the command.
#plugin_name ⇒ String
The name of the plugin, or step name, for which details are reported.
#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 Simple Storage Service (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`

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

Returns:

(Types::CloudWatchOutputConfig)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8292

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)
  SENSITIVE = []
  include Aws::Structure
end

#command_id ⇒ `String`

The parent command ID of the invocation plugin.

Returns:

(String)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8292

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)
  SENSITIVE = []
  include Aws::Structure
end

#comment ⇒ `String`

The comment text for the command.

Returns:

(String)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8292

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)
  SENSITIVE = []
  include Aws::Structure
end

#document_name ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8292

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)
  SENSITIVE = []
  include Aws::Structure
end

#document_version ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8292

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)
  SENSITIVE = []
  include Aws::Structure
end

#execution_elapsed_time ⇒ `String`

Duration since ExecutionStartDateTime.

Returns:

(String)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8292

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)
  SENSITIVE = []
  include Aws::Structure
end

#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.

Returns:

(String)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8292

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)
  SENSITIVE = []
  include Aws::Structure
end

#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.

Returns:

(String)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8292

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)
  SENSITIVE = []
  include Aws::Structure
end

#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.

Returns:

(String)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8292

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)
  SENSITIVE = []
  include Aws::Structure
end

#plugin_name ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8292

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)
  SENSITIVE = []
  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 hasn't started running on the managed node, or it wasn't received by the node.

Returns:

(Integer)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8292

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)
  SENSITIVE = []
  include Aws::Structure
end

#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.

Returns:

(String)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8292

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)
  SENSITIVE = []
  include Aws::Structure
end

#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.

Returns:

(String)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8292

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)
  SENSITIVE = []
  include Aws::Structure
end

#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.

Returns:

(String)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8292

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)
  SENSITIVE = []
  include Aws::Structure
end

#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.

Returns:

(String)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8292

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)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8292

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)
  SENSITIVE = []
  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 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.

Returns:

(String)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8292

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)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::SSM::Types::GetCommandInvocationResult

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#cloud_watch_output_config ⇒ Types::CloudWatchOutputConfig

#command_id ⇒ String

#comment ⇒ String

#document_name ⇒ String

#document_version ⇒ String

#execution_elapsed_time ⇒ String

#execution_end_date_time ⇒ String

#execution_start_date_time ⇒ String

#instance_id ⇒ String

#plugin_name ⇒ String

#response_code ⇒ Integer

#standard_error_content ⇒ String

#standard_error_url ⇒ String

#standard_output_content ⇒ String

#standard_output_url ⇒ String

#status ⇒ String

#status_details ⇒ String

#cloud_watch_output_config ⇒ `Types::CloudWatchOutputConfig`

#command_id ⇒ `String`

#comment ⇒ `String`

#document_name ⇒ `String`

#document_version ⇒ `String`

#execution_elapsed_time ⇒ `String`

#execution_end_date_time ⇒ `String`

#execution_start_date_time ⇒ `String`

#instance_id ⇒ `String`

#plugin_name ⇒ `String`

#response_code ⇒ `Integer`

#standard_error_content ⇒ `String`

#standard_error_url ⇒ `String`

#standard_output_content ⇒ `String`

#standard_output_url ⇒ `String`

#status ⇒ `String`

#status_details ⇒ `String`