Menu
AWS Systems Manager
API Reference (API Version 2014-11-06)

DescribeMaintenanceWindowTasks

Lists the tasks in a Maintenance Window.

Request Syntax

{
   "Filters": [ 
      { 
         "Key": "string",
         "Values": [ "string" ]
      }
   ],
   "MaxResults": number,
   "NextToken": "string",
   "WindowId": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Filters

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

Type: Array of MaintenanceWindowFilter objects

Array Members: Minimum number of 0 items. Maximum number of 5 items.

Required: No

MaxResults

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.

Type: Integer

Valid Range: Minimum value of 10. Maximum value of 100.

Required: No

NextToken

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

Type: String

Required: No

WindowId

The ID of the Maintenance Window whose tasks should be retrieved.

Type: String

Length Constraints: Fixed length of 20.

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

Required: Yes

Response Syntax

{
   "NextToken": "string",
   "Tasks": [ 
      { 
         "Description": "string",
         "LoggingInfo": { 
            "S3BucketName": "string",
            "S3KeyPrefix": "string",
            "S3Region": "string"
         },
         "MaxConcurrency": "string",
         "MaxErrors": "string",
         "Name": "string",
         "Priority": number,
         "ServiceRoleArn": "string",
         "Targets": [ 
            { 
               "Key": "string",
               "Values": [ "string" ]
            }
         ],
         "TaskArn": "string",
         "TaskParameters": { 
            "string" : { 
               "Values": [ "string" ]
            }
         },
         "Type": "string",
         "WindowId": "string",
         "WindowTaskId": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken

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

Type: String

Tasks

Information about the tasks in the Maintenance Window.

Type: Array of MaintenanceWindowTask objects

Errors

For information about the errors that are common to all actions, see Common Errors.

DoesNotExistException

Error returned when the ID specified for a resource (e.g. a Maintenance Window) doesn't exist.

HTTP Status Code: 400

InternalServerError

An error occurred on the server side.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: