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

Inherits:

Struct

Object
Struct
Aws::SSM::Types::SendCommandRequest

show all

Includes:: Aws::Structure

Defined in:: 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_version: "DocumentVersion",
  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
  },
  cloud_watch_output_config: {
    cloud_watch_log_group_name: "CloudWatchLogGroupName",
    cloud_watch_output_enabled: false,
  },
}

Instance Attribute Summary collapse

#cloud_watch_output_config ⇒ Types::CloudWatchOutputConfig

Enables Systems Manager to send Run Command output to Amazon CloudWatch Logs.
#comment ⇒ String

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

The Sha256 or Sha1 hash created by the system when the document was created.
#document_hash_type ⇒ String

Sha256 or Sha1.
#document_name ⇒ String

Required.
#document_version ⇒ String

The SSM document version to use in the request.
#instance_ids ⇒ Array<String>

The instance IDs where the command should run.
#max_concurrency ⇒ String

(Optional) The maximum number of instances that are allowed to run the command at the same time.
#max_errors ⇒ String

The maximum number of errors allowed without the command failing.
#notification_config ⇒ Types::NotificationConfig

Configurations for sending notifications.
#output_s3_bucket_name ⇒ String

The name of the S3 bucket where command execution responses should be stored.
#output_s3_key_prefix ⇒ String

The directory structure within the S3 bucket where the responses should be stored.
#output_s3_region ⇒ String

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

The required and optional parameters specified in the document being run.
#service_role_arn ⇒ String

The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for Run Command commands.
#targets ⇒ Array<Types::Target>

(Optional) An array of search criteria that targets instances using a Key,Value combination that you specify.
#timeout_seconds ⇒ Integer

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

Instance Attribute Details

#cloud_watch_output_config ⇒ `Types::CloudWatchOutputConfig`

Enables Systems Manager to send Run Command output to Amazon CloudWatch Logs.

Returns:

(Types::CloudWatchOutputConfig)

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

class SendCommandRequest < Struct.new(
  :instance_ids,
  :targets,
  :document_name,
  :document_version,
  :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,
  :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 14659

class SendCommandRequest < Struct.new(
  :instance_ids,
  :targets,
  :document_name,
  :document_version,
  :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,
  :cloud_watch_output_config)
  include Aws::Structure
end

#document_hash ⇒ `String`

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

<note markdown=“1”> Sha1 hashes have been deprecated.

</note>

Returns:

(String)

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

class SendCommandRequest < Struct.new(
  :instance_ids,
  :targets,
  :document_name,
  :document_version,
  :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,
  :cloud_watch_output_config)
  include Aws::Structure
end

#document_hash_type ⇒ `String`

Sha256 or Sha1.

<note markdown=“1”> Sha1 hashes have been deprecated.

</note>

Returns:

(String)

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

class SendCommandRequest < Struct.new(
  :instance_ids,
  :targets,
  :document_name,
  :document_version,
  :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,
  :cloud_watch_output_config)
  include Aws::Structure
end

#document_name ⇒ `String`

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

Returns:

(String)

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

class SendCommandRequest < Struct.new(
  :instance_ids,
  :targets,
  :document_name,
  :document_version,
  :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,
  :cloud_watch_output_config)
  include Aws::Structure
end

#document_version ⇒ `String`

The SSM document version to use in the request. You can specify $DEFAULT, $LATEST, or a specific version number. If you run commands by using the AWS CLI, then you must escape the first two options by using a backslash. If you specify a version number, then you don’t need to use the backslash. For example:

–document-version “\$DEFAULT”

–document-version “\$LATEST”

–document-version “3”

Returns:

(String)

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

class SendCommandRequest < Struct.new(
  :instance_ids,
  :targets,
  :document_name,
  :document_version,
  :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,
  :cloud_watch_output_config)
  include Aws::Structure
end

#instance_ids ⇒ `Array<String>`

The instance IDs where the command should run. 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] in the *AWS Systems Manager User Guide*.

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

Returns:

(Array<String>)

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

class SendCommandRequest < Struct.new(
  :instance_ids,
  :targets,
  :document_name,
  :document_version,
  :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,
  :cloud_watch_output_config)
  include Aws::Structure
end

#max_concurrency ⇒ `String`

(Optional) The maximum number of instances that are allowed to run 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] in the *AWS Systems Manager User Guide*.

[1]: docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html#send-commands-velocity

Returns:

(String)

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

class SendCommandRequest < Struct.new(
  :instance_ids,
  :targets,
  :document_name,
  :document_version,
  :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,
  :cloud_watch_output_config)
  include Aws::Structure
end

#max_errors ⇒ `String`

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 0. For more information about how to use MaxErrors, see [Using Error Controls] in the *AWS Systems Manager User Guide*.

[1]: docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html#send-commands-maxerrors

Returns:

(String)

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

class SendCommandRequest < Struct.new(
  :instance_ids,
  :targets,
  :document_name,
  :document_version,
  :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,
  :cloud_watch_output_config)
  include Aws::Structure
end

#notification_config ⇒ `Types::NotificationConfig`

Configurations for sending notifications.

Returns:

(Types::NotificationConfig)

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

class SendCommandRequest < Struct.new(
  :instance_ids,
  :targets,
  :document_name,
  :document_version,
  :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,
  :cloud_watch_output_config)
  include Aws::Structure
end

#output_s3_bucket_name ⇒ `String`

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

Returns:

(String)

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

class SendCommandRequest < Struct.new(
  :instance_ids,
  :targets,
  :document_name,
  :document_version,
  :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,
  :cloud_watch_output_config)
  include Aws::Structure
end

#output_s3_key_prefix ⇒ `String`

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

Returns:

(String)

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

class SendCommandRequest < Struct.new(
  :instance_ids,
  :targets,
  :document_name,
  :document_version,
  :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,
  :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 14659

class SendCommandRequest < Struct.new(
  :instance_ids,
  :targets,
  :document_name,
  :document_version,
  :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,
  :cloud_watch_output_config)
  include Aws::Structure
end

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

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

Returns:

(Hash<String,Array<String>>)

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

class SendCommandRequest < Struct.new(
  :instance_ids,
  :targets,
  :document_name,
  :document_version,
  :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,
  :cloud_watch_output_config)
  include Aws::Structure
end

#service_role_arn ⇒ `String`

The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for Run Command commands.

Returns:

(String)

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

class SendCommandRequest < Struct.new(
  :instance_ids,
  :targets,
  :document_name,
  :document_version,
  :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,
  :cloud_watch_output_config)
  include Aws::Structure
end

#targets ⇒ `Array<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] in the *AWS Systems Manager User Guide*.

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

Returns:

(Array<Types::Target>)

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

class SendCommandRequest < Struct.new(
  :instance_ids,
  :targets,
  :document_name,
  :document_version,
  :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,
  :cloud_watch_output_config)
  include Aws::Structure
end

#timeout_seconds ⇒ `Integer`

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

Returns:

(Integer)

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

class SendCommandRequest < Struct.new(
  :instance_ids,
  :targets,
  :document_name,
  :document_version,
  :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,
  :cloud_watch_output_config)
  include Aws::Structure
end

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

Overview

Instance Attribute Summary collapse

Instance Attribute Details

#cloud_watch_output_config ⇒ Types::CloudWatchOutputConfig

#comment ⇒ String

#document_hash ⇒ String

#document_hash_type ⇒ String

#document_name ⇒ String

#document_version ⇒ String

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

#service_role_arn ⇒ String

#targets ⇒ Array<Types::Target>

#timeout_seconds ⇒ Integer

#cloud_watch_output_config ⇒ `Types::CloudWatchOutputConfig`

#comment ⇒ `String`

#document_hash ⇒ `String`

#document_hash_type ⇒ `String`

#document_name ⇒ `String`

#document_version ⇒ `String`

#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>>`

#service_role_arn ⇒ `String`

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

#timeout_seconds ⇒ `Integer`