Class: Aws::SSM::Types::Command
- Inherits:
-
Struct
- Object
- Struct
- Aws::SSM::Types::Command
- Includes:
- Aws::Structure
- Defined in:
- lib/aws-sdk-ssm/types.rb
Overview
Describes a command request.
Constant Summary collapse
- SENSITIVE =
[:parameters]
Instance Attribute Summary collapse
-
#alarm_configuration ⇒ Types::AlarmConfiguration
The details for the CloudWatch alarm applied to your command.
-
#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
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 Systems Manager document (SSM document) version.
-
#error_count ⇒ Integer
The number of targets for which the status is Failed or Execution Timed Out.
-
#expires_after ⇒ Time
If a command expires, it changes status to ‘DeliveryTimedOut` for all invocations that have the status `InProgress`, `Pending`, or `Delayed`.
-
#instance_ids ⇒ Array<String>
The managed node IDs against which this command was requested.
-
#max_concurrency ⇒ String
The maximum number of managed nodes that are allowed to run 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 running the command.
-
#requested_date_time ⇒ Time
The date and time the command was requested.
-
#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.
-
#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 managed nodes using a Key,Value combination that you specify.
-
#timeout_seconds ⇒ Integer
The ‘TimeoutSeconds` value specified for a command.
-
#triggered_alarms ⇒ Array<Types::AlarmStateInformation>
The CloudWatch alarm that was invoked by the command.
Instance Attribute Details
#alarm_configuration ⇒ Types::AlarmConfiguration
The details for the CloudWatch alarm applied to your command.
2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 |
# File 'lib/aws-sdk-ssm/types.rb', line 2119 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, :timeout_seconds, :alarm_configuration, :triggered_alarms) SENSITIVE = [:parameters] include Aws::Structure end |
#cloud_watch_output_config ⇒ Types::CloudWatchOutputConfig
Amazon CloudWatch Logs information where you want Amazon Web Services Systems Manager to send the command output.
2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 |
# File 'lib/aws-sdk-ssm/types.rb', line 2119 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, :timeout_seconds, :alarm_configuration, :triggered_alarms) SENSITIVE = [:parameters] include Aws::Structure end |
#command_id ⇒ String
A unique identifier for this command.
2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 |
# File 'lib/aws-sdk-ssm/types.rb', line 2119 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, :timeout_seconds, :alarm_configuration, :triggered_alarms) SENSITIVE = [:parameters] include Aws::Structure end |
#comment ⇒ String
User-specified information about the command, such as a brief description of what the command should do.
2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 |
# File 'lib/aws-sdk-ssm/types.rb', line 2119 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, :timeout_seconds, :alarm_configuration, :triggered_alarms) SENSITIVE = [:parameters] 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, Cancelled, Terminated, or Undeliverable.
2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 |
# File 'lib/aws-sdk-ssm/types.rb', line 2119 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, :timeout_seconds, :alarm_configuration, :triggered_alarms) SENSITIVE = [:parameters] include Aws::Structure end |
#delivery_timed_out_count ⇒ Integer
The number of targets for which the status is Delivery Timed Out.
2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 |
# File 'lib/aws-sdk-ssm/types.rb', line 2119 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, :timeout_seconds, :alarm_configuration, :triggered_alarms) SENSITIVE = [:parameters] include Aws::Structure end |
#document_name ⇒ String
The name of the document requested for execution.
2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 |
# File 'lib/aws-sdk-ssm/types.rb', line 2119 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, :timeout_seconds, :alarm_configuration, :triggered_alarms) SENSITIVE = [:parameters] include Aws::Structure end |
#document_version ⇒ String
The Systems Manager document (SSM document) version.
2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 |
# File 'lib/aws-sdk-ssm/types.rb', line 2119 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, :timeout_seconds, :alarm_configuration, :triggered_alarms) SENSITIVE = [:parameters] include Aws::Structure end |
#error_count ⇒ Integer
The number of targets for which the status is Failed or Execution Timed Out.
2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 |
# File 'lib/aws-sdk-ssm/types.rb', line 2119 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, :timeout_seconds, :alarm_configuration, :triggered_alarms) SENSITIVE = [:parameters] include Aws::Structure end |
#expires_after ⇒ Time
If a command expires, it changes status to ‘DeliveryTimedOut` for all invocations that have the status `InProgress`, `Pending`, or `Delayed`. `ExpiresAfter` is calculated based on the total timeout for the overall command. For more information, see [Understanding command timeout values] in the *Amazon Web Services Systems Manager User Guide*.
2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 |
# File 'lib/aws-sdk-ssm/types.rb', line 2119 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, :timeout_seconds, :alarm_configuration, :triggered_alarms) SENSITIVE = [:parameters] include Aws::Structure end |
#instance_ids ⇒ Array<String>
The managed node IDs against which this command was requested.
2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 |
# File 'lib/aws-sdk-ssm/types.rb', line 2119 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, :timeout_seconds, :alarm_configuration, :triggered_alarms) SENSITIVE = [:parameters] include Aws::Structure end |
#max_concurrency ⇒ String
The maximum number of managed nodes that are allowed to run the command at the same time. You can specify a number of managed nodes, such as 10, or a percentage of nodes, such as 10%. The default value is 50. For more information about how to use ‘MaxConcurrency`, see
- Amazon Web Services Systems Manager Run Command][1
-
in the *Amazon
Web Services Systems Manager User Guide*.
[1]: docs.aws.amazon.com/systems-manager/latest/userguide/run-command.html
2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 |
# File 'lib/aws-sdk-ssm/types.rb', line 2119 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, :timeout_seconds, :alarm_configuration, :triggered_alarms) SENSITIVE = [:parameters] 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 [Amazon Web Services Systems Manager Run Command] in the *Amazon Web Services Systems Manager User Guide*.
[1]: docs.aws.amazon.com/systems-manager/latest/userguide/run-command.html
2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 |
# File 'lib/aws-sdk-ssm/types.rb', line 2119 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, :timeout_seconds, :alarm_configuration, :triggered_alarms) SENSITIVE = [:parameters] include Aws::Structure end |
#notification_config ⇒ Types::NotificationConfig
Configurations for sending notifications about command status changes.
2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 |
# File 'lib/aws-sdk-ssm/types.rb', line 2119 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, :timeout_seconds, :alarm_configuration, :triggered_alarms) SENSITIVE = [:parameters] 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.
2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 |
# File 'lib/aws-sdk-ssm/types.rb', line 2119 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, :timeout_seconds, :alarm_configuration, :triggered_alarms) SENSITIVE = [:parameters] 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.
2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 |
# File 'lib/aws-sdk-ssm/types.rb', line 2119 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, :timeout_seconds, :alarm_configuration, :triggered_alarms) SENSITIVE = [:parameters] 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 Web Services Region of the S3 bucket.
2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 |
# File 'lib/aws-sdk-ssm/types.rb', line 2119 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, :timeout_seconds, :alarm_configuration, :triggered_alarms) SENSITIVE = [:parameters] include Aws::Structure end |
#parameters ⇒ Hash<String,Array<String>>
The parameter values to be inserted in the document when running the command.
2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 |
# File 'lib/aws-sdk-ssm/types.rb', line 2119 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, :timeout_seconds, :alarm_configuration, :triggered_alarms) SENSITIVE = [:parameters] include Aws::Structure end |
#requested_date_time ⇒ Time
The date and time the command was requested.
2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 |
# File 'lib/aws-sdk-ssm/types.rb', line 2119 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, :timeout_seconds, :alarm_configuration, :triggered_alarms) SENSITIVE = [:parameters] 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.
2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 |
# File 'lib/aws-sdk-ssm/types.rb', line 2119 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, :timeout_seconds, :alarm_configuration, :triggered_alarms) SENSITIVE = [:parameters] include Aws::Structure end |
#status ⇒ String
The status of the command.
2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 |
# File 'lib/aws-sdk-ssm/types.rb', line 2119 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, :timeout_seconds, :alarm_configuration, :triggered_alarms) SENSITIVE = [:parameters] 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 *Amazon Web Services Systems Manager User Guide*. StatusDetails can be one of the following values:
-
Pending: The command hasn’t been sent to any managed nodes.
-
In Progress: The command has been sent to at least one managed node but hasn’t reached a final state on all managed nodes.
-
Success: The command successfully ran 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 managed nodes and one or more invocations doesn’t have a value of Success but not enough invocations failed for the status to be Failed. This is a terminal state.
-
Cancelled: The command was terminated before it was completed. This is a terminal state.
-
Rate Exceeded: The number of managed nodes targeted by the command exceeded the account limit for pending invocations. The system has canceled the command before running it on any managed node. 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
2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 |
# File 'lib/aws-sdk-ssm/types.rb', line 2119 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, :timeout_seconds, :alarm_configuration, :triggered_alarms) SENSITIVE = [:parameters] include Aws::Structure end |
#target_count ⇒ Integer
The number of targets for the command.
2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 |
# File 'lib/aws-sdk-ssm/types.rb', line 2119 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, :timeout_seconds, :alarm_configuration, :triggered_alarms) SENSITIVE = [:parameters] include Aws::Structure end |
#targets ⇒ Array<Types::Target>
An array of search criteria that targets managed nodes using a Key,Value combination that you specify. Targets is required if you don’t provide one or more managed node IDs in the call.
2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 |
# File 'lib/aws-sdk-ssm/types.rb', line 2119 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, :timeout_seconds, :alarm_configuration, :triggered_alarms) SENSITIVE = [:parameters] include Aws::Structure end |
#timeout_seconds ⇒ Integer
The ‘TimeoutSeconds` value specified for a command.
2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 |
# File 'lib/aws-sdk-ssm/types.rb', line 2119 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, :timeout_seconds, :alarm_configuration, :triggered_alarms) SENSITIVE = [:parameters] include Aws::Structure end |
#triggered_alarms ⇒ Array<Types::AlarmStateInformation>
The CloudWatch alarm that was invoked by the command.
2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 |
# File 'lib/aws-sdk-ssm/types.rb', line 2119 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, :timeout_seconds, :alarm_configuration, :triggered_alarms) SENSITIVE = [:parameters] include Aws::Structure end |