MailManager / Client / stop_archive_search

stop_archive_search

MailManager.Client.stop_archive_search(**kwargs)

Stops an in-progress archive search job.

See also: AWS API Documentation

Request Syntax

response = client.stop_archive_search(
    SearchId='string'
)

Parameters:

SearchId (string) –

[REQUIRED]

The identifier of the search job to stop.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

• (dict) –

  The response indicating if the request to stop the search job succeeded.

  On success, returns an HTTP 200 status code. On failure, returns an error message.

Exceptions

• MailManager.Client.exceptions.ValidationException

• MailManager.Client.exceptions.AccessDeniedException

• MailManager.Client.exceptions.ThrottlingException