Class: Aws::SSM::Types::Command

Inherits:

Struct

Object
Struct
Aws::SSM::Types::Command

show all

Includes:: Aws::Structure

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

Overview

Describes a command request.

Instance Attribute Summary collapse

#cloud_watch_output_config ⇒ Types::CloudWatchOutputConfig

CloudWatch Logs information where you want Systems Manager to send the command output.
#command_id ⇒ String

A unique identifier for this command.
#comment ⇒ String

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

The number of targets for which the command invocation reached a terminal state.
#delivery_timed_out_count ⇒ Integer

The number of targets for which the status is Delivery Timed Out.
#document_name ⇒ String

The name of the document requested for execution.
#document_version ⇒ String

The SSM document version.
#error_count ⇒ Integer

The number of targets for which the status is Failed or Execution Timed Out.
#expires_after ⇒ Time

If this time is reached and the command has not already started executing, it will not run.
#instance_ids ⇒ Array<String>

The instance IDs against which this command was requested.
#max_concurrency ⇒ String

The maximum number of instances that are allowed to execute the command at the same time.
#max_errors ⇒ String

The maximum number of errors allowed before the system stops sending the command to additional targets.
#notification_config ⇒ Types::NotificationConfig

Configurations for sending notifications about command status changes.
#output_s3_bucket_name ⇒ String

The S3 bucket where the responses to the command executions should be stored.
#output_s3_key_prefix ⇒ String

The S3 directory path inside the bucket where the responses to the command executions should be stored.
#output_s3_region ⇒ String

(Deprecated) You can no longer specify this parameter.
#parameters ⇒ Hash<String,Array<String>>

The parameter values to be inserted in the document when executing the command.
#requested_date_time ⇒ Time

The date and time the command was requested.
#service_role ⇒ String

The IAM service role that Run Command uses to act on your behalf when sending notifications about command status changes.
#status ⇒ String

The status of the command.
#status_details ⇒ String

A detailed status of the command execution.
#target_count ⇒ Integer

The number of targets for the command.
#targets ⇒ Array<Types::Target>

An array of search criteria that targets instances using a Key,Value combination that you specify.

Instance Attribute Details

#cloud_watch_output_config ⇒ `Types::CloudWatchOutputConfig`

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

Returns:

(Types::CloudWatchOutputConfig)

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

class Command < Struct.new(
  :command_id,
  :document_name,
  :document_version,
  :comment,
  :expires_after,
  :parameters,
  :instance_ids,
  :targets,
  :requested_date_time,
  :status,
  :status_details,
  :output_s3_region,
  :output_s3_bucket_name,
  :output_s3_key_prefix,
  :max_concurrency,
  :max_errors,
  :target_count,
  :completed_count,
  :error_count,
  :delivery_timed_out_count,
  :service_role,
  :notification_config,
  :cloud_watch_output_config)
  include Aws::Structure
end

#command_id ⇒ `String`

A unique identifier for this command.

Returns:

(String)

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

class Command < Struct.new(
  :command_id,
  :document_name,
  :document_version,
  :comment,
  :expires_after,
  :parameters,
  :instance_ids,
  :targets,
  :requested_date_time,
  :status,
  :status_details,
  :output_s3_region,
  :output_s3_bucket_name,
  :output_s3_key_prefix,
  :max_concurrency,
  :max_errors,
  :target_count,
  :completed_count,
  :error_count,
  :delivery_timed_out_count,
  :service_role,
  :notification_config,
  :cloud_watch_output_config)
  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 1346

class Command < Struct.new(
  :command_id,
  :document_name,
  :document_version,
  :comment,
  :expires_after,
  :parameters,
  :instance_ids,
  :targets,
  :requested_date_time,
  :status,
  :status_details,
  :output_s3_region,
  :output_s3_bucket_name,
  :output_s3_key_prefix,
  :max_concurrency,
  :max_errors,
  :target_count,
  :completed_count,
  :error_count,
  :delivery_timed_out_count,
  :service_role,
  :notification_config,
  :cloud_watch_output_config)
  include Aws::Structure
end

#completed_count ⇒ `Integer`

The number of targets for which the command invocation reached a terminal state. Terminal states include the following: Success, Failed, Execution Timed Out, Delivery Timed Out, Canceled, Terminated, or Undeliverable.

Returns:

(Integer)

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

class Command < Struct.new(
  :command_id,
  :document_name,
  :document_version,
  :comment,
  :expires_after,
  :parameters,
  :instance_ids,
  :targets,
  :requested_date_time,
  :status,
  :status_details,
  :output_s3_region,
  :output_s3_bucket_name,
  :output_s3_key_prefix,
  :max_concurrency,
  :max_errors,
  :target_count,
  :completed_count,
  :error_count,
  :delivery_timed_out_count,
  :service_role,
  :notification_config,
  :cloud_watch_output_config)
  include Aws::Structure
end

#delivery_timed_out_count ⇒ `Integer`

The number of targets for which the status is Delivery Timed Out.

Returns:

(Integer)

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

class Command < Struct.new(
  :command_id,
  :document_name,
  :document_version,
  :comment,
  :expires_after,
  :parameters,
  :instance_ids,
  :targets,
  :requested_date_time,
  :status,
  :status_details,
  :output_s3_region,
  :output_s3_bucket_name,
  :output_s3_key_prefix,
  :max_concurrency,
  :max_errors,
  :target_count,
  :completed_count,
  :error_count,
  :delivery_timed_out_count,
  :service_role,
  :notification_config,
  :cloud_watch_output_config)
  include Aws::Structure
end

#document_name ⇒ `String`

The name of the document requested for execution.

Returns:

(String)

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

class Command < Struct.new(
  :command_id,
  :document_name,
  :document_version,
  :comment,
  :expires_after,
  :parameters,
  :instance_ids,
  :targets,
  :requested_date_time,
  :status,
  :status_details,
  :output_s3_region,
  :output_s3_bucket_name,
  :output_s3_key_prefix,
  :max_concurrency,
  :max_errors,
  :target_count,
  :completed_count,
  :error_count,
  :delivery_timed_out_count,
  :service_role,
  :notification_config,
  :cloud_watch_output_config)
  include Aws::Structure
end

#document_version ⇒ `String`

The SSM document version.

Returns:

(String)

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

class Command < Struct.new(
  :command_id,
  :document_name,
  :document_version,
  :comment,
  :expires_after,
  :parameters,
  :instance_ids,
  :targets,
  :requested_date_time,
  :status,
  :status_details,
  :output_s3_region,
  :output_s3_bucket_name,
  :output_s3_key_prefix,
  :max_concurrency,
  :max_errors,
  :target_count,
  :completed_count,
  :error_count,
  :delivery_timed_out_count,
  :service_role,
  :notification_config,
  :cloud_watch_output_config)
  include Aws::Structure
end

#error_count ⇒ `Integer`

The number of targets for which the status is Failed or Execution Timed Out.

Returns:

(Integer)

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

class Command < Struct.new(
  :command_id,
  :document_name,
  :document_version,
  :comment,
  :expires_after,
  :parameters,
  :instance_ids,
  :targets,
  :requested_date_time,
  :status,
  :status_details,
  :output_s3_region,
  :output_s3_bucket_name,
  :output_s3_key_prefix,
  :max_concurrency,
  :max_errors,
  :target_count,
  :completed_count,
  :error_count,
  :delivery_timed_out_count,
  :service_role,
  :notification_config,
  :cloud_watch_output_config)
  include Aws::Structure
end

#expires_after ⇒ `Time`

If this time is reached and the command has not already started executing, it will not run. Calculated based on the ExpiresAfter user input provided as part of the SendCommand API.

Returns:

(Time)

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

class Command < Struct.new(
  :command_id,
  :document_name,
  :document_version,
  :comment,
  :expires_after,
  :parameters,
  :instance_ids,
  :targets,
  :requested_date_time,
  :status,
  :status_details,
  :output_s3_region,
  :output_s3_bucket_name,
  :output_s3_key_prefix,
  :max_concurrency,
  :max_errors,
  :target_count,
  :completed_count,
  :error_count,
  :delivery_timed_out_count,
  :service_role,
  :notification_config,
  :cloud_watch_output_config)
  include Aws::Structure
end

#instance_ids ⇒ `Array<String>`

The instance IDs against which this command was requested.

Returns:

(Array<String>)

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

class Command < Struct.new(
  :command_id,
  :document_name,
  :document_version,
  :comment,
  :expires_after,
  :parameters,
  :instance_ids,
  :targets,
  :requested_date_time,
  :status,
  :status_details,
  :output_s3_region,
  :output_s3_bucket_name,
  :output_s3_key_prefix,
  :max_concurrency,
  :max_errors,
  :target_count,
  :completed_count,
  :error_count,
  :delivery_timed_out_count,
  :service_role,
  :notification_config,
  :cloud_watch_output_config)
  include Aws::Structure
end

#max_concurrency ⇒ `String`

The maximum number of instances that are allowed to execute the command at the same time. You can specify a number of instances, such as 10, or a percentage of instances, such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see [Executing Commands Using Systems Manager Run Command] in the *AWS Systems Manager User Guide*.

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

Returns:

(String)

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

class Command < Struct.new(
  :command_id,
  :document_name,
  :document_version,
  :comment,
  :expires_after,
  :parameters,
  :instance_ids,
  :targets,
  :requested_date_time,
  :status,
  :status_details,
  :output_s3_region,
  :output_s3_bucket_name,
  :output_s3_key_prefix,
  :max_concurrency,
  :max_errors,
  :target_count,
  :completed_count,
  :error_count,
  :delivery_timed_out_count,
  :service_role,
  :notification_config,
  :cloud_watch_output_config)
  include Aws::Structure
end

#max_errors ⇒ `String`

The maximum number of errors allowed before the system stops sending the command to additional targets. You can specify a number of errors, such as 10, or a percentage or errors, such as 10%. The default value is 0. For more information about how to use MaxErrors, see [Executing Commands Using Systems Manager Run Command] in the *AWS Systems Manager User Guide*.

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

Returns:

(String)

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

class Command < Struct.new(
  :command_id,
  :document_name,
  :document_version,
  :comment,
  :expires_after,
  :parameters,
  :instance_ids,
  :targets,
  :requested_date_time,
  :status,
  :status_details,
  :output_s3_region,
  :output_s3_bucket_name,
  :output_s3_key_prefix,
  :max_concurrency,
  :max_errors,
  :target_count,
  :completed_count,
  :error_count,
  :delivery_timed_out_count,
  :service_role,
  :notification_config,
  :cloud_watch_output_config)
  include Aws::Structure
end

#notification_config ⇒ `Types::NotificationConfig`

Configurations for sending notifications about command status changes.

Returns:

(Types::NotificationConfig)

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

class Command < Struct.new(
  :command_id,
  :document_name,
  :document_version,
  :comment,
  :expires_after,
  :parameters,
  :instance_ids,
  :targets,
  :requested_date_time,
  :status,
  :status_details,
  :output_s3_region,
  :output_s3_bucket_name,
  :output_s3_key_prefix,
  :max_concurrency,
  :max_errors,
  :target_count,
  :completed_count,
  :error_count,
  :delivery_timed_out_count,
  :service_role,
  :notification_config,
  :cloud_watch_output_config)
  include Aws::Structure
end

#output_s3_bucket_name ⇒ `String`

The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command.

Returns:

(String)

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

class Command < Struct.new(
  :command_id,
  :document_name,
  :document_version,
  :comment,
  :expires_after,
  :parameters,
  :instance_ids,
  :targets,
  :requested_date_time,
  :status,
  :status_details,
  :output_s3_region,
  :output_s3_bucket_name,
  :output_s3_key_prefix,
  :max_concurrency,
  :max_errors,
  :target_count,
  :completed_count,
  :error_count,
  :delivery_timed_out_count,
  :service_role,
  :notification_config,
  :cloud_watch_output_config)
  include Aws::Structure
end

#output_s3_key_prefix ⇒ `String`

The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command.

Returns:

(String)

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

class Command < Struct.new(
  :command_id,
  :document_name,
  :document_version,
  :comment,
  :expires_after,
  :parameters,
  :instance_ids,
  :targets,
  :requested_date_time,
  :status,
  :status_details,
  :output_s3_region,
  :output_s3_bucket_name,
  :output_s3_key_prefix,
  :max_concurrency,
  :max_errors,
  :target_count,
  :completed_count,
  :error_count,
  :delivery_timed_out_count,
  :service_role,
  :notification_config,
  :cloud_watch_output_config)
  include Aws::Structure
end

#output_s3_region ⇒ `String`

(Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon S3 bucket region.

Returns:

(String)

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

class Command < Struct.new(
  :command_id,
  :document_name,
  :document_version,
  :comment,
  :expires_after,
  :parameters,
  :instance_ids,
  :targets,
  :requested_date_time,
  :status,
  :status_details,
  :output_s3_region,
  :output_s3_bucket_name,
  :output_s3_key_prefix,
  :max_concurrency,
  :max_errors,
  :target_count,
  :completed_count,
  :error_count,
  :delivery_timed_out_count,
  :service_role,
  :notification_config,
  :cloud_watch_output_config)
  include Aws::Structure
end

#parameters ⇒ `Hash<String,Array<String>>`

The parameter values to be inserted in the document when executing the command.

Returns:

(Hash<String,Array<String>>)

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

class Command < Struct.new(
  :command_id,
  :document_name,
  :document_version,
  :comment,
  :expires_after,
  :parameters,
  :instance_ids,
  :targets,
  :requested_date_time,
  :status,
  :status_details,
  :output_s3_region,
  :output_s3_bucket_name,
  :output_s3_key_prefix,
  :max_concurrency,
  :max_errors,
  :target_count,
  :completed_count,
  :error_count,
  :delivery_timed_out_count,
  :service_role,
  :notification_config,
  :cloud_watch_output_config)
  include Aws::Structure
end

#requested_date_time ⇒ `Time`

The date and time the command was requested.

Returns:

(Time)

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

class Command < Struct.new(
  :command_id,
  :document_name,
  :document_version,
  :comment,
  :expires_after,
  :parameters,
  :instance_ids,
  :targets,
  :requested_date_time,
  :status,
  :status_details,
  :output_s3_region,
  :output_s3_bucket_name,
  :output_s3_key_prefix,
  :max_concurrency,
  :max_errors,
  :target_count,
  :completed_count,
  :error_count,
  :delivery_timed_out_count,
  :service_role,
  :notification_config,
  :cloud_watch_output_config)
  include Aws::Structure
end

#service_role ⇒ `String`

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

Returns:

(String)

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

class Command < Struct.new(
  :command_id,
  :document_name,
  :document_version,
  :comment,
  :expires_after,
  :parameters,
  :instance_ids,
  :targets,
  :requested_date_time,
  :status,
  :status_details,
  :output_s3_region,
  :output_s3_bucket_name,
  :output_s3_key_prefix,
  :max_concurrency,
  :max_errors,
  :target_count,
  :completed_count,
  :error_count,
  :delivery_timed_out_count,
  :service_role,
  :notification_config,
  :cloud_watch_output_config)
  include Aws::Structure
end

#status ⇒ `String`

The status of the command.

Returns:

(String)

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

class Command < Struct.new(
  :command_id,
  :document_name,
  :document_version,
  :comment,
  :expires_after,
  :parameters,
  :instance_ids,
  :targets,
  :requested_date_time,
  :status,
  :status_details,
  :output_s3_region,
  :output_s3_bucket_name,
  :output_s3_key_prefix,
  :max_concurrency,
  :max_errors,
  :target_count,
  :completed_count,
  :error_count,
  :delivery_timed_out_count,
  :service_role,
  :notification_config,
  :cloud_watch_output_config)
  include Aws::Structure
end

#status_details ⇒ `String`

A detailed status of the command execution. 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 any instances.
In Progress: The command has been sent to at least one instance but has not reached a final state on all instances.
Success: The command successfully executed on all invocations. This is a terminal state.
Delivery Timed Out: The value of MaxErrors or more command invocations shows a status of Delivery Timed Out. This is a terminal state.
Execution Timed Out: The value of MaxErrors or more command invocations shows a status of Execution Timed Out. This is a terminal state.
Failed: The value of MaxErrors or more command invocations shows a status of Failed. This is a terminal state.
Incomplete: The command was attempted on all instances and one or more invocations does not have a value of Success but not enough invocations failed for the status to be Failed. This is a terminal state.
Canceled: The command was terminated before it was completed. This is a terminal state.
Rate Exceeded: The number of instances targeted by the command exceeded the account limit for pending invocations. The system has canceled the command before executing it on any instance. This is a terminal state.

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

Returns:

(String)

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

class Command < Struct.new(
  :command_id,
  :document_name,
  :document_version,
  :comment,
  :expires_after,
  :parameters,
  :instance_ids,
  :targets,
  :requested_date_time,
  :status,
  :status_details,
  :output_s3_region,
  :output_s3_bucket_name,
  :output_s3_key_prefix,
  :max_concurrency,
  :max_errors,
  :target_count,
  :completed_count,
  :error_count,
  :delivery_timed_out_count,
  :service_role,
  :notification_config,
  :cloud_watch_output_config)
  include Aws::Structure
end

#target_count ⇒ `Integer`

The number of targets for the command.

Returns:

(Integer)

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

class Command < Struct.new(
  :command_id,
  :document_name,
  :document_version,
  :comment,
  :expires_after,
  :parameters,
  :instance_ids,
  :targets,
  :requested_date_time,
  :status,
  :status_details,
  :output_s3_region,
  :output_s3_bucket_name,
  :output_s3_key_prefix,
  :max_concurrency,
  :max_errors,
  :target_count,
  :completed_count,
  :error_count,
  :delivery_timed_out_count,
  :service_role,
  :notification_config,
  :cloud_watch_output_config)
  include Aws::Structure
end

#targets ⇒ `Array<Types::Target>`

An array of search criteria that targets instances using a Key,Value combination that you specify. Targets is required if you don’t provide one or more instance IDs in the call.

Returns:

(Array<Types::Target>)

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

class Command < Struct.new(
  :command_id,
  :document_name,
  :document_version,
  :comment,
  :expires_after,
  :parameters,
  :instance_ids,
  :targets,
  :requested_date_time,
  :status,
  :status_details,
  :output_s3_region,
  :output_s3_bucket_name,
  :output_s3_key_prefix,
  :max_concurrency,
  :max_errors,
  :target_count,
  :completed_count,
  :error_count,
  :delivery_timed_out_count,
  :service_role,
  :notification_config,
  :cloud_watch_output_config)
  include Aws::Structure
end

Class: Aws::SSM::Types::Command

Overview

Instance Attribute Summary collapse

Instance Attribute Details

#cloud_watch_output_config ⇒ Types::CloudWatchOutputConfig

#command_id ⇒ String

#comment ⇒ String

#completed_count ⇒ Integer

#delivery_timed_out_count ⇒ Integer

#document_name ⇒ String

#document_version ⇒ String

#error_count ⇒ Integer

#expires_after ⇒ Time

#instance_ids ⇒ Array<String>

#max_concurrency ⇒ String

#max_errors ⇒ String

#notification_config ⇒ Types::NotificationConfig

#output_s3_bucket_name ⇒ String

#output_s3_key_prefix ⇒ String

#output_s3_region ⇒ String

#parameters ⇒ Hash<String,Array<String>>

#requested_date_time ⇒ Time

#service_role ⇒ String

#status ⇒ String

#status_details ⇒ String

#target_count ⇒ Integer

#targets ⇒ Array<Types::Target>

#cloud_watch_output_config ⇒ `Types::CloudWatchOutputConfig`

#command_id ⇒ `String`

#comment ⇒ `String`

#completed_count ⇒ `Integer`

#delivery_timed_out_count ⇒ `Integer`

#document_name ⇒ `String`

#document_version ⇒ `String`

#error_count ⇒ `Integer`

#expires_after ⇒ `Time`

#instance_ids ⇒ `Array<String>`

#max_concurrency ⇒ `String`

#max_errors ⇒ `String`

#notification_config ⇒ `Types::NotificationConfig`

#output_s3_bucket_name ⇒ `String`

#output_s3_key_prefix ⇒ `String`

#output_s3_region ⇒ `String`

#parameters ⇒ `Hash<String,Array<String>>`

#requested_date_time ⇒ `Time`

#service_role ⇒ `String`

#status ⇒ `String`

#status_details ⇒ `String`

#target_count ⇒ `Integer`

#targets ⇒ `Array<Types::Target>`