list_archive_searches async ¶

async def list_archive_searches(
    self,
    archive_id: "capo_mailmanager.types.archive_id.ArchiveId",
    *,
    config_overrides: Optional[AsyncMailManagerClientConfig] = None,
    next_token: Optional[
        "capo_mailmanager.types.pagination_token.PaginationToken"
    ] = None,
    page_size: Optional["capo_mailmanager.types.page_size.PageSize"] = None,
) -> "capo_mailmanager.types.list_archive_searches_response.ListArchiveSearchesResponse":
    """<p>Returns a list of email archive search jobs.</p>

    Args:
        archive_id: <p>The identifier of the archive.</p>
        next_token: <p>If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. </p>
        page_size: <p>The maximum number of archive search jobs that are returned per call. You can use NextToken to obtain further pages of archives. </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.resource_not_found_exception.ResourceNotFoundException: <p>Occurs when a requested resource is not found.</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.list_archive_searches_request.ListArchiveSearchesRequest]",
    ) -> AsyncOperationResponse[
        "capo_mailmanager.types.list_archive_searches_response.ListArchiveSearchesResponse"
    ]:
        import capo_mailmanager._operations.mail_manager_svc.list_archive_searches

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListArchiveSearches")
    )
    input_: capo_mailmanager.types.list_archive_searches_request.ListArchiveSearchesRequest = {
        "archive_id": archive_id
    }
    if next_token is not None:
        input_["next_token"] = next_token
    if page_size is not None:
        input_["page_size"] = page_size

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