Struct aws_sdk_ssm::operation::get_command_invocation::builders::GetCommandInvocationFluentBuilder

pub struct GetCommandInvocationFluentBuilder { /* private fields */ }

Fluent builder constructing a request to GetCommandInvocation.

Returns detailed information about command execution for an invocation or plugin. The Run Command API follows an eventual consistency model, due to the distributed nature of the system supporting the API. This means that the result of an API command you run that affects your resources might not be immediately visible to all subsequent commands you run. You should keep this in mind when you carry out an API command that immediately follows a previous API command.

GetCommandInvocation only gives the execution status of a plugin in a document. To get the command execution status on a specific managed node, use ListCommandInvocations. To get the command execution status across managed nodes, use ListCommands.

Implementations

impl GetCommandInvocationFluentBuilder

pub fn as_input(&self) -> &GetCommandInvocationInputBuilder

Access the GetCommandInvocation as a reference.

pub async fn send( self, ) -> Result<GetCommandInvocationOutput, SdkError<GetCommandInvocationError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn customize( self, ) -> CustomizableOperation<GetCommandInvocationOutput, GetCommandInvocationError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

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

(Required) The parent command ID of the invocation plugin.

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

(Required) The parent command ID of the invocation plugin.

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

(Required) The parent command ID of the invocation plugin.

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

(Required) The ID of the managed node targeted by the command. A managed node can be an Amazon Elastic Compute Cloud (Amazon EC2) instance, edge device, and on-premises server or VM in your hybrid environment that is configured for Amazon Web Services Systems Manager.

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

(Required) The ID of the managed node targeted by the command. A managed node can be an Amazon Elastic Compute Cloud (Amazon EC2) instance, edge device, and on-premises server or VM in your hybrid environment that is configured for Amazon Web Services Systems Manager.

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

(Required) The ID of the managed node targeted by the command. A managed node can be an Amazon Elastic Compute Cloud (Amazon EC2) instance, edge device, and on-premises server or VM in your hybrid environment that is configured for Amazon Web Services Systems Manager.

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

The name of the step for which you want detailed results. If the document contains only one step, you can omit the name and details for that step. If the document contains more than one step, you must specify the name of the step for which you want to view details. Be sure to specify the name of the step, not the name of a plugin like aws:RunShellScript.

To find the PluginName, check the document content and find the name of the step you want details for. Alternatively, use ListCommandInvocations with the CommandId and Details parameters. The PluginName is the Name attribute of the CommandPlugin object in the CommandPlugins list.

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

The name of the step for which you want detailed results. If the document contains only one step, you can omit the name and details for that step. If the document contains more than one step, you must specify the name of the step for which you want to view details. Be sure to specify the name of the step, not the name of a plugin like aws:RunShellScript.

To find the PluginName, check the document content and find the name of the step you want details for. Alternatively, use ListCommandInvocations with the CommandId and Details parameters. The PluginName is the Name attribute of the CommandPlugin object in the CommandPlugins list.

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

The name of the step for which you want detailed results. If the document contains only one step, you can omit the name and details for that step. If the document contains more than one step, you must specify the name of the step for which you want to view details. Be sure to specify the name of the step, not the name of a plugin like aws:RunShellScript.

To find the PluginName, check the document content and find the name of the step you want details for. Alternatively, use ListCommandInvocations with the CommandId and Details parameters. The PluginName is the Name attribute of the CommandPlugin object in the CommandPlugins list.

Trait Implementations

impl Clone for GetCommandInvocationFluentBuilder

fn clone(&self) -> GetCommandInvocationFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GetCommandInvocationFluentBuilder

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

Formats the value using the given formatter.