Struct aws_sdk_ssm::types::builders::CommandInvocationBuilder

#[non_exhaustive]
pub struct CommandInvocationBuilder { /* private fields */ }

A builder for CommandInvocation.

Implementations

impl CommandInvocationBuilder

pub fn command_id(self, input: impl Into<String>) -> Self

The command against which this invocation was requested.

pub fn set_command_id(self, input: Option<String>) -> Self

The command against which this invocation was requested.

pub fn get_command_id(&self) -> &Option<String>

The command against which this invocation was requested.

pub fn instance_id(self, input: impl Into<String>) -> Self

The managed node ID in which this invocation was requested.

pub fn set_instance_id(self, input: Option<String>) -> Self

The managed node ID in which this invocation was requested.

pub fn get_instance_id(&self) -> &Option<String>

The managed node ID in which this invocation was requested.

pub fn instance_name(self, input: impl Into<String>) -> Self

The fully qualified host name of the managed node.

pub fn set_instance_name(self, input: Option<String>) -> Self

The fully qualified host name of the managed node.

pub fn get_instance_name(&self) -> &Option<String>

The fully qualified host name of the managed node.

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.

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.

pub fn get_comment(&self) -> &Option<String>

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

pub fn document_name(self, input: impl Into<String>) -> Self

The document name that was requested for execution.

pub fn set_document_name(self, input: Option<String>) -> Self

The document name that was requested for execution.

pub fn get_document_name(&self) -> &Option<String>

The document name that was requested for execution.

pub fn document_version(self, input: impl Into<String>) -> Self

The Systems Manager document (SSM document) version.

pub fn set_document_version(self, input: Option<String>) -> Self

The Systems Manager document (SSM document) version.

pub fn get_document_version(&self) -> &Option<String>

The Systems Manager document (SSM document) version.

pub fn requested_date_time(self, input: DateTime) -> Self

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

pub fn set_requested_date_time(self, input: Option<DateTime>) -> Self

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

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

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

pub fn status(self, input: CommandInvocationStatus) -> Self

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

pub fn set_status(self, input: Option<CommandInvocationStatus>) -> Self

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

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

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

pub fn status_details(self, input: impl Into<String>) -> Self

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 set_status_details(self, input: Option<String>) -> Self

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 get_status_details(&self) -> &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.

pub fn trace_output(self, input: impl Into<String>) -> Self

Gets the trace output sent by the agent.

pub fn set_trace_output(self, input: Option<String>) -> Self

Gets the trace output sent by the agent.

pub fn get_trace_output(&self) -> &Option<String>

Gets the trace output sent by the agent.

pub fn standard_output_url(self, input: impl Into<String>) -> Self

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 set_standard_output_url(self, input: Option<String>) -> Self

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 get_standard_output_url(&self) -> &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.

pub fn standard_error_url(self, input: impl Into<String>) -> Self

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 set_standard_error_url(self, input: Option<String>) -> Self

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 get_standard_error_url(&self) -> &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.

pub fn command_plugins(self, input: CommandPlugin) -> Self

Appends an item to command_plugins.

To override the contents of this collection use set_command_plugins.

Plugins processed by the command.

pub fn set_command_plugins(self, input: Option<Vec<CommandPlugin>>) -> Self

Plugins processed by the command.

pub fn get_command_plugins(&self) -> &Option<Vec<CommandPlugin>>

Plugins processed by the command.

pub fn service_role(self, input: impl Into<String>) -> Self

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 set_service_role(self, input: Option<String>) -> Self

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 get_service_role(&self) -> &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.

pub fn notification_config(self, input: NotificationConfig) -> Self

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

pub fn set_notification_config(self, input: Option<NotificationConfig>) -> Self

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

pub fn get_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, input: CloudWatchOutputConfig) -> Self

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

pub fn set_cloud_watch_output_config( self, input: Option<CloudWatchOutputConfig> ) -> Self

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

pub fn get_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 build(self) -> CommandInvocation

Consumes the builder and constructs a CommandInvocation.

Trait Implementations

impl Clone for CommandInvocationBuilder

fn clone(&self) -> CommandInvocationBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CommandInvocationBuilder

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

Formats the value using the given formatter.

impl Default for CommandInvocationBuilder

fn default() -> CommandInvocationBuilder

Returns the “default value” for a type.

impl PartialEq for CommandInvocationBuilder

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