Class: Aws::SSM::Types::CommandInvocation

Inherits:

Struct

• Object
• Struct
• Aws::SSM::Types::CommandInvocation

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-ssm/types.rb

Overview

An invocation is a 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. A command invocation returns status and detail information about a command you ran.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #cloud_watch_output_config ⇒ Types::CloudWatchOutputConfig

  Amazon CloudWatch Logs information where you want Amazon Web Services Systems Manager to send the command output.

• #command_id ⇒ String

  The command against which this invocation was requested.

• #command_plugins ⇒ Array<Types::CommandPlugin>

  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.

• #document_version ⇒ String

  The Systems Manager document (SSM document) version.

• #instance_id ⇒ String

  The managed node ID in which this invocation was requested.

• #instance_name ⇒ String

  The fully qualified host name of the managed node.

• #notification_config ⇒ Types::NotificationConfig

  Configurations for sending notifications about command status changes on a per managed node basis.

• #requested_date_time ⇒ 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 capability of 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.

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

• #status ⇒ String

  Whether or not the invocation succeeded, failed, or is pending.

• #status_details ⇒ String

  A detailed status of the command execution for each invocation (each managed node targeted by the command).

• #trace_output ⇒ String

  Gets the trace output sent by the agent.

Instance Attribute Details

#cloud_watch_output_config ⇒ Types::CloudWatchOutputConfig

Amazon CloudWatch Logs information where you want Amazon Web Services Systems Manager to send the command output.

Returns:

• (Types::CloudWatchOutputConfig)

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

class CommandInvocation < Struct.new(
  :command_id,
  :instance_id,
  :instance_name,
  :comment,
  :document_name,
  :document_version,
  :requested_date_time,
  :status,
  :status_details,
  :trace_output,
  :standard_output_url,
  :standard_error_url,
  :command_plugins,
  :service_role,
  :notification_config,
  :cloud_watch_output_config)
  SENSITIVE = []
  include Aws::Structure
end

#command_id ⇒ String

The command against which this invocation was requested.

Returns:

• (String)

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

class CommandInvocation < Struct.new(
  :command_id,
  :instance_id,
  :instance_name,
  :comment,
  :document_name,
  :document_version,
  :requested_date_time,
  :status,
  :status_details,
  :trace_output,
  :standard_output_url,
  :standard_error_url,
  :command_plugins,
  :service_role,
  :notification_config,
  :cloud_watch_output_config)
  SENSITIVE = []
  include Aws::Structure
end

#command_plugins ⇒ Array<Types::CommandPlugin>

Plugins processed by the command.

Returns:

• (Array<Types::CommandPlugin>)

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

class CommandInvocation < Struct.new(
  :command_id,
  :instance_id,
  :instance_name,
  :comment,
  :document_name,
  :document_version,
  :requested_date_time,
  :status,
  :status_details,
  :trace_output,
  :standard_output_url,
  :standard_error_url,
  :command_plugins,
  :service_role,
  :notification_config,
  :cloud_watch_output_config)
  SENSITIVE = []
  include Aws::Structure
end

#comment ⇒ String

User-specified information about the command, such as a brief description of what the command should do.

Returns:

• (String)

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

class CommandInvocation < Struct.new(
  :command_id,
  :instance_id,
  :instance_name,
  :comment,
  :document_name,
  :document_version,
  :requested_date_time,
  :status,
  :status_details,
  :trace_output,
  :standard_output_url,
  :standard_error_url,
  :command_plugins,
  :service_role,
  :notification_config,
  :cloud_watch_output_config)
  SENSITIVE = []
  include Aws::Structure
end

#document_name ⇒ String

The document name that was requested for execution.

Returns:

• (String)

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

class CommandInvocation < Struct.new(
  :command_id,
  :instance_id,
  :instance_name,
  :comment,
  :document_name,
  :document_version,
  :requested_date_time,
  :status,
  :status_details,
  :trace_output,
  :standard_output_url,
  :standard_error_url,
  :command_plugins,
  :service_role,
  :notification_config,
  :cloud_watch_output_config)
  SENSITIVE = []
  include Aws::Structure
end

#document_version ⇒ String

The Systems Manager document (SSM document) version.

Returns:

• (String)

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

class CommandInvocation < Struct.new(
  :command_id,
  :instance_id,
  :instance_name,
  :comment,
  :document_name,
  :document_version,
  :requested_date_time,
  :status,
  :status_details,
  :trace_output,
  :standard_output_url,
  :standard_error_url,
  :command_plugins,
  :service_role,
  :notification_config,
  :cloud_watch_output_config)
  SENSITIVE = []
  include Aws::Structure
end

#instance_id ⇒ String

The managed node ID in which this invocation was requested.

Returns:

• (String)

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

class CommandInvocation < Struct.new(
  :command_id,
  :instance_id,
  :instance_name,
  :comment,
  :document_name,
  :document_version,
  :requested_date_time,
  :status,
  :status_details,
  :trace_output,
  :standard_output_url,
  :standard_error_url,
  :command_plugins,
  :service_role,
  :notification_config,
  :cloud_watch_output_config)
  SENSITIVE = []
  include Aws::Structure
end

#instance_name ⇒ String

The fully qualified host name of the managed node.

Returns:

• (String)

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

class CommandInvocation < Struct.new(
  :command_id,
  :instance_id,
  :instance_name,
  :comment,
  :document_name,
  :document_version,
  :requested_date_time,
  :status,
  :status_details,
  :trace_output,
  :standard_output_url,
  :standard_error_url,
  :command_plugins,
  :service_role,
  :notification_config,
  :cloud_watch_output_config)
  SENSITIVE = []
  include Aws::Structure
end

#notification_config ⇒ Types::NotificationConfig

Configurations for sending notifications about command status changes on a per managed node basis.

Returns:

• (Types::NotificationConfig)

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

class CommandInvocation < Struct.new(
  :command_id,
  :instance_id,
  :instance_name,
  :comment,
  :document_name,
  :document_version,
  :requested_date_time,
  :status,
  :status_details,
  :trace_output,
  :standard_output_url,
  :standard_error_url,
  :command_plugins,
  :service_role,
  :notification_config,
  :cloud_watch_output_config)
  SENSITIVE = []
  include Aws::Structure
end

#requested_date_time ⇒ Time

The time and date the request was sent to this managed node.

Returns:

• (Time)

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

class CommandInvocation < Struct.new(
  :command_id,
  :instance_id,
  :instance_name,
  :comment,
  :document_name,
  :document_version,
  :requested_date_time,
  :status,
  :status_details,
  :trace_output,
  :standard_output_url,
  :standard_error_url,
  :command_plugins,
  :service_role,
  :notification_config,
  :cloud_watch_output_config)
  SENSITIVE = []
  include Aws::Structure
end

#service_role ⇒ String

The Identity and Access Management (IAM) service role that Run Command, a capability of Amazon Web Services Systems Manager, uses to act on your behalf when sending notifications about command status changes on a per managed node basis.

Returns:

• (String)

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

class CommandInvocation < Struct.new(
  :command_id,
  :instance_id,
  :instance_name,
  :comment,
  :document_name,
  :document_version,
  :requested_date_time,
  :status,
  :status_details,
  :trace_output,
  :standard_output_url,
  :standard_error_url,
  :command_plugins,
  :service_role,
  :notification_config,
  :cloud_watch_output_config)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

• (String)

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

class CommandInvocation < Struct.new(
  :command_id,
  :instance_id,
  :instance_name,
  :comment,
  :document_name,
  :document_version,
  :requested_date_time,
  :status,
  :status_details,
  :trace_output,
  :standard_output_url,
  :standard_error_url,
  :command_plugins,
  :service_role,
  :notification_config,
  :cloud_watch_output_config)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

• (String)

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

class CommandInvocation < Struct.new(
  :command_id,
  :instance_id,
  :instance_name,
  :comment,
  :document_name,
  :document_version,
  :requested_date_time,
  :status,
  :status_details,
  :trace_output,
  :standard_output_url,
  :standard_error_url,
  :command_plugins,
  :service_role,
  :notification_config,
  :cloud_watch_output_config)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

Whether or not the invocation succeeded, failed, or is pending.

Returns:

• (String)

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

class CommandInvocation < Struct.new(
  :command_id,
  :instance_id,
  :instance_name,
  :comment,
  :document_name,
  :document_version,
  :requested_date_time,
  :status,
  :status_details,
  :trace_output,
  :standard_output_url,
  :standard_error_url,
  :command_plugins,
  :service_role,
  :notification_config,
  :cloud_watch_output_config)
  SENSITIVE = []
  include Aws::Structure
end

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

[1]: docs.aws.amazon.com/systems-manager/latest/userguide/monitor-commands.html

Returns:

• (String)

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

class CommandInvocation < Struct.new(
  :command_id,
  :instance_id,
  :instance_name,
  :comment,
  :document_name,
  :document_version,
  :requested_date_time,
  :status,
  :status_details,
  :trace_output,
  :standard_output_url,
  :standard_error_url,
  :command_plugins,
  :service_role,
  :notification_config,
  :cloud_watch_output_config)
  SENSITIVE = []
  include Aws::Structure
end

#trace_output ⇒ String

Gets the trace output sent by the agent.

Returns:

• (String)

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

class CommandInvocation < Struct.new(
  :command_id,
  :instance_id,
  :instance_name,
  :comment,
  :document_name,
  :document_version,
  :requested_date_time,
  :status,
  :status_details,
  :trace_output,
  :standard_output_url,
  :standard_error_url,
  :command_plugins,
  :service_role,
  :notification_config,
  :cloud_watch_output_config)
  SENSITIVE = []
  include Aws::Structure
end