WorkMail

Table of Contents

Client

class WorkMail.Client

A low-level client representing Amazon WorkMail:

import boto3

client = boto3.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) --

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) --

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.
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) --

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.

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.

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.

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) --

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) --

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) --

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) --

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) --

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) --

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.

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'
}

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.

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) or disabled (deregistered or never registered to WorkMail).

    • 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.

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.

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) --

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) --

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_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_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.

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.

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.

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.

list_organizations(**kwargs)

Returns summaries of the customer's non-deleted 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',
            '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.

        • 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.

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.

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.

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.

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) --

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) --

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) --

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) --

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) --

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',
            '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.

        • 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.