/ - Amazon Simple Systems Manager (SSM)

Retrieves the details of a maintenance window task.

To retrieve a list of tasks in a maintenance window, instead use the DescribeMaintenanceWindowTasks command.

curl --location -g --request POST 'http://ssm.{region}.amazonaws.com/' \ --header 'X-Amz-Target;' \ --header 'Content-Type: application/json' \ --data-raw '{ "WindowId": "string", "WindowTaskId": "string" }'

{ "WindowId": "string", "WindowTaskId": "string", "Targets": [], "TaskArn": "string", "ServiceRoleArn": "string", "TaskType": "RUN_COMMAND", "TaskParameters": { "property1": { "Values": [] } }, "TaskInvocationParameters": { "RunCommand": {}, "Automation": { "DocumentVersion": "string", "Parameters": { "property1": [ "string" ], "property2": [ "string" ] } }, "StepFunctions": {}, "Lambda": {} }, "Priority": 0, "MaxConcurrency": "string", "MaxErrors": "string", "LoggingInfo": {}, "Name": "string", "Description": "string", "CutoffBehavior": "CONTINUE_TASK", "AlarmConfiguration": { "IgnorePollAlarmFailure": true, "Alarms": [] } }

Request

Header Params

X-Amz-Target

string

required

Body Params application/json

WindowId

string

required

The maintenance window ID that includes the task to retrieve.

>= 20 characters<= 20 characters

Match pattern:

^mw-[0-9a-f]{17}$

WindowTaskId

string

required

The maintenance window task ID to retrieve.

>= 36 characters<= 36 characters

Match pattern:

^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$

Examples

Responses

🟢200Success

application/json

Body

WindowId

string

optional

The retrieved maintenance window ID.

>= 20 characters<= 20 characters

Match pattern:

^mw-[0-9a-f]{17}$

WindowTaskId

string

optional

The retrieved maintenance window task ID.

>= 36 characters<= 36 characters

Match pattern:

^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$

Targets

array [object]

optional

The targets where the task should run.

>= 0 items<= 5 items

TaskArn

string

optional

The resource that the task used during execution. For RUN_COMMAND and AUTOMATION task types, the value of TaskArn is the SSM document name/ARN. For LAMBDA tasks, the value is the function name/ARN. For STEP_FUNCTIONS tasks, the value is the state machine ARN.

>= 1 characters<= 1600 characters

ServiceRoleArn

string

optional

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.

TaskType

enum<string>

optional

The type of task to run.

Allowed values:

RUN_COMMANDAUTOMATIONSTEP_FUNCTIONSLAMBDA

TaskParameters

object

optional

The parameters to pass to the task when it runs.

TaskInvocationParameters

object

optional

The parameters to pass to the task when it runs.

RunCommand

object

optional

The parameters for a RUN_COMMAND task type.

Automation

object

optional

The parameters for an AUTOMATION task type.

StepFunctions

object

optional

The parameters for a STEP_FUNCTIONS task type.

Lambda

object

optional

The parameters for a LAMBDA task type.

Priority

integer

optional

The priority of the task when it runs. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.

>= 0

MaxConcurrency

string

optional

The maximum number of targets allowed to run this task in parallel.

>= 1 characters<= 7 characters

Match pattern:

^([1-9][0-9]*|[1-9][0-9]%|[1-9]%|100%)$

MaxErrors

string

optional

The maximum number of errors allowed before the task stops being scheduled.

>= 1 characters<= 7 characters

Match pattern:

^([1-9][0-9]*|[0]|[1-9][0-9]%|[0-9]%|100%)$

LoggingInfo

object

optional

The location in Amazon Simple Storage Service (Amazon S3) where the task results are logged.

Name

string

optional

The retrieved task name.

>= 3 characters<= 128 characters

Match pattern:

^[a-zA-Z0-9_\-.]{3,128}$

Description

string <password>

optional

The retrieved task description.

>= 1 characters<= 128 characters

CutoffBehavior

enum<string>

optional

The action to take on tasks when the maintenance window cutoff time is reached. CONTINUE_TASK means that tasks continue to run. For Automation, Lambda, Step Functions tasks, CANCEL_TASK means that currently running task invocations continue, but no new task invocations are started. For Run Command tasks, CANCEL_TASK means the system attempts to stop the task by sending a CancelCommand operation.

Allowed values:

CONTINUE_TASKCANCEL_TASK

AlarmConfiguration

object

optional

The details for the CloudWatch alarm you applied to your maintenance window task.

IgnorePollAlarmFailure

boolean

optional

When this value is true, your automation or command continues to run in cases where we can’t retrieve alarm status information from CloudWatch. In cases where we successfully retrieve an alarm status of OK or INSUFFICIENT_DATA, the automation or command continues to run, regardless of this value. Default is false.

Alarms

array[object (Alarm) {1}]

required

The name of the CloudWatch alarm specified in the configuration.

>= 1 items<= 1 items

🟠480DoesNotExistException

🟠481InternalServerError