WorkMail / Client / cancel_mailbox_export_job

cancel_mailbox_export_job#

WorkMail.Client.cancel_mailbox_export_job(**kwargs)#

Cancels a mailbox export job.

Note

If the mailbox export job is near completion, it might not be possible to cancel it.

See also: AWS API Documentation

Request Syntax

response = client.cancel_mailbox_export_job(
    ClientToken='string',
    JobId='string',
    OrganizationId='string'
)
Parameters:
  • ClientToken (string) –

    [REQUIRED]

    The idempotency token for the client request.

    This field is autopopulated if not provided.

  • JobId (string) –

    [REQUIRED]

    The job ID.

  • OrganizationId (string) –

    [REQUIRED]

    The organization ID.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • WorkMail.Client.exceptions.InvalidParameterException

  • WorkMail.Client.exceptions.OrganizationNotFoundException

  • WorkMail.Client.exceptions.OrganizationStateException

  • WorkMail.Client.exceptions.EntityNotFoundException