Struct aws_sdk_ssm::client::fluent_builders::GetCommandInvocation

pub struct GetCommandInvocation<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* private fields */ }

Fluent builder constructing a request to GetCommandInvocation.

Returns detailed information about command execution for an invocation or plugin.

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<C, M, R> GetCommandInvocation<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<GetCommandInvocationOutput, SdkError<GetCommandInvocationError>> where
    R::Policy: SmithyRetryPolicy<GetCommandInvocationInputOperationOutputAlias, GetCommandInvocationOutput, GetCommandInvocationError, GetCommandInvocationInputOperationRetryAlias>, 

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 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 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 plugin_name(self, input: impl Into<String>) -> Self

The name of the plugin for which you want detailed results. If the document contains only one plugin, you can omit the name and details for that plugin. If the document contains more than one plugin, you must specify the name of the plugin for which you want to view details.

Plugin names are also referred to as step names in Systems Manager documents (SSM documents). For example, aws:RunShellScript is a plugin.

To find the PluginName, check the document content and find the name of the plugin. 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 plugin for which you want detailed results. If the document contains only one plugin, you can omit the name and details for that plugin. If the document contains more than one plugin, you must specify the name of the plugin for which you want to view details.

Plugin names are also referred to as step names in Systems Manager documents (SSM documents). For example, aws:RunShellScript is a plugin.

To find the PluginName, check the document content and find the name of the plugin. 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<C: Clone, M: Clone, R: Clone> Clone for GetCommandInvocation<C, M, R>

fn clone(&self) -> GetCommandInvocation<C, M, R>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug, M: Debug, R: Debug> Debug for GetCommandInvocation<C, M, R>

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

Formats the value using the given formatter.