Struct aws_sdk_ssm::output::GetCommandInvocationOutput [−][src]
#[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>,
}
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: 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.
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
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. -
Canceled: 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.
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
The parent command ID of the invocation plugin.
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.
The name of the document that was run. For example, AWS-RunShellScript
.
The Systems Manager document (SSM document) version used in the request.
The name of the plugin, or step name, for which details are reported.
For example, aws:RunShellScript
is a plugin.
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.
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.
Duration since ExecutionStartDateTime
.
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.
The status of this invocation plugin. This status can be different than
StatusDetails
.
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. -
Canceled: 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.
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.
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.
The first 8,000 characters written by the plugin to stderr
. If the command
hasn't finished running, then this string is empty.
The URL for the complete text written by the plugin to stderr
. If the command
hasn't finished running, then this string is empty.
Amazon CloudWatch Logs information where Systems Manager sent the command output.
Creates a new builder-style object to manufacture GetCommandInvocationOutput
Trait Implementations
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
This method tests for !=
.
Auto Trait Implementations
impl RefUnwindSafe for GetCommandInvocationOutput
impl Send for GetCommandInvocationOutput
impl Sync for GetCommandInvocationOutput
impl Unpin for GetCommandInvocationOutput
impl UnwindSafe for GetCommandInvocationOutput
Blanket Implementations
Mutably borrows from an owned value. Read more
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more