Struct aws_sdk_ssm::client::fluent_builders::SendCommand
source · [−]pub struct SendCommand { /* private fields */ }
Expand description
Fluent builder constructing a request to SendCommand
.
Runs commands on one or more managed nodes.
Implementations
sourceimpl SendCommand
impl SendCommand
sourcepub async fn send(self) -> Result<SendCommandOutput, SdkError<SendCommandError>>
pub async fn send(self) -> Result<SendCommandOutput, SdkError<SendCommandError>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
sourcepub fn instance_ids(self, input: impl Into<String>) -> Self
pub fn instance_ids(self, input: impl Into<String>) -> Self
Appends an item to InstanceIds
.
To override the contents of this collection use set_instance_ids
.
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.
sourcepub fn set_instance_ids(self, input: Option<Vec<String>>) -> Self
pub fn set_instance_ids(self, input: Option<Vec<String>>) -> Self
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.
sourcepub fn targets(self, input: Target) -> Self
pub fn targets(self, input: Target) -> Self
Appends an item to Targets
.
To override the contents of this collection use set_targets
.
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.
sourcepub fn set_targets(self, input: Option<Vec<Target>>) -> Self
pub fn set_targets(self, input: Option<Vec<Target>>) -> Self
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.
sourcepub fn document_name(self, input: impl Into<String>) -> Self
pub fn document_name(self, input: impl Into<String>) -> Self
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.
If you specify a document name or ARN that hasn't been shared with your account, you receive an InvalidDocument
error.
sourcepub fn set_document_name(self, input: Option<String>) -> Self
pub fn set_document_name(self, input: Option<String>) -> Self
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.
If you specify a document name or ARN that hasn't been shared with your account, you receive an InvalidDocument
error.
sourcepub fn document_version(self, input: impl Into<String>) -> Self
pub fn document_version(self, input: impl Into<String>) -> Self
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"
sourcepub fn set_document_version(self, input: Option<String>) -> Self
pub fn set_document_version(self, input: Option<String>) -> Self
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"
sourcepub fn document_hash(self, input: impl Into<String>) -> Self
pub fn document_hash(self, input: impl Into<String>) -> Self
The Sha256 or Sha1 hash created by the system when the document was created.
Sha1 hashes have been deprecated.
sourcepub fn set_document_hash(self, input: Option<String>) -> Self
pub fn set_document_hash(self, input: Option<String>) -> Self
The Sha256 or Sha1 hash created by the system when the document was created.
Sha1 hashes have been deprecated.
sourcepub fn document_hash_type(self, input: DocumentHashType) -> Self
pub fn document_hash_type(self, input: DocumentHashType) -> Self
Sha256 or Sha1.
Sha1 hashes have been deprecated.
sourcepub fn set_document_hash_type(self, input: Option<DocumentHashType>) -> Self
pub fn set_document_hash_type(self, input: Option<DocumentHashType>) -> Self
Sha256 or Sha1.
Sha1 hashes have been deprecated.
sourcepub fn timeout_seconds(self, input: i32) -> Self
pub fn timeout_seconds(self, input: i32) -> Self
If this time is reached and the command hasn't already started running, it won't run.
sourcepub fn set_timeout_seconds(self, input: Option<i32>) -> Self
pub fn set_timeout_seconds(self, input: Option<i32>) -> Self
If this time is reached and the command hasn't already started running, it won't run.
sourcepub fn comment(self, input: impl Into<String>) -> Self
pub fn comment(self, input: impl Into<String>) -> Self
User-specified information about the command, such as a brief description of what the command should do.
sourcepub fn set_comment(self, input: Option<String>) -> Self
pub fn set_comment(self, input: Option<String>) -> Self
User-specified information about the command, such as a brief description of what the command should do.
sourcepub fn parameters(self, k: impl Into<String>, v: Vec<String>) -> Self
pub fn parameters(self, k: impl Into<String>, v: Vec<String>) -> Self
Adds a key-value pair to Parameters
.
To override the contents of this collection use set_parameters
.
The required and optional parameters specified in the document being run.
sourcepub fn set_parameters(self, input: Option<HashMap<String, Vec<String>>>) -> Self
pub fn set_parameters(self, input: Option<HashMap<String, Vec<String>>>) -> Self
The required and optional parameters specified in the document being run.
sourcepub fn output_s3_region(self, input: impl Into<String>) -> Self
pub fn output_s3_region(self, input: impl Into<String>) -> Self
(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.
sourcepub fn set_output_s3_region(self, input: Option<String>) -> Self
pub fn set_output_s3_region(self, input: Option<String>) -> Self
(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.
sourcepub fn output_s3_bucket_name(self, input: impl Into<String>) -> Self
pub fn output_s3_bucket_name(self, input: impl Into<String>) -> Self
The name of the S3 bucket where command execution responses should be stored.
sourcepub fn set_output_s3_bucket_name(self, input: Option<String>) -> Self
pub fn set_output_s3_bucket_name(self, input: Option<String>) -> Self
The name of the S3 bucket where command execution responses should be stored.
sourcepub fn output_s3_key_prefix(self, input: impl Into<String>) -> Self
pub fn output_s3_key_prefix(self, input: impl Into<String>) -> Self
The directory structure within the S3 bucket where the responses should be stored.
sourcepub fn set_output_s3_key_prefix(self, input: Option<String>) -> Self
pub fn set_output_s3_key_prefix(self, input: Option<String>) -> Self
The directory structure within the S3 bucket where the responses should be stored.
sourcepub fn max_concurrency(self, input: impl Into<String>) -> Self
pub fn max_concurrency(self, input: impl Into<String>) -> Self
(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.
sourcepub fn set_max_concurrency(self, input: Option<String>) -> Self
pub fn set_max_concurrency(self, input: Option<String>) -> Self
(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.
sourcepub fn max_errors(self, input: impl Into<String>) -> Self
pub fn max_errors(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_max_errors(self, input: Option<String>) -> Self
pub fn set_max_errors(self, input: Option<String>) -> Self
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.
sourcepub fn service_role_arn(self, input: impl Into<String>) -> Self
pub fn service_role_arn(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_service_role_arn(self, input: Option<String>) -> Self
pub fn set_service_role_arn(self, input: Option<String>) -> Self
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.
sourcepub fn notification_config(self, input: NotificationConfig) -> Self
pub fn notification_config(self, input: NotificationConfig) -> Self
Configurations for sending notifications.
sourcepub fn set_notification_config(self, input: Option<NotificationConfig>) -> Self
pub fn set_notification_config(self, input: Option<NotificationConfig>) -> Self
Configurations for sending notifications.
sourcepub fn cloud_watch_output_config(self, input: CloudWatchOutputConfig) -> Self
pub fn cloud_watch_output_config(self, input: CloudWatchOutputConfig) -> Self
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.
sourcepub fn set_cloud_watch_output_config(
self,
input: Option<CloudWatchOutputConfig>
) -> Self
pub fn set_cloud_watch_output_config(
self,
input: Option<CloudWatchOutputConfig>
) -> Self
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.
Trait Implementations
sourceimpl Clone for SendCommand
impl Clone for SendCommand
sourcefn clone(&self) -> SendCommand
fn clone(&self) -> SendCommand
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
Auto Trait Implementations
impl !RefUnwindSafe for SendCommand
impl Send for SendCommand
impl Sync for SendCommand
impl Unpin for SendCommand
impl !UnwindSafe for SendCommand
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more