Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetWorkUnits

Retrieves the work units generated by the StartQueryPlanning operation.

Request Syntax


{
   "NextToken": "string",
   "PageSize": number,
   "QueryId": "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.

NextToken

A continuation token, if this is a continuation call.

Type: String

Required: No

PageSize

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command's output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

Type: Integer

Required: No

QueryId

The ID of the plan query operation.

Type: String

Length Constraints: Fixed length of 36.

Required: Yes

Response Syntax


{
   "NextToken": "string",
   "QueryId": "string",
   "WorkUnitRanges": [ 
      { 
         "WorkUnitIdMax": number,
         "WorkUnitIdMin": number,
         "WorkUnitToken": "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 continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.

Type: String

QueryId

The ID of the plan query operation.

Type: String

WorkUnitRanges

A WorkUnitRangeList object that specifies the valid range of work unit IDs for querying the execution service.

Type: Array of WorkUnitRange objects

Errors

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

AccessDeniedException

Access to a resource was denied.

Message: A message describing the problem.

HTTP Status Code: 400

ExpiredException

Contains details about an error where the query request expired.

Message: A message describing the error.

HTTP Status Code: 400

InternalServiceException

An internal service error occurred.

Message: A message describing the problem.

HTTP Status Code: 500

InvalidInputException

The input provided was not valid.

Message: A message describing the problem.

HTTP Status Code: 400

WorkUnitsNotReadyYetException

Contains details about an error related to work units not being ready.

Message: A message describing the error.

HTTP Status Code: 400