Struct aws_sdk_ssm::model::Command [−][src]
#[non_exhaustive]pub struct Command {Show 24 fields
pub command_id: Option<String>,
pub document_name: Option<String>,
pub document_version: Option<String>,
pub comment: Option<String>,
pub expires_after: Option<Instant>,
pub parameters: Option<HashMap<String, Vec<String>>>,
pub instance_ids: Option<Vec<String>>,
pub targets: Option<Vec<Target>>,
pub requested_date_time: Option<Instant>,
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: i32,
}
Expand description
Describes a command request.
Fields (Non-exhaustive)
This struct is marked as non-exhaustive
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<Instant>
If this time is reached and the command hasn't already started running, it won't run.
Calculated based on the ExpiresAfter
user input provided as part of the
SendCommand
API operation.
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 instance IDs against which this command was requested.
targets: Option<Vec<Target>>
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.
requested_date_time: Option<Instant>
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 instances.
-
In Progress: The command has been sent to at least one instance but hasn't reached a final state on all instances.
-
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 instances 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.
-
Canceled: The command was terminated before it was completed. This is a terminal state.
-
Rate Exceeded: The number of instances targeted by the command exceeded the account limit for pending invocations. The system has canceled the command before running it on any instance. This is a terminal state.
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 instances that are allowed to run the command at the same time. You
can specify a number of instances, such as 10, or a percentage of instances, such as 10%. The
default value is 50. For more information about how to use MaxConcurrency
, see
Running
commands using 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 Running commands using 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, Canceled, 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: i32
The TimeoutSeconds
value specified for a command.
Implementations
A unique identifier for this command.
The name of the document requested for execution.
The Systems Manager document (SSM document) version.
User-specified information about the command, such as a brief description of what the command should do.
If this time is reached and the command hasn't already started running, it won't run.
Calculated based on the ExpiresAfter
user input provided as part of the
SendCommand
API operation.
The parameter values to be inserted in the document when running the command.
The instance IDs against which this command was requested.
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.
The date and time the command was requested.
The status of the command.
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 instances.
-
In Progress: The command has been sent to at least one instance but hasn't reached a final state on all instances.
-
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 instances 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.
-
Canceled: The command was terminated before it was completed. This is a terminal state.
-
Rate Exceeded: The number of instances targeted by the command exceeded the account limit for pending invocations. The system has canceled the command before running it on any instance. This is a terminal state.
(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.
The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command.
The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command.
The maximum number of instances that are allowed to run the command at the same time. You
can specify a number of instances, such as 10, or a percentage of instances, such as 10%. The
default value is 50. For more information about how to use MaxConcurrency
, see
Running
commands using Systems Manager Run Command in the Amazon Web Services Systems Manager User Guide.
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 Running commands using Systems Manager Run
Command in the Amazon Web Services Systems Manager User Guide.
The number of targets for the command.
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, Canceled, Terminated, or Undeliverable.
The number of targets for which the status is Failed or Execution Timed Out.
The number of targets for which the status is Delivery Timed Out.
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.
Configurations for sending notifications about command status changes.
Amazon CloudWatch Logs information where you want Amazon Web Services Systems Manager to send the command output.
The TimeoutSeconds
value specified for a command.
Trait Implementations
Auto Trait Implementations
impl RefUnwindSafe for Command
impl UnwindSafe for Command
Blanket Implementations
Mutably borrows from an owned value. Read more
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more