Struct aws_sdk_ssm::model::CommandPlugin
source · [−]#[non_exhaustive]pub struct CommandPlugin {
pub name: Option<String>,
pub status: Option<CommandPluginStatus>,
pub status_details: Option<String>,
pub response_code: i32,
pub response_start_date_time: Option<DateTime>,
pub response_finish_date_time: Option<DateTime>,
pub output: Option<String>,
pub standard_output_url: Option<String>,
pub standard_error_url: Option<String>,
pub output_s3_region: Option<String>,
pub output_s3_bucket_name: Option<String>,
pub output_s3_key_prefix: Option<String>,
}
Expand description
Describes plugin details.
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.name: Option<String>
The name of the plugin. Must be one of the following: aws:updateAgent
, aws:domainjoin
, aws:applications
, aws:runPowerShellScript
, aws:psmodule
, aws:cloudWatch
, aws:runShellScript
, or aws:updateSSMAgent
.
status: Option<CommandPluginStatus>
The status of this plugin. You can run a document with multiple plugins.
status_details: Option<String>
A detailed status of the plugin execution. 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.
-
Success: The execution of the command or plugin was successfully completed. 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: Command execution started on the managed node, but the execution wasn't complete before the execution timeout expired. Execution timeouts count against the
MaxErrors
limit of the parent command. This is a terminal state. -
Failed: The command wasn't successful 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 managed node might not exist, or it might not be responding. Undeliverable invocations don't count against the parent command's MaxErrors limit, and they 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.
response_code: i32
A numeric response code generated after running the plugin.
response_start_date_time: Option<DateTime>
The time the plugin started running.
response_finish_date_time: Option<DateTime>
The time the plugin stopped running. Could stop prematurely if, for example, a cancel command was sent.
output: Option<String>
Output of the plugin execution.
standard_output_url: Option<String>
The URL for the complete text written by the plugin to stdout in Amazon S3. If the S3 bucket for the command wasn't specified, then this string is empty.
standard_error_url: Option<String>
The URL for the complete text written by the plugin to stderr. If execution isn't yet complete, then this string is empty.
output_s3_region: Option<String>
(Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Amazon Web Services Systems Manager automatically determines the S3 bucket region.
output_s3_bucket_name: Option<String>
The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command. For example, in the following response:
doc-example-bucket/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-02573cafcfEXAMPLE/awsrunShellScript
doc-example-bucket
is the name of the S3 bucket;
ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix
is the name of the S3 prefix;
i-02573cafcfEXAMPLE
is the managed node ID;
awsrunShellScript
is the name of the plugin.
output_s3_key_prefix: Option<String>
The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command. For example, in the following response:
doc-example-bucket/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-02573cafcfEXAMPLE/awsrunShellScript
doc-example-bucket
is the name of the S3 bucket;
ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix
is the name of the S3 prefix;
i-02573cafcfEXAMPLE
is the managed node ID;
awsrunShellScript
is the name of the plugin.
Implementations
sourceimpl CommandPlugin
impl CommandPlugin
sourcepub fn name(&self) -> Option<&str>
pub fn name(&self) -> Option<&str>
The name of the plugin. Must be one of the following: aws:updateAgent
, aws:domainjoin
, aws:applications
, aws:runPowerShellScript
, aws:psmodule
, aws:cloudWatch
, aws:runShellScript
, or aws:updateSSMAgent
.
sourcepub fn status(&self) -> Option<&CommandPluginStatus>
pub fn status(&self) -> Option<&CommandPluginStatus>
The status of this plugin. You can run a document with multiple plugins.
sourcepub fn status_details(&self) -> Option<&str>
pub fn status_details(&self) -> Option<&str>
A detailed status of the plugin execution. 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.
-
Success: The execution of the command or plugin was successfully completed. 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: Command execution started on the managed node, but the execution wasn't complete before the execution timeout expired. Execution timeouts count against the
MaxErrors
limit of the parent command. This is a terminal state. -
Failed: The command wasn't successful 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 managed node might not exist, or it might not be responding. Undeliverable invocations don't count against the parent command's MaxErrors limit, and they 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 response_code(&self) -> i32
pub fn response_code(&self) -> i32
A numeric response code generated after running the plugin.
sourcepub fn response_start_date_time(&self) -> Option<&DateTime>
pub fn response_start_date_time(&self) -> Option<&DateTime>
The time the plugin started running.
sourcepub fn response_finish_date_time(&self) -> Option<&DateTime>
pub fn response_finish_date_time(&self) -> Option<&DateTime>
The time the plugin stopped running. Could stop prematurely if, for example, a cancel command was sent.
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 S3. If the S3 bucket for the command wasn't specified, 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 execution isn't yet complete, then this string is empty.
sourcepub fn output_s3_region(&self) -> Option<&str>
pub fn output_s3_region(&self) -> Option<&str>
(Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Amazon Web Services Systems Manager automatically determines the S3 bucket region.
sourcepub fn output_s3_bucket_name(&self) -> Option<&str>
pub fn output_s3_bucket_name(&self) -> Option<&str>
The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command. For example, in the following response:
doc-example-bucket/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-02573cafcfEXAMPLE/awsrunShellScript
doc-example-bucket
is the name of the S3 bucket;
ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix
is the name of the S3 prefix;
i-02573cafcfEXAMPLE
is the managed node ID;
awsrunShellScript
is the name of the plugin.
sourcepub fn output_s3_key_prefix(&self) -> Option<&str>
pub fn output_s3_key_prefix(&self) -> Option<&str>
The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command. For example, in the following response:
doc-example-bucket/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-02573cafcfEXAMPLE/awsrunShellScript
doc-example-bucket
is the name of the S3 bucket;
ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix
is the name of the S3 prefix;
i-02573cafcfEXAMPLE
is the managed node ID;
awsrunShellScript
is the name of the plugin.
sourceimpl CommandPlugin
impl CommandPlugin
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture CommandPlugin
Trait Implementations
sourceimpl Clone for CommandPlugin
impl Clone for CommandPlugin
sourcefn clone(&self) -> CommandPlugin
fn clone(&self) -> CommandPlugin
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for CommandPlugin
impl Debug for CommandPlugin
sourceimpl PartialEq<CommandPlugin> for CommandPlugin
impl PartialEq<CommandPlugin> for CommandPlugin
sourcefn eq(&self, other: &CommandPlugin) -> bool
fn eq(&self, other: &CommandPlugin) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &CommandPlugin) -> bool
fn ne(&self, other: &CommandPlugin) -> bool
This method tests for !=
.
impl StructuralPartialEq for CommandPlugin
Auto Trait Implementations
impl RefUnwindSafe for CommandPlugin
impl Send for CommandPlugin
impl Sync for CommandPlugin
impl Unpin for CommandPlugin
impl UnwindSafe for CommandPlugin
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more