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

Inherits:
Struct
  • Object
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,
  },
  alarm_configuration: {
    ignore_poll_alarm_failure: false,
    alarms: [ # required
      {
        name: "AlarmName", # required
      },
    ],
  },
}

Constant Summary collapse

SENSITIVE =
[:parameters]

Instance Attribute Summary collapse

Instance Attribute Details

#alarm_configurationTypes::AlarmConfiguration

The CloudWatch alarm you want to apply to your command.


19133
19134
19135
19136
19137
19138
19139
19140
19141
19142
19143
19144
19145
19146
19147
19148
19149
19150
19151
19152
19153
19154
# File 'lib/aws-sdk-ssm/types.rb', line 19133

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,
  :alarm_configuration)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#cloud_watch_output_configTypes::CloudWatchOutputConfig

Enables Amazon Web Services Systems Manager to send Run Command output to Amazon CloudWatch Logs. Run Command is a capability of Amazon Web Services Systems Manager.


19133
19134
19135
19136
19137
19138
19139
19140
19141
19142
19143
19144
19145
19146
19147
19148
19149
19150
19151
19152
19153
19154
# File 'lib/aws-sdk-ssm/types.rb', line 19133

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,
  :alarm_configuration)
  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)

19133
19134
19135
19136
19137
19138
19139
19140
19141
19142
19143
19144
19145
19146
19147
19148
19149
19150
19151
19152
19153
19154
# File 'lib/aws-sdk-ssm/types.rb', line 19133

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,
  :alarm_configuration)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#document_hashString

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)

19133
19134
19135
19136
19137
19138
19139
19140
19141
19142
19143
19144
19145
19146
19147
19148
19149
19150
19151
19152
19153
19154
# File 'lib/aws-sdk-ssm/types.rb', line 19133

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,
  :alarm_configuration)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#document_hash_typeString

Sha256 or Sha1.

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

</note>

Returns:

  • (String)

19133
19134
19135
19136
19137
19138
19139
19140
19141
19142
19143
19144
19145
19146
19147
19148
19149
19150
19151
19152
19153
19154
# File 'lib/aws-sdk-ssm/types.rb', line 19133

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,
  :alarm_configuration)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#document_nameString

The name of the Amazon Web Services Systems Manager document (SSM document) to run. This can be a public document or a custom document. To run a shared document belonging to another account, specify the document Amazon Resource Name (ARN). For more information about how to use shared documents, see [Using shared SSM documents] in the *Amazon Web Services Systems Manager User Guide*.

<note markdown=“1”> If you specify a document name or ARN that hasn't been shared with your account, you receive an `InvalidDocument` error.

</note>

[1]: docs.aws.amazon.com/systems-manager/latest/userguide/ssm-using-shared.html

Returns:

  • (String)

19133
19134
19135
19136
19137
19138
19139
19140
19141
19142
19143
19144
19145
19146
19147
19148
19149
19150
19151
19152
19153
19154
# File 'lib/aws-sdk-ssm/types.rb', line 19133

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,
  :alarm_configuration)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#document_versionString

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 Command Line Interface (Amazon Web Services 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)

19133
19134
19135
19136
19137
19138
19139
19140
19141
19142
19143
19144
19145
19146
19147
19148
19149
19150
19151
19152
19153
19154
# File 'lib/aws-sdk-ssm/types.rb', line 19133

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,
  :alarm_configuration)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#instance_idsArray<String>

The IDs of the managed nodes where the command should run. Specifying managed node IDs is most useful when you are targeting a limited number of managed nodes, though you can specify up to 50 IDs.

To target a larger number of managed nodes, or if you prefer not to list individual node IDs, we recommend using the `Targets` option instead. Using `Targets`, which accepts tag key-value pairs to identify the managed nodes to send commands to, you can a send command to tens, hundreds, or thousands of nodes at once.

For more information about how to use targets, see [Using targets and rate controls to send commands to a fleet] in the *Amazon Web Services Systems Manager User Guide*.

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

Returns:

  • (Array<String>)

19133
19134
19135
19136
19137
19138
19139
19140
19141
19142
19143
19144
19145
19146
19147
19148
19149
19150
19151
19152
19153
19154
# File 'lib/aws-sdk-ssm/types.rb', line 19133

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,
  :alarm_configuration)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#max_concurrencyString

(Optional) The maximum number of managed nodes 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 *Amazon Web Services Systems Manager User Guide*.

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

Returns:

  • (String)

19133
19134
19135
19136
19137
19138
19139
19140
19141
19142
19143
19144
19145
19146
19147
19148
19149
19150
19151
19152
19153
19154
# File 'lib/aws-sdk-ssm/types.rb', line 19133

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,
  :alarm_configuration)
  SENSITIVE = [:parameters]
  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 `0`. For more information about how to use `MaxErrors`, see [Using error controls] in the *Amazon Web Services Systems Manager User Guide*.

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

Returns:

  • (String)

19133
19134
19135
19136
19137
19138
19139
19140
19141
19142
19143
19144
19145
19146
19147
19148
19149
19150
19151
19152
19153
19154
# File 'lib/aws-sdk-ssm/types.rb', line 19133

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,
  :alarm_configuration)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#notification_configTypes::NotificationConfig

Configurations for sending notifications.


19133
19134
19135
19136
19137
19138
19139
19140
19141
19142
19143
19144
19145
19146
19147
19148
19149
19150
19151
19152
19153
19154
# File 'lib/aws-sdk-ssm/types.rb', line 19133

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,
  :alarm_configuration)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#output_s3_bucket_nameString

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

Returns:

  • (String)

19133
19134
19135
19136
19137
19138
19139
19140
19141
19142
19143
19144
19145
19146
19147
19148
19149
19150
19151
19152
19153
19154
# File 'lib/aws-sdk-ssm/types.rb', line 19133

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,
  :alarm_configuration)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#output_s3_key_prefixString

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

Returns:

  • (String)

19133
19134
19135
19136
19137
19138
19139
19140
19141
19142
19143
19144
19145
19146
19147
19148
19149
19150
19151
19152
19153
19154
# File 'lib/aws-sdk-ssm/types.rb', line 19133

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,
  :alarm_configuration)
  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)

19133
19134
19135
19136
19137
19138
19139
19140
19141
19142
19143
19144
19145
19146
19147
19148
19149
19150
19151
19152
19153
19154
# File 'lib/aws-sdk-ssm/types.rb', line 19133

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,
  :alarm_configuration)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#parametersHash<String,Array<String>>

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

Returns:

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

19133
19134
19135
19136
19137
19138
19139
19140
19141
19142
19143
19144
19145
19146
19147
19148
19149
19150
19151
19152
19153
19154
# File 'lib/aws-sdk-ssm/types.rb', line 19133

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,
  :alarm_configuration)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#service_role_arnString

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

This role must provide the `sns:Publish` permission for your notification topic. For information about creating and using this service role, see [Monitoring Systems Manager status changes using Amazon SNS notifications] in the *Amazon Web Services Systems Manager User Guide*.

[1]: docs.aws.amazon.com/systems-manager/latest/userguide/monitoring-sns-notifications.html

Returns:

  • (String)

19133
19134
19135
19136
19137
19138
19139
19140
19141
19142
19143
19144
19145
19146
19147
19148
19149
19150
19151
19152
19153
19154
# File 'lib/aws-sdk-ssm/types.rb', line 19133

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,
  :alarm_configuration)
  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. Specifying targets is most useful when you want to send a command to a large number of managed nodes at once. Using `Targets`, which accepts tag key-value pairs to identify managed nodes, you can send a command to tens, hundreds, or thousands of nodes at once.

To send a command to a smaller number of managed nodes, you can use the `InstanceIds` option instead.

For more information about how to use targets, see [Sending commands to a fleet] in the *Amazon Web Services Systems Manager User Guide*.

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

Returns:


19133
19134
19135
19136
19137
19138
19139
19140
19141
19142
19143
19144
19145
19146
19147
19148
19149
19150
19151
19152
19153
19154
# File 'lib/aws-sdk-ssm/types.rb', line 19133

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,
  :alarm_configuration)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#timeout_secondsInteger

If this time is reached and the command hasn't already started running, it won't run.

Returns:

  • (Integer)

19133
19134
19135
19136
19137
19138
19139
19140
19141
19142
19143
19144
19145
19146
19147
19148
19149
19150
19151
19152
19153
19154
# File 'lib/aws-sdk-ssm/types.rb', line 19133

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,
  :alarm_configuration)
  SENSITIVE = [:parameters]
  include Aws::Structure
end