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

ListExecutions

Returns the status of tasks for one or more target devices.

Request Syntax


GET /executions?maxResults=maxResults&nextToken=nextToken&state=state&taskId=taskId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

maxResults

The maximum number of tasks to list 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 tasks by their current state.

taskId

The ID of the task.

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

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "executions": [ 
      { 
         "executionId": "string",
         "managedDeviceId": "string",
         "state": "string",
         "taskId": "string"
      }
   ],
   "nextToken": "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.

executions

A list of executions. Each execution contains the task ID, the device that the task is executing on, the execution ID, and the status of the execution.

Type: Array of ExecutionSummary objects

nextToken

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

Type: String

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

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

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

ResourceNotFoundException

The request references a resource that doesn't exist.

HTTP Status Code: 404

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