This operation returns a list of search jobs belonging to an account.
Parameters:
-
by_status
(Optional[SearchJobState], default:
None
)
–
Include this parameter to filter list by search job status.
-
next_token
(Optional[str], default:
None
)
–
The next item following a partial list of returned search jobs.
For example, if a request is made to return MaxResults number of backups, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
-
max_results
(Optional[int], default:
None
)
–
The maximum number of resource list items to be returned.
Raises:
Source code in docs_src/capo_backupsearch/_services/backup_search.py
| def list_search_jobs(
self,
*,
config_overrides: Optional[BackupSearchClientConfig] = None,
by_status: Optional[
"capo_backupsearch.types.search_job_state.SearchJobState"
] = None,
next_token: Optional[str] = None,
max_results: Optional[int] = None,
) -> "capo_backupsearch.types.list_search_jobs_output.ListSearchJobsOutput":
"""<p>This operation returns a list of search jobs belonging to an account.</p>
Args:
by_status: <p>Include this parameter to filter list by search job status.</p>
next_token: <p>The next item following a partial list of returned search jobs.</p> <p>For example, if a request is made to return <code>MaxResults</code> number of backups, <code>NextToken</code> allows you to return more items in your list starting at the location pointed to by the next token.</p>
max_results: <p>The maximum number of resource list items to be returned.</p>
Raises:
capo_backupsearch.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
capo_backupsearch.errors.internal_server_exception.InternalServerException: <p>An internal server error occurred. Retry your request.</p>
capo_backupsearch.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
capo_backupsearch.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by a service.</p>
capo_backupsearch.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_backupsearch.types.list_search_jobs_input.ListSearchJobsInput]",
) -> OperationResponse[
"capo_backupsearch.types.list_search_jobs_output.ListSearchJobsOutput"
]:
import capo_backupsearch._operations.cryo_backup_search_service.list_search_jobs
output, http_response = (
capo_backupsearch._operations.cryo_backup_search_service.list_search_jobs.list_search_jobs(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListSearchJobs")
)
input_: capo_backupsearch.types.list_search_jobs_input.ListSearchJobsInput = {}
if by_status is not None:
input_["by_status"] = by_status
if next_token is not None:
input_["next_token"] = next_token
if max_results is not None:
input_["max_results"] = max_results
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|