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<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: i32,
}

Expand description

Describes a command request.

Fields (Non-exhaustive)

This struct is marked as 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 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 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.
Canceled: 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.

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

Struct aws_sdk_ssm::model::Command[−][src]

Fields (Non-exhaustive)

Implementations

impl Command

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

pub fn target_count(&self) -> i32

pub fn completed_count(&self) -> i32

pub fn error_count(&self) -> i32

pub fn delivery_timed_out_count(&self) -> i32

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

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

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

pub fn timeout_seconds(&self) -> i32

impl Command

pub fn builder() -> Builder

Trait Implementations

impl Clone for Command

fn clone(&self) -> Command

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

impl Debug for Command

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

impl PartialEq<Command> for Command

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

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

impl StructuralPartialEq for Command

Auto Trait Implementations

impl RefUnwindSafe for Command

impl Send for Command

impl Sync for Command

impl Unpin for Command

impl UnwindSafe for Command

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

pub fn to_owned(&self) -> T

pub fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

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

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

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,