SearchQuantumTasks
Searches for tasks that match the specified filter values.
Request Syntax
POST /quantum-tasks HTTP/1.1
Content-type: application/json
{
"filters": [
{
"name": "string
",
"operator": "string
",
"values": [ "string
" ]
}
],
"maxResults": number
,
"nextToken": "string
"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- filters
-
Array of
SearchQuantumTasksFilter
objects.Type: Array of SearchQuantumTasksFilter objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
Required: Yes
- maxResults
-
Maximum number of results to return in the response.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- nextToken
-
A token used for pagination of results returned in the response. Use the token returned from the previous request continue results where the previous request ended.
Type: String
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"nextToken": "string",
"quantumTasks": [
{
"createdAt": number,
"deviceArn": "string",
"endedAt": number,
"outputS3Bucket": "string",
"outputS3Directory": "string",
"quantumTaskArn": "string",
"shots": number,
"status": "string",
"tags": {
"string" : "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 token used for pagination of results, or null if there are no additional results. Use the token value in a subsequent request to continue results where the previous request ended.
Type: String
- quantumTasks
-
An array of
QuantumTaskSummary
objects for tasks that match the specified filters.Type: Array of QuantumTaskSummary objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 403
- InternalServiceException
-
The request processing has failed because of an unknown error, exception, or failure.
HTTP Status Code: 500
- ThrottlingException
-
The throttling rate limit is met.
HTTP Status Code: 429
- ValidationException
-
The input fails to satisfy the constraints specified by an AWS service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: