Retrieves information about a specific task running on a specific target.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
get-maintenance-window-execution-task-invocation
--window-execution-id <value>
--task-id <value>
--invocation-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
--window-execution-id
(string)
The ID of the maintenance window execution for which the task is a part.
--task-id
(string)
The ID of the specific task in the maintenance window task that should be retrieved.
--invocation-id
(string)
The invocation ID to retrieve.
--cli-input-json
| --cli-input-yaml
(string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml
.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. Similarly, if provided yaml-input
it will print a sample input YAML that can be used with --cli-input-yaml
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
To get information about a maintenance window task invocation
The following get-maintenance-window-execution-task-invocation
example lists information about the specified task invocation that is part of the specified maintenance window execution.
aws ssm get-maintenance-window-execution-task-invocation \
--window-execution-id "bc494bfa-e63b-49f6-8ad1-aa9f2EXAMPLE" \
--task-id "96f2ad59-97e3-461d-a63d-40c8aEXAMPLE" \
--invocation-id "a5273e2c-d2c6-4880-b3e1-5e550EXAMPLE"
Output:
{
"Status": "SUCCESS",
"Parameters": "{\"comment\":\"\",\"documentName\":\"AWS-RunPowerShellScript\",\"instanceIds\":[\"i-1234567890EXAMPLE\"],\"maxConcurrency\":\"1\",\"maxErrors\":\"1\",\"parameters\":{\"executionTimeout\":[\"3600\"],\"workingDirectory\":[\"\"],\"commands\":[\"echo Hello\"]},\"timeoutSeconds\":600}",
"ExecutionId": "03b6baa0-5460-4e15-83f2-ea685EXAMPLE",
"InvocationId": "a5273e2c-d2c6-4880-b3e1-5e550EXAMPLE",
"StartTime": 1549998326.421,
"TaskType": "RUN_COMMAND",
"EndTime": 1550001931.784,
"WindowExecutionId": "bc494bfa-e63b-49f6-8ad1-aa9f2EXAMPLE",
"StatusDetails": "Failed",
"TaskExecutionId": "96f2ad59-97e3-461d-a63d-40c8aEXAMPLE"
}
For more information, see View Information About Tasks and Task Executions (AWS CLI) in the AWS Systems Manager User Guide.
WindowExecutionId -> (string)
The maintenance window execution ID.
TaskExecutionId -> (string)
The task execution ID.
InvocationId -> (string)
The invocation ID.
ExecutionId -> (string)
The execution ID.
TaskType -> (string)
Retrieves the task type for a maintenance window.
Parameters -> (string)
The parameters used at the time that the task ran.
Status -> (string)
The task status for an invocation.
StatusDetails -> (string)
The details explaining the status. Details are only available for certain status values.
StartTime -> (timestamp)
The time that the task started running on the target.
EndTime -> (timestamp)
The time that the task finished running on the target.
OwnerInformation -> (string)
User-provided value to be included in any Amazon CloudWatch Events or Amazon EventBridge events raised while running tasks for these targets in this maintenance window.
WindowTargetId -> (string)
The maintenance window target ID.