Struct aws_sdk_ssm::types::Command

#[non_exhaustive]
pub struct Command {

    pub command_id: Option<String>,
    pub document_name: Option<String>,
    pub document_version: Option<String>,
    pub comment: Option<String>,
    pub expires_after: Option<DateTime>,
    pub parameters: Option<HashMap<String, Vec<String>>>,
    pub instance_ids: Option<Vec<String>>,
    pub targets: Option<Vec<Target>>,
    pub requested_date_time: Option<DateTime>,
    pub status: Option<CommandStatus>,
    pub status_details: Option<String>,
    pub output_s3_region: Option<String>,
    pub output_s3_bucket_name: Option<String>,
    pub output_s3_key_prefix: Option<String>,
    pub max_concurrency: Option<String>,
    pub max_errors: Option<String>,
    pub target_count: i32,
    pub completed_count: i32,
    pub error_count: i32,
    pub delivery_timed_out_count: i32,
    pub service_role: Option<String>,
    pub notification_config: Option<NotificationConfig>,
    pub cloud_watch_output_config: Option<CloudWatchOutputConfig>,
    pub timeout_seconds: Option<i32>,
    pub alarm_configuration: Option<AlarmConfiguration>,
    pub triggered_alarms: Option<Vec<AlarmStateInformation>>,
}

Describes a command request.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

command_id: Option<String>

A unique identifier for this command.

document_name: Option<String>

The name of the document requested for execution.

document_version: Option<String>

The Systems Manager document (SSM document) version.

comment: Option<String>

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

expires_after: Option<DateTime>

If a command expires, it changes status to DeliveryTimedOut for all invocations that have the status InProgress, Pending, or Delayed. ExpiresAfter is calculated based on the total timeout for the overall command. For more information, see Understanding command timeout values in the Amazon Web Services Systems Manager User Guide.

parameters: Option<HashMap<String, Vec<String>>>

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

instance_ids: Option<Vec<String>>

The managed node IDs against which this command was requested.

targets: Option<Vec<Target>>

An array of search criteria that targets managed nodes using a Key,Value combination that you specify. Targets is required if you don't provide one or more managed node IDs in the call.

requested_date_time: Option<DateTime>

The date and time the command was requested.

status: Option<CommandStatus>

The status of the command.

status_details: Option<String>

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 Understanding command statuses in the Amazon Web Services Systems Manager User Guide. StatusDetails can be one of the following values:

• Pending: The command hasn't been sent to any managed nodes.

• In Progress: The command has been sent to at least one managed node but hasn't reached a final state on all managed nodes.

• Success: The command successfully ran 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 managed nodes and one or more invocations doesn't have a value of Success but not enough invocations failed for the status to be Failed. This is a terminal state.

• Cancelled: The command was terminated before it was completed. This is a terminal state.

• Rate Exceeded: The number of managed nodes targeted by the command exceeded the account limit for pending invocations. The system has canceled the command before running it on any managed node. This is a terminal state.

• Delayed: The system attempted to send the command to the managed node but wasn't successful. The system retries again.

output_s3_region: Option<String>

(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.

output_s3_bucket_name: Option<String>

The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command.

output_s3_key_prefix: Option<String>

The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command.

max_concurrency: Option<String>

The maximum number of managed nodes that are allowed to run the command at the same time. You can specify a number of managed nodes, such as 10, or a percentage of nodes, such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Amazon Web Services Systems Manager Run Command in the Amazon Web Services Systems Manager User Guide.

max_errors: Option<String>

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 0. For more information about how to use MaxErrors, see Amazon Web Services Systems Manager Run Command in the Amazon Web Services Systems Manager User Guide.

target_count: i32

The number of targets for the command.

completed_count: i32

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, Cancelled, Terminated, or Undeliverable.

error_count: i32

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

delivery_timed_out_count: i32

The number of targets for which the status is Delivery Timed Out.

service_role: Option<String>

The Identity and Access Management (IAM) service role that Run Command, a capability of Amazon Web Services Systems Manager, uses to act on your behalf when sending notifications about command status changes.

notification_config: Option<NotificationConfig>

Configurations for sending notifications about command status changes.

cloud_watch_output_config: Option<CloudWatchOutputConfig>

Amazon CloudWatch Logs information where you want Amazon Web Services Systems Manager to send the command output.

timeout_seconds: Option<i32>

The TimeoutSeconds value specified for a command.

alarm_configuration: Option<AlarmConfiguration>

The details for the CloudWatch alarm applied to your command.

triggered_alarms: Option<Vec<AlarmStateInformation>>

The CloudWatch alarm that was invoked by the command.

Implementations

impl Command

pub fn command_id(&self) -> Option<&str>

A unique identifier for this command.

pub fn document_name(&self) -> Option<&str>

The name of the document requested for execution.

pub fn document_version(&self) -> Option<&str>

The Systems Manager document (SSM document) version.

pub fn comment(&self) -> Option<&str>

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

pub fn expires_after(&self) -> Option<&DateTime>

If a command expires, it changes status to DeliveryTimedOut for all invocations that have the status InProgress, Pending, or Delayed. ExpiresAfter is calculated based on the total timeout for the overall command. For more information, see Understanding command timeout values in the Amazon Web Services Systems Manager User Guide.

pub fn parameters(&self) -> Option<&HashMap<String, Vec<String>>>

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

pub fn instance_ids(&self) -> &[String]

The managed node IDs against which this command was requested.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .instance_ids.is_none().

pub fn targets(&self) -> &[Target]

An array of search criteria that targets managed nodes using a Key,Value combination that you specify. Targets is required if you don't provide one or more managed node IDs in the call.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .targets.is_none().

pub fn requested_date_time(&self) -> Option<&DateTime>

The date and time the command was requested.

pub fn status(&self) -> Option<&CommandStatus>

The status of the command.

pub fn status_details(&self) -> Option<&str>

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 Understanding command statuses in the Amazon Web Services Systems Manager User Guide. StatusDetails can be one of the following values:

• Pending: The command hasn't been sent to any managed nodes.

• In Progress: The command has been sent to at least one managed node but hasn't reached a final state on all managed nodes.

• Success: The command successfully ran 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 managed nodes and one or more invocations doesn't have a value of Success but not enough invocations failed for the status to be Failed. This is a terminal state.

• Cancelled: The command was terminated before it was completed. This is a terminal state.

• Rate Exceeded: The number of managed nodes targeted by the command exceeded the account limit for pending invocations. The system has canceled the command before running it on any managed node. This is a terminal state.

• Delayed: The system attempted to send the command to the managed node but wasn't successful. The system retries again.

pub fn output_s3_region(&self) -> Option<&str>

(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.

pub fn output_s3_bucket_name(&self) -> Option<&str>

The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command.

pub fn output_s3_key_prefix(&self) -> Option<&str>

The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command.

pub fn max_concurrency(&self) -> Option<&str>

The maximum number of managed nodes that are allowed to run the command at the same time. You can specify a number of managed nodes, such as 10, or a percentage of nodes, such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Amazon Web Services Systems Manager Run Command in the Amazon Web Services Systems Manager User Guide.

pub fn max_errors(&self) -> Option<&str>

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 0. For more information about how to use MaxErrors, see Amazon Web Services Systems Manager Run Command in the Amazon Web Services Systems Manager User Guide.

pub fn target_count(&self) -> i32

The number of targets for the command.

pub fn completed_count(&self) -> i32

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, Cancelled, Terminated, or Undeliverable.

pub fn error_count(&self) -> i32

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

pub fn delivery_timed_out_count(&self) -> i32

The number of targets for which the status is Delivery Timed Out.

pub fn service_role(&self) -> Option<&str>

The Identity and Access Management (IAM) service role that Run Command, a capability of Amazon Web Services Systems Manager, uses to act on your behalf when sending notifications about command status changes.

pub fn notification_config(&self) -> Option<&NotificationConfig>

Configurations for sending notifications about command status changes.

pub fn cloud_watch_output_config(&self) -> Option<&CloudWatchOutputConfig>

Amazon CloudWatch Logs information where you want Amazon Web Services Systems Manager to send the command output.

pub fn timeout_seconds(&self) -> Option<i32>

The TimeoutSeconds value specified for a command.

pub fn alarm_configuration(&self) -> Option<&AlarmConfiguration>

The details for the CloudWatch alarm applied to your command.

pub fn triggered_alarms(&self) -> &[AlarmStateInformation]

The CloudWatch alarm that was invoked by the command.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .triggered_alarms.is_none().

impl Command

pub fn builder() -> CommandBuilder

Creates a new builder-style object to manufacture Command.

Trait Implementations

impl Clone for Command

fn clone(&self) -> Command

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Command

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for Command

fn eq(&self, other: &Command) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Command