Struct aws_sdk_ssm::operation::get_command_invocation::builders::GetCommandInvocationOutputBuilder
source · #[non_exhaustive]pub struct GetCommandInvocationOutputBuilder { /* private fields */ }
Expand description
A builder for GetCommandInvocationOutput
.
Implementations§
source§impl GetCommandInvocationOutputBuilder
impl GetCommandInvocationOutputBuilder
sourcepub fn command_id(self, input: impl Into<String>) -> Self
pub fn command_id(self, input: impl Into<String>) -> Self
The parent command ID of the invocation plugin.
sourcepub fn set_command_id(self, input: Option<String>) -> Self
pub fn set_command_id(self, input: Option<String>) -> Self
The parent command ID of the invocation plugin.
sourcepub fn get_command_id(&self) -> &Option<String>
pub fn get_command_id(&self) -> &Option<String>
The parent command ID of the invocation plugin.
sourcepub fn instance_id(self, input: impl Into<String>) -> Self
pub fn instance_id(self, input: impl Into<String>) -> Self
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, or on-premises server or VM in your hybrid environment that is configured for Amazon Web Services Systems Manager.
sourcepub fn set_instance_id(self, input: Option<String>) -> Self
pub fn set_instance_id(self, input: Option<String>) -> Self
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, or on-premises server or VM in your hybrid environment that is configured for Amazon Web Services Systems Manager.
sourcepub fn get_instance_id(&self) -> &Option<String>
pub fn get_instance_id(&self) -> &Option<String>
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, or on-premises server or VM in your hybrid environment that is configured for Amazon Web Services Systems Manager.
sourcepub fn set_comment(self, input: Option<String>) -> Self
pub fn set_comment(self, input: Option<String>) -> Self
The comment text for the command.
sourcepub fn get_comment(&self) -> &Option<String>
pub fn get_comment(&self) -> &Option<String>
The comment text for the command.
sourcepub fn document_name(self, input: impl Into<String>) -> Self
pub fn document_name(self, input: impl Into<String>) -> Self
The name of the document that was run. For example, AWS-RunShellScript
.
sourcepub fn set_document_name(self, input: Option<String>) -> Self
pub fn set_document_name(self, input: Option<String>) -> Self
The name of the document that was run. For example, AWS-RunShellScript
.
sourcepub fn get_document_name(&self) -> &Option<String>
pub fn get_document_name(&self) -> &Option<String>
The name of the document that was run. For example, AWS-RunShellScript
.
sourcepub fn document_version(self, input: impl Into<String>) -> Self
pub fn document_version(self, input: impl Into<String>) -> Self
The Systems Manager document (SSM document) version used in the request.
sourcepub fn set_document_version(self, input: Option<String>) -> Self
pub fn set_document_version(self, input: Option<String>) -> Self
The Systems Manager document (SSM document) version used in the request.
sourcepub fn get_document_version(&self) -> &Option<String>
pub fn get_document_version(&self) -> &Option<String>
The Systems Manager document (SSM document) version used in the request.
sourcepub fn plugin_name(self, input: impl Into<String>) -> Self
pub fn plugin_name(self, input: impl Into<String>) -> Self
The name of the plugin, or step name, for which details are reported. For example, aws:RunShellScript
is a plugin.
sourcepub fn set_plugin_name(self, input: Option<String>) -> Self
pub fn set_plugin_name(self, input: Option<String>) -> Self
The name of the plugin, or step name, for which details are reported. For example, aws:RunShellScript
is a plugin.
sourcepub fn get_plugin_name(&self) -> &Option<String>
pub fn get_plugin_name(&self) -> &Option<String>
The name of the plugin, or step name, for which details are reported. For example, aws:RunShellScript
is a plugin.
sourcepub fn response_code(self, input: i32) -> Self
pub fn response_code(self, input: i32) -> Self
The error level response code for the plugin script. If the response code is -1
, then the command hasn't started running on the managed node, or it wasn't received by the node.
sourcepub fn set_response_code(self, input: Option<i32>) -> Self
pub fn set_response_code(self, input: Option<i32>) -> Self
The error level response code for the plugin script. If the response code is -1
, then the command hasn't started running on the managed node, or it wasn't received by the node.
sourcepub fn get_response_code(&self) -> &Option<i32>
pub fn get_response_code(&self) -> &Option<i32>
The error level response code for the plugin script. If the response code is -1
, then the command hasn't started running on the managed node, or it wasn't received by the node.
sourcepub fn execution_start_date_time(self, input: impl Into<String>) -> Self
pub fn execution_start_date_time(self, input: impl Into<String>) -> Self
The date and time the plugin started running. Date and time are written in ISO 8601 format. For example, June 7, 2017 is represented as 2017-06-7. The following sample Amazon Web Services CLI command uses the InvokedBefore
filter.
aws ssm list-commands --filters key=InvokedBefore,value=2017-06-07T00:00:00Z
If the plugin hasn't started to run, the string is empty.
sourcepub fn set_execution_start_date_time(self, input: Option<String>) -> Self
pub fn set_execution_start_date_time(self, input: Option<String>) -> Self
The date and time the plugin started running. Date and time are written in ISO 8601 format. For example, June 7, 2017 is represented as 2017-06-7. The following sample Amazon Web Services CLI command uses the InvokedBefore
filter.
aws ssm list-commands --filters key=InvokedBefore,value=2017-06-07T00:00:00Z
If the plugin hasn't started to run, the string is empty.
sourcepub fn get_execution_start_date_time(&self) -> &Option<String>
pub fn get_execution_start_date_time(&self) -> &Option<String>
The date and time the plugin started running. Date and time are written in ISO 8601 format. For example, June 7, 2017 is represented as 2017-06-7. The following sample Amazon Web Services CLI command uses the InvokedBefore
filter.
aws ssm list-commands --filters key=InvokedBefore,value=2017-06-07T00:00:00Z
If the plugin hasn't started to run, the string is empty.
sourcepub fn execution_elapsed_time(self, input: impl Into<String>) -> Self
pub fn execution_elapsed_time(self, input: impl Into<String>) -> Self
Duration since ExecutionStartDateTime
.
sourcepub fn set_execution_elapsed_time(self, input: Option<String>) -> Self
pub fn set_execution_elapsed_time(self, input: Option<String>) -> Self
Duration since ExecutionStartDateTime
.
sourcepub fn get_execution_elapsed_time(&self) -> &Option<String>
pub fn get_execution_elapsed_time(&self) -> &Option<String>
Duration since ExecutionStartDateTime
.
sourcepub fn execution_end_date_time(self, input: impl Into<String>) -> Self
pub fn execution_end_date_time(self, input: impl Into<String>) -> Self
The date and time the plugin finished running. Date and time are written in ISO 8601 format. For example, June 7, 2017 is represented as 2017-06-7. The following sample Amazon Web Services CLI command uses the InvokedAfter
filter.
aws ssm list-commands --filters key=InvokedAfter,value=2017-06-07T00:00:00Z
If the plugin hasn't started to run, the string is empty.
sourcepub fn set_execution_end_date_time(self, input: Option<String>) -> Self
pub fn set_execution_end_date_time(self, input: Option<String>) -> Self
The date and time the plugin finished running. Date and time are written in ISO 8601 format. For example, June 7, 2017 is represented as 2017-06-7. The following sample Amazon Web Services CLI command uses the InvokedAfter
filter.
aws ssm list-commands --filters key=InvokedAfter,value=2017-06-07T00:00:00Z
If the plugin hasn't started to run, the string is empty.
sourcepub fn get_execution_end_date_time(&self) -> &Option<String>
pub fn get_execution_end_date_time(&self) -> &Option<String>
The date and time the plugin finished running. Date and time are written in ISO 8601 format. For example, June 7, 2017 is represented as 2017-06-7. The following sample Amazon Web Services CLI command uses the InvokedAfter
filter.
aws ssm list-commands --filters key=InvokedAfter,value=2017-06-07T00:00:00Z
If the plugin hasn't started to run, the string is empty.
sourcepub fn status(self, input: CommandInvocationStatus) -> Self
pub fn status(self, input: CommandInvocationStatus) -> Self
The status of this invocation plugin. This status can be different than StatusDetails
.
sourcepub fn set_status(self, input: Option<CommandInvocationStatus>) -> Self
pub fn set_status(self, input: Option<CommandInvocationStatus>) -> Self
The status of this invocation plugin. This status can be different than StatusDetails
.
sourcepub fn get_status(&self) -> &Option<CommandInvocationStatus>
pub fn get_status(&self) -> &Option<CommandInvocationStatus>
The status of this invocation plugin. This status can be different than StatusDetails
.
sourcepub fn status_details(self, input: impl Into<String>) -> Self
pub fn status_details(self, input: impl Into<String>) -> Self
A detailed status of the command execution for an invocation. 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.
-
Delayed: The system attempted to send the command to the target, but the target wasn't available. The managed node might not be available because of network issues, because the node was stopped, or for similar reasons. The system will try to send the command again.
-
Success: The command or plugin ran successfully. 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: The command started to run on the managed node, but the execution wasn't complete before the timeout expired. Execution timeouts count against the
MaxErrors
limit of the parent command. This is a terminal state. -
Failed: The command wasn't run successfully 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 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.
sourcepub fn set_status_details(self, input: Option<String>) -> Self
pub fn set_status_details(self, input: Option<String>) -> Self
A detailed status of the command execution for an invocation. 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.
-
Delayed: The system attempted to send the command to the target, but the target wasn't available. The managed node might not be available because of network issues, because the node was stopped, or for similar reasons. The system will try to send the command again.
-
Success: The command or plugin ran successfully. 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: The command started to run on the managed node, but the execution wasn't complete before the timeout expired. Execution timeouts count against the
MaxErrors
limit of the parent command. This is a terminal state. -
Failed: The command wasn't run successfully 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 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.
sourcepub fn get_status_details(&self) -> &Option<String>
pub fn get_status_details(&self) -> &Option<String>
A detailed status of the command execution for an invocation. 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.
-
Delayed: The system attempted to send the command to the target, but the target wasn't available. The managed node might not be available because of network issues, because the node was stopped, or for similar reasons. The system will try to send the command again.
-
Success: The command or plugin ran successfully. 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: The command started to run on the managed node, but the execution wasn't complete before the timeout expired. Execution timeouts count against the
MaxErrors
limit of the parent command. This is a terminal state. -
Failed: The command wasn't run successfully 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 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.
sourcepub fn standard_output_content(self, input: impl Into<String>) -> Self
pub fn standard_output_content(self, input: impl Into<String>) -> Self
The first 24,000 characters written by the plugin to stdout
. If the command hasn't finished running, if ExecutionStatus
is neither Succeeded nor Failed, then this string is empty.
sourcepub fn set_standard_output_content(self, input: Option<String>) -> Self
pub fn set_standard_output_content(self, input: Option<String>) -> Self
The first 24,000 characters written by the plugin to stdout
. If the command hasn't finished running, if ExecutionStatus
is neither Succeeded nor Failed, then this string is empty.
sourcepub fn get_standard_output_content(&self) -> &Option<String>
pub fn get_standard_output_content(&self) -> &Option<String>
The first 24,000 characters written by the plugin to stdout
. If the command hasn't finished running, if ExecutionStatus
is neither Succeeded nor Failed, then this string is empty.
sourcepub fn standard_output_url(self, input: impl Into<String>) -> Self
pub fn standard_output_url(self, input: impl Into<String>) -> Self
The URL for the complete text written by the plugin to stdout
in Amazon Simple Storage Service (Amazon S3). If an S3 bucket wasn't specified, then this string is empty.
sourcepub fn set_standard_output_url(self, input: Option<String>) -> Self
pub fn set_standard_output_url(self, input: Option<String>) -> Self
The URL for the complete text written by the plugin to stdout
in Amazon Simple Storage Service (Amazon S3). If an S3 bucket wasn't specified, then this string is empty.
sourcepub fn get_standard_output_url(&self) -> &Option<String>
pub fn get_standard_output_url(&self) -> &Option<String>
The URL for the complete text written by the plugin to stdout
in Amazon Simple Storage Service (Amazon S3). If an S3 bucket wasn't specified, then this string is empty.
sourcepub fn standard_error_content(self, input: impl Into<String>) -> Self
pub fn standard_error_content(self, input: impl Into<String>) -> Self
The first 8,000 characters written by the plugin to stderr
. If the command hasn't finished running, then this string is empty.
sourcepub fn set_standard_error_content(self, input: Option<String>) -> Self
pub fn set_standard_error_content(self, input: Option<String>) -> Self
The first 8,000 characters written by the plugin to stderr
. If the command hasn't finished running, then this string is empty.
sourcepub fn get_standard_error_content(&self) -> &Option<String>
pub fn get_standard_error_content(&self) -> &Option<String>
The first 8,000 characters written by the plugin to stderr
. If the command hasn't finished running, then this string is empty.
sourcepub fn standard_error_url(self, input: impl Into<String>) -> Self
pub fn standard_error_url(self, input: impl Into<String>) -> Self
The URL for the complete text written by the plugin to stderr
. If the command hasn't finished running, then this string is empty.
sourcepub fn set_standard_error_url(self, input: Option<String>) -> Self
pub fn set_standard_error_url(self, input: Option<String>) -> Self
The URL for the complete text written by the plugin to stderr
. If the command hasn't finished running, then this string is empty.
sourcepub fn get_standard_error_url(&self) -> &Option<String>
pub fn get_standard_error_url(&self) -> &Option<String>
The URL for the complete text written by the plugin to stderr
. If the command hasn't finished running, then this string is empty.
sourcepub fn cloud_watch_output_config(self, input: CloudWatchOutputConfig) -> Self
pub fn cloud_watch_output_config(self, input: CloudWatchOutputConfig) -> Self
Amazon CloudWatch Logs information where Systems Manager sent the command output.
sourcepub fn set_cloud_watch_output_config(
self,
input: Option<CloudWatchOutputConfig>
) -> Self
pub fn set_cloud_watch_output_config( self, input: Option<CloudWatchOutputConfig> ) -> Self
Amazon CloudWatch Logs information where Systems Manager sent the command output.
sourcepub fn get_cloud_watch_output_config(&self) -> &Option<CloudWatchOutputConfig>
pub fn get_cloud_watch_output_config(&self) -> &Option<CloudWatchOutputConfig>
Amazon CloudWatch Logs information where Systems Manager sent the command output.
sourcepub fn build(self) -> GetCommandInvocationOutput
pub fn build(self) -> GetCommandInvocationOutput
Consumes the builder and constructs a GetCommandInvocationOutput
.
Trait Implementations§
source§impl Clone for GetCommandInvocationOutputBuilder
impl Clone for GetCommandInvocationOutputBuilder
source§fn clone(&self) -> GetCommandInvocationOutputBuilder
fn clone(&self) -> GetCommandInvocationOutputBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Default for GetCommandInvocationOutputBuilder
impl Default for GetCommandInvocationOutputBuilder
source§fn default() -> GetCommandInvocationOutputBuilder
fn default() -> GetCommandInvocationOutputBuilder
source§impl PartialEq for GetCommandInvocationOutputBuilder
impl PartialEq for GetCommandInvocationOutputBuilder
source§fn eq(&self, other: &GetCommandInvocationOutputBuilder) -> bool
fn eq(&self, other: &GetCommandInvocationOutputBuilder) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for GetCommandInvocationOutputBuilder
Auto Trait Implementations§
impl Freeze for GetCommandInvocationOutputBuilder
impl RefUnwindSafe for GetCommandInvocationOutputBuilder
impl Send for GetCommandInvocationOutputBuilder
impl Sync for GetCommandInvocationOutputBuilder
impl Unpin for GetCommandInvocationOutputBuilder
impl UnwindSafe for GetCommandInvocationOutputBuilder
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more