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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb

Overview

An invocation is copy of a command sent to a specific instance. A command can apply to one or more instances. A command invocation applies to one instance. For example, if a user runs SendCommand against three instances, then a command invocation is created for each requested instance ID. A command invocation returns status and detail information about a command you ran.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#cloud_watch_output_configTypes::CloudWatchOutputConfig

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



1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1855

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_idString

The command against which this invocation was requested.

Returns:

  • (String)


1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1855

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_pluginsArray<Types::CommandPlugin>

Returns:



1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1855

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

#commentString

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

Returns:

  • (String)


1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1855

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_nameString

The document name that was requested for execution.

Returns:

  • (String)


1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1855

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_versionString

The SSM document version.

Returns:

  • (String)


1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1855

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_idString

The instance ID in which this invocation was requested.

Returns:

  • (String)


1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1855

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_nameString

The name of the invocation target. For EC2 instances this is the value for the aws:Name tag. For on-premises instances, this is the name of the instance.

Returns:

  • (String)


1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1855

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_configTypes::NotificationConfig

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



1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1855

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_timeTime

The time and date the request was sent to this instance.

Returns:

  • (Time)


1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1855

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_roleString

The IAM service role that Run Command uses to act on your behalf when sending notifications about command status changes on a per instance basis.

Returns:

  • (String)


1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1855

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_urlString

The URL to the plugin's StdErr file in 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)


1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1855

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_urlString

The URL to the plugin's StdOut file in 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)


1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1855

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

#statusString

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

Returns:

  • (String)


1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1855

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_detailsString

A detailed status of the command execution for each invocation (each instance 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 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.

  • Success: The execution of the command or plugin was successfully completed. 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: Command execution started on the instance, but the execution was not 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 was not successful 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.

Returns:

  • (String)


1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1855

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_outputString

Gets the trace output sent by the agent.

Returns:

  • (String)


1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1855

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