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

Class: Aws::SSM::Types::SendCommandRequest

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

Overview

Note:

When making an API call, you may pass SendCommandRequest data as a hash:

{
  instance_ids: ["InstanceId"],
  targets: [
    {
      key: "TargetKey",
      values: ["TargetValue"],
    },
  ],
  document_name: "DocumentARN", # required
  document_hash: "DocumentHash",
  document_hash_type: "Sha256", # accepts Sha256, Sha1
  timeout_seconds: 1,
  comment: "Comment",
  parameters: {
    "ParameterName" => ["ParameterValue"],
  },
  output_s3_region: "S3Region",
  output_s3_bucket_name: "S3BucketName",
  output_s3_key_prefix: "S3KeyPrefix",
  max_concurrency: "MaxConcurrency",
  max_errors: "MaxErrors",
  service_role_arn: "ServiceRole",
  notification_config: {
    notification_arn: "NotificationArn",
    notification_events: ["All"], # accepts All, InProgress, Success, TimedOut, Cancelled, Failed
    notification_type: "Command", # accepts Command, Invocation
  },
}

Instance Attribute Summary collapse

Instance Attribute Details

#commentString

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

Returns:

  • (String)


8632
8633
8634
8635
8636
8637
8638
8639
8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8632

class SendCommandRequest < Struct.new(
  :instance_ids,
  :targets,
  :document_name,
  :document_hash,
  :document_hash_type,
  :timeout_seconds,
  :comment,
  :parameters,
  :output_s3_region,
  :output_s3_bucket_name,
  :output_s3_key_prefix,
  :max_concurrency,
  :max_errors,
  :service_role_arn,
  :notification_config)
  include Aws::Structure
end

#document_hashString

The Sha256 or Sha1 hash created by the system when the document was created.

Sha1 hashes have been deprecated.

Returns:

  • (String)


8632
8633
8634
8635
8636
8637
8638
8639
8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8632

class SendCommandRequest < Struct.new(
  :instance_ids,
  :targets,
  :document_name,
  :document_hash,
  :document_hash_type,
  :timeout_seconds,
  :comment,
  :parameters,
  :output_s3_region,
  :output_s3_bucket_name,
  :output_s3_key_prefix,
  :max_concurrency,
  :max_errors,
  :service_role_arn,
  :notification_config)
  include Aws::Structure
end

#document_hash_typeString

Sha256 or Sha1.

Sha1 hashes have been deprecated.

Returns:

  • (String)


8632
8633
8634
8635
8636
8637
8638
8639
8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8632

class SendCommandRequest < Struct.new(
  :instance_ids,
  :targets,
  :document_name,
  :document_hash,
  :document_hash_type,
  :timeout_seconds,
  :comment,
  :parameters,
  :output_s3_region,
  :output_s3_bucket_name,
  :output_s3_key_prefix,
  :max_concurrency,
  :max_errors,
  :service_role_arn,
  :notification_config)
  include Aws::Structure
end

#document_nameString

Required. The name of the Systems Manager document to execute. This can be a public document or a custom document.

Returns:

  • (String)


8632
8633
8634
8635
8636
8637
8638
8639
8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8632

class SendCommandRequest < Struct.new(
  :instance_ids,
  :targets,
  :document_name,
  :document_hash,
  :document_hash_type,
  :timeout_seconds,
  :comment,
  :parameters,
  :output_s3_region,
  :output_s3_bucket_name,
  :output_s3_key_prefix,
  :max_concurrency,
  :max_errors,
  :service_role_arn,
  :notification_config)
  include Aws::Structure
end

#instance_idsArray<String>

The instance IDs where the command should execute. You can specify a maximum of 50 IDs. If you prefer not to list individual instance IDs, you can instead send commands to a fleet of instances using the Targets parameter, which accepts EC2 tags. For more information about how to use Targets, see Sending Commands to a Fleet.

Returns:

  • (Array<String>)


8632
8633
8634
8635
8636
8637
8638
8639
8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8632

class SendCommandRequest < Struct.new(
  :instance_ids,
  :targets,
  :document_name,
  :document_hash,
  :document_hash_type,
  :timeout_seconds,
  :comment,
  :parameters,
  :output_s3_region,
  :output_s3_bucket_name,
  :output_s3_key_prefix,
  :max_concurrency,
  :max_errors,
  :service_role_arn,
  :notification_config)
  include Aws::Structure
end

#max_concurrencyString

(Optional) The maximum number of instances that are allowed to execute the command at the same time. You can specify a number such as 10 or a percentage such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Using Concurrency Controls.

Returns:

  • (String)


8632
8633
8634
8635
8636
8637
8638
8639
8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8632

class SendCommandRequest < Struct.new(
  :instance_ids,
  :targets,
  :document_name,
  :document_hash,
  :document_hash_type,
  :timeout_seconds,
  :comment,
  :parameters,
  :output_s3_region,
  :output_s3_bucket_name,
  :output_s3_key_prefix,
  :max_concurrency,
  :max_errors,
  :service_role_arn,
  :notification_config)
  include Aws::Structure
end

#max_errorsString

The maximum number of errors allowed without the command failing. When the command fails one more time beyond the value of MaxErrors, the systems stops sending the command to additional targets. You can specify a number like 10 or a percentage like 10%. The default value is 50. For more information about how to use MaxErrors, see Using Error Controls.

Returns:

  • (String)


8632
8633
8634
8635
8636
8637
8638
8639
8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8632

class SendCommandRequest < Struct.new(
  :instance_ids,
  :targets,
  :document_name,
  :document_hash,
  :document_hash_type,
  :timeout_seconds,
  :comment,
  :parameters,
  :output_s3_region,
  :output_s3_bucket_name,
  :output_s3_key_prefix,
  :max_concurrency,
  :max_errors,
  :service_role_arn,
  :notification_config)
  include Aws::Structure
end

#notification_configTypes::NotificationConfig

Configurations for sending notifications.



8632
8633
8634
8635
8636
8637
8638
8639
8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8632

class SendCommandRequest < Struct.new(
  :instance_ids,
  :targets,
  :document_name,
  :document_hash,
  :document_hash_type,
  :timeout_seconds,
  :comment,
  :parameters,
  :output_s3_region,
  :output_s3_bucket_name,
  :output_s3_key_prefix,
  :max_concurrency,
  :max_errors,
  :service_role_arn,
  :notification_config)
  include Aws::Structure
end

#output_s3_bucket_nameString

The name of the S3 bucket where command execution responses should be stored.

Returns:

  • (String)


8632
8633
8634
8635
8636
8637
8638
8639
8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8632

class SendCommandRequest < Struct.new(
  :instance_ids,
  :targets,
  :document_name,
  :document_hash,
  :document_hash_type,
  :timeout_seconds,
  :comment,
  :parameters,
  :output_s3_region,
  :output_s3_bucket_name,
  :output_s3_key_prefix,
  :max_concurrency,
  :max_errors,
  :service_role_arn,
  :notification_config)
  include Aws::Structure
end

#output_s3_key_prefixString

The directory structure within the S3 bucket where the responses should be stored.

Returns:

  • (String)


8632
8633
8634
8635
8636
8637
8638
8639
8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8632

class SendCommandRequest < Struct.new(
  :instance_ids,
  :targets,
  :document_name,
  :document_hash,
  :document_hash_type,
  :timeout_seconds,
  :comment,
  :parameters,
  :output_s3_region,
  :output_s3_bucket_name,
  :output_s3_key_prefix,
  :max_concurrency,
  :max_errors,
  :service_role_arn,
  :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)


8632
8633
8634
8635
8636
8637
8638
8639
8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8632

class SendCommandRequest < Struct.new(
  :instance_ids,
  :targets,
  :document_name,
  :document_hash,
  :document_hash_type,
  :timeout_seconds,
  :comment,
  :parameters,
  :output_s3_region,
  :output_s3_bucket_name,
  :output_s3_key_prefix,
  :max_concurrency,
  :max_errors,
  :service_role_arn,
  :notification_config)
  include Aws::Structure
end

#parametersHash<String,Array<String>>

The required and optional parameters specified in the document being executed.

Returns:

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


8632
8633
8634
8635
8636
8637
8638
8639
8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8632

class SendCommandRequest < Struct.new(
  :instance_ids,
  :targets,
  :document_name,
  :document_hash,
  :document_hash_type,
  :timeout_seconds,
  :comment,
  :parameters,
  :output_s3_region,
  :output_s3_bucket_name,
  :output_s3_key_prefix,
  :max_concurrency,
  :max_errors,
  :service_role_arn,
  :notification_config)
  include Aws::Structure
end

#service_role_arnString

The IAM role that Systems Manager uses to send notifications.

Returns:

  • (String)


8632
8633
8634
8635
8636
8637
8638
8639
8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8632

class SendCommandRequest < Struct.new(
  :instance_ids,
  :targets,
  :document_name,
  :document_hash,
  :document_hash_type,
  :timeout_seconds,
  :comment,
  :parameters,
  :output_s3_region,
  :output_s3_bucket_name,
  :output_s3_key_prefix,
  :max_concurrency,
  :max_errors,
  :service_role_arn,
  :notification_config)
  include Aws::Structure
end

#targetsArray<Types::Target>

(Optional) 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. For more information about how to use Targets, see Sending Commands to a Fleet.

Returns:



8632
8633
8634
8635
8636
8637
8638
8639
8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8632

class SendCommandRequest < Struct.new(
  :instance_ids,
  :targets,
  :document_name,
  :document_hash,
  :document_hash_type,
  :timeout_seconds,
  :comment,
  :parameters,
  :output_s3_region,
  :output_s3_bucket_name,
  :output_s3_key_prefix,
  :max_concurrency,
  :max_errors,
  :service_role_arn,
  :notification_config)
  include Aws::Structure
end

#timeout_secondsInteger

If this time is reached and the command has not already started executing, it will not execute.

Returns:

  • (Integer)


8632
8633
8634
8635
8636
8637
8638
8639
8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8632

class SendCommandRequest < Struct.new(
  :instance_ids,
  :targets,
  :document_name,
  :document_hash,
  :document_hash_type,
  :timeout_seconds,
  :comment,
  :parameters,
  :output_s3_region,
  :output_s3_bucket_name,
  :output_s3_key_prefix,
  :max_concurrency,
  :max_errors,
  :service_role_arn,
  :notification_config)
  include Aws::Structure
end