#[non_exhaustive]pub struct GetCommandInvocationOutput {Show 17 fields
pub command_id: Option<String>,
pub instance_id: Option<String>,
pub comment: Option<String>,
pub document_name: Option<String>,
pub document_version: Option<String>,
pub plugin_name: Option<String>,
pub response_code: i32,
pub execution_start_date_time: Option<String>,
pub execution_elapsed_time: Option<String>,
pub execution_end_date_time: Option<String>,
pub status: Option<CommandInvocationStatus>,
pub status_details: Option<String>,
pub standard_output_content: Option<String>,
pub standard_output_url: Option<String>,
pub standard_error_content: Option<String>,
pub standard_error_url: Option<String>,
pub cloud_watch_output_config: Option<CloudWatchOutputConfig>,
/* private fields */
}Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.command_id: Option<String>The parent command ID of the invocation plugin.
instance_id: 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.
comment: Option<String>The comment text for the command.
document_name: Option<String>The name of the document that was run. For example, AWS-RunShellScript.
document_version: Option<String>The Systems Manager document (SSM document) version used in the request.
plugin_name: Option<String>The name of the plugin, or step name, for which details are reported. For example, aws:RunShellScript is a plugin.
response_code: i32The 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.
execution_start_date_time: 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.
execution_elapsed_time: Option<String>Duration since ExecutionStartDateTime.
execution_end_date_time: 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.
status: Option<CommandInvocationStatus>The status of this invocation plugin. This status can be different than StatusDetails.
status_details: 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
MaxErrorslimit, 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
MaxErrorslimit 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
MaxErrorslimit 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
MaxErrorslimit 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
MaxErrorslimit and subsequent command invocations were canceled by the system. This is a terminal state.
standard_output_content: 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.
standard_output_url: 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.
standard_error_content: 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.
standard_error_url: 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.
cloud_watch_output_config: Option<CloudWatchOutputConfig>Amazon CloudWatch Logs information where Systems Manager sent the command output.
Implementations§
Source§impl GetCommandInvocationOutput
impl GetCommandInvocationOutput
Sourcepub fn command_id(&self) -> Option<&str>
pub fn command_id(&self) -> Option<&str>
The parent command ID of the invocation plugin.
Sourcepub fn instance_id(&self) -> Option<&str>
pub fn instance_id(&self) -> Option<&str>
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 document_name(&self) -> Option<&str>
pub fn document_name(&self) -> Option<&str>
The name of the document that was run. For example, AWS-RunShellScript.
Sourcepub fn document_version(&self) -> Option<&str>
pub fn document_version(&self) -> Option<&str>
The Systems Manager document (SSM document) version used in the request.
Sourcepub fn plugin_name(&self) -> Option<&str>
pub fn plugin_name(&self) -> Option<&str>
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) -> i32
pub fn response_code(&self) -> 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) -> Option<&str>
pub fn execution_start_date_time(&self) -> Option<&str>
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) -> Option<&str>
pub fn execution_elapsed_time(&self) -> Option<&str>
Duration since ExecutionStartDateTime.
Sourcepub fn execution_end_date_time(&self) -> Option<&str>
pub fn execution_end_date_time(&self) -> Option<&str>
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) -> Option<&CommandInvocationStatus>
pub fn status(&self) -> Option<&CommandInvocationStatus>
The status of this invocation plugin. This status can be different than StatusDetails.
Sourcepub fn status_details(&self) -> Option<&str>
pub fn status_details(&self) -> Option<&str>
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
MaxErrorslimit, 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
MaxErrorslimit 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
MaxErrorslimit 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
MaxErrorslimit 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
MaxErrorslimit and subsequent command invocations were canceled by the system. This is a terminal state.
Sourcepub fn standard_output_content(&self) -> Option<&str>
pub fn standard_output_content(&self) -> Option<&str>
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) -> Option<&str>
pub fn standard_output_url(&self) -> Option<&str>
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) -> Option<&str>
pub fn standard_error_content(&self) -> Option<&str>
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) -> Option<&str>
pub fn standard_error_url(&self) -> Option<&str>
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) -> Option<&CloudWatchOutputConfig>
pub fn cloud_watch_output_config(&self) -> Option<&CloudWatchOutputConfig>
Amazon CloudWatch Logs information where Systems Manager sent the command output.
Source§impl GetCommandInvocationOutput
impl GetCommandInvocationOutput
Sourcepub fn builder() -> GetCommandInvocationOutputBuilder
pub fn builder() -> GetCommandInvocationOutputBuilder
Creates a new builder-style object to manufacture GetCommandInvocationOutput.
Trait Implementations§
Source§impl Clone for GetCommandInvocationOutput
impl Clone for GetCommandInvocationOutput
Source§fn clone(&self) -> GetCommandInvocationOutput
fn clone(&self) -> GetCommandInvocationOutput
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for GetCommandInvocationOutput
impl Debug for GetCommandInvocationOutput
Source§impl RequestId for GetCommandInvocationOutput
impl RequestId for GetCommandInvocationOutput
Source§fn request_id(&self) -> Option<&str>
fn request_id(&self) -> Option<&str>
None if the service could not be reached.impl StructuralPartialEq for GetCommandInvocationOutput
Auto Trait Implementations§
impl Freeze for GetCommandInvocationOutput
impl RefUnwindSafe for GetCommandInvocationOutput
impl Send for GetCommandInvocationOutput
impl Sync for GetCommandInvocationOutput
impl Unpin for GetCommandInvocationOutput
impl UnwindSafe for GetCommandInvocationOutput
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> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
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 moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);