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 |
Synopsis
- data CommandInvocation = CommandInvocation' {
- cloudWatchOutputConfig :: Maybe CloudWatchOutputConfig
- commandId :: Maybe Text
- commandPlugins :: Maybe [CommandPlugin]
- comment :: Maybe Text
- documentName :: Maybe Text
- documentVersion :: Maybe Text
- instanceId :: Maybe Text
- instanceName :: Maybe Text
- notificationConfig :: Maybe NotificationConfig
- requestedDateTime :: Maybe POSIX
- serviceRole :: Maybe Text
- standardErrorUrl :: Maybe Text
- standardOutputUrl :: Maybe Text
- status :: Maybe CommandInvocationStatus
- statusDetails :: Maybe Text
- traceOutput :: Maybe Text
- newCommandInvocation :: CommandInvocation
- commandInvocation_cloudWatchOutputConfig :: Lens' CommandInvocation (Maybe CloudWatchOutputConfig)
- commandInvocation_commandId :: Lens' CommandInvocation (Maybe Text)
- commandInvocation_commandPlugins :: Lens' CommandInvocation (Maybe [CommandPlugin])
- commandInvocation_comment :: Lens' CommandInvocation (Maybe Text)
- commandInvocation_documentName :: Lens' CommandInvocation (Maybe Text)
- commandInvocation_documentVersion :: Lens' CommandInvocation (Maybe Text)
- commandInvocation_instanceId :: Lens' CommandInvocation (Maybe Text)
- commandInvocation_instanceName :: Lens' CommandInvocation (Maybe Text)
- commandInvocation_notificationConfig :: Lens' CommandInvocation (Maybe NotificationConfig)
- commandInvocation_requestedDateTime :: Lens' CommandInvocation (Maybe UTCTime)
- commandInvocation_serviceRole :: Lens' CommandInvocation (Maybe Text)
- commandInvocation_standardErrorUrl :: Lens' CommandInvocation (Maybe Text)
- commandInvocation_standardOutputUrl :: Lens' CommandInvocation (Maybe Text)
- commandInvocation_status :: Lens' CommandInvocation (Maybe CommandInvocationStatus)
- commandInvocation_statusDetails :: Lens' CommandInvocation (Maybe Text)
- commandInvocation_traceOutput :: Lens' CommandInvocation (Maybe Text)
Documentation
data CommandInvocation Source #
An invocation is a copy of a command sent to a specific managed node. A
command can apply to one or more managed nodes. A command invocation
applies to one managed node. For example, if a user runs SendCommand
against three managed nodes, then a command invocation is created for
each requested managed node ID. A command invocation returns status and
detail information about a command you ran.
See: newCommandInvocation
smart constructor.
CommandInvocation' | |
|
Instances
newCommandInvocation :: CommandInvocation Source #
Create a value of CommandInvocation
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:
$sel:cloudWatchOutputConfig:CommandInvocation'
, commandInvocation_cloudWatchOutputConfig
- Amazon CloudWatch Logs information where you want Amazon Web Services
Systems Manager to send the command output.
$sel:commandId:CommandInvocation'
, commandInvocation_commandId
- The command against which this invocation was requested.
$sel:commandPlugins:CommandInvocation'
, commandInvocation_commandPlugins
- Plugins processed by the command.
$sel:comment:CommandInvocation'
, commandInvocation_comment
- User-specified information about the command, such as a brief
description of what the command should do.
$sel:documentName:CommandInvocation'
, commandInvocation_documentName
- The document name that was requested for execution.
$sel:documentVersion:CommandInvocation'
, commandInvocation_documentVersion
- The Systems Manager document (SSM document) version.
$sel:instanceId:CommandInvocation'
, commandInvocation_instanceId
- The managed node ID in which this invocation was requested.
$sel:instanceName:CommandInvocation'
, commandInvocation_instanceName
- The fully qualified host name of the managed node.
$sel:notificationConfig:CommandInvocation'
, commandInvocation_notificationConfig
- Configurations for sending notifications about command status changes on
a per managed node basis.
$sel:requestedDateTime:CommandInvocation'
, commandInvocation_requestedDateTime
- The time and date the request was sent to this managed node.
$sel:serviceRole:CommandInvocation'
, commandInvocation_serviceRole
- The Identity and Access Management (IAM) service role that Run Command,
a capability of Amazon Web Services Systems Manager, uses to act on your
behalf when sending notifications about command status changes on a per
managed node basis.
CommandInvocation
, commandInvocation_standardErrorUrl
- The URL to the plugin's StdErr file in Amazon Simple Storage Service
(Amazon S3), if the S3 bucket was defined for the parent command. For an
invocation, StandardErrorUrl
is populated if there is just one plugin
defined for the command, and the S3 bucket was defined for the command.
CommandInvocation
, commandInvocation_standardOutputUrl
- The URL to the plugin's StdOut file in Amazon Simple Storage Service
(Amazon S3), if the S3 bucket was defined for the parent command. For an
invocation, StandardOutputUrl
is populated if there is just one plugin
defined for the command, and the S3 bucket was defined for the command.
CommandInvocation
, commandInvocation_status
- Whether or not the invocation succeeded, failed, or is pending.
CommandInvocation
, commandInvocation_statusDetails
- A detailed status of the command execution for each invocation (each
managed node targeted by the command). 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 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.
- Delayed: The system attempted to send the command to the managed node but wasn't successful. The system retries again.
$sel:traceOutput:CommandInvocation'
, commandInvocation_traceOutput
- Gets the trace output sent by the agent.
commandInvocation_cloudWatchOutputConfig :: Lens' CommandInvocation (Maybe CloudWatchOutputConfig) Source #
Amazon CloudWatch Logs information where you want Amazon Web Services Systems Manager to send the command output.
commandInvocation_commandId :: Lens' CommandInvocation (Maybe Text) Source #
The command against which this invocation was requested.
commandInvocation_commandPlugins :: Lens' CommandInvocation (Maybe [CommandPlugin]) Source #
Plugins processed by the command.
commandInvocation_comment :: Lens' CommandInvocation (Maybe Text) Source #
User-specified information about the command, such as a brief description of what the command should do.
commandInvocation_documentName :: Lens' CommandInvocation (Maybe Text) Source #
The document name that was requested for execution.
commandInvocation_documentVersion :: Lens' CommandInvocation (Maybe Text) Source #
The Systems Manager document (SSM document) version.
commandInvocation_instanceId :: Lens' CommandInvocation (Maybe Text) Source #
The managed node ID in which this invocation was requested.
commandInvocation_instanceName :: Lens' CommandInvocation (Maybe Text) Source #
The fully qualified host name of the managed node.
commandInvocation_notificationConfig :: Lens' CommandInvocation (Maybe NotificationConfig) Source #
Configurations for sending notifications about command status changes on a per managed node basis.
commandInvocation_requestedDateTime :: Lens' CommandInvocation (Maybe UTCTime) Source #
The time and date the request was sent to this managed node.
commandInvocation_serviceRole :: Lens' CommandInvocation (Maybe Text) Source #
The Identity and Access Management (IAM) service role that Run Command, a capability of Amazon Web Services Systems Manager, uses to act on your behalf when sending notifications about command status changes on a per managed node basis.
commandInvocation_standardErrorUrl :: Lens' CommandInvocation (Maybe Text) Source #
The URL to the plugin's StdErr file in Amazon Simple Storage Service
(Amazon S3), if the S3 bucket was defined for the parent command. For an
invocation, StandardErrorUrl
is populated if there is just one plugin
defined for the command, and the S3 bucket was defined for the command.
commandInvocation_standardOutputUrl :: Lens' CommandInvocation (Maybe Text) Source #
The URL to the plugin's StdOut file in Amazon Simple Storage Service
(Amazon S3), if the S3 bucket was defined for the parent command. For an
invocation, StandardOutputUrl
is populated if there is just one plugin
defined for the command, and the S3 bucket was defined for the command.
commandInvocation_status :: Lens' CommandInvocation (Maybe CommandInvocationStatus) Source #
Whether or not the invocation succeeded, failed, or is pending.
commandInvocation_statusDetails :: Lens' CommandInvocation (Maybe Text) Source #
A detailed status of the command execution for each invocation (each managed node targeted by the command). 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 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.
- Delayed: The system attempted to send the command to the managed node but wasn't successful. The system retries again.
commandInvocation_traceOutput :: Lens' CommandInvocation (Maybe Text) Source #
Gets the trace output sent by the agent.