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

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

Overview

Describes a command request.

Constant Summary collapse

SENSITIVE =
[:parameters]

Instance Attribute Summary collapse

Instance Attribute Details

#alarm_configurationTypes::AlarmConfiguration

The details for the CloudWatch alarm applied to your command.



2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2007

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

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



2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2007

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_idString

A unique identifier for this command.

Returns:

  • (String)


2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2007

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

#commentString

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

Returns:

  • (String)


2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2007

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_countInteger

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.

Returns:

  • (Integer)


2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2007

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_countInteger

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

Returns:

  • (Integer)


2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2007

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_nameString

The name of the document requested for execution.

Returns:

  • (String)


2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2007

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_versionString

The Systems Manager document (SSM document) version.

Returns:

  • (String)


2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2007

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_countInteger

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

Returns:

  • (Integer)


2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2007

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_afterTime

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.

Returns:

  • (Time)


2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2007

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_idsArray<String>

The managed node IDs against which this command was requested.

Returns:

  • (Array<String>)


2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2007

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_concurrencyString

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 in the Amazon Web Services Systems Manager User Guide.

Returns:

  • (String)


2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2007

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_errorsString

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.

Returns:

  • (String)


2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2007

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

Configurations for sending notifications about command status changes.



2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2007

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_nameString

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

Returns:

  • (String)


2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2007

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_prefixString

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)


2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2007

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_regionString

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

Returns:

  • (String)


2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2007

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

#parametersHash<String,Array<String>>

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

Returns:

  • (Hash<String,Array<String>>)


2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2007

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_timeTime

The date and time the command was requested.

Returns:

  • (Time)


2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2007

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

Returns:

  • (String)


2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2007

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

#statusString

The status of the command.

Returns:

  • (String)


2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2007

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_detailsString

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.

Returns:

  • (String)


2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2007

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_countInteger

The number of targets for the command.

Returns:

  • (Integer)


2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2007

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

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

Returns:



2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2007

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_secondsInteger

The TimeoutSeconds value specified for a command.

Returns:

  • (Integer)


2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2007

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_alarmsArray<Types::AlarmStateInformation>

The CloudWatch alarm that was invoked by the command.

Returns:



2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2007

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