You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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.

Instance Attribute Summary collapse

Instance Attribute Details

#command_idString

A unique identifier for this command.

Returns:

  • (String)


763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 763

class Command < Struct.new(
  :command_id,
  :document_name,
  :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,
  :service_role,
  :notification_config)
  include Aws::Structure
end

#commentString

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

Returns:

  • (String)


763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 763

class Command < Struct.new(
  :command_id,
  :document_name,
  :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,
  :service_role,
  :notification_config)
  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, Canceled, Terminated, or Undeliverable.

Returns:

  • (Integer)


763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 763

class Command < Struct.new(
  :command_id,
  :document_name,
  :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,
  :service_role,
  :notification_config)
  include Aws::Structure
end

#document_nameString

The name of the document requested for execution.

Returns:

  • (String)


763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 763

class Command < Struct.new(
  :command_id,
  :document_name,
  :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,
  :service_role,
  :notification_config)
  include Aws::Structure
end

#error_countInteger

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

Returns:

  • (Integer)


763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 763

class Command < Struct.new(
  :command_id,
  :document_name,
  :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,
  :service_role,
  :notification_config)
  include Aws::Structure
end

#expires_afterTime

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

Returns:

  • (Time)


763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 763

class Command < Struct.new(
  :command_id,
  :document_name,
  :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,
  :service_role,
  :notification_config)
  include Aws::Structure
end

#instance_idsArray<String>

The instance IDs against which this command was requested.

Returns:

  • (Array<String>)


763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 763

class Command < Struct.new(
  :command_id,
  :document_name,
  :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,
  :service_role,
  :notification_config)
  include Aws::Structure
end

#max_concurrencyString

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 a Command Using Systems Manager Run Command.

Returns:

  • (String)


763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 763

class Command < Struct.new(
  :command_id,
  :document_name,
  :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,
  :service_role,
  :notification_config)
  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 50. For more information about how to use MaxErrors, see Executing a Command Using Systems Manager Run Command.

Returns:

  • (String)


763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 763

class Command < Struct.new(
  :command_id,
  :document_name,
  :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,
  :service_role,
  :notification_config)
  include Aws::Structure
end

#notification_configTypes::NotificationConfig

Configurations for sending notifications about command status changes.



763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 763

class Command < Struct.new(
  :command_id,
  :document_name,
  :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,
  :service_role,
  :notification_config)
  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)


763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 763

class Command < Struct.new(
  :command_id,
  :document_name,
  :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,
  :service_role,
  :notification_config)
  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)


763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 763

class Command < Struct.new(
  :command_id,
  :document_name,
  :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,
  :service_role,
  :notification_config)
  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 S3 bucket region.

Returns:

  • (String)


763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 763

class Command < Struct.new(
  :command_id,
  :document_name,
  :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,
  :service_role,
  :notification_config)
  include Aws::Structure
end

#parametersHash<String,Array<String>>

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

Returns:

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


763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 763

class Command < Struct.new(
  :command_id,
  :document_name,
  :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,
  :service_role,
  :notification_config)
  include Aws::Structure
end

#requested_date_timeTime

The date and time the command was requested.

Returns:

  • (Time)


763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 763

class Command < Struct.new(
  :command_id,
  :document_name,
  :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,
  :service_role,
  :notification_config)
  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.

Returns:

  • (String)


763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 763

class Command < Struct.new(
  :command_id,
  :document_name,
  :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,
  :service_role,
  :notification_config)
  include Aws::Structure
end

#statusString

The status of the command.

Returns:

  • (String)


763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 763

class Command < Struct.new(
  :command_id,
  :document_name,
  :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,
  :service_role,
  :notification_config)
  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 Run Command Status. 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.

Returns:

  • (String)


763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 763

class Command < Struct.new(
  :command_id,
  :document_name,
  :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,
  :service_role,
  :notification_config)
  include Aws::Structure
end

#target_countInteger

The number of targets for the command.

Returns:

  • (Integer)


763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 763

class Command < Struct.new(
  :command_id,
  :document_name,
  :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,
  :service_role,
  :notification_config)
  include Aws::Structure
end

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



763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 763

class Command < Struct.new(
  :command_id,
  :document_name,
  :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,
  :service_role,
  :notification_config)
  include Aws::Structure
end