/ - Amazon Simple Systems Manager (SSM)

Lists the tasks in a maintenance window.

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

Request

Query Params

MaxResults

string

optional

Pagination limit

NextToken

string

optional

Pagination token

Header Params

X-Amz-Target

string

required

Body Params application/json

WindowId

string

required

The ID of the maintenance window whose tasks should be retrieved.

>= 20 characters<= 20 characters

Match pattern:

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

Filters

array [object]

optional

Optional filters used to narrow down the scope of the returned tasks. The supported filter keys are WindowTaskId, TaskArn, Priority, and TaskType.

>= 0 items<= 5 items

MaxResults

integer

optional

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

>= 10<= 100

NextToken

string

optional

The token for the next set of items to return. (You received this token from a previous call.)

Examples

Responses

🟢200Success

application/json

Body

Tasks

array[object (MaintenanceWindowTask) {15}]

optional

Information about the tasks in the maintenance window.

WindowId

string

optional

The ID of the maintenance window where the task is registered.

>= 20 characters<= 20 characters

Match pattern:

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

WindowTaskId

string

optional

The 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}$

TaskArn

string

optional

The resource that the task uses during execution. For RUN_COMMAND and AUTOMATION task types, TaskArn is the Amazon Web Services Systems Manager (SSM document) name or ARN. For LAMBDA tasks, it's the function name or ARN. For STEP_FUNCTIONS tasks, it's the state machine ARN.

>= 1 characters<= 1600 characters

Type

enum<string>

optional

The type of task.

Allowed values:

RUN_COMMANDAUTOMATIONSTEP_FUNCTIONSLAMBDA

Targets

array [object]

optional

The targets (either managed nodes or tags). Managed nodes are specified using Key=instanceids,Values=<instanceid1>,<instanceid2>. Tags are specified using Key=<tag name>,Values=<tag value>.

>= 0 items<= 5 items

TaskParameters

object

optional

The parameters that should be passed to the task when it is run.

Priority

integer

optional

The priority of the task in the maintenance window. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.

>= 0

LoggingInfo

object

optional

Information about an S3 bucket to write task-level logs to.

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.

MaxConcurrency

string

optional

The maximum number of targets this task can be run for, 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 this task stops being scheduled.

>= 1 characters<= 7 characters

Match pattern:

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

Name

string

optional

The task name.

>= 3 characters<= 128 characters

Match pattern:

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

Description

string <password>

optional

A description of the task.

>= 1 characters<= 128 characters

CutoffBehavior

enum<string>

optional

The specification for whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.

Allowed values:

CONTINUE_TASKCANCEL_TASK

AlarmConfiguration

object

optional

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

NextToken

string

optional

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

🟠480DoesNotExistException

🟠481InternalServerError