list_search_result_export_jobs `async` ¶

list_search_result_export_jobs(
    *,
    config_overrides: Optional[AsyncBackupSearchClientConfig] = None,
    status: Optional[ExportJobStatus] = None,
    search_job_identifier: Optional[GenericId] = None,
    next_token: Optional[str] = None,
    max_results: Optional[int] = None,
) -> ListSearchResultExportJobsOutput

This operation exports search results of a search job to a specified destination S3 bucket.

Parameters:

status (Optional[ExportJobStatus], default: None ) –

The search jobs to be included in the export job can be filtered by including this parameter.
search_job_identifier (Optional[GenericId], default: None ) –

The unique string that specifies the search job.
next_token (Optional[str], default: None ) –

The next item following a partial list of returned backups included in a search job.

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:

AccessDeniedException –

You do not have sufficient access to perform this action.
InternalServerException –

An internal server error occurred. Retry your request.
ThrottlingException –

The request was denied due to request throttling.
ValidationException –

The input fails to satisfy the constraints specified by a service.
ResourceNotFoundException –

The resource was not found for this request.

Confirm the resource information, such as the ARN or type is correct and exists, then retry the request.
ServiceQuotaExceededException –

The request denied due to exceeding the quota limits permitted.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_backupsearch/_services/async_backup_search.py

async def list_search_result_export_jobs(
    self,
    *,
    config_overrides: Optional[AsyncBackupSearchClientConfig] = None,
    status: Optional[
        "capo_backupsearch.types.export_job_status.ExportJobStatus"
    ] = None,
    search_job_identifier: Optional[
        "capo_backupsearch.types.generic_id.GenericId"
    ] = None,
    next_token: Optional[str] = None,
    max_results: Optional[int] = None,
) -> "capo_backupsearch.types.list_search_result_export_jobs_output.ListSearchResultExportJobsOutput":
    """<p>This operation exports search results of a search job to a specified destination S3 bucket.</p>

    Args:
        status: <p>The search jobs to be included in the export job can be filtered by including this parameter.</p>
        search_job_identifier: <p>The unique string that specifies the search job.</p>
        next_token: <p>The next item following a partial list of returned backups included in a search job.</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.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.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The request denied due to exceeding the quota limits permitted.</p>
        capo_backupsearch.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_backupsearch.types.list_search_result_export_jobs_input.ListSearchResultExportJobsInput]",
    ) -> AsyncOperationResponse[
        "capo_backupsearch.types.list_search_result_export_jobs_output.ListSearchResultExportJobsOutput"
    ]:
        import capo_backupsearch._operations.cryo_backup_search_service.list_search_result_export_jobs

        (
            output,
            http_response,
        ) = await capo_backupsearch._operations.cryo_backup_search_service.list_search_result_export_jobs.async_list_search_result_export_jobs(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListSearchResultExportJobs")
    )
    input_: capo_backupsearch.types.list_search_result_export_jobs_input.ListSearchResultExportJobsInput = {}
    if status is not None:
        input_["status"] = status
    if search_job_identifier is not None:
        input_["search_job_identifier"] = search_job_identifier
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

list_search_result_export_jobs async ¶

list_search_result_export_jobs `async` ¶