stop_archive_search ¶

stop_archive_search(
    search_id: SearchId, *, config_overrides: Optional[MailManagerClientConfig] = None
) -> StopArchiveSearchResponse

Stops an in-progress archive search job.

Parameters:

search_id (SearchId) –

The identifier of the search job to stop.

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/mail_manager.py

def stop_archive_search(
    self,
    search_id: "capo_mailmanager.types.search_id.SearchId",
    *,
    config_overrides: Optional[MailManagerClientConfig] = None,
) -> (
    "capo_mailmanager.types.stop_archive_search_response.StopArchiveSearchResponse"
):
    """<p>Stops an in-progress archive search job.</p>

    Args:
        search_id: <p>The identifier of the search job to stop.</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.
    """

    def _handler(
        req: "OperationRequest[capo_mailmanager.types.stop_archive_search_request.StopArchiveSearchRequest]",
    ) -> OperationResponse[
        "capo_mailmanager.types.stop_archive_search_response.StopArchiveSearchResponse"
    ]:
        import capo_mailmanager._operations.mail_manager_svc.stop_archive_search

        output, http_response = (
            capo_mailmanager._operations.mail_manager_svc.stop_archive_search.stop_archive_search(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StopArchiveSearch")
    )
    input_: capo_mailmanager.types.stop_archive_search_request.StopArchiveSearchRequest = {
        "search_id": search_id
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output