Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
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.
Synopsis
- data GetCommandInvocation = GetCommandInvocation' {
- pluginName :: Maybe Text
- commandId :: Text
- instanceId :: Text
- newGetCommandInvocation :: Text -> Text -> GetCommandInvocation
- getCommandInvocation_pluginName :: Lens' GetCommandInvocation (Maybe Text)
- getCommandInvocation_commandId :: Lens' GetCommandInvocation Text
- getCommandInvocation_instanceId :: Lens' GetCommandInvocation Text
- data GetCommandInvocationResponse = GetCommandInvocationResponse' {
- cloudWatchOutputConfig :: Maybe CloudWatchOutputConfig
- commandId :: Maybe Text
- comment :: Maybe Text
- documentName :: Maybe Text
- documentVersion :: Maybe Text
- executionElapsedTime :: Maybe Text
- executionEndDateTime :: Maybe Text
- executionStartDateTime :: Maybe Text
- instanceId :: Maybe Text
- pluginName :: Maybe Text
- responseCode :: Maybe Int
- standardErrorContent :: Maybe Text
- standardErrorUrl :: Maybe Text
- standardOutputContent :: Maybe Text
- standardOutputUrl :: Maybe Text
- status :: Maybe CommandInvocationStatus
- statusDetails :: Maybe Text
- httpStatus :: Int
- newGetCommandInvocationResponse :: Int -> GetCommandInvocationResponse
- getCommandInvocationResponse_cloudWatchOutputConfig :: Lens' GetCommandInvocationResponse (Maybe CloudWatchOutputConfig)
- getCommandInvocationResponse_commandId :: Lens' GetCommandInvocationResponse (Maybe Text)
- getCommandInvocationResponse_comment :: Lens' GetCommandInvocationResponse (Maybe Text)
- getCommandInvocationResponse_documentName :: Lens' GetCommandInvocationResponse (Maybe Text)
- getCommandInvocationResponse_documentVersion :: Lens' GetCommandInvocationResponse (Maybe Text)
- getCommandInvocationResponse_executionElapsedTime :: Lens' GetCommandInvocationResponse (Maybe Text)
- getCommandInvocationResponse_executionEndDateTime :: Lens' GetCommandInvocationResponse (Maybe Text)
- getCommandInvocationResponse_executionStartDateTime :: Lens' GetCommandInvocationResponse (Maybe Text)
- getCommandInvocationResponse_instanceId :: Lens' GetCommandInvocationResponse (Maybe Text)
- getCommandInvocationResponse_pluginName :: Lens' GetCommandInvocationResponse (Maybe Text)
- getCommandInvocationResponse_responseCode :: Lens' GetCommandInvocationResponse (Maybe Int)
- getCommandInvocationResponse_standardErrorContent :: Lens' GetCommandInvocationResponse (Maybe Text)
- getCommandInvocationResponse_standardErrorUrl :: Lens' GetCommandInvocationResponse (Maybe Text)
- getCommandInvocationResponse_standardOutputContent :: Lens' GetCommandInvocationResponse (Maybe Text)
- getCommandInvocationResponse_standardOutputUrl :: Lens' GetCommandInvocationResponse (Maybe Text)
- getCommandInvocationResponse_status :: Lens' GetCommandInvocationResponse (Maybe CommandInvocationStatus)
- getCommandInvocationResponse_statusDetails :: Lens' GetCommandInvocationResponse (Maybe Text)
- getCommandInvocationResponse_httpStatus :: Lens' GetCommandInvocationResponse Int
Creating a Request
data GetCommandInvocation Source #
See: newGetCommandInvocation
smart constructor.
GetCommandInvocation' | |
|
Instances
newGetCommandInvocation Source #
Create a value of GetCommandInvocation
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetCommandInvocation
, getCommandInvocation_pluginName
- The name of the step for which you want detailed results. If the
document contains only one step, you can omit the name and details for
that step. If the document contains more than one step, you must specify
the name of the step for which you want to view details. Be sure to
specify the name of the step, not the name of a plugin like
aws:RunShellScript
.
To find the PluginName
, check the document content and find the name
of the step you want details for. Alternatively, use
ListCommandInvocations with the CommandId
and Details
parameters.
The PluginName
is the Name
attribute of the CommandPlugin
object
in the CommandPlugins
list.
GetCommandInvocation
, getCommandInvocation_commandId
- (Required) The parent command ID of the invocation plugin.
GetCommandInvocation
, getCommandInvocation_instanceId
- (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.
Request Lenses
getCommandInvocation_pluginName :: Lens' GetCommandInvocation (Maybe Text) Source #
The name of the step for which you want detailed results. If the
document contains only one step, you can omit the name and details for
that step. If the document contains more than one step, you must specify
the name of the step for which you want to view details. Be sure to
specify the name of the step, not the name of a plugin like
aws:RunShellScript
.
To find the PluginName
, check the document content and find the name
of the step you want details for. Alternatively, use
ListCommandInvocations with the CommandId
and Details
parameters.
The PluginName
is the Name
attribute of the CommandPlugin
object
in the CommandPlugins
list.
getCommandInvocation_commandId :: Lens' GetCommandInvocation Text Source #
(Required) The parent command ID of the invocation plugin.
getCommandInvocation_instanceId :: Lens' GetCommandInvocation Text Source #
(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.
Destructuring the Response
data GetCommandInvocationResponse Source #
See: newGetCommandInvocationResponse
smart constructor.
GetCommandInvocationResponse' | |
|
Instances
newGetCommandInvocationResponse Source #
Create a value of GetCommandInvocationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetCommandInvocationResponse
, getCommandInvocationResponse_cloudWatchOutputConfig
- Amazon CloudWatch Logs information where Systems Manager sent the
command output.
GetCommandInvocation
, getCommandInvocationResponse_commandId
- The parent command ID of the invocation plugin.
GetCommandInvocationResponse
, getCommandInvocationResponse_comment
- The comment text for the command.
GetCommandInvocationResponse
, getCommandInvocationResponse_documentName
- The name of the document that was run. For example,
AWS-RunShellScript
.
GetCommandInvocationResponse
, getCommandInvocationResponse_documentVersion
- The Systems Manager document (SSM document) version used in the request.
$sel:executionElapsedTime:GetCommandInvocationResponse'
, getCommandInvocationResponse_executionElapsedTime
- Duration since ExecutionStartDateTime
.
$sel:executionEndDateTime:GetCommandInvocationResponse'
, getCommandInvocationResponse_executionEndDateTime
- 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.
$sel:executionStartDateTime:GetCommandInvocationResponse'
, getCommandInvocationResponse_executionStartDateTime
- 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.
GetCommandInvocation
, getCommandInvocationResponse_instanceId
- 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.
GetCommandInvocation
, getCommandInvocationResponse_pluginName
- The name of the plugin, or step name, for which details are reported.
For example, aws:RunShellScript
is a plugin.
GetCommandInvocationResponse
, getCommandInvocationResponse_responseCode
- 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.
$sel:standardErrorContent:GetCommandInvocationResponse'
, getCommandInvocationResponse_standardErrorContent
- The first 8,000 characters written by the plugin to stderr
. If the
command hasn't finished running, then this string is empty.
GetCommandInvocationResponse
, getCommandInvocationResponse_standardErrorUrl
- The URL for the complete text written by the plugin to stderr
. If the
command hasn't finished running, then this string is empty.
$sel:standardOutputContent:GetCommandInvocationResponse'
, getCommandInvocationResponse_standardOutputContent
- 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.
GetCommandInvocationResponse
, getCommandInvocationResponse_standardOutputUrl
- 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.
GetCommandInvocationResponse
, getCommandInvocationResponse_status
- The status of this invocation plugin. This status can be different than
StatusDetails
.
GetCommandInvocationResponse
, getCommandInvocationResponse_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. - 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.
$sel:httpStatus:GetCommandInvocationResponse'
, getCommandInvocationResponse_httpStatus
- The response's http status code.
Response Lenses
getCommandInvocationResponse_cloudWatchOutputConfig :: Lens' GetCommandInvocationResponse (Maybe CloudWatchOutputConfig) Source #
Amazon CloudWatch Logs information where Systems Manager sent the command output.
getCommandInvocationResponse_commandId :: Lens' GetCommandInvocationResponse (Maybe Text) Source #
The parent command ID of the invocation plugin.
getCommandInvocationResponse_comment :: Lens' GetCommandInvocationResponse (Maybe Text) Source #
The comment text for the command.
getCommandInvocationResponse_documentName :: Lens' GetCommandInvocationResponse (Maybe Text) Source #
The name of the document that was run. For example,
AWS-RunShellScript
.
getCommandInvocationResponse_documentVersion :: Lens' GetCommandInvocationResponse (Maybe Text) Source #
The Systems Manager document (SSM document) version used in the request.
getCommandInvocationResponse_executionElapsedTime :: Lens' GetCommandInvocationResponse (Maybe Text) Source #
Duration since ExecutionStartDateTime
.
getCommandInvocationResponse_executionEndDateTime :: Lens' GetCommandInvocationResponse (Maybe Text) Source #
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.
getCommandInvocationResponse_executionStartDateTime :: Lens' GetCommandInvocationResponse (Maybe Text) Source #
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.
getCommandInvocationResponse_instanceId :: Lens' GetCommandInvocationResponse (Maybe Text) Source #
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.
getCommandInvocationResponse_pluginName :: Lens' GetCommandInvocationResponse (Maybe Text) Source #
The name of the plugin, or step name, for which details are reported.
For example, aws:RunShellScript
is a plugin.
getCommandInvocationResponse_responseCode :: Lens' GetCommandInvocationResponse (Maybe Int) Source #
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.
getCommandInvocationResponse_standardErrorContent :: Lens' GetCommandInvocationResponse (Maybe Text) Source #
The first 8,000 characters written by the plugin to stderr
. If the
command hasn't finished running, then this string is empty.
getCommandInvocationResponse_standardErrorUrl :: Lens' GetCommandInvocationResponse (Maybe Text) Source #
The URL for the complete text written by the plugin to stderr
. If the
command hasn't finished running, then this string is empty.
getCommandInvocationResponse_standardOutputContent :: Lens' GetCommandInvocationResponse (Maybe Text) Source #
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.
getCommandInvocationResponse_standardOutputUrl :: Lens' GetCommandInvocationResponse (Maybe Text) Source #
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.
getCommandInvocationResponse_status :: Lens' GetCommandInvocationResponse (Maybe CommandInvocationStatus) Source #
The status of this invocation plugin. This status can be different than
StatusDetails
.
getCommandInvocationResponse_statusDetails :: Lens' GetCommandInvocationResponse (Maybe Text) Source #
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.
getCommandInvocationResponse_httpStatus :: Lens' GetCommandInvocationResponse Int Source #
The response's http status code.