get_archive_search `async` ¶

get_archive_search(
    search_id: SearchId,
    *,
    config_overrides: Optional[AsyncMailManagerClientConfig] = None,
) -> GetArchiveSearchResponse

Retrieves the details and current status of a specific email archive search job.

Parameters:

search_id (SearchId) –

The identifier of the search job to get details for.

Raises:

AccessDeniedException –

Occurs when a user is denied access to a specific resource or action.
ThrottlingException –

Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
ValidationException –

The request validation has failed. For details, see the accompanying error message.
UnknownServiceError –

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

Source code in docs_src/capo_mailmanager/_services/async_mail_manager.py

async def get_archive_search(
    self,
    search_id: "capo_mailmanager.types.search_id.SearchId",
    *,
    config_overrides: Optional[AsyncMailManagerClientConfig] = None,
) -> "capo_mailmanager.types.get_archive_search_response.GetArchiveSearchResponse":
    """<p>Retrieves the details and current status of a specific email archive search job.</p>

    Args:
        search_id: <p>The identifier of the search job to get details for.</p>

    Raises:
        capo_mailmanager.errors.access_denied_exception.AccessDeniedException: <p>Occurs when a user is denied access to a specific resource or action.</p>
        capo_mailmanager.errors.throttling_exception.ThrottlingException: <p>Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.</p>
        capo_mailmanager.errors.validation_exception.ValidationException: <p>The request validation has failed. For details, see the accompanying error message.</p>
        capo_mailmanager.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_mailmanager.types.get_archive_search_request.GetArchiveSearchRequest]",
    ) -> AsyncOperationResponse[
        "capo_mailmanager.types.get_archive_search_response.GetArchiveSearchResponse"
    ]:
        import capo_mailmanager._operations.mail_manager_svc.get_archive_search

        (
            output,
            http_response,
        ) = await capo_mailmanager._operations.mail_manager_svc.get_archive_search.async_get_archive_search(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetArchiveSearch")
    )
    input_: capo_mailmanager.types.get_archive_search_request.GetArchiveSearchRequest = {
        "search_id": search_id
    }

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

get_archive_search async ¶

get_archive_search `async` ¶