deregister_from_work_mail

WorkMail.Client.deregister_from_work_mail(**kwargs)

Mark a user, group, or resource as no longer used in WorkMail. This action disassociates the mailbox and schedules it for clean-up. WorkMail keeps mailboxes for 30 days before they are permanently removed. The functionality in the console is Disable .

See also: AWS API Documentation

Request Syntax

response = client.deregister_from_work_mail(
    OrganizationId='string',
    EntityId='string'
)

Parameters

• OrganizationId (string) --

  [REQUIRED]

  The identifier for the organization under which the WorkMail entity exists.

• EntityId (string) --

  [REQUIRED]

  The identifier for the member (user or group) to be updated.

Return type

dict

Returns

Response Syntax

{}

Response Structure

• (dict) --

Exceptions

• WorkMail.Client.exceptions.EntityNotFoundException
• WorkMail.Client.exceptions.EntityStateException
• WorkMail.Client.exceptions.InvalidParameterException
• WorkMail.Client.exceptions.OrganizationNotFoundException
• WorkMail.Client.exceptions.OrganizationStateException