Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListTasks

Returns a list of tasks that can be filtered by state.

Request Syntax


GET /tasks?maxResults=maxResults&nextToken=nextToken&state=state HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

maxResults

The maximum number of tasks per page.

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

nextToken

A pagination token to continue to the next page of tasks.

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: ^[a-zA-Z0-9+/=]*$

state

A structure used to filter the list of tasks.

Valid Values: IN_PROGRESS | CANCELED | COMPLETED

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "tasks": [ 
      { 
         "state": "string",
         "tags": { 
            "string" : "string" 
         },
         "taskArn": "string",
         "taskId": "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

A pagination token to continue to the next page of tasks.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: ^[a-zA-Z0-9+/=]*$

tasks

A list of task structures containing details about each task.

Type: Array of TaskSummary objects

Errors

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

AccessDeniedException

You don't have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

An unexpected error occurred while processing the request.

HTTP Status Code: 500

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400