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

Inherits:
Struct
  • Object
show all
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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#cloud_watch_output_configTypes::CloudWatchOutputConfig

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


2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
# File 'lib/aws-sdk-ssm/types.rb', line 2240

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)

2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
# File 'lib/aws-sdk-ssm/types.rb', line 2240

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>

Plugins processed by the command.

Returns:


2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
# File 'lib/aws-sdk-ssm/types.rb', line 2240

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)

2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
# File 'lib/aws-sdk-ssm/types.rb', line 2240

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)

2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
# File 'lib/aws-sdk-ssm/types.rb', line 2240

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 Systems Manager document (SSM document) version.

Returns:

  • (String)

2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
# File 'lib/aws-sdk-ssm/types.rb', line 2240

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 managed node ID in which this invocation was requested.

Returns:

  • (String)

2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
# File 'lib/aws-sdk-ssm/types.rb', line 2240

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 fully qualified host name of the managed node.

Returns:

  • (String)

2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
# File 'lib/aws-sdk-ssm/types.rb', line 2240

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 managed node basis.


2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
# File 'lib/aws-sdk-ssm/types.rb', line 2240

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 managed node.

Returns:

  • (Time)

2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
# File 'lib/aws-sdk-ssm/types.rb', line 2240

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 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)

2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
# File 'lib/aws-sdk-ssm/types.rb', line 2240

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 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)

2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
# File 'lib/aws-sdk-ssm/types.rb', line 2240

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 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)

2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
# File 'lib/aws-sdk-ssm/types.rb', line 2240

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)

2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
# File 'lib/aws-sdk-ssm/types.rb', line 2240

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

  • Canceled: 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.

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

Returns:

  • (String)

2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
# File 'lib/aws-sdk-ssm/types.rb', line 2240

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)

2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
# File 'lib/aws-sdk-ssm/types.rb', line 2240

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