This operation returns a list of search jobs belonging to an account.
Request Syntax
GET /search-jobs?MaxResults=MaxResults&NextToken=NextToken&Status=ByStatus HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- ByStatus
-
Include this parameter to filter list by search job status.
Valid Values:
RUNNING | COMPLETED | STOPPING | STOPPED | FAILED - MaxResults
-
The maximum number of resource list items to be returned.
Valid Range: Minimum value of 1. Maximum value of 1000.
- NextToken
-
The next item following a partial list of returned search jobs.
For example, if a request is made to return
MaxResultsnumber of backups,NextTokenallows you to return more items in your list starting at the location pointed to by the next token.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"NextToken": "string",
"SearchJobs": [
{
"CompletionTime": number,
"CreationTime": number,
"Name": "string",
"SearchJobArn": "string",
"SearchJobIdentifier": "string",
"SearchScopeSummary": {
"TotalItemsToScanCount": number,
"TotalRecoveryPointsToScanCount": number
},
"Status": "string",
"StatusMessage": "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 next item following a partial list of returned backups included in a search job.
For example, if a request is made to return
MaxResultsnumber of backups,NextTokenallows you to return more items in your list starting at the location pointed to by the next token.Type: String
- SearchJobs
-
The search jobs among the list, with details of the returned search jobs.
Type: Array of SearchJobSummary 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
- InternalServerException
-
An internal server error occurred. Retry your 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 a 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:
