This operation retrieves metadata of a search job, including its progress.
Parameters:
-
search_job_identifier
(GenericId)
–
Required unique string that specifies the search job.
Raises:
Source code in docs_src/capo_backupsearch/_services/backup_search.py
| def get_search_job(
self,
search_job_identifier: "capo_backupsearch.types.generic_id.GenericId",
*,
config_overrides: Optional[BackupSearchClientConfig] = None,
) -> "capo_backupsearch.types.get_search_job_output.GetSearchJobOutput":
"""<p>This operation retrieves metadata of a search job, including its progress.</p>
Args:
search_job_identifier: <p>Required unique string that specifies the search job.</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.resource_not_found_exception.ResourceNotFoundException: <p>The resource was not found for this request.</p> <p>Confirm the resource information, such as the ARN or type is correct and exists, then retry the request.</p>
capo_backupsearch.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_backupsearch.types.get_search_job_input.GetSearchJobInput]",
) -> OperationResponse[
"capo_backupsearch.types.get_search_job_output.GetSearchJobOutput"
]:
import capo_backupsearch._operations.cryo_backup_search_service.get_search_job
output, http_response = (
capo_backupsearch._operations.cryo_backup_search_service.get_search_job.get_search_job(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("GetSearchJob")
)
input_: capo_backupsearch.types.get_search_job_input.GetSearchJobInput = {
"search_job_identifier": search_job_identifier
}
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|