Stops an in-progress export of emails from an archive.
Parameters:
-
export_id
(ExportId)
–
The identifier of the export 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_export(
self,
export_id: "capo_mailmanager.types.export_id.ExportId",
*,
config_overrides: Optional[MailManagerClientConfig] = None,
) -> (
"capo_mailmanager.types.stop_archive_export_response.StopArchiveExportResponse"
):
"""<p>Stops an in-progress export of emails from an archive.</p>
Args:
export_id: <p>The identifier of the export 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_export_request.StopArchiveExportRequest]",
) -> OperationResponse[
"capo_mailmanager.types.stop_archive_export_response.StopArchiveExportResponse"
]:
import capo_mailmanager._operations.mail_manager_svc.stop_archive_export
output, http_response = (
capo_mailmanager._operations.mail_manager_svc.stop_archive_export.stop_archive_export(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("StopArchiveExport")
)
input_: capo_mailmanager.types.stop_archive_export_request.StopArchiveExportRequest = {
"export_id": export_id
}
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|