WorkMail

Client

class WorkMail.Client

A low-level client representing Amazon WorkMail:

client = session.create_client('workmail')

These are the available methods:

associate_delegate_to_resource(**kwargs)

Adds a member (user or group) to the resource's set of delegates.

See also: AWS API Documentation

Request Syntax

response = client.associate_delegate_to_resource(
    OrganizationId='string',
    ResourceId='string',
    EntityId='string'
)
Parameters
  • OrganizationId (string) --

    [REQUIRED]

    The organization under which the resource exists.

  • ResourceId (string) --

    [REQUIRED]

    The resource for which members (users or groups) are associated.

  • EntityId (string) --

    [REQUIRED]

    The member (user or group) to associate to the resource.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

associate_member_to_group(**kwargs)

Adds a member (user or group) to the group's set.

See also: AWS API Documentation

Request Syntax

response = client.associate_member_to_group(
    OrganizationId='string',
    GroupId='string',
    MemberId='string'
)
Parameters
  • OrganizationId (string) --

    [REQUIRED]

    The organization under which the group exists.

  • GroupId (string) --

    [REQUIRED]

    The group to which the member (user or group) is associated.

  • MemberId (string) --

    [REQUIRED]

    The member (user or group) to associate to the group.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
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

create_alias(**kwargs)

Adds an alias to the set of a given member (user or group) of Amazon WorkMail.

See also: AWS API Documentation

Request Syntax

response = client.create_alias(
    OrganizationId='string',
    EntityId='string',
    Alias='string'
)
Parameters
  • OrganizationId (string) --

    [REQUIRED]

    The organization under which the member (user or group) exists.

  • EntityId (string) --

    [REQUIRED]

    The member (user or group) to which this alias is added.

  • Alias (string) --

    [REQUIRED]

    The alias to add to the member set.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

create_group(**kwargs)

Creates a group that can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.

See also: AWS API Documentation

Request Syntax

response = client.create_group(
    OrganizationId='string',
    Name='string'
)
Parameters
  • OrganizationId (string) --

    [REQUIRED]

    The organization under which the group is to be created.

  • Name (string) --

    [REQUIRED]

    The name of the group.

Return type

dict

Returns

Response Syntax

{
    'GroupId': 'string'
}

Response Structure

  • (dict) --

    • GroupId (string) --

      The identifier of the group.

Exceptions

create_organization(**kwargs)

Creates a new Amazon WorkMail organization. Optionally, you can choose to associate an existing AWS Directory Service directory with your organization. If an AWS Directory Service directory ID is specified, the organization alias must match the directory alias. If you choose not to associate an existing directory with your organization, then we create a new Amazon WorkMail directory for you. For more information, see Adding an organization in the Amazon WorkMail Administrator Guide .

You can associate multiple email domains with an organization, then set your default email domain from the Amazon WorkMail console. You can also associate a domain that is managed in an Amazon Route 53 public hosted zone. For more information, see Adding a domain and Choosing the default domain in the Amazon WorkMail Administrator Guide .

Optionally, you can use a customer managed master key from AWS Key Management Service (AWS KMS) to encrypt email for your organization. If you don't associate an AWS KMS key, Amazon WorkMail creates a default AWS managed master key for you.

See also: AWS API Documentation

Request Syntax

response = client.create_organization(
    DirectoryId='string',
    Alias='string',
    ClientToken='string',
    Domains=[
        {
            'DomainName': 'string',
            'HostedZoneId': 'string'
        },
    ],
    KmsKeyArn='string',
    EnableInteroperability=True|False
)
Parameters
  • DirectoryId (string) -- The AWS Directory Service directory ID.
  • Alias (string) --

    [REQUIRED]

    The organization alias.

  • ClientToken (string) --

    The idempotency token associated with the request.

    This field is autopopulated if not provided.

  • Domains (list) --

    The email domains to associate with the organization.

    • (dict) --

      The domain to associate with an Amazon WorkMail organization.

      When you configure a domain hosted in Amazon Route 53 (Route 53), all recommended DNS records are added to the organization when you create it. For more information, see Adding a domain in the Amazon WorkMail Administrator Guide .

      • DomainName (string) --

        The fully qualified domain name.

      • HostedZoneId (string) --

        The hosted zone ID for a domain hosted in Route 53. Required when configuring a domain hosted in Route 53.

  • KmsKeyArn (string) -- The Amazon Resource Name (ARN) of a customer managed master key from AWS KMS.
  • EnableInteroperability (boolean) -- When true , allows organization interoperability between Amazon WorkMail and Microsoft Exchange. Can only be set to true if an AD Connector directory ID is included in the request.
Return type

dict

Returns

Response Syntax

{
    'OrganizationId': 'string'
}

Response Structure

  • (dict) --

    • OrganizationId (string) --

      The organization ID.

Exceptions

create_resource(**kwargs)

Creates a new Amazon WorkMail resource.

See also: AWS API Documentation

Request Syntax

response = client.create_resource(
    OrganizationId='string',
    Name='string',
    Type='ROOM'|'EQUIPMENT'
)
Parameters
  • OrganizationId (string) --

    [REQUIRED]

    The identifier associated with the organization for which the resource is created.

  • Name (string) --

    [REQUIRED]

    The name of the new resource.

  • Type (string) --

    [REQUIRED]

    The type of the new resource. The available types are equipment and room .

Return type

dict

Returns

Response Syntax

{
    'ResourceId': 'string'
}

Response Structure

  • (dict) --

    • ResourceId (string) --

      The identifier of the new resource.

Exceptions

create_user(**kwargs)

Creates a user who can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.

See also: AWS API Documentation

Request Syntax

response = client.create_user(
    OrganizationId='string',
    Name='string',
    DisplayName='string',
    Password='string'
)
Parameters
  • OrganizationId (string) --

    [REQUIRED]

    The identifier of the organization for which the user is created.

  • Name (string) --

    [REQUIRED]

    The name for the new user. Simple AD or AD Connector user names have a maximum length of 20. All others have a maximum length of 64.

  • DisplayName (string) --

    [REQUIRED]

    The display name for the new user.

  • Password (string) --

    [REQUIRED]

    The password for the new user.

Return type

dict

Returns

Response Syntax

{
    'UserId': 'string'
}

Response Structure

  • (dict) --

    • UserId (string) --

      The identifier for the new user.

Exceptions

delete_access_control_rule(**kwargs)

Deletes an access control rule for the specified WorkMail organization.

See also: AWS API Documentation

Request Syntax

response = client.delete_access_control_rule(
    OrganizationId='string',
    Name='string'
)
Parameters
  • OrganizationId (string) --

    [REQUIRED]

    The identifier for the organization.

  • Name (string) --

    [REQUIRED]

    The name of the access control rule.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

delete_alias(**kwargs)

Remove one or more specified aliases from a set of aliases for a given user.

See also: AWS API Documentation

Request Syntax

response = client.delete_alias(
    OrganizationId='string',
    EntityId='string',
    Alias='string'
)
Parameters
  • OrganizationId (string) --

    [REQUIRED]

    The identifier for the organization under which the user exists.

  • EntityId (string) --

    [REQUIRED]

    The identifier for the member (user or group) from which to have the aliases removed.

  • Alias (string) --

    [REQUIRED]

    The aliases to be removed from the user's set of aliases. Duplicate entries in the list are collapsed into single entries (the list is transformed into a set).

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

delete_group(**kwargs)

Deletes a group from Amazon WorkMail.

See also: AWS API Documentation

Request Syntax

response = client.delete_group(
    OrganizationId='string',
    GroupId='string'
)
Parameters
  • OrganizationId (string) --

    [REQUIRED]

    The organization that contains the group.

  • GroupId (string) --

    [REQUIRED]

    The identifier of the group to be deleted.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

delete_mailbox_permissions(**kwargs)

Deletes permissions granted to a member (user or group).

See also: AWS API Documentation

Request Syntax

response = client.delete_mailbox_permissions(
    OrganizationId='string',
    EntityId='string',
    GranteeId='string'
)
Parameters
  • OrganizationId (string) --

    [REQUIRED]

    The identifier of the organization under which the member (user or group) exists.

  • EntityId (string) --

    [REQUIRED]

    The identifier of the member (user or group) that owns the mailbox.

  • GranteeId (string) --

    [REQUIRED]

    The identifier of the member (user or group) for which to delete granted permissions.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

delete_organization(**kwargs)

Deletes an Amazon WorkMail organization and all underlying AWS resources managed by Amazon WorkMail as part of the organization. You can choose whether to delete the associated directory. For more information, see Removing an organization in the Amazon WorkMail Administrator Guide .

See also: AWS API Documentation

Request Syntax

response = client.delete_organization(
    ClientToken='string',
    OrganizationId='string',
    DeleteDirectory=True|False
)
Parameters
  • ClientToken (string) --

    The idempotency token associated with the request.

    This field is autopopulated if not provided.

  • OrganizationId (string) --

    [REQUIRED]

    The organization ID.

  • DeleteDirectory (boolean) --

    [REQUIRED]

    If true, deletes the AWS Directory Service directory associated with the organization.

Return type

dict

Returns

Response Syntax

{
    'OrganizationId': 'string',
    'State': 'string'
}

Response Structure

  • (dict) --

    • OrganizationId (string) --

      The organization ID.

    • State (string) --

      The state of the organization.

Exceptions

delete_resource(**kwargs)

Deletes the specified resource.

See also: AWS API Documentation

Request Syntax

response = client.delete_resource(
    OrganizationId='string',
    ResourceId='string'
)
Parameters
  • OrganizationId (string) --

    [REQUIRED]

    The identifier associated with the organization from which the resource is deleted.

  • ResourceId (string) --

    [REQUIRED]

    The identifier of the resource to be deleted.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

delete_retention_policy(**kwargs)

Deletes the specified retention policy from the specified organization.

See also: AWS API Documentation

Request Syntax

response = client.delete_retention_policy(
    OrganizationId='string',
    Id='string'
)
Parameters
  • OrganizationId (string) --

    [REQUIRED]

    The organization ID.

  • Id (string) --

    [REQUIRED]

    The retention policy ID.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

delete_user(**kwargs)

Deletes a user from Amazon WorkMail and all subsequent systems. Before you can delete a user, the user state must be DISABLED . Use the DescribeUser action to confirm the user state.

Deleting a user is permanent and cannot be undone. WorkMail archives user mailboxes for 30 days before they are permanently removed.

See also: AWS API Documentation

Request Syntax

response = client.delete_user(
    OrganizationId='string',
    UserId='string'
)
Parameters
  • OrganizationId (string) --

    [REQUIRED]

    The organization that contains the user to be deleted.

  • UserId (string) --

    [REQUIRED]

    The identifier of the user to be deleted.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

deregister_from_work_mail(**kwargs)

Mark a user, group, or resource as no longer used in Amazon 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 Amazon 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

describe_group(**kwargs)

Returns the data available for the group.

See also: AWS API Documentation

Request Syntax

response = client.describe_group(
    OrganizationId='string',
    GroupId='string'
)
Parameters
  • OrganizationId (string) --

    [REQUIRED]

    The identifier for the organization under which the group exists.

  • GroupId (string) --

    [REQUIRED]

    The identifier for the group to be described.

Return type

dict

Returns

Response Syntax

{
    'GroupId': 'string',
    'Name': 'string',
    'Email': 'string',
    'State': 'ENABLED'|'DISABLED'|'DELETED',
    'EnabledDate': datetime(2015, 1, 1),
    'DisabledDate': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • GroupId (string) --

      The identifier of the described group.

    • Name (string) --

      The name of the described group.

    • Email (string) --

      The email of the described group.

    • State (string) --

      The state of the user: enabled (registered to Amazon WorkMail) or disabled (deregistered or never registered to WorkMail).

    • EnabledDate (datetime) --

      The date and time when a user was registered to WorkMail, in UNIX epoch time format.

    • DisabledDate (datetime) --

      The date and time when a user was deregistered from WorkMail, in UNIX epoch time format.

Exceptions

describe_mailbox_export_job(**kwargs)

Describes the current status of a mailbox export job.

See also: AWS API Documentation

Request Syntax

response = client.describe_mailbox_export_job(
    JobId='string',
    OrganizationId='string'
)
Parameters
  • JobId (string) --

    [REQUIRED]

    The mailbox export job ID.

  • OrganizationId (string) --

    [REQUIRED]

    The organization ID.

Return type

dict

Returns

Response Syntax

{
    'EntityId': 'string',
    'Description': 'string',
    'RoleArn': 'string',
    'KmsKeyArn': 'string',
    'S3BucketName': 'string',
    'S3Prefix': 'string',
    'S3Path': 'string',
    'EstimatedProgress': 123,
    'State': 'RUNNING'|'COMPLETED'|'FAILED'|'CANCELLED',
    'ErrorInfo': 'string',
    'StartTime': datetime(2015, 1, 1),
    'EndTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • EntityId (string) --

      The identifier of the user or resource associated with the mailbox.

    • Description (string) --

      The mailbox export job description.

    • RoleArn (string) --

      The ARN of the AWS Identity and Access Management (IAM) role that grants write permission to the Amazon Simple Storage Service (Amazon S3) bucket.

    • KmsKeyArn (string) --

      The Amazon Resource Name (ARN) of the symmetric AWS Key Management Service (AWS KMS) key that encrypts the exported mailbox content.

    • S3BucketName (string) --

      The name of the S3 bucket.

    • S3Prefix (string) --

      The S3 bucket prefix.

    • S3Path (string) --

      The path to the S3 bucket and file that the mailbox export job is exporting to.

    • EstimatedProgress (integer) --

      The estimated progress of the mailbox export job, in percentage points.

    • State (string) --

      The state of the mailbox export job.

    • ErrorInfo (string) --

      Error information for failed mailbox export jobs.

    • StartTime (datetime) --

      The mailbox export job start timestamp.

    • EndTime (datetime) --

      The mailbox export job end timestamp.

Exceptions

describe_organization(**kwargs)

Provides more information regarding a given organization based on its identifier.

See also: AWS API Documentation

Request Syntax

response = client.describe_organization(
    OrganizationId='string'
)
Parameters
OrganizationId (string) --

[REQUIRED]

The identifier for the organization to be described.

Return type
dict
Returns
Response Syntax
{
    'OrganizationId': 'string',
    'Alias': 'string',
    'State': 'string',
    'DirectoryId': 'string',
    'DirectoryType': 'string',
    'DefaultMailDomain': 'string',
    'CompletedDate': datetime(2015, 1, 1),
    'ErrorMessage': 'string',
    'ARN': 'string'
}

Response Structure

  • (dict) --
    • OrganizationId (string) --

      The identifier of an organization.

    • Alias (string) --

      The alias for an organization.

    • State (string) --

      The state of an organization.

    • DirectoryId (string) --

      The identifier for the directory associated with an Amazon WorkMail organization.

    • DirectoryType (string) --

      The type of directory associated with the WorkMail organization.

    • DefaultMailDomain (string) --

      The default mail domain associated with the organization.

    • CompletedDate (datetime) --

      The date at which the organization became usable in the WorkMail context, in UNIX epoch time format.

    • ErrorMessage (string) --

      (Optional) The error message indicating if unexpected behavior was encountered with regards to the organization.

    • ARN (string) --

      The Amazon Resource Name (ARN) of the organization.

Exceptions

describe_resource(**kwargs)

Returns the data available for the resource.

See also: AWS API Documentation

Request Syntax

response = client.describe_resource(
    OrganizationId='string',
    ResourceId='string'
)
Parameters
  • OrganizationId (string) --

    [REQUIRED]

    The identifier associated with the organization for which the resource is described.

  • ResourceId (string) --

    [REQUIRED]

    The identifier of the resource to be described.

Return type

dict

Returns

Response Syntax

{
    'ResourceId': 'string',
    'Email': 'string',
    'Name': 'string',
    'Type': 'ROOM'|'EQUIPMENT',
    'BookingOptions': {
        'AutoAcceptRequests': True|False,
        'AutoDeclineRecurringRequests': True|False,
        'AutoDeclineConflictingRequests': True|False
    },
    'State': 'ENABLED'|'DISABLED'|'DELETED',
    'EnabledDate': datetime(2015, 1, 1),
    'DisabledDate': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • ResourceId (string) --

      The identifier of the described resource.

    • Email (string) --

      The email of the described resource.

    • Name (string) --

      The name of the described resource.

    • Type (string) --

      The type of the described resource.

    • BookingOptions (dict) --

      The booking options for the described resource.

      • AutoAcceptRequests (boolean) --

        The resource's ability to automatically reply to requests. If disabled, delegates must be associated to the resource.

      • AutoDeclineRecurringRequests (boolean) --

        The resource's ability to automatically decline any recurring requests.

      • AutoDeclineConflictingRequests (boolean) --

        The resource's ability to automatically decline any conflicting requests.

    • State (string) --

      The state of the resource: enabled (registered to Amazon WorkMail), disabled (deregistered or never registered to WorkMail), or deleted.

    • EnabledDate (datetime) --

      The date and time when a resource was enabled for WorkMail, in UNIX epoch time format.

    • DisabledDate (datetime) --

      The date and time when a resource was disabled from WorkMail, in UNIX epoch time format.

Exceptions

describe_user(**kwargs)

Provides information regarding the user.

See also: AWS API Documentation

Request Syntax

response = client.describe_user(
    OrganizationId='string',
    UserId='string'
)
Parameters
  • OrganizationId (string) --

    [REQUIRED]

    The identifier for the organization under which the user exists.

  • UserId (string) --

    [REQUIRED]

    The identifier for the user to be described.

Return type

dict

Returns

Response Syntax

{
    'UserId': 'string',
    'Name': 'string',
    'Email': 'string',
    'DisplayName': 'string',
    'State': 'ENABLED'|'DISABLED'|'DELETED',
    'UserRole': 'USER'|'RESOURCE'|'SYSTEM_USER',
    'EnabledDate': datetime(2015, 1, 1),
    'DisabledDate': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • UserId (string) --

      The identifier for the described user.

    • Name (string) --

      The name for the user.

    • Email (string) --

      The email of the user.

    • DisplayName (string) --

      The display name of the user.

    • State (string) --

      The state of a user: enabled (registered to Amazon WorkMail) or disabled (deregistered or never registered to WorkMail).

    • UserRole (string) --

      In certain cases, other entities are modeled as users. If interoperability is enabled, resources are imported into Amazon WorkMail as users. Because different WorkMail organizations rely on different directory types, administrators can distinguish between an unregistered user (account is disabled and has a user role) and the directory administrators. The values are USER, RESOURCE, and SYSTEM_USER.

    • EnabledDate (datetime) --

      The date and time at which the user was enabled for Amazon WorkMail usage, in UNIX epoch time format.

    • DisabledDate (datetime) --

      The date and time at which the user was disabled for Amazon WorkMail usage, in UNIX epoch time format.

Exceptions

disassociate_delegate_from_resource(**kwargs)

Removes a member from the resource's set of delegates.

See also: AWS API Documentation

Request Syntax

response = client.disassociate_delegate_from_resource(
    OrganizationId='string',
    ResourceId='string',
    EntityId='string'
)
Parameters
  • OrganizationId (string) --

    [REQUIRED]

    The identifier for the organization under which the resource exists.

  • ResourceId (string) --

    [REQUIRED]

    The identifier of the resource from which delegates' set members are removed.

  • EntityId (string) --

    [REQUIRED]

    The identifier for the member (user, group) to be removed from the resource's delegates.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

disassociate_member_from_group(**kwargs)

Removes a member from a group.

See also: AWS API Documentation

Request Syntax

response = client.disassociate_member_from_group(
    OrganizationId='string',
    GroupId='string',
    MemberId='string'
)
Parameters
  • OrganizationId (string) --

    [REQUIRED]

    The identifier for the organization under which the group exists.

  • GroupId (string) --

    [REQUIRED]

    The identifier for the group from which members are removed.

  • MemberId (string) --

    [REQUIRED]

    The identifier for the member to be removed to the group.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

Generate a presigned url given a client, its method, and arguments

Parameters
  • ClientMethod (string) -- The client method to presign for
  • Params (dict) -- The parameters normally passed to ClientMethod.
  • ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
  • HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.
Returns

The presigned url

get_access_control_effect(**kwargs)

Gets the effects of an organization's access control rules as they apply to a specified IPv4 address, access protocol action, or user ID.

See also: AWS API Documentation

Request Syntax

response = client.get_access_control_effect(
    OrganizationId='string',
    IpAddress='string',
    Action='string',
    UserId='string'
)
Parameters
  • OrganizationId (string) --

    [REQUIRED]

    The identifier for the organization.

  • IpAddress (string) --

    [REQUIRED]

    The IPv4 address.

  • Action (string) --

    [REQUIRED]

    The access protocol action. Valid values include ActiveSync , AutoDiscover , EWS , IMAP , SMTP , WindowsOutlook , and WebMail .

  • UserId (string) --

    [REQUIRED]

    The user ID.

Return type

dict

Returns

Response Syntax

{
    'Effect': 'ALLOW'|'DENY',
    'MatchedRules': [
        'string',
    ]
}

Response Structure

  • (dict) --

    • Effect (string) --

      The rule effect.

    • MatchedRules (list) --

      The rules that match the given parameters, resulting in an effect.

      • (string) --

Exceptions

get_default_retention_policy(**kwargs)

Gets the default retention policy details for the specified organization.

See also: AWS API Documentation

Request Syntax

response = client.get_default_retention_policy(
    OrganizationId='string'
)
Parameters
OrganizationId (string) --

[REQUIRED]

The organization ID.

Return type
dict
Returns
Response Syntax
{
    'Id': 'string',
    'Name': 'string',
    'Description': 'string',
    'FolderConfigurations': [
        {
            'Name': 'INBOX'|'DELETED_ITEMS'|'SENT_ITEMS'|'DRAFTS'|'JUNK_EMAIL',
            'Action': 'NONE'|'DELETE'|'PERMANENTLY_DELETE',
            'Period': 123
        },
    ]
}

Response Structure

  • (dict) --
    • Id (string) --

      The retention policy ID.

    • Name (string) --

      The retention policy name.

    • Description (string) --

      The retention policy description.

    • FolderConfigurations (list) --

      The retention policy folder configurations.

      • (dict) --

        The configuration applied to an organization's folders by its retention policy.

        • Name (string) --

          The folder name.

        • Action (string) --

          The action to take on the folder contents at the end of the folder configuration period.

        • Period (integer) --

          The period of time at which the folder configuration action is applied.

Exceptions

get_mailbox_details(**kwargs)

Requests a user's mailbox details for a specified organization and user.

See also: AWS API Documentation

Request Syntax

response = client.get_mailbox_details(
    OrganizationId='string',
    UserId='string'
)
Parameters
  • OrganizationId (string) --

    [REQUIRED]

    The identifier for the organization that contains the user whose mailbox details are being requested.

  • UserId (string) --

    [REQUIRED]

    The identifier for the user whose mailbox details are being requested.

Return type

dict

Returns

Response Syntax

{
    'MailboxQuota': 123,
    'MailboxSize': 123.0
}

Response Structure

  • (dict) --

    • MailboxQuota (integer) --

      The maximum allowed mailbox size, in MB, for the specified user.

    • MailboxSize (float) --

      The current mailbox size, in MB, for the specified user.

Exceptions

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
list_access_control_rules(**kwargs)

Lists the access control rules for the specified organization.

See also: AWS API Documentation

Request Syntax

response = client.list_access_control_rules(
    OrganizationId='string'
)
Parameters
OrganizationId (string) --

[REQUIRED]

The identifier for the organization.

Return type
dict
Returns
Response Syntax
{
    'Rules': [
        {
            'Name': 'string',
            'Effect': 'ALLOW'|'DENY',
            'Description': 'string',
            'IpRanges': [
                'string',
            ],
            'NotIpRanges': [
                'string',
            ],
            'Actions': [
                'string',
            ],
            'NotActions': [
                'string',
            ],
            'UserIds': [
                'string',
            ],
            'NotUserIds': [
                'string',
            ],
            'DateCreated': datetime(2015, 1, 1),
            'DateModified': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

  • (dict) --
    • Rules (list) --

      The access control rules.

      • (dict) --

        A rule that controls access to an Amazon WorkMail organization.

        • Name (string) --

          The rule name.

        • Effect (string) --

          The rule effect.

        • Description (string) --

          The rule description.

        • IpRanges (list) --

          IPv4 CIDR ranges to include in the rule.

          • (string) --
        • NotIpRanges (list) --

          IPv4 CIDR ranges to exclude from the rule.

          • (string) --
        • Actions (list) --

          Access protocol actions to include in the rule. Valid values include ActiveSync , AutoDiscover , EWS , IMAP , SMTP , WindowsOutlook , and WebMail .

          • (string) --
        • NotActions (list) --

          Access protocol actions to exclude from the rule. Valid values include ActiveSync , AutoDiscover , EWS , IMAP , SMTP , WindowsOutlook , and WebMail .

          • (string) --
        • UserIds (list) --

          User IDs to include in the rule.

          • (string) --
        • NotUserIds (list) --

          User IDs to exclude from the rule.

          • (string) --
        • DateCreated (datetime) --

          The date that the rule was created.

        • DateModified (datetime) --

          The date that the rule was modified.

Exceptions

list_aliases(**kwargs)

Creates a paginated call to list the aliases associated with a given entity.

See also: AWS API Documentation

Request Syntax

response = client.list_aliases(
    OrganizationId='string',
    EntityId='string',
    NextToken='string',
    MaxResults=123
)
Parameters
  • OrganizationId (string) --

    [REQUIRED]

    The identifier for the organization under which the entity exists.

  • EntityId (string) --

    [REQUIRED]

    The identifier for the entity for which to list the aliases.

  • NextToken (string) -- The token to use to retrieve the next page of results. The first call does not contain any tokens.
  • MaxResults (integer) -- The maximum number of results to return in a single call.
Return type

dict

Returns

Response Syntax

{
    'Aliases': [
        'string',
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Aliases (list) --

      The entity's paginated aliases.

      • (string) --
    • NextToken (string) --

      The token to use to retrieve the next page of results. The value is "null" when there are no more results to return.

Exceptions

list_group_members(**kwargs)

Returns an overview of the members of a group. Users and groups can be members of a group.

See also: AWS API Documentation

Request Syntax

response = client.list_group_members(
    OrganizationId='string',
    GroupId='string',
    NextToken='string',
    MaxResults=123
)
Parameters
  • OrganizationId (string) --

    [REQUIRED]

    The identifier for the organization under which the group exists.

  • GroupId (string) --

    [REQUIRED]

    The identifier for the group to which the members (users or groups) are associated.

  • NextToken (string) -- The token to use to retrieve the next page of results. The first call does not contain any tokens.
  • MaxResults (integer) -- The maximum number of results to return in a single call.
Return type

dict

Returns

Response Syntax

{
    'Members': [
        {
            'Id': 'string',
            'Name': 'string',
            'Type': 'GROUP'|'USER',
            'State': 'ENABLED'|'DISABLED'|'DELETED',
            'EnabledDate': datetime(2015, 1, 1),
            'DisabledDate': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Members (list) --

      The members associated to the group.

      • (dict) --

        The representation of a user or group.

        • Id (string) --

          The identifier of the member.

        • Name (string) --

          The name of the member.

        • Type (string) --

          A member can be a user or group.

        • State (string) --

          The state of the member, which can be ENABLED, DISABLED, or DELETED.

        • EnabledDate (datetime) --

          The date indicating when the member was enabled for Amazon WorkMail use.

        • DisabledDate (datetime) --

          The date indicating when the member was disabled from Amazon WorkMail use.

    • NextToken (string) --

      The token to use to retrieve the next page of results. The first call does not contain any tokens.

Exceptions

list_groups(**kwargs)

Returns summaries of the organization's groups.

See also: AWS API Documentation

Request Syntax

response = client.list_groups(
    OrganizationId='string',
    NextToken='string',
    MaxResults=123
)
Parameters
  • OrganizationId (string) --

    [REQUIRED]

    The identifier for the organization under which the groups exist.

  • NextToken (string) -- The token to use to retrieve the next page of results. The first call does not contain any tokens.
  • MaxResults (integer) -- The maximum number of results to return in a single call.
Return type

dict

Returns

Response Syntax

{
    'Groups': [
        {
            'Id': 'string',
            'Email': 'string',
            'Name': 'string',
            'State': 'ENABLED'|'DISABLED'|'DELETED',
            'EnabledDate': datetime(2015, 1, 1),
            'DisabledDate': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Groups (list) --

      The overview of groups for an organization.

      • (dict) --

        The representation of an Amazon WorkMail group.

        • Id (string) --

          The identifier of the group.

        • Email (string) --

          The email of the group.

        • Name (string) --

          The name of the group.

        • State (string) --

          The state of the group, which can be ENABLED, DISABLED, or DELETED.

        • EnabledDate (datetime) --

          The date indicating when the group was enabled for Amazon WorkMail use.

        • DisabledDate (datetime) --

          The date indicating when the group was disabled from Amazon WorkMail use.

    • NextToken (string) --

      The token to use to retrieve the next page of results. The value is "null" when there are no more results to return.

Exceptions

list_mailbox_export_jobs(**kwargs)

Lists the mailbox export jobs started for the specified organization within the last seven days.

See also: AWS API Documentation

Request Syntax

response = client.list_mailbox_export_jobs(
    OrganizationId='string',
    NextToken='string',
    MaxResults=123
)
Parameters
  • OrganizationId (string) --

    [REQUIRED]

    The organization ID.

  • NextToken (string) -- The token to use to retrieve the next page of results.
  • MaxResults (integer) -- The maximum number of results to return in a single call.
Return type

dict

Returns

Response Syntax

{
    'Jobs': [
        {
            'JobId': 'string',
            'EntityId': 'string',
            'Description': 'string',
            'S3BucketName': 'string',
            'S3Path': 'string',
            'EstimatedProgress': 123,
            'State': 'RUNNING'|'COMPLETED'|'FAILED'|'CANCELLED',
            'StartTime': datetime(2015, 1, 1),
            'EndTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Jobs (list) --

      The mailbox export job details.

      • (dict) --

        The details of a mailbox export job, including the user or resource ID associated with the mailbox and the S3 bucket that the mailbox contents are exported to.

        • JobId (string) --

          The identifier of the mailbox export job.

        • EntityId (string) --

          The identifier of the user or resource associated with the mailbox.

        • Description (string) --

          The mailbox export job description.

        • S3BucketName (string) --

          The name of the S3 bucket.

        • S3Path (string) --

          The path to the S3 bucket and file that the mailbox export job exports to.

        • EstimatedProgress (integer) --

          The estimated progress of the mailbox export job, in percentage points.

        • State (string) --

          The state of the mailbox export job.

        • StartTime (datetime) --

          The mailbox export job start timestamp.

        • EndTime (datetime) --

          The mailbox export job end timestamp.

    • NextToken (string) --

      The token to use to retrieve the next page of results.

Exceptions

list_mailbox_permissions(**kwargs)

Lists the mailbox permissions associated with a user, group, or resource mailbox.

See also: AWS API Documentation

Request Syntax

response = client.list_mailbox_permissions(
    OrganizationId='string',
    EntityId='string',
    NextToken='string',
    MaxResults=123
)
Parameters
  • OrganizationId (string) --

    [REQUIRED]

    The identifier of the organization under which the user, group, or resource exists.

  • EntityId (string) --

    [REQUIRED]

    The identifier of the user, group, or resource for which to list mailbox permissions.

  • NextToken (string) -- The token to use to retrieve the next page of results. The first call does not contain any tokens.
  • MaxResults (integer) -- The maximum number of results to return in a single call.
Return type

dict

Returns

Response Syntax

{
    'Permissions': [
        {
            'GranteeId': 'string',
            'GranteeType': 'GROUP'|'USER',
            'PermissionValues': [
                'FULL_ACCESS'|'SEND_AS'|'SEND_ON_BEHALF',
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Permissions (list) --

      One page of the user, group, or resource mailbox permissions.

      • (dict) --

        Permission granted to a user, group, or resource to access a certain aspect of another user, group, or resource mailbox.

        • GranteeId (string) --

          The identifier of the user, group, or resource to which the permissions are granted.

        • GranteeType (string) --

          The type of user, group, or resource referred to in GranteeId.

        • PermissionValues (list) --

          The permissions granted to the grantee. SEND_AS allows the grantee to send email as the owner of the mailbox (the grantee is not mentioned on these emails). SEND_ON_BEHALF allows the grantee to send email on behalf of the owner of the mailbox (the grantee is not mentioned as the physical sender of these emails). FULL_ACCESS allows the grantee full access to the mailbox, irrespective of other folder-level permissions set on the mailbox.

          • (string) --
    • NextToken (string) --

      The token to use to retrieve the next page of results. The value is "null" when there are no more results to return.

Exceptions

list_organizations(**kwargs)

Returns summaries of the customer's organizations.

See also: AWS API Documentation

Request Syntax

response = client.list_organizations(
    NextToken='string',
    MaxResults=123
)
Parameters
  • NextToken (string) -- The token to use to retrieve the next page of results. The first call does not contain any tokens.
  • MaxResults (integer) -- The maximum number of results to return in a single call.
Return type

dict

Returns

Response Syntax

{
    'OrganizationSummaries': [
        {
            'OrganizationId': 'string',
            'Alias': 'string',
            'DefaultMailDomain': 'string',
            'ErrorMessage': 'string',
            'State': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • OrganizationSummaries (list) --

      The overview of owned organizations presented as a list of organization summaries.

      • (dict) --

        The representation of an organization.

        • OrganizationId (string) --

          The identifier associated with the organization.

        • Alias (string) --

          The alias associated with the organization.

        • DefaultMailDomain (string) --

          The default email domain associated with the organization.

        • ErrorMessage (string) --

          The error message associated with the organization. It is only present if unexpected behavior has occurred with regards to the organization. It provides insight or solutions regarding unexpected behavior.

        • State (string) --

          The state associated with the organization.

    • NextToken (string) --

      The token to use to retrieve the next page of results. The value is "null" when there are no more results to return.

Exceptions

list_resource_delegates(**kwargs)

Lists the delegates associated with a resource. Users and groups can be resource delegates and answer requests on behalf of the resource.

See also: AWS API Documentation

Request Syntax

response = client.list_resource_delegates(
    OrganizationId='string',
    ResourceId='string',
    NextToken='string',
    MaxResults=123
)
Parameters
  • OrganizationId (string) --

    [REQUIRED]

    The identifier for the organization that contains the resource for which delegates are listed.

  • ResourceId (string) --

    [REQUIRED]

    The identifier for the resource whose delegates are listed.

  • NextToken (string) -- The token used to paginate through the delegates associated with a resource.
  • MaxResults (integer) -- The number of maximum results in a page.
Return type

dict

Returns

Response Syntax

{
    'Delegates': [
        {
            'Id': 'string',
            'Type': 'GROUP'|'USER'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Delegates (list) --

      One page of the resource's delegates.

      • (dict) --

        The name of the attribute, which is one of the values defined in the UserAttribute enumeration.

        • Id (string) --

          The identifier for the user or group associated as the resource's delegate.

        • Type (string) --

          The type of the delegate: user or group.

    • NextToken (string) --

      The token used to paginate through the delegates associated with a resource. While results are still available, it has an associated value. When the last page is reached, the token is empty.

Exceptions

list_resources(**kwargs)

Returns summaries of the organization's resources.

See also: AWS API Documentation

Request Syntax

response = client.list_resources(
    OrganizationId='string',
    NextToken='string',
    MaxResults=123
)
Parameters
  • OrganizationId (string) --

    [REQUIRED]

    The identifier for the organization under which the resources exist.

  • NextToken (string) -- The token to use to retrieve the next page of results. The first call does not contain any tokens.
  • MaxResults (integer) -- The maximum number of results to return in a single call.
Return type

dict

Returns

Response Syntax

{
    'Resources': [
        {
            'Id': 'string',
            'Email': 'string',
            'Name': 'string',
            'Type': 'ROOM'|'EQUIPMENT',
            'State': 'ENABLED'|'DISABLED'|'DELETED',
            'EnabledDate': datetime(2015, 1, 1),
            'DisabledDate': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Resources (list) --

      One page of the organization's resource representation.

      • (dict) --

        The representation of a resource.

        • Id (string) --

          The identifier of the resource.

        • Email (string) --

          The email of the resource.

        • Name (string) --

          The name of the resource.

        • Type (string) --

          The type of the resource: equipment or room.

        • State (string) --

          The state of the resource, which can be ENABLED, DISABLED, or DELETED.

        • EnabledDate (datetime) --

          The date indicating when the resource was enabled for Amazon WorkMail use.

        • DisabledDate (datetime) --

          The date indicating when the resource was disabled from Amazon WorkMail use.

    • NextToken (string) --

      The token used to paginate through all the organization's resources. While results are still available, it has an associated value. When the last page is reached, the token is empty.

Exceptions

list_tags_for_resource(**kwargs)

Lists the tags applied to an Amazon WorkMail organization resource.

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_resource(
    ResourceARN='string'
)
Parameters
ResourceARN (string) --

[REQUIRED]

The resource ARN.

Return type
dict
Returns
Response Syntax
{
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

  • (dict) --
    • Tags (list) --

      A list of tag key-value pairs.

      • (dict) --

        Describes a tag applied to a resource.

        • Key (string) --

          The key of the tag.

        • Value (string) --

          The value of the tag.

Exceptions

list_users(**kwargs)

Returns summaries of the organization's users.

See also: AWS API Documentation

Request Syntax

response = client.list_users(
    OrganizationId='string',
    NextToken='string',
    MaxResults=123
)
Parameters
  • OrganizationId (string) --

    [REQUIRED]

    The identifier for the organization under which the users exist.

  • NextToken (string) -- The token to use to retrieve the next page of results. The first call does not contain any tokens.
  • MaxResults (integer) -- The maximum number of results to return in a single call.
Return type

dict

Returns

Response Syntax

{
    'Users': [
        {
            'Id': 'string',
            'Email': 'string',
            'Name': 'string',
            'DisplayName': 'string',
            'State': 'ENABLED'|'DISABLED'|'DELETED',
            'UserRole': 'USER'|'RESOURCE'|'SYSTEM_USER',
            'EnabledDate': datetime(2015, 1, 1),
            'DisabledDate': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Users (list) --

      The overview of users for an organization.

      • (dict) --

        The representation of an Amazon WorkMail user.

        • Id (string) --

          The identifier of the user.

        • Email (string) --

          The email of the user.

        • Name (string) --

          The name of the user.

        • DisplayName (string) --

          The display name of the user.

        • State (string) --

          The state of the user, which can be ENABLED, DISABLED, or DELETED.

        • UserRole (string) --

          The role of the user.

        • EnabledDate (datetime) --

          The date indicating when the user was enabled for Amazon WorkMail use.

        • DisabledDate (datetime) --

          The date indicating when the user was disabled from Amazon WorkMail use.

    • NextToken (string) --

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Exceptions

put_access_control_rule(**kwargs)

Adds a new access control rule for the specified organization. The rule allows or denies access to the organization for the specified IPv4 addresses, access protocol actions, and user IDs. Adding a new rule with the same name as an existing rule replaces the older rule.

See also: AWS API Documentation

Request Syntax

response = client.put_access_control_rule(
    Name='string',
    Effect='ALLOW'|'DENY',
    Description='string',
    IpRanges=[
        'string',
    ],
    NotIpRanges=[
        'string',
    ],
    Actions=[
        'string',
    ],
    NotActions=[
        'string',
    ],
    UserIds=[
        'string',
    ],
    NotUserIds=[
        'string',
    ],
    OrganizationId='string'
)
Parameters
  • Name (string) --

    [REQUIRED]

    The rule name.

  • Effect (string) --

    [REQUIRED]

    The rule effect.

  • Description (string) --

    [REQUIRED]

    The rule description.

  • IpRanges (list) --

    IPv4 CIDR ranges to include in the rule.

    • (string) --
  • NotIpRanges (list) --

    IPv4 CIDR ranges to exclude from the rule.

    • (string) --
  • Actions (list) --

    Access protocol actions to include in the rule. Valid values include ActiveSync , AutoDiscover , EWS , IMAP , SMTP , WindowsOutlook , and WebMail .

    • (string) --
  • NotActions (list) --

    Access protocol actions to exclude from the rule. Valid values include ActiveSync , AutoDiscover , EWS , IMAP , SMTP , WindowsOutlook , and WebMail .

    • (string) --
  • UserIds (list) --

    User IDs to include in the rule.

    • (string) --
  • NotUserIds (list) --

    User IDs to exclude from the rule.

    • (string) --
  • OrganizationId (string) --

    [REQUIRED]

    The identifier of the organization.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

put_mailbox_permissions(**kwargs)

Sets permissions for a user, group, or resource. This replaces any pre-existing permissions.

See also: AWS API Documentation

Request Syntax

response = client.put_mailbox_permissions(
    OrganizationId='string',
    EntityId='string',
    GranteeId='string',
    PermissionValues=[
        'FULL_ACCESS'|'SEND_AS'|'SEND_ON_BEHALF',
    ]
)
Parameters
  • OrganizationId (string) --

    [REQUIRED]

    The identifier of the organization under which the user, group, or resource exists.

  • EntityId (string) --

    [REQUIRED]

    The identifier of the user, group, or resource for which to update mailbox permissions.

  • GranteeId (string) --

    [REQUIRED]

    The identifier of the user, group, or resource to which to grant the permissions.

  • PermissionValues (list) --

    [REQUIRED]

    The permissions granted to the grantee. SEND_AS allows the grantee to send email as the owner of the mailbox (the grantee is not mentioned on these emails). SEND_ON_BEHALF allows the grantee to send email on behalf of the owner of the mailbox (the grantee is not mentioned as the physical sender of these emails). FULL_ACCESS allows the grantee full access to the mailbox, irrespective of other folder-level permissions set on the mailbox.

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

put_retention_policy(**kwargs)

Puts a retention policy to the specified organization.

See also: AWS API Documentation

Request Syntax

response = client.put_retention_policy(
    OrganizationId='string',
    Id='string',
    Name='string',
    Description='string',
    FolderConfigurations=[
        {
            'Name': 'INBOX'|'DELETED_ITEMS'|'SENT_ITEMS'|'DRAFTS'|'JUNK_EMAIL',
            'Action': 'NONE'|'DELETE'|'PERMANENTLY_DELETE',
            'Period': 123
        },
    ]
)
Parameters
  • OrganizationId (string) --

    [REQUIRED]

    The organization ID.

  • Id (string) -- The retention policy ID.
  • Name (string) --

    [REQUIRED]

    The retention policy name.

  • Description (string) -- The retention policy description.
  • FolderConfigurations (list) --

    [REQUIRED]

    The retention policy folder configurations.

    • (dict) --

      The configuration applied to an organization's folders by its retention policy.

      • Name (string) -- [REQUIRED]

        The folder name.

      • Action (string) -- [REQUIRED]

        The action to take on the folder contents at the end of the folder configuration period.

      • Period (integer) --

        The period of time at which the folder configuration action is applied.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

register_to_work_mail(**kwargs)

Registers an existing and disabled user, group, or resource for Amazon WorkMail use by associating a mailbox and calendaring capabilities. It performs no change if the user, group, or resource is enabled and fails if the user, group, or resource is deleted. This operation results in the accumulation of costs. For more information, see Pricing . The equivalent console functionality for this operation is Enable .

Users can either be created by calling the CreateUser API operation or they can be synchronized from your directory. For more information, see DeregisterFromWorkMail .

See also: AWS API Documentation

Request Syntax

response = client.register_to_work_mail(
    OrganizationId='string',
    EntityId='string',
    Email='string'
)
Parameters
  • OrganizationId (string) --

    [REQUIRED]

    The identifier for the organization under which the user, group, or resource exists.

  • EntityId (string) --

    [REQUIRED]

    The identifier for the user, group, or resource to be updated.

  • Email (string) --

    [REQUIRED]

    The email for the user, group, or resource to be updated.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

reset_password(**kwargs)

Allows the administrator to reset the password for a user.

See also: AWS API Documentation

Request Syntax

response = client.reset_password(
    OrganizationId='string',
    UserId='string',
    Password='string'
)
Parameters
  • OrganizationId (string) --

    [REQUIRED]

    The identifier of the organization that contains the user for which the password is reset.

  • UserId (string) --

    [REQUIRED]

    The identifier of the user for whom the password is reset.

  • Password (string) --

    [REQUIRED]

    The new password for the user.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

start_mailbox_export_job(**kwargs)

Starts a mailbox export job to export MIME-format email messages and calendar items from the specified mailbox to the specified Amazon Simple Storage Service (Amazon S3) bucket. For more information, see Exporting mailbox content in the Amazon WorkMail Administrator Guide .

See also: AWS API Documentation

Request Syntax

response = client.start_mailbox_export_job(
    ClientToken='string',
    OrganizationId='string',
    EntityId='string',
    Description='string',
    RoleArn='string',
    KmsKeyArn='string',
    S3BucketName='string',
    S3Prefix='string'
)
Parameters
  • ClientToken (string) --

    [REQUIRED]

    The idempotency token for the client request.

    This field is autopopulated if not provided.

  • OrganizationId (string) --

    [REQUIRED]

    The identifier associated with the organization.

  • EntityId (string) --

    [REQUIRED]

    The identifier of the user or resource associated with the mailbox.

  • Description (string) -- The mailbox export job description.
  • RoleArn (string) --

    [REQUIRED]

    The ARN of the AWS Identity and Access Management (IAM) role that grants write permission to the S3 bucket.

  • KmsKeyArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the symmetric AWS Key Management Service (AWS KMS) key that encrypts the exported mailbox content.

  • S3BucketName (string) --

    [REQUIRED]

    The name of the S3 bucket.

  • S3Prefix (string) --

    [REQUIRED]

    The S3 bucket prefix.

Return type

dict

Returns

Response Syntax

{
    'JobId': 'string'
}

Response Structure

  • (dict) --

    • JobId (string) --

      The job ID.

Exceptions

tag_resource(**kwargs)

Applies the specified tags to the specified Amazon WorkMail organization resource.

See also: AWS API Documentation

Request Syntax

response = client.tag_resource(
    ResourceARN='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • ResourceARN (string) --

    [REQUIRED]

    The resource ARN.

  • Tags (list) --

    [REQUIRED]

    The tag key-value pairs.

    • (dict) --

      Describes a tag applied to a resource.

      • Key (string) -- [REQUIRED]

        The key of the tag.

      • Value (string) -- [REQUIRED]

        The value of the tag.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

untag_resource(**kwargs)

Untags the specified tags from the specified Amazon WorkMail organization resource.

See also: AWS API Documentation

Request Syntax

response = client.untag_resource(
    ResourceARN='string',
    TagKeys=[
        'string',
    ]
)
Parameters
  • ResourceARN (string) --

    [REQUIRED]

    The resource ARN.

  • TagKeys (list) --

    [REQUIRED]

    The tag keys.

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

update_mailbox_quota(**kwargs)

Updates a user's current mailbox quota for a specified organization and user.

See also: AWS API Documentation

Request Syntax

response = client.update_mailbox_quota(
    OrganizationId='string',
    UserId='string',
    MailboxQuota=123
)
Parameters
  • OrganizationId (string) --

    [REQUIRED]

    The identifier for the organization that contains the user for whom to update the mailbox quota.

  • UserId (string) --

    [REQUIRED]

    The identifer for the user for whom to update the mailbox quota.

  • MailboxQuota (integer) --

    [REQUIRED]

    The updated mailbox quota, in MB, for the specified user.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

update_primary_email_address(**kwargs)

Updates the primary email for a user, group, or resource. The current email is moved into the list of aliases (or swapped between an existing alias and the current primary email), and the email provided in the input is promoted as the primary.

See also: AWS API Documentation

Request Syntax

response = client.update_primary_email_address(
    OrganizationId='string',
    EntityId='string',
    Email='string'
)
Parameters
  • OrganizationId (string) --

    [REQUIRED]

    The organization that contains the user, group, or resource to update.

  • EntityId (string) --

    [REQUIRED]

    The user, group, or resource to update.

  • Email (string) --

    [REQUIRED]

    The value of the email to be updated as primary.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

update_resource(**kwargs)

Updates data for the resource. To have the latest information, it must be preceded by a DescribeResource call. The dataset in the request should be the one expected when performing another DescribeResource call.

See also: AWS API Documentation

Request Syntax

response = client.update_resource(
    OrganizationId='string',
    ResourceId='string',
    Name='string',
    BookingOptions={
        'AutoAcceptRequests': True|False,
        'AutoDeclineRecurringRequests': True|False,
        'AutoDeclineConflictingRequests': True|False
    }
)
Parameters
  • OrganizationId (string) --

    [REQUIRED]

    The identifier associated with the organization for which the resource is updated.

  • ResourceId (string) --

    [REQUIRED]

    The identifier of the resource to be updated.

  • Name (string) -- The name of the resource to be updated.
  • BookingOptions (dict) --

    The resource's booking options to be updated.

    • AutoAcceptRequests (boolean) --

      The resource's ability to automatically reply to requests. If disabled, delegates must be associated to the resource.

    • AutoDeclineRecurringRequests (boolean) --

      The resource's ability to automatically decline any recurring requests.

    • AutoDeclineConflictingRequests (boolean) --

      The resource's ability to automatically decline any conflicting requests.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

Client Exceptions

Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.

The available client exceptions are:

class WorkMail.Client.exceptions.DirectoryInUseException

The directory is already in use by another WorkMail organization in the same account and Region.

Example

try:
  ...
except client.exceptions.DirectoryInUseException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The directory is already in use by another WorkMail organization in the same account and Region.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class WorkMail.Client.exceptions.DirectoryServiceAuthenticationFailedException

The directory service doesn't recognize the credentials supplied by WorkMail.

Example

try:
  ...
except client.exceptions.DirectoryServiceAuthenticationFailedException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The directory service doesn't recognize the credentials supplied by WorkMail.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class WorkMail.Client.exceptions.DirectoryUnavailableException

The directory is unavailable. It might be located in another Region or deleted.

Example

try:
  ...
except client.exceptions.DirectoryUnavailableException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The directory is unavailable. It might be located in another Region or deleted.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class WorkMail.Client.exceptions.EmailAddressInUseException

The email address that you're trying to assign is already created for a different user, group, or resource.

Example

try:
  ...
except client.exceptions.EmailAddressInUseException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The email address that you're trying to assign is already created for a different user, group, or resource.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class WorkMail.Client.exceptions.EntityAlreadyRegisteredException

The user, group, or resource that you're trying to register is already registered.

Example

try:
  ...
except client.exceptions.EntityAlreadyRegisteredException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The user, group, or resource that you're trying to register is already registered.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class WorkMail.Client.exceptions.EntityNotFoundException

The identifier supplied for the user, group, or resource does not exist in your organization.

Example

try:
  ...
except client.exceptions.EntityNotFoundException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The identifier supplied for the user, group, or resource does not exist in your organization.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class WorkMail.Client.exceptions.EntityStateException

You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.

Example

try:
  ...
except client.exceptions.EntityStateException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class WorkMail.Client.exceptions.InvalidConfigurationException

The configuration for a resource isn't valid. A resource must either be able to auto-respond to requests or have at least one delegate associated that can do so on its behalf.

Example

try:
  ...
except client.exceptions.InvalidConfigurationException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The configuration for a resource isn't valid. A resource must either be able to auto-respond to requests or have at least one delegate associated that can do so on its behalf.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class WorkMail.Client.exceptions.InvalidParameterException

One or more of the input parameters don't match the service's restrictions.

Example

try:
  ...
except client.exceptions.InvalidParameterException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    One or more of the input parameters don't match the service's restrictions.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class WorkMail.Client.exceptions.InvalidPasswordException

The supplied password doesn't match the minimum security constraints, such as length or use of special characters.

Example

try:
  ...
except client.exceptions.InvalidPasswordException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The supplied password doesn't match the minimum security constraints, such as length or use of special characters.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class WorkMail.Client.exceptions.LimitExceededException

The request exceeds the limit of the resource.

Example

try:
  ...
except client.exceptions.LimitExceededException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The request exceeds the limit of the resource.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class WorkMail.Client.exceptions.MailDomainNotFoundException

For an email or alias to be created in Amazon WorkMail, the included domain must be defined in the organization.

Example

try:
  ...
except client.exceptions.MailDomainNotFoundException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    For an email or alias to be created in Amazon WorkMail, the included domain must be defined in the organization.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class WorkMail.Client.exceptions.MailDomainStateException

After a domain has been added to the organization, it must be verified. The domain is not yet verified.

Example

try:
  ...
except client.exceptions.MailDomainStateException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    After a domain has been added to the organization, it must be verified. The domain is not yet verified.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class WorkMail.Client.exceptions.NameAvailabilityException

The user, group, or resource name isn't unique in Amazon WorkMail.

Example

try:
  ...
except client.exceptions.NameAvailabilityException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The user, group, or resource name isn't unique in Amazon WorkMail.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class WorkMail.Client.exceptions.OrganizationNotFoundException

An operation received a valid organization identifier that either doesn't belong or exist in the system.

Example

try:
  ...
except client.exceptions.OrganizationNotFoundException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    An operation received a valid organization identifier that either doesn't belong or exist in the system.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class WorkMail.Client.exceptions.OrganizationStateException

The organization must have a valid state to perform certain operations on the organization or its members.

Example

try:
  ...
except client.exceptions.OrganizationStateException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The organization must have a valid state to perform certain operations on the organization or its members.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class WorkMail.Client.exceptions.ReservedNameException

This user, group, or resource name is not allowed in Amazon WorkMail.

Example

try:
  ...
except client.exceptions.ReservedNameException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    This user, group, or resource name is not allowed in Amazon WorkMail.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class WorkMail.Client.exceptions.ResourceNotFoundException

The resource cannot be found.

Example

try:
  ...
except client.exceptions.ResourceNotFoundException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The resource cannot be found.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class WorkMail.Client.exceptions.TooManyTagsException

The resource can have up to 50 user-applied tags.

Example

try:
  ...
except client.exceptions.TooManyTagsException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The resource can have up to 50 user-applied tags.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class WorkMail.Client.exceptions.UnsupportedOperationException

You can't perform a write operation against a read-only directory.

Example

try:
  ...
except client.exceptions.UnsupportedOperationException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    You can't perform a write operation against a read-only directory.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.

Paginators

The available paginators are:

class WorkMail.Paginator.ListAliases
paginator = client.get_paginator('list_aliases')
paginate(**kwargs)

Creates an iterator that will paginate through responses from WorkMail.Client.list_aliases().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    OrganizationId='string',
    EntityId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • OrganizationId (string) --

    [REQUIRED]

    The identifier for the organization under which the entity exists.

  • EntityId (string) --

    [REQUIRED]

    The identifier for the entity for which to list the aliases.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Aliases': [
        'string',
    ],

}

Response Structure

  • (dict) --

    • Aliases (list) --

      The entity's paginated aliases.

      • (string) --

class WorkMail.Paginator.ListGroupMembers
paginator = client.get_paginator('list_group_members')
paginate(**kwargs)

Creates an iterator that will paginate through responses from WorkMail.Client.list_group_members().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    OrganizationId='string',
    GroupId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • OrganizationId (string) --

    [REQUIRED]

    The identifier for the organization under which the group exists.

  • GroupId (string) --

    [REQUIRED]

    The identifier for the group to which the members (users or groups) are associated.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Members': [
        {
            'Id': 'string',
            'Name': 'string',
            'Type': 'GROUP'|'USER',
            'State': 'ENABLED'|'DISABLED'|'DELETED',
            'EnabledDate': datetime(2015, 1, 1),
            'DisabledDate': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

  • (dict) --

    • Members (list) --

      The members associated to the group.

      • (dict) --

        The representation of a user or group.

        • Id (string) --

          The identifier of the member.

        • Name (string) --

          The name of the member.

        • Type (string) --

          A member can be a user or group.

        • State (string) --

          The state of the member, which can be ENABLED, DISABLED, or DELETED.

        • EnabledDate (datetime) --

          The date indicating when the member was enabled for Amazon WorkMail use.

        • DisabledDate (datetime) --

          The date indicating when the member was disabled from Amazon WorkMail use.

class WorkMail.Paginator.ListGroups
paginator = client.get_paginator('list_groups')
paginate(**kwargs)

Creates an iterator that will paginate through responses from WorkMail.Client.list_groups().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    OrganizationId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • OrganizationId (string) --

    [REQUIRED]

    The identifier for the organization under which the groups exist.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Groups': [
        {
            'Id': 'string',
            'Email': 'string',
            'Name': 'string',
            'State': 'ENABLED'|'DISABLED'|'DELETED',
            'EnabledDate': datetime(2015, 1, 1),
            'DisabledDate': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

  • (dict) --

    • Groups (list) --

      The overview of groups for an organization.

      • (dict) --

        The representation of an Amazon WorkMail group.

        • Id (string) --

          The identifier of the group.

        • Email (string) --

          The email of the group.

        • Name (string) --

          The name of the group.

        • State (string) --

          The state of the group, which can be ENABLED, DISABLED, or DELETED.

        • EnabledDate (datetime) --

          The date indicating when the group was enabled for Amazon WorkMail use.

        • DisabledDate (datetime) --

          The date indicating when the group was disabled from Amazon WorkMail use.

class WorkMail.Paginator.ListMailboxPermissions
paginator = client.get_paginator('list_mailbox_permissions')
paginate(**kwargs)

Creates an iterator that will paginate through responses from WorkMail.Client.list_mailbox_permissions().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    OrganizationId='string',
    EntityId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • OrganizationId (string) --

    [REQUIRED]

    The identifier of the organization under which the user, group, or resource exists.

  • EntityId (string) --

    [REQUIRED]

    The identifier of the user, group, or resource for which to list mailbox permissions.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Permissions': [
        {
            'GranteeId': 'string',
            'GranteeType': 'GROUP'|'USER',
            'PermissionValues': [
                'FULL_ACCESS'|'SEND_AS'|'SEND_ON_BEHALF',
            ]
        },
    ],

}

Response Structure

  • (dict) --

    • Permissions (list) --

      One page of the user, group, or resource mailbox permissions.

      • (dict) --

        Permission granted to a user, group, or resource to access a certain aspect of another user, group, or resource mailbox.

        • GranteeId (string) --

          The identifier of the user, group, or resource to which the permissions are granted.

        • GranteeType (string) --

          The type of user, group, or resource referred to in GranteeId.

        • PermissionValues (list) --

          The permissions granted to the grantee. SEND_AS allows the grantee to send email as the owner of the mailbox (the grantee is not mentioned on these emails). SEND_ON_BEHALF allows the grantee to send email on behalf of the owner of the mailbox (the grantee is not mentioned as the physical sender of these emails). FULL_ACCESS allows the grantee full access to the mailbox, irrespective of other folder-level permissions set on the mailbox.

          • (string) --

class WorkMail.Paginator.ListOrganizations
paginator = client.get_paginator('list_organizations')
paginate(**kwargs)

Creates an iterator that will paginate through responses from WorkMail.Client.list_organizations().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type
dict
Returns
Response Syntax
{
    'OrganizationSummaries': [
        {
            'OrganizationId': 'string',
            'Alias': 'string',
            'DefaultMailDomain': 'string',
            'ErrorMessage': 'string',
            'State': 'string'
        },
    ],

}

Response Structure

  • (dict) --
    • OrganizationSummaries (list) --

      The overview of owned organizations presented as a list of organization summaries.

      • (dict) --

        The representation of an organization.

        • OrganizationId (string) --

          The identifier associated with the organization.

        • Alias (string) --

          The alias associated with the organization.

        • DefaultMailDomain (string) --

          The default email domain associated with the organization.

        • ErrorMessage (string) --

          The error message associated with the organization. It is only present if unexpected behavior has occurred with regards to the organization. It provides insight or solutions regarding unexpected behavior.

        • State (string) --

          The state associated with the organization.

class WorkMail.Paginator.ListResourceDelegates
paginator = client.get_paginator('list_resource_delegates')
paginate(**kwargs)

Creates an iterator that will paginate through responses from WorkMail.Client.list_resource_delegates().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    OrganizationId='string',
    ResourceId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • OrganizationId (string) --

    [REQUIRED]

    The identifier for the organization that contains the resource for which delegates are listed.

  • ResourceId (string) --

    [REQUIRED]

    The identifier for the resource whose delegates are listed.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Delegates': [
        {
            'Id': 'string',
            'Type': 'GROUP'|'USER'
        },
    ],

}

Response Structure

  • (dict) --

    • Delegates (list) --

      One page of the resource's delegates.

      • (dict) --

        The name of the attribute, which is one of the values defined in the UserAttribute enumeration.

        • Id (string) --

          The identifier for the user or group associated as the resource's delegate.

        • Type (string) --

          The type of the delegate: user or group.

class WorkMail.Paginator.ListResources
paginator = client.get_paginator('list_resources')
paginate(**kwargs)

Creates an iterator that will paginate through responses from WorkMail.Client.list_resources().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    OrganizationId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • OrganizationId (string) --

    [REQUIRED]

    The identifier for the organization under which the resources exist.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Resources': [
        {
            'Id': 'string',
            'Email': 'string',
            'Name': 'string',
            'Type': 'ROOM'|'EQUIPMENT',
            'State': 'ENABLED'|'DISABLED'|'DELETED',
            'EnabledDate': datetime(2015, 1, 1),
            'DisabledDate': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

  • (dict) --

    • Resources (list) --

      One page of the organization's resource representation.

      • (dict) --

        The representation of a resource.

        • Id (string) --

          The identifier of the resource.

        • Email (string) --

          The email of the resource.

        • Name (string) --

          The name of the resource.

        • Type (string) --

          The type of the resource: equipment or room.

        • State (string) --

          The state of the resource, which can be ENABLED, DISABLED, or DELETED.

        • EnabledDate (datetime) --

          The date indicating when the resource was enabled for Amazon WorkMail use.

        • DisabledDate (datetime) --

          The date indicating when the resource was disabled from Amazon WorkMail use.

class WorkMail.Paginator.ListUsers
paginator = client.get_paginator('list_users')
paginate(**kwargs)

Creates an iterator that will paginate through responses from WorkMail.Client.list_users().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    OrganizationId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • OrganizationId (string) --

    [REQUIRED]

    The identifier for the organization under which the users exist.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Users': [
        {
            'Id': 'string',
            'Email': 'string',
            'Name': 'string',
            'DisplayName': 'string',
            'State': 'ENABLED'|'DISABLED'|'DELETED',
            'UserRole': 'USER'|'RESOURCE'|'SYSTEM_USER',
            'EnabledDate': datetime(2015, 1, 1),
            'DisabledDate': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

  • (dict) --

    • Users (list) --

      The overview of users for an organization.

      • (dict) --

        The representation of an Amazon WorkMail user.

        • Id (string) --

          The identifier of the user.

        • Email (string) --

          The email of the user.

        • Name (string) --

          The name of the user.

        • DisplayName (string) --

          The display name of the user.

        • State (string) --

          The state of the user, which can be ENABLED, DISABLED, or DELETED.

        • UserRole (string) --

          The role of the user.

        • EnabledDate (datetime) --

          The date indicating when the user was enabled for Amazon WorkMail use.

        • DisabledDate (datetime) --

          The date indicating when the user was disabled from Amazon WorkMail use.