Struct aws_sdk_ssm::types::CommandInvocation

#[non_exhaustive]
pub struct CommandInvocation {

    pub command_id: Option<String>,
    pub instance_id: Option<String>,
    pub instance_name: Option<String>,
    pub comment: Option<String>,
    pub document_name: Option<String>,
    pub document_version: Option<String>,
    pub requested_date_time: Option<DateTime>,
    pub status: Option<CommandInvocationStatus>,
    pub status_details: Option<String>,
    pub trace_output: Option<String>,
    pub standard_output_url: Option<String>,
    pub standard_error_url: Option<String>,
    pub command_plugins: Option<Vec<CommandPlugin>>,
    pub service_role: Option<String>,
    pub notification_config: Option<NotificationConfig>,
    pub cloud_watch_output_config: Option<CloudWatchOutputConfig>,
}

An invocation is a copy of a command sent to a specific managed node. A command can apply to one or more managed nodes. A command invocation applies to one managed node. For example, if a user runs SendCommand against three managed nodes, then a command invocation is created for each requested managed node ID. A command invocation returns status and detail information about a command you ran.

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>

The command against which this invocation was requested.

instance_id: Option<String>

The managed node ID in which this invocation was requested.

instance_name: Option<String>

The fully qualified host name of the managed node.

comment: Option<String>

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

document_name: Option<String>

The document name that was requested for execution.

document_version: Option<String>

The Systems Manager document (SSM document) version.

requested_date_time: Option<DateTime>

The time and date the request was sent to this managed node.

status: Option<CommandInvocationStatus>

Whether or not the invocation succeeded, failed, or is pending.

status_details: Option<String>

A detailed status of the command execution for each invocation (each managed node targeted by the command). 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 the managed node.

• In Progress: The command has been sent to the managed node but hasn't reached a terminal state.

• Success: The execution of the command or plugin was successfully completed. This is a terminal state.

• Delivery Timed Out: The command wasn't delivered to the managed node before the delivery timeout expired. Delivery timeouts don't count against the parent command's MaxErrors limit, but they do contribute to whether the parent command status is Success or Incomplete. This is a terminal state.

• Execution Timed Out: Command execution started on the managed node, but the execution wasn't complete before the execution timeout expired. Execution timeouts count against the MaxErrors limit of the parent command. This is a terminal state.

• Failed: The command wasn't successful on the managed node. For a plugin, this indicates that the result code wasn't zero. For a command invocation, this indicates that the result code for one or more plugins wasn't zero. Invocation failures count against the MaxErrors limit of the parent command. This is a terminal state.

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

• Undeliverable: The command can't be delivered to the managed node. The managed node might not exist or might not be responding. Undeliverable invocations don't count against the parent command's MaxErrors limit and don't contribute to whether the parent command status is Success or Incomplete. This is a terminal state.

• Terminated: The parent command exceeded its MaxErrors limit and subsequent command invocations were canceled by the system. 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.

trace_output: Option<String>

Gets the trace output sent by the agent.

standard_output_url: Option<String>

The URL to the plugin's StdOut file in Amazon Simple Storage Service (Amazon S3), if the S3 bucket was defined for the parent command. For an invocation, StandardOutputUrl is populated if there is just one plugin defined for the command, and the S3 bucket was defined for the command.

standard_error_url: Option<String>

The URL to the plugin's StdErr file in Amazon Simple Storage Service (Amazon S3), if the S3 bucket was defined for the parent command. For an invocation, StandardErrorUrl is populated if there is just one plugin defined for the command, and the S3 bucket was defined for the command.

command_plugins: Option<Vec<CommandPlugin>>

Plugins processed by the command.

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 on a per managed node basis.

notification_config: Option<NotificationConfig>

Configurations for sending notifications about command status changes on a per managed node basis.

cloud_watch_output_config: Option<CloudWatchOutputConfig>

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

Implementations

impl CommandInvocation

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

The command against which this invocation was requested.

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

The managed node ID in which this invocation was requested.

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

The fully qualified host name of the managed node.

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 document_name(&self) -> Option<&str>

The document name that was requested for execution.

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

The Systems Manager document (SSM document) version.

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

The time and date the request was sent to this managed node.

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

Whether or not the invocation succeeded, failed, or is pending.

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

A detailed status of the command execution for each invocation (each managed node targeted by the command). 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 the managed node.

• In Progress: The command has been sent to the managed node but hasn't reached a terminal state.

• Success: The execution of the command or plugin was successfully completed. This is a terminal state.

• Delivery Timed Out: The command wasn't delivered to the managed node before the delivery timeout expired. Delivery timeouts don't count against the parent command's MaxErrors limit, but they do contribute to whether the parent command status is Success or Incomplete. This is a terminal state.

• Execution Timed Out: Command execution started on the managed node, but the execution wasn't complete before the execution timeout expired. Execution timeouts count against the MaxErrors limit of the parent command. This is a terminal state.

• Failed: The command wasn't successful on the managed node. For a plugin, this indicates that the result code wasn't zero. For a command invocation, this indicates that the result code for one or more plugins wasn't zero. Invocation failures count against the MaxErrors limit of the parent command. This is a terminal state.

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

• Undeliverable: The command can't be delivered to the managed node. The managed node might not exist or might not be responding. Undeliverable invocations don't count against the parent command's MaxErrors limit and don't contribute to whether the parent command status is Success or Incomplete. This is a terminal state.

• Terminated: The parent command exceeded its MaxErrors limit and subsequent command invocations were canceled by the system. 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 trace_output(&self) -> Option<&str>

Gets the trace output sent by the agent.

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

The URL to the plugin's StdOut file in Amazon Simple Storage Service (Amazon S3), if the S3 bucket was defined for the parent command. For an invocation, StandardOutputUrl is populated if there is just one plugin defined for the command, and the S3 bucket was defined for the command.

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

The URL to the plugin's StdErr file in Amazon Simple Storage Service (Amazon S3), if the S3 bucket was defined for the parent command. For an invocation, StandardErrorUrl is populated if there is just one plugin defined for the command, and the S3 bucket was defined for the command.

pub fn command_plugins(&self) -> &[CommandPlugin]

Plugins processed 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 .command_plugins.is_none().

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 on a per managed node basis.

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

Configurations for sending notifications about command status changes on a per managed node basis.

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.

impl CommandInvocation

pub fn builder() -> CommandInvocationBuilder

Creates a new builder-style object to manufacture CommandInvocation.

Trait Implementations

impl Clone for CommandInvocation

fn clone(&self) -> CommandInvocation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CommandInvocation

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

Formats the value using the given formatter.

impl PartialEq for CommandInvocation

fn eq(&self, other: &CommandInvocation) -> 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 CommandInvocation