Skip to content

WorkMailClient#

Index > WorkMail > WorkMailClient

Auto-generated documentation for WorkMail type annotations stubs module mypy-boto3-workmail.

WorkMailClient#

Type annotations and code completion for boto3.client("workmail"). boto3 documentation

# WorkMailClient usage example

from boto3.session import Session
from mypy_boto3_workmail.client import WorkMailClient

def get_workmail_client() -> WorkMailClient:
    return Session().client("workmail")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("workmail").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("workmail")

try:
    do_something(client)
except (
    client.exceptions.ClientError,
    client.exceptions.DirectoryInUseException,
    client.exceptions.DirectoryServiceAuthenticationFailedException,
    client.exceptions.DirectoryUnavailableException,
    client.exceptions.EmailAddressInUseException,
    client.exceptions.EntityAlreadyRegisteredException,
    client.exceptions.EntityNotFoundException,
    client.exceptions.EntityStateException,
    client.exceptions.InvalidConfigurationException,
    client.exceptions.InvalidCustomSesConfigurationException,
    client.exceptions.InvalidParameterException,
    client.exceptions.InvalidPasswordException,
    client.exceptions.LimitExceededException,
    client.exceptions.MailDomainInUseException,
    client.exceptions.MailDomainNotFoundException,
    client.exceptions.MailDomainStateException,
    client.exceptions.NameAvailabilityException,
    client.exceptions.OrganizationNotFoundException,
    client.exceptions.OrganizationStateException,
    client.exceptions.ReservedNameException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.TooManyTagsException,
    client.exceptions.UnsupportedOperationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_workmail.client import Exceptions

def handle_error(exc: Exceptions.ClientError) -> None:
    ...

Methods#

can_paginate#

Type annotations and code completion for boto3.client("workmail").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url#

Type annotations and code completion for boto3.client("workmail").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

associate_delegate_to_resource#

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

Type annotations and code completion for boto3.client("workmail").associate_delegate_to_resource method. boto3 documentation

# associate_delegate_to_resource method definition

def associate_delegate_to_resource(
    self,
    *,
    OrganizationId: str,
    ResourceId: str,
    EntityId: str,
) -> Dict[str, Any]:
    ...
# associate_delegate_to_resource method usage example with argument unpacking

kwargs: AssociateDelegateToResourceRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "ResourceId": ...,
    "EntityId": ...,
}

parent.associate_delegate_to_resource(**kwargs)
  1. See AssociateDelegateToResourceRequestTypeDef

associate_member_to_group#

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

Type annotations and code completion for boto3.client("workmail").associate_member_to_group method. boto3 documentation

# associate_member_to_group method definition

def associate_member_to_group(
    self,
    *,
    OrganizationId: str,
    GroupId: str,
    MemberId: str,
) -> Dict[str, Any]:
    ...
# associate_member_to_group method usage example with argument unpacking

kwargs: AssociateMemberToGroupRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "GroupId": ...,
    "MemberId": ...,
}

parent.associate_member_to_group(**kwargs)
  1. See AssociateMemberToGroupRequestTypeDef

assume_impersonation_role#

Assumes an impersonation role for the given WorkMail organization.

Type annotations and code completion for boto3.client("workmail").assume_impersonation_role method. boto3 documentation

# assume_impersonation_role method definition

def assume_impersonation_role(
    self,
    *,
    OrganizationId: str,
    ImpersonationRoleId: str,
) -> AssumeImpersonationRoleResponseTypeDef:  # (1)
    ...
  1. See AssumeImpersonationRoleResponseTypeDef
# assume_impersonation_role method usage example with argument unpacking

kwargs: AssumeImpersonationRoleRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "ImpersonationRoleId": ...,
}

parent.assume_impersonation_role(**kwargs)
  1. See AssumeImpersonationRoleRequestTypeDef

cancel_mailbox_export_job#

Cancels a mailbox export job.

Type annotations and code completion for boto3.client("workmail").cancel_mailbox_export_job method. boto3 documentation

# cancel_mailbox_export_job method definition

def cancel_mailbox_export_job(
    self,
    *,
    ClientToken: str,
    JobId: str,
    OrganizationId: str,
) -> Dict[str, Any]:
    ...
# cancel_mailbox_export_job method usage example with argument unpacking

kwargs: CancelMailboxExportJobRequestTypeDef = {  # (1)
    "ClientToken": ...,
    "JobId": ...,
    "OrganizationId": ...,
}

parent.cancel_mailbox_export_job(**kwargs)
  1. See CancelMailboxExportJobRequestTypeDef

create_alias#

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

Type annotations and code completion for boto3.client("workmail").create_alias method. boto3 documentation

# create_alias method definition

def create_alias(
    self,
    *,
    OrganizationId: str,
    EntityId: str,
    Alias: str,
) -> Dict[str, Any]:
    ...
# create_alias method usage example with argument unpacking

kwargs: CreateAliasRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "EntityId": ...,
    "Alias": ...,
}

parent.create_alias(**kwargs)
  1. See CreateAliasRequestTypeDef

create_availability_configuration#

Creates an AvailabilityConfiguration for the given WorkMail organization and domain.

Type annotations and code completion for boto3.client("workmail").create_availability_configuration method. boto3 documentation

# create_availability_configuration method definition

def create_availability_configuration(
    self,
    *,
    OrganizationId: str,
    DomainName: str,
    ClientToken: str = ...,
    EwsProvider: EwsAvailabilityProviderTypeDef = ...,  # (1)
    LambdaProvider: LambdaAvailabilityProviderTypeDef = ...,  # (2)
) -> Dict[str, Any]:
    ...
  1. See EwsAvailabilityProviderTypeDef
  2. See LambdaAvailabilityProviderTypeDef
# create_availability_configuration method usage example with argument unpacking

kwargs: CreateAvailabilityConfigurationRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "DomainName": ...,
}

parent.create_availability_configuration(**kwargs)
  1. See CreateAvailabilityConfigurationRequestTypeDef

create_group#

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

Type annotations and code completion for boto3.client("workmail").create_group method. boto3 documentation

# create_group method definition

def create_group(
    self,
    *,
    OrganizationId: str,
    Name: str,
    HiddenFromGlobalAddressList: bool = ...,
) -> CreateGroupResponseTypeDef:  # (1)
    ...
  1. See CreateGroupResponseTypeDef
# create_group method usage example with argument unpacking

kwargs: CreateGroupRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "Name": ...,
}

parent.create_group(**kwargs)
  1. See CreateGroupRequestTypeDef

create_identity_center_application#

Creates the WorkMail application in IAM Identity Center that can be used later in the WorkMail - IdC integration.

Type annotations and code completion for boto3.client("workmail").create_identity_center_application method. boto3 documentation

# create_identity_center_application method definition

def create_identity_center_application(
    self,
    *,
    Name: str,
    InstanceArn: str,
    ClientToken: str = ...,
) -> CreateIdentityCenterApplicationResponseTypeDef:  # (1)
    ...
  1. See CreateIdentityCenterApplicationResponseTypeDef
# create_identity_center_application method usage example with argument unpacking

kwargs: CreateIdentityCenterApplicationRequestTypeDef = {  # (1)
    "Name": ...,
    "InstanceArn": ...,
}

parent.create_identity_center_application(**kwargs)
  1. See CreateIdentityCenterApplicationRequestTypeDef

create_impersonation_role#

Creates an impersonation role for the given WorkMail organization.

Type annotations and code completion for boto3.client("workmail").create_impersonation_role method. boto3 documentation

# create_impersonation_role method definition

def create_impersonation_role(
    self,
    *,
    OrganizationId: str,
    Name: str,
    Type: ImpersonationRoleTypeType,  # (1)
    Rules: Sequence[ImpersonationRuleUnionTypeDef],  # (2)
    ClientToken: str = ...,
    Description: str = ...,
) -> CreateImpersonationRoleResponseTypeDef:  # (3)
    ...
  1. See ImpersonationRoleTypeType
  2. See Sequence[ImpersonationRuleUnionTypeDef]
  3. See CreateImpersonationRoleResponseTypeDef
# create_impersonation_role method usage example with argument unpacking

kwargs: CreateImpersonationRoleRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "Name": ...,
    "Type": ...,
    "Rules": ...,
}

parent.create_impersonation_role(**kwargs)
  1. See CreateImpersonationRoleRequestTypeDef

create_mobile_device_access_rule#

Creates a new mobile device access rule for the specified WorkMail organization.

Type annotations and code completion for boto3.client("workmail").create_mobile_device_access_rule method. boto3 documentation

# create_mobile_device_access_rule method definition

def create_mobile_device_access_rule(
    self,
    *,
    OrganizationId: str,
    Name: str,
    Effect: MobileDeviceAccessRuleEffectType,  # (1)
    ClientToken: str = ...,
    Description: str = ...,
    DeviceTypes: Sequence[str] = ...,
    NotDeviceTypes: Sequence[str] = ...,
    DeviceModels: Sequence[str] = ...,
    NotDeviceModels: Sequence[str] = ...,
    DeviceOperatingSystems: Sequence[str] = ...,
    NotDeviceOperatingSystems: Sequence[str] = ...,
    DeviceUserAgents: Sequence[str] = ...,
    NotDeviceUserAgents: Sequence[str] = ...,
) -> CreateMobileDeviceAccessRuleResponseTypeDef:  # (2)
    ...
  1. See MobileDeviceAccessRuleEffectType
  2. See CreateMobileDeviceAccessRuleResponseTypeDef
# create_mobile_device_access_rule method usage example with argument unpacking

kwargs: CreateMobileDeviceAccessRuleRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "Name": ...,
    "Effect": ...,
}

parent.create_mobile_device_access_rule(**kwargs)
  1. See CreateMobileDeviceAccessRuleRequestTypeDef

create_organization#

Creates a new WorkMail organization.

Type annotations and code completion for boto3.client("workmail").create_organization method. boto3 documentation

# create_organization method definition

def create_organization(
    self,
    *,
    Alias: str,
    DirectoryId: str = ...,
    ClientToken: str = ...,
    Domains: Sequence[DomainTypeDef] = ...,  # (1)
    KmsKeyArn: str = ...,
    EnableInteroperability: bool = ...,
) -> CreateOrganizationResponseTypeDef:  # (2)
    ...
  1. See Sequence[DomainTypeDef]
  2. See CreateOrganizationResponseTypeDef
# create_organization method usage example with argument unpacking

kwargs: CreateOrganizationRequestTypeDef = {  # (1)
    "Alias": ...,
}

parent.create_organization(**kwargs)
  1. See CreateOrganizationRequestTypeDef

create_resource#

Creates a new WorkMail resource.

Type annotations and code completion for boto3.client("workmail").create_resource method. boto3 documentation

# create_resource method definition

def create_resource(
    self,
    *,
    OrganizationId: str,
    Name: str,
    Type: ResourceTypeType,  # (1)
    Description: str = ...,
    HiddenFromGlobalAddressList: bool = ...,
) -> CreateResourceResponseTypeDef:  # (2)
    ...
  1. See ResourceTypeType
  2. See CreateResourceResponseTypeDef
# create_resource method usage example with argument unpacking

kwargs: CreateResourceRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "Name": ...,
    "Type": ...,
}

parent.create_resource(**kwargs)
  1. See CreateResourceRequestTypeDef

create_user#

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

Type annotations and code completion for boto3.client("workmail").create_user method. boto3 documentation

# create_user method definition

def create_user(
    self,
    *,
    OrganizationId: str,
    Name: str,
    DisplayName: str,
    Password: str = ...,
    Role: UserRoleType = ...,  # (1)
    FirstName: str = ...,
    LastName: str = ...,
    HiddenFromGlobalAddressList: bool = ...,
    IdentityProviderUserId: str = ...,
) -> CreateUserResponseTypeDef:  # (2)
    ...
  1. See UserRoleType
  2. See CreateUserResponseTypeDef
# create_user method usage example with argument unpacking

kwargs: CreateUserRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "Name": ...,
    "DisplayName": ...,
}

parent.create_user(**kwargs)
  1. See CreateUserRequestTypeDef

delete_access_control_rule#

Deletes an access control rule for the specified WorkMail organization.

Type annotations and code completion for boto3.client("workmail").delete_access_control_rule method. boto3 documentation

# delete_access_control_rule method definition

def delete_access_control_rule(
    self,
    *,
    OrganizationId: str,
    Name: str,
) -> Dict[str, Any]:
    ...
# delete_access_control_rule method usage example with argument unpacking

kwargs: DeleteAccessControlRuleRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "Name": ...,
}

parent.delete_access_control_rule(**kwargs)
  1. See DeleteAccessControlRuleRequestTypeDef

delete_alias#

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

Type annotations and code completion for boto3.client("workmail").delete_alias method. boto3 documentation

# delete_alias method definition

def delete_alias(
    self,
    *,
    OrganizationId: str,
    EntityId: str,
    Alias: str,
) -> Dict[str, Any]:
    ...
# delete_alias method usage example with argument unpacking

kwargs: DeleteAliasRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "EntityId": ...,
    "Alias": ...,
}

parent.delete_alias(**kwargs)
  1. See DeleteAliasRequestTypeDef

delete_availability_configuration#

Deletes the AvailabilityConfiguration for the given WorkMail organization and domain.

Type annotations and code completion for boto3.client("workmail").delete_availability_configuration method. boto3 documentation

# delete_availability_configuration method definition

def delete_availability_configuration(
    self,
    *,
    OrganizationId: str,
    DomainName: str,
) -> Dict[str, Any]:
    ...
# delete_availability_configuration method usage example with argument unpacking

kwargs: DeleteAvailabilityConfigurationRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "DomainName": ...,
}

parent.delete_availability_configuration(**kwargs)
  1. See DeleteAvailabilityConfigurationRequestTypeDef

delete_email_monitoring_configuration#

Deletes the email monitoring configuration for a specified organization.

Type annotations and code completion for boto3.client("workmail").delete_email_monitoring_configuration method. boto3 documentation

# delete_email_monitoring_configuration method definition

def delete_email_monitoring_configuration(
    self,
    *,
    OrganizationId: str,
) -> Dict[str, Any]:
    ...
# delete_email_monitoring_configuration method usage example with argument unpacking

kwargs: DeleteEmailMonitoringConfigurationRequestTypeDef = {  # (1)
    "OrganizationId": ...,
}

parent.delete_email_monitoring_configuration(**kwargs)
  1. See DeleteEmailMonitoringConfigurationRequestTypeDef

delete_group#

Deletes a group from WorkMail.

Type annotations and code completion for boto3.client("workmail").delete_group method. boto3 documentation

# delete_group method definition

def delete_group(
    self,
    *,
    OrganizationId: str,
    GroupId: str,
) -> Dict[str, Any]:
    ...
# delete_group method usage example with argument unpacking

kwargs: DeleteGroupRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "GroupId": ...,
}

parent.delete_group(**kwargs)
  1. See DeleteGroupRequestTypeDef

delete_identity_center_application#

Deletes the IAM Identity Center application from WorkMail.

Type annotations and code completion for boto3.client("workmail").delete_identity_center_application method. boto3 documentation

# delete_identity_center_application method definition

def delete_identity_center_application(
    self,
    *,
    ApplicationArn: str,
) -> Dict[str, Any]:
    ...
# delete_identity_center_application method usage example with argument unpacking

kwargs: DeleteIdentityCenterApplicationRequestTypeDef = {  # (1)
    "ApplicationArn": ...,
}

parent.delete_identity_center_application(**kwargs)
  1. See DeleteIdentityCenterApplicationRequestTypeDef

delete_identity_provider_configuration#

Disables the integration between IdC and WorkMail.

Type annotations and code completion for boto3.client("workmail").delete_identity_provider_configuration method. boto3 documentation

# delete_identity_provider_configuration method definition

def delete_identity_provider_configuration(
    self,
    *,
    OrganizationId: str,
) -> Dict[str, Any]:
    ...
# delete_identity_provider_configuration method usage example with argument unpacking

kwargs: DeleteIdentityProviderConfigurationRequestTypeDef = {  # (1)
    "OrganizationId": ...,
}

parent.delete_identity_provider_configuration(**kwargs)
  1. See DeleteIdentityProviderConfigurationRequestTypeDef

delete_impersonation_role#

Deletes an impersonation role for the given WorkMail organization.

Type annotations and code completion for boto3.client("workmail").delete_impersonation_role method. boto3 documentation

# delete_impersonation_role method definition

def delete_impersonation_role(
    self,
    *,
    OrganizationId: str,
    ImpersonationRoleId: str,
) -> Dict[str, Any]:
    ...
# delete_impersonation_role method usage example with argument unpacking

kwargs: DeleteImpersonationRoleRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "ImpersonationRoleId": ...,
}

parent.delete_impersonation_role(**kwargs)
  1. See DeleteImpersonationRoleRequestTypeDef

delete_mailbox_permissions#

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

Type annotations and code completion for boto3.client("workmail").delete_mailbox_permissions method. boto3 documentation

# delete_mailbox_permissions method definition

def delete_mailbox_permissions(
    self,
    *,
    OrganizationId: str,
    EntityId: str,
    GranteeId: str,
) -> Dict[str, Any]:
    ...
# delete_mailbox_permissions method usage example with argument unpacking

kwargs: DeleteMailboxPermissionsRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "EntityId": ...,
    "GranteeId": ...,
}

parent.delete_mailbox_permissions(**kwargs)
  1. See DeleteMailboxPermissionsRequestTypeDef

delete_mobile_device_access_override#

Deletes the mobile device access override for the given WorkMail organization, user, and device.

Type annotations and code completion for boto3.client("workmail").delete_mobile_device_access_override method. boto3 documentation

# delete_mobile_device_access_override method definition

def delete_mobile_device_access_override(
    self,
    *,
    OrganizationId: str,
    UserId: str,
    DeviceId: str,
) -> Dict[str, Any]:
    ...
# delete_mobile_device_access_override method usage example with argument unpacking

kwargs: DeleteMobileDeviceAccessOverrideRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "UserId": ...,
    "DeviceId": ...,
}

parent.delete_mobile_device_access_override(**kwargs)
  1. See DeleteMobileDeviceAccessOverrideRequestTypeDef

delete_mobile_device_access_rule#

Deletes a mobile device access rule for the specified WorkMail organization.

Type annotations and code completion for boto3.client("workmail").delete_mobile_device_access_rule method. boto3 documentation

# delete_mobile_device_access_rule method definition

def delete_mobile_device_access_rule(
    self,
    *,
    OrganizationId: str,
    MobileDeviceAccessRuleId: str,
) -> Dict[str, Any]:
    ...
# delete_mobile_device_access_rule method usage example with argument unpacking

kwargs: DeleteMobileDeviceAccessRuleRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "MobileDeviceAccessRuleId": ...,
}

parent.delete_mobile_device_access_rule(**kwargs)
  1. See DeleteMobileDeviceAccessRuleRequestTypeDef

delete_organization#

Deletes an WorkMail organization and all underlying AWS resources managed by WorkMail as part of the organization.

Type annotations and code completion for boto3.client("workmail").delete_organization method. boto3 documentation

# delete_organization method definition

def delete_organization(
    self,
    *,
    OrganizationId: str,
    DeleteDirectory: bool,
    ClientToken: str = ...,
    ForceDelete: bool = ...,
    DeleteIdentityCenterApplication: bool = ...,
) -> DeleteOrganizationResponseTypeDef:  # (1)
    ...
  1. See DeleteOrganizationResponseTypeDef
# delete_organization method usage example with argument unpacking

kwargs: DeleteOrganizationRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "DeleteDirectory": ...,
}

parent.delete_organization(**kwargs)
  1. See DeleteOrganizationRequestTypeDef

delete_personal_access_token#

Deletes the Personal Access Token from the provided WorkMail Organization.

Type annotations and code completion for boto3.client("workmail").delete_personal_access_token method. boto3 documentation

# delete_personal_access_token method definition

def delete_personal_access_token(
    self,
    *,
    OrganizationId: str,
    PersonalAccessTokenId: str,
) -> Dict[str, Any]:
    ...
# delete_personal_access_token method usage example with argument unpacking

kwargs: DeletePersonalAccessTokenRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "PersonalAccessTokenId": ...,
}

parent.delete_personal_access_token(**kwargs)
  1. See DeletePersonalAccessTokenRequestTypeDef

delete_resource#

Deletes the specified resource.

Type annotations and code completion for boto3.client("workmail").delete_resource method. boto3 documentation

# delete_resource method definition

def delete_resource(
    self,
    *,
    OrganizationId: str,
    ResourceId: str,
) -> Dict[str, Any]:
    ...
# delete_resource method usage example with argument unpacking

kwargs: DeleteResourceRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "ResourceId": ...,
}

parent.delete_resource(**kwargs)
  1. See DeleteResourceRequestTypeDef

delete_retention_policy#

Deletes the specified retention policy from the specified organization.

Type annotations and code completion for boto3.client("workmail").delete_retention_policy method. boto3 documentation

# delete_retention_policy method definition

def delete_retention_policy(
    self,
    *,
    OrganizationId: str,
    Id: str,
) -> Dict[str, Any]:
    ...
# delete_retention_policy method usage example with argument unpacking

kwargs: DeleteRetentionPolicyRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "Id": ...,
}

parent.delete_retention_policy(**kwargs)
  1. See DeleteRetentionPolicyRequestTypeDef

delete_user#

Deletes a user from WorkMail and all subsequent systems.

Type annotations and code completion for boto3.client("workmail").delete_user method. boto3 documentation

# delete_user method definition

def delete_user(
    self,
    *,
    OrganizationId: str,
    UserId: str,
) -> Dict[str, Any]:
    ...
# delete_user method usage example with argument unpacking

kwargs: DeleteUserRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "UserId": ...,
}

parent.delete_user(**kwargs)
  1. See DeleteUserRequestTypeDef

deregister_from_work_mail#

Mark a user, group, or resource as no longer used in WorkMail.

Type annotations and code completion for boto3.client("workmail").deregister_from_work_mail method. boto3 documentation

# deregister_from_work_mail method definition

def deregister_from_work_mail(
    self,
    *,
    OrganizationId: str,
    EntityId: str,
) -> Dict[str, Any]:
    ...
# deregister_from_work_mail method usage example with argument unpacking

kwargs: DeregisterFromWorkMailRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "EntityId": ...,
}

parent.deregister_from_work_mail(**kwargs)
  1. See DeregisterFromWorkMailRequestTypeDef

deregister_mail_domain#

Removes a domain from WorkMail, stops email routing to WorkMail, and removes the authorization allowing WorkMail use.

Type annotations and code completion for boto3.client("workmail").deregister_mail_domain method. boto3 documentation

# deregister_mail_domain method definition

def deregister_mail_domain(
    self,
    *,
    OrganizationId: str,
    DomainName: str,
) -> Dict[str, Any]:
    ...
# deregister_mail_domain method usage example with argument unpacking

kwargs: DeregisterMailDomainRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "DomainName": ...,
}

parent.deregister_mail_domain(**kwargs)
  1. See DeregisterMailDomainRequestTypeDef

describe_email_monitoring_configuration#

Describes the current email monitoring configuration for a specified organization.

Type annotations and code completion for boto3.client("workmail").describe_email_monitoring_configuration method. boto3 documentation

# describe_email_monitoring_configuration method definition

def describe_email_monitoring_configuration(
    self,
    *,
    OrganizationId: str,
) -> DescribeEmailMonitoringConfigurationResponseTypeDef:  # (1)
    ...
  1. See DescribeEmailMonitoringConfigurationResponseTypeDef
# describe_email_monitoring_configuration method usage example with argument unpacking

kwargs: DescribeEmailMonitoringConfigurationRequestTypeDef = {  # (1)
    "OrganizationId": ...,
}

parent.describe_email_monitoring_configuration(**kwargs)
  1. See DescribeEmailMonitoringConfigurationRequestTypeDef

describe_entity#

Returns basic details about an entity in WorkMail.

Type annotations and code completion for boto3.client("workmail").describe_entity method. boto3 documentation

# describe_entity method definition

def describe_entity(
    self,
    *,
    OrganizationId: str,
    Email: str,
) -> DescribeEntityResponseTypeDef:  # (1)
    ...
  1. See DescribeEntityResponseTypeDef
# describe_entity method usage example with argument unpacking

kwargs: DescribeEntityRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "Email": ...,
}

parent.describe_entity(**kwargs)
  1. See DescribeEntityRequestTypeDef

describe_group#

Returns the data available for the group.

Type annotations and code completion for boto3.client("workmail").describe_group method. boto3 documentation

# describe_group method definition

def describe_group(
    self,
    *,
    OrganizationId: str,
    GroupId: str,
) -> DescribeGroupResponseTypeDef:  # (1)
    ...
  1. See DescribeGroupResponseTypeDef
# describe_group method usage example with argument unpacking

kwargs: DescribeGroupRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "GroupId": ...,
}

parent.describe_group(**kwargs)
  1. See DescribeGroupRequestTypeDef

describe_identity_provider_configuration#

Returns detailed information on the current IdC setup for the WorkMail organization.

Type annotations and code completion for boto3.client("workmail").describe_identity_provider_configuration method. boto3 documentation

# describe_identity_provider_configuration method definition

def describe_identity_provider_configuration(
    self,
    *,
    OrganizationId: str,
) -> DescribeIdentityProviderConfigurationResponseTypeDef:  # (1)
    ...
  1. See DescribeIdentityProviderConfigurationResponseTypeDef
# describe_identity_provider_configuration method usage example with argument unpacking

kwargs: DescribeIdentityProviderConfigurationRequestTypeDef = {  # (1)
    "OrganizationId": ...,
}

parent.describe_identity_provider_configuration(**kwargs)
  1. See DescribeIdentityProviderConfigurationRequestTypeDef

describe_inbound_dmarc_settings#

Lists the settings in a DMARC policy for a specified organization.

Type annotations and code completion for boto3.client("workmail").describe_inbound_dmarc_settings method. boto3 documentation

# describe_inbound_dmarc_settings method definition

def describe_inbound_dmarc_settings(
    self,
    *,
    OrganizationId: str,
) -> DescribeInboundDmarcSettingsResponseTypeDef:  # (1)
    ...
  1. See DescribeInboundDmarcSettingsResponseTypeDef
# describe_inbound_dmarc_settings method usage example with argument unpacking

kwargs: DescribeInboundDmarcSettingsRequestTypeDef = {  # (1)
    "OrganizationId": ...,
}

parent.describe_inbound_dmarc_settings(**kwargs)
  1. See DescribeInboundDmarcSettingsRequestTypeDef

describe_mailbox_export_job#

Describes the current status of a mailbox export job.

Type annotations and code completion for boto3.client("workmail").describe_mailbox_export_job method. boto3 documentation

# describe_mailbox_export_job method definition

def describe_mailbox_export_job(
    self,
    *,
    JobId: str,
    OrganizationId: str,
) -> DescribeMailboxExportJobResponseTypeDef:  # (1)
    ...
  1. See DescribeMailboxExportJobResponseTypeDef
# describe_mailbox_export_job method usage example with argument unpacking

kwargs: DescribeMailboxExportJobRequestTypeDef = {  # (1)
    "JobId": ...,
    "OrganizationId": ...,
}

parent.describe_mailbox_export_job(**kwargs)
  1. See DescribeMailboxExportJobRequestTypeDef

describe_organization#

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

Type annotations and code completion for boto3.client("workmail").describe_organization method. boto3 documentation

# describe_organization method definition

def describe_organization(
    self,
    *,
    OrganizationId: str,
) -> DescribeOrganizationResponseTypeDef:  # (1)
    ...
  1. See DescribeOrganizationResponseTypeDef
# describe_organization method usage example with argument unpacking

kwargs: DescribeOrganizationRequestTypeDef = {  # (1)
    "OrganizationId": ...,
}

parent.describe_organization(**kwargs)
  1. See DescribeOrganizationRequestTypeDef

describe_resource#

Returns the data available for the resource.

Type annotations and code completion for boto3.client("workmail").describe_resource method. boto3 documentation

# describe_resource method definition

def describe_resource(
    self,
    *,
    OrganizationId: str,
    ResourceId: str,
) -> DescribeResourceResponseTypeDef:  # (1)
    ...
  1. See DescribeResourceResponseTypeDef
# describe_resource method usage example with argument unpacking

kwargs: DescribeResourceRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "ResourceId": ...,
}

parent.describe_resource(**kwargs)
  1. See DescribeResourceRequestTypeDef

describe_user#

Provides information regarding the user.

Type annotations and code completion for boto3.client("workmail").describe_user method. boto3 documentation

# describe_user method definition

def describe_user(
    self,
    *,
    OrganizationId: str,
    UserId: str,
) -> DescribeUserResponseTypeDef:  # (1)
    ...
  1. See DescribeUserResponseTypeDef
# describe_user method usage example with argument unpacking

kwargs: DescribeUserRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "UserId": ...,
}

parent.describe_user(**kwargs)
  1. See DescribeUserRequestTypeDef

disassociate_delegate_from_resource#

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

Type annotations and code completion for boto3.client("workmail").disassociate_delegate_from_resource method. boto3 documentation

# disassociate_delegate_from_resource method definition

def disassociate_delegate_from_resource(
    self,
    *,
    OrganizationId: str,
    ResourceId: str,
    EntityId: str,
) -> Dict[str, Any]:
    ...
# disassociate_delegate_from_resource method usage example with argument unpacking

kwargs: DisassociateDelegateFromResourceRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "ResourceId": ...,
    "EntityId": ...,
}

parent.disassociate_delegate_from_resource(**kwargs)
  1. See DisassociateDelegateFromResourceRequestTypeDef

disassociate_member_from_group#

Removes a member from a group.

Type annotations and code completion for boto3.client("workmail").disassociate_member_from_group method. boto3 documentation

# disassociate_member_from_group method definition

def disassociate_member_from_group(
    self,
    *,
    OrganizationId: str,
    GroupId: str,
    MemberId: str,
) -> Dict[str, Any]:
    ...
# disassociate_member_from_group method usage example with argument unpacking

kwargs: DisassociateMemberFromGroupRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "GroupId": ...,
    "MemberId": ...,
}

parent.disassociate_member_from_group(**kwargs)
  1. See DisassociateMemberFromGroupRequestTypeDef

get_access_control_effect#

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

Type annotations and code completion for boto3.client("workmail").get_access_control_effect method. boto3 documentation

# get_access_control_effect method definition

def get_access_control_effect(
    self,
    *,
    OrganizationId: str,
    IpAddress: str,
    Action: str,
    UserId: str = ...,
    ImpersonationRoleId: str = ...,
) -> GetAccessControlEffectResponseTypeDef:  # (1)
    ...
  1. See GetAccessControlEffectResponseTypeDef
# get_access_control_effect method usage example with argument unpacking

kwargs: GetAccessControlEffectRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "IpAddress": ...,
    "Action": ...,
}

parent.get_access_control_effect(**kwargs)
  1. See GetAccessControlEffectRequestTypeDef

get_default_retention_policy#

Gets the default retention policy details for the specified organization.

Type annotations and code completion for boto3.client("workmail").get_default_retention_policy method. boto3 documentation

# get_default_retention_policy method definition

def get_default_retention_policy(
    self,
    *,
    OrganizationId: str,
) -> GetDefaultRetentionPolicyResponseTypeDef:  # (1)
    ...
  1. See GetDefaultRetentionPolicyResponseTypeDef
# get_default_retention_policy method usage example with argument unpacking

kwargs: GetDefaultRetentionPolicyRequestTypeDef = {  # (1)
    "OrganizationId": ...,
}

parent.get_default_retention_policy(**kwargs)
  1. See GetDefaultRetentionPolicyRequestTypeDef

get_impersonation_role#

Gets the impersonation role details for the given WorkMail organization.

Type annotations and code completion for boto3.client("workmail").get_impersonation_role method. boto3 documentation

# get_impersonation_role method definition

def get_impersonation_role(
    self,
    *,
    OrganizationId: str,
    ImpersonationRoleId: str,
) -> GetImpersonationRoleResponseTypeDef:  # (1)
    ...
  1. See GetImpersonationRoleResponseTypeDef
# get_impersonation_role method usage example with argument unpacking

kwargs: GetImpersonationRoleRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "ImpersonationRoleId": ...,
}

parent.get_impersonation_role(**kwargs)
  1. See GetImpersonationRoleRequestTypeDef

get_impersonation_role_effect#

Tests whether the given impersonation role can impersonate a target user.

Type annotations and code completion for boto3.client("workmail").get_impersonation_role_effect method. boto3 documentation

# get_impersonation_role_effect method definition

def get_impersonation_role_effect(
    self,
    *,
    OrganizationId: str,
    ImpersonationRoleId: str,
    TargetUser: str,
) -> GetImpersonationRoleEffectResponseTypeDef:  # (1)
    ...
  1. See GetImpersonationRoleEffectResponseTypeDef
# get_impersonation_role_effect method usage example with argument unpacking

kwargs: GetImpersonationRoleEffectRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "ImpersonationRoleId": ...,
    "TargetUser": ...,
}

parent.get_impersonation_role_effect(**kwargs)
  1. See GetImpersonationRoleEffectRequestTypeDef

get_mail_domain#

Gets details for a mail domain, including domain records required to configure your domain with recommended security.

Type annotations and code completion for boto3.client("workmail").get_mail_domain method. boto3 documentation

# get_mail_domain method definition

def get_mail_domain(
    self,
    *,
    OrganizationId: str,
    DomainName: str,
) -> GetMailDomainResponseTypeDef:  # (1)
    ...
  1. See GetMailDomainResponseTypeDef
# get_mail_domain method usage example with argument unpacking

kwargs: GetMailDomainRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "DomainName": ...,
}

parent.get_mail_domain(**kwargs)
  1. See GetMailDomainRequestTypeDef

get_mailbox_details#

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

Type annotations and code completion for boto3.client("workmail").get_mailbox_details method. boto3 documentation

# get_mailbox_details method definition

def get_mailbox_details(
    self,
    *,
    OrganizationId: str,
    UserId: str,
) -> GetMailboxDetailsResponseTypeDef:  # (1)
    ...
  1. See GetMailboxDetailsResponseTypeDef
# get_mailbox_details method usage example with argument unpacking

kwargs: GetMailboxDetailsRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "UserId": ...,
}

parent.get_mailbox_details(**kwargs)
  1. See GetMailboxDetailsRequestTypeDef

get_mobile_device_access_effect#

Simulates the effect of the mobile device access rules for the given attributes of a sample access event.

Type annotations and code completion for boto3.client("workmail").get_mobile_device_access_effect method. boto3 documentation

# get_mobile_device_access_effect method definition

def get_mobile_device_access_effect(
    self,
    *,
    OrganizationId: str,
    DeviceType: str = ...,
    DeviceModel: str = ...,
    DeviceOperatingSystem: str = ...,
    DeviceUserAgent: str = ...,
) -> GetMobileDeviceAccessEffectResponseTypeDef:  # (1)
    ...
  1. See GetMobileDeviceAccessEffectResponseTypeDef
# get_mobile_device_access_effect method usage example with argument unpacking

kwargs: GetMobileDeviceAccessEffectRequestTypeDef = {  # (1)
    "OrganizationId": ...,
}

parent.get_mobile_device_access_effect(**kwargs)
  1. See GetMobileDeviceAccessEffectRequestTypeDef

get_mobile_device_access_override#

Gets the mobile device access override for the given WorkMail organization, user, and device.

Type annotations and code completion for boto3.client("workmail").get_mobile_device_access_override method. boto3 documentation

# get_mobile_device_access_override method definition

def get_mobile_device_access_override(
    self,
    *,
    OrganizationId: str,
    UserId: str,
    DeviceId: str,
) -> GetMobileDeviceAccessOverrideResponseTypeDef:  # (1)
    ...
  1. See GetMobileDeviceAccessOverrideResponseTypeDef
# get_mobile_device_access_override method usage example with argument unpacking

kwargs: GetMobileDeviceAccessOverrideRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "UserId": ...,
    "DeviceId": ...,
}

parent.get_mobile_device_access_override(**kwargs)
  1. See GetMobileDeviceAccessOverrideRequestTypeDef

get_personal_access_token_metadata#

Requests details of a specific Personal Access Token within the WorkMail organization.

Type annotations and code completion for boto3.client("workmail").get_personal_access_token_metadata method. boto3 documentation

# get_personal_access_token_metadata method definition

def get_personal_access_token_metadata(
    self,
    *,
    OrganizationId: str,
    PersonalAccessTokenId: str,
) -> GetPersonalAccessTokenMetadataResponseTypeDef:  # (1)
    ...
  1. See GetPersonalAccessTokenMetadataResponseTypeDef
# get_personal_access_token_metadata method usage example with argument unpacking

kwargs: GetPersonalAccessTokenMetadataRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "PersonalAccessTokenId": ...,
}

parent.get_personal_access_token_metadata(**kwargs)
  1. See GetPersonalAccessTokenMetadataRequestTypeDef

list_access_control_rules#

Lists the access control rules for the specified organization.

Type annotations and code completion for boto3.client("workmail").list_access_control_rules method. boto3 documentation

# list_access_control_rules method definition

def list_access_control_rules(
    self,
    *,
    OrganizationId: str,
) -> ListAccessControlRulesResponseTypeDef:  # (1)
    ...
  1. See ListAccessControlRulesResponseTypeDef
# list_access_control_rules method usage example with argument unpacking

kwargs: ListAccessControlRulesRequestTypeDef = {  # (1)
    "OrganizationId": ...,
}

parent.list_access_control_rules(**kwargs)
  1. See ListAccessControlRulesRequestTypeDef

list_aliases#

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

Type annotations and code completion for boto3.client("workmail").list_aliases method. boto3 documentation

# list_aliases method definition

def list_aliases(
    self,
    *,
    OrganizationId: str,
    EntityId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListAliasesResponseTypeDef:  # (1)
    ...
  1. See ListAliasesResponseTypeDef
# list_aliases method usage example with argument unpacking

kwargs: ListAliasesRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "EntityId": ...,
}

parent.list_aliases(**kwargs)
  1. See ListAliasesRequestTypeDef

list_availability_configurations#

List all the AvailabilityConfiguration's for the given WorkMail organization.

Type annotations and code completion for boto3.client("workmail").list_availability_configurations method. boto3 documentation

# list_availability_configurations method definition

def list_availability_configurations(
    self,
    *,
    OrganizationId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListAvailabilityConfigurationsResponseTypeDef:  # (1)
    ...
  1. See ListAvailabilityConfigurationsResponseTypeDef
# list_availability_configurations method usage example with argument unpacking

kwargs: ListAvailabilityConfigurationsRequestTypeDef = {  # (1)
    "OrganizationId": ...,
}

parent.list_availability_configurations(**kwargs)
  1. See ListAvailabilityConfigurationsRequestTypeDef

list_group_members#

Returns an overview of the members of a group.

Type annotations and code completion for boto3.client("workmail").list_group_members method. boto3 documentation

# list_group_members method definition

def list_group_members(
    self,
    *,
    OrganizationId: str,
    GroupId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListGroupMembersResponseTypeDef:  # (1)
    ...
  1. See ListGroupMembersResponseTypeDef
# list_group_members method usage example with argument unpacking

kwargs: ListGroupMembersRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "GroupId": ...,
}

parent.list_group_members(**kwargs)
  1. See ListGroupMembersRequestTypeDef

list_groups#

Returns summaries of the organization's groups.

Type annotations and code completion for boto3.client("workmail").list_groups method. boto3 documentation

# list_groups method definition

def list_groups(
    self,
    *,
    OrganizationId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
    Filters: ListGroupsFiltersTypeDef = ...,  # (1)
) -> ListGroupsResponseTypeDef:  # (2)
    ...
  1. See ListGroupsFiltersTypeDef
  2. See ListGroupsResponseTypeDef
# list_groups method usage example with argument unpacking

kwargs: ListGroupsRequestTypeDef = {  # (1)
    "OrganizationId": ...,
}

parent.list_groups(**kwargs)
  1. See ListGroupsRequestTypeDef

list_groups_for_entity#

Returns all the groups to which an entity belongs.

Type annotations and code completion for boto3.client("workmail").list_groups_for_entity method. boto3 documentation

# list_groups_for_entity method definition

def list_groups_for_entity(
    self,
    *,
    OrganizationId: str,
    EntityId: str,
    Filters: ListGroupsForEntityFiltersTypeDef = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListGroupsForEntityResponseTypeDef:  # (2)
    ...
  1. See ListGroupsForEntityFiltersTypeDef
  2. See ListGroupsForEntityResponseTypeDef
# list_groups_for_entity method usage example with argument unpacking

kwargs: ListGroupsForEntityRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "EntityId": ...,
}

parent.list_groups_for_entity(**kwargs)
  1. See ListGroupsForEntityRequestTypeDef

list_impersonation_roles#

Lists all the impersonation roles for the given WorkMail organization.

Type annotations and code completion for boto3.client("workmail").list_impersonation_roles method. boto3 documentation

# list_impersonation_roles method definition

def list_impersonation_roles(
    self,
    *,
    OrganizationId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListImpersonationRolesResponseTypeDef:  # (1)
    ...
  1. See ListImpersonationRolesResponseTypeDef
# list_impersonation_roles method usage example with argument unpacking

kwargs: ListImpersonationRolesRequestTypeDef = {  # (1)
    "OrganizationId": ...,
}

parent.list_impersonation_roles(**kwargs)
  1. See ListImpersonationRolesRequestTypeDef

list_mail_domains#

Lists the mail domains in a given WorkMail organization.

Type annotations and code completion for boto3.client("workmail").list_mail_domains method. boto3 documentation

# list_mail_domains method definition

def list_mail_domains(
    self,
    *,
    OrganizationId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListMailDomainsResponseTypeDef:  # (1)
    ...
  1. See ListMailDomainsResponseTypeDef
# list_mail_domains method usage example with argument unpacking

kwargs: ListMailDomainsRequestTypeDef = {  # (1)
    "OrganizationId": ...,
}

parent.list_mail_domains(**kwargs)
  1. See ListMailDomainsRequestTypeDef

list_mailbox_export_jobs#

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

Type annotations and code completion for boto3.client("workmail").list_mailbox_export_jobs method. boto3 documentation

# list_mailbox_export_jobs method definition

def list_mailbox_export_jobs(
    self,
    *,
    OrganizationId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListMailboxExportJobsResponseTypeDef:  # (1)
    ...
  1. See ListMailboxExportJobsResponseTypeDef
# list_mailbox_export_jobs method usage example with argument unpacking

kwargs: ListMailboxExportJobsRequestTypeDef = {  # (1)
    "OrganizationId": ...,
}

parent.list_mailbox_export_jobs(**kwargs)
  1. See ListMailboxExportJobsRequestTypeDef

list_mailbox_permissions#

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

Type annotations and code completion for boto3.client("workmail").list_mailbox_permissions method. boto3 documentation

# list_mailbox_permissions method definition

def list_mailbox_permissions(
    self,
    *,
    OrganizationId: str,
    EntityId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListMailboxPermissionsResponseTypeDef:  # (1)
    ...
  1. See ListMailboxPermissionsResponseTypeDef
# list_mailbox_permissions method usage example with argument unpacking

kwargs: ListMailboxPermissionsRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "EntityId": ...,
}

parent.list_mailbox_permissions(**kwargs)
  1. See ListMailboxPermissionsRequestTypeDef

list_mobile_device_access_overrides#

Lists all the mobile device access overrides for any given combination of WorkMail organization, user, or device.

Type annotations and code completion for boto3.client("workmail").list_mobile_device_access_overrides method. boto3 documentation

# list_mobile_device_access_overrides method definition

def list_mobile_device_access_overrides(
    self,
    *,
    OrganizationId: str,
    UserId: str = ...,
    DeviceId: str = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListMobileDeviceAccessOverridesResponseTypeDef:  # (1)
    ...
  1. See ListMobileDeviceAccessOverridesResponseTypeDef
# list_mobile_device_access_overrides method usage example with argument unpacking

kwargs: ListMobileDeviceAccessOverridesRequestTypeDef = {  # (1)
    "OrganizationId": ...,
}

parent.list_mobile_device_access_overrides(**kwargs)
  1. See ListMobileDeviceAccessOverridesRequestTypeDef

list_mobile_device_access_rules#

Lists the mobile device access rules for the specified WorkMail organization.

Type annotations and code completion for boto3.client("workmail").list_mobile_device_access_rules method. boto3 documentation

# list_mobile_device_access_rules method definition

def list_mobile_device_access_rules(
    self,
    *,
    OrganizationId: str,
) -> ListMobileDeviceAccessRulesResponseTypeDef:  # (1)
    ...
  1. See ListMobileDeviceAccessRulesResponseTypeDef
# list_mobile_device_access_rules method usage example with argument unpacking

kwargs: ListMobileDeviceAccessRulesRequestTypeDef = {  # (1)
    "OrganizationId": ...,
}

parent.list_mobile_device_access_rules(**kwargs)
  1. See ListMobileDeviceAccessRulesRequestTypeDef

list_organizations#

Returns summaries of the customer's organizations.

Type annotations and code completion for boto3.client("workmail").list_organizations method. boto3 documentation

# list_organizations method definition

def list_organizations(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListOrganizationsResponseTypeDef:  # (1)
    ...
  1. See ListOrganizationsResponseTypeDef
# list_organizations method usage example with argument unpacking

kwargs: ListOrganizationsRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_organizations(**kwargs)
  1. See ListOrganizationsRequestTypeDef

list_personal_access_tokens#

Returns a summary of your Personal Access Tokens.

Type annotations and code completion for boto3.client("workmail").list_personal_access_tokens method. boto3 documentation

# list_personal_access_tokens method definition

def list_personal_access_tokens(
    self,
    *,
    OrganizationId: str,
    UserId: str = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListPersonalAccessTokensResponseTypeDef:  # (1)
    ...
  1. See ListPersonalAccessTokensResponseTypeDef
# list_personal_access_tokens method usage example with argument unpacking

kwargs: ListPersonalAccessTokensRequestTypeDef = {  # (1)
    "OrganizationId": ...,
}

parent.list_personal_access_tokens(**kwargs)
  1. See ListPersonalAccessTokensRequestTypeDef

list_resource_delegates#

Lists the delegates associated with a resource.

Type annotations and code completion for boto3.client("workmail").list_resource_delegates method. boto3 documentation

# list_resource_delegates method definition

def list_resource_delegates(
    self,
    *,
    OrganizationId: str,
    ResourceId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListResourceDelegatesResponseTypeDef:  # (1)
    ...
  1. See ListResourceDelegatesResponseTypeDef
# list_resource_delegates method usage example with argument unpacking

kwargs: ListResourceDelegatesRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "ResourceId": ...,
}

parent.list_resource_delegates(**kwargs)
  1. See ListResourceDelegatesRequestTypeDef

list_resources#

Returns summaries of the organization's resources.

Type annotations and code completion for boto3.client("workmail").list_resources method. boto3 documentation

# list_resources method definition

def list_resources(
    self,
    *,
    OrganizationId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
    Filters: ListResourcesFiltersTypeDef = ...,  # (1)
) -> ListResourcesResponseTypeDef:  # (2)
    ...
  1. See ListResourcesFiltersTypeDef
  2. See ListResourcesResponseTypeDef
# list_resources method usage example with argument unpacking

kwargs: ListResourcesRequestTypeDef = {  # (1)
    "OrganizationId": ...,
}

parent.list_resources(**kwargs)
  1. See ListResourcesRequestTypeDef

list_tags_for_resource#

Lists the tags applied to an WorkMail organization resource.

Type annotations and code completion for boto3.client("workmail").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    ResourceARN: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef
# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestTypeDef = {  # (1)
    "ResourceARN": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestTypeDef

list_users#

Returns summaries of the organization's users.

Type annotations and code completion for boto3.client("workmail").list_users method. boto3 documentation

# list_users method definition

def list_users(
    self,
    *,
    OrganizationId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
    Filters: ListUsersFiltersTypeDef = ...,  # (1)
) -> ListUsersResponseTypeDef:  # (2)
    ...
  1. See ListUsersFiltersTypeDef
  2. See ListUsersResponseTypeDef
# list_users method usage example with argument unpacking

kwargs: ListUsersRequestTypeDef = {  # (1)
    "OrganizationId": ...,
}

parent.list_users(**kwargs)
  1. See ListUsersRequestTypeDef

put_access_control_rule#

Adds a new access control rule for the specified organization.

Type annotations and code completion for boto3.client("workmail").put_access_control_rule method. boto3 documentation

# put_access_control_rule method definition

def put_access_control_rule(
    self,
    *,
    Name: str,
    Effect: AccessControlRuleEffectType,  # (1)
    Description: str,
    OrganizationId: str,
    IpRanges: Sequence[str] = ...,
    NotIpRanges: Sequence[str] = ...,
    Actions: Sequence[str] = ...,
    NotActions: Sequence[str] = ...,
    UserIds: Sequence[str] = ...,
    NotUserIds: Sequence[str] = ...,
    ImpersonationRoleIds: Sequence[str] = ...,
    NotImpersonationRoleIds: Sequence[str] = ...,
) -> Dict[str, Any]:
    ...
  1. See AccessControlRuleEffectType
# put_access_control_rule method usage example with argument unpacking

kwargs: PutAccessControlRuleRequestTypeDef = {  # (1)
    "Name": ...,
    "Effect": ...,
    "Description": ...,
    "OrganizationId": ...,
}

parent.put_access_control_rule(**kwargs)
  1. See PutAccessControlRuleRequestTypeDef

put_email_monitoring_configuration#

Creates or updates the email monitoring configuration for a specified organization.

Type annotations and code completion for boto3.client("workmail").put_email_monitoring_configuration method. boto3 documentation

# put_email_monitoring_configuration method definition

def put_email_monitoring_configuration(
    self,
    *,
    OrganizationId: str,
    RoleArn: str,
    LogGroupArn: str,
) -> Dict[str, Any]:
    ...
# put_email_monitoring_configuration method usage example with argument unpacking

kwargs: PutEmailMonitoringConfigurationRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "RoleArn": ...,
    "LogGroupArn": ...,
}

parent.put_email_monitoring_configuration(**kwargs)
  1. See PutEmailMonitoringConfigurationRequestTypeDef

put_identity_provider_configuration#

Enables integration between IAM Identity Center (IdC) and WorkMail to proxy authentication requests for mailbox users.

Type annotations and code completion for boto3.client("workmail").put_identity_provider_configuration method. boto3 documentation

# put_identity_provider_configuration method definition

def put_identity_provider_configuration(
    self,
    *,
    OrganizationId: str,
    AuthenticationMode: IdentityProviderAuthenticationModeType,  # (1)
    IdentityCenterConfiguration: IdentityCenterConfigurationTypeDef,  # (2)
    PersonalAccessTokenConfiguration: PersonalAccessTokenConfigurationTypeDef,  # (3)
) -> Dict[str, Any]:
    ...
  1. See IdentityProviderAuthenticationModeType
  2. See IdentityCenterConfigurationTypeDef
  3. See PersonalAccessTokenConfigurationTypeDef
# put_identity_provider_configuration method usage example with argument unpacking

kwargs: PutIdentityProviderConfigurationRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "AuthenticationMode": ...,
    "IdentityCenterConfiguration": ...,
    "PersonalAccessTokenConfiguration": ...,
}

parent.put_identity_provider_configuration(**kwargs)
  1. See PutIdentityProviderConfigurationRequestTypeDef

put_inbound_dmarc_settings#

Enables or disables a DMARC policy for a given organization.

Type annotations and code completion for boto3.client("workmail").put_inbound_dmarc_settings method. boto3 documentation

# put_inbound_dmarc_settings method definition

def put_inbound_dmarc_settings(
    self,
    *,
    OrganizationId: str,
    Enforced: bool,
) -> Dict[str, Any]:
    ...
# put_inbound_dmarc_settings method usage example with argument unpacking

kwargs: PutInboundDmarcSettingsRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "Enforced": ...,
}

parent.put_inbound_dmarc_settings(**kwargs)
  1. See PutInboundDmarcSettingsRequestTypeDef

put_mailbox_permissions#

Sets permissions for a user, group, or resource.

Type annotations and code completion for boto3.client("workmail").put_mailbox_permissions method. boto3 documentation

# put_mailbox_permissions method definition

def put_mailbox_permissions(
    self,
    *,
    OrganizationId: str,
    EntityId: str,
    GranteeId: str,
    PermissionValues: Sequence[PermissionTypeType],  # (1)
) -> Dict[str, Any]:
    ...
  1. See Sequence[PermissionTypeType]
# put_mailbox_permissions method usage example with argument unpacking

kwargs: PutMailboxPermissionsRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "EntityId": ...,
    "GranteeId": ...,
    "PermissionValues": ...,
}

parent.put_mailbox_permissions(**kwargs)
  1. See PutMailboxPermissionsRequestTypeDef

put_mobile_device_access_override#

Creates or updates a mobile device access override for the given WorkMail organization, user, and device.

Type annotations and code completion for boto3.client("workmail").put_mobile_device_access_override method. boto3 documentation

# put_mobile_device_access_override method definition

def put_mobile_device_access_override(
    self,
    *,
    OrganizationId: str,
    UserId: str,
    DeviceId: str,
    Effect: MobileDeviceAccessRuleEffectType,  # (1)
    Description: str = ...,
) -> Dict[str, Any]:
    ...
  1. See MobileDeviceAccessRuleEffectType
# put_mobile_device_access_override method usage example with argument unpacking

kwargs: PutMobileDeviceAccessOverrideRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "UserId": ...,
    "DeviceId": ...,
    "Effect": ...,
}

parent.put_mobile_device_access_override(**kwargs)
  1. See PutMobileDeviceAccessOverrideRequestTypeDef

put_retention_policy#

Puts a retention policy to the specified organization.

Type annotations and code completion for boto3.client("workmail").put_retention_policy method. boto3 documentation

# put_retention_policy method definition

def put_retention_policy(
    self,
    *,
    OrganizationId: str,
    Name: str,
    FolderConfigurations: Sequence[FolderConfigurationTypeDef],  # (1)
    Id: str = ...,
    Description: str = ...,
) -> Dict[str, Any]:
    ...
  1. See Sequence[FolderConfigurationTypeDef]
# put_retention_policy method usage example with argument unpacking

kwargs: PutRetentionPolicyRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "Name": ...,
    "FolderConfigurations": ...,
}

parent.put_retention_policy(**kwargs)
  1. See PutRetentionPolicyRequestTypeDef

register_mail_domain#

Registers a new domain in WorkMail and SES, and configures it for use by WorkMail.

Type annotations and code completion for boto3.client("workmail").register_mail_domain method. boto3 documentation

# register_mail_domain method definition

def register_mail_domain(
    self,
    *,
    OrganizationId: str,
    DomainName: str,
    ClientToken: str = ...,
) -> Dict[str, Any]:
    ...
# register_mail_domain method usage example with argument unpacking

kwargs: RegisterMailDomainRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "DomainName": ...,
}

parent.register_mail_domain(**kwargs)
  1. See RegisterMailDomainRequestTypeDef

register_to_work_mail#

Registers an existing and disabled user, group, or resource for WorkMail use by associating a mailbox and calendaring capabilities.

Type annotations and code completion for boto3.client("workmail").register_to_work_mail method. boto3 documentation

# register_to_work_mail method definition

def register_to_work_mail(
    self,
    *,
    OrganizationId: str,
    EntityId: str,
    Email: str,
) -> Dict[str, Any]:
    ...
# register_to_work_mail method usage example with argument unpacking

kwargs: RegisterToWorkMailRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "EntityId": ...,
    "Email": ...,
}

parent.register_to_work_mail(**kwargs)
  1. See RegisterToWorkMailRequestTypeDef

reset_password#

Allows the administrator to reset the password for a user.

Type annotations and code completion for boto3.client("workmail").reset_password method. boto3 documentation

# reset_password method definition

def reset_password(
    self,
    *,
    OrganizationId: str,
    UserId: str,
    Password: str,
) -> Dict[str, Any]:
    ...
# reset_password method usage example with argument unpacking

kwargs: ResetPasswordRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "UserId": ...,
    "Password": ...,
}

parent.reset_password(**kwargs)
  1. See ResetPasswordRequestTypeDef

start_mailbox_export_job#

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.

Type annotations and code completion for boto3.client("workmail").start_mailbox_export_job method. boto3 documentation

# start_mailbox_export_job method definition

def start_mailbox_export_job(
    self,
    *,
    ClientToken: str,
    OrganizationId: str,
    EntityId: str,
    RoleArn: str,
    KmsKeyArn: str,
    S3BucketName: str,
    S3Prefix: str,
    Description: str = ...,
) -> StartMailboxExportJobResponseTypeDef:  # (1)
    ...
  1. See StartMailboxExportJobResponseTypeDef
# start_mailbox_export_job method usage example with argument unpacking

kwargs: StartMailboxExportJobRequestTypeDef = {  # (1)
    "ClientToken": ...,
    "OrganizationId": ...,
    "EntityId": ...,
    "RoleArn": ...,
    "KmsKeyArn": ...,
    "S3BucketName": ...,
    "S3Prefix": ...,
}

parent.start_mailbox_export_job(**kwargs)
  1. See StartMailboxExportJobRequestTypeDef

tag_resource#

Applies the specified tags to the specified WorkMailorganization resource.

Type annotations and code completion for boto3.client("workmail").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    ResourceARN: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...
  1. See Sequence[TagTypeDef]
# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestTypeDef = {  # (1)
    "ResourceARN": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestTypeDef

test_availability_configuration#

Performs a test on an availability provider to ensure that access is allowed.

Type annotations and code completion for boto3.client("workmail").test_availability_configuration method. boto3 documentation

# test_availability_configuration method definition

def test_availability_configuration(
    self,
    *,
    OrganizationId: str,
    DomainName: str = ...,
    EwsProvider: EwsAvailabilityProviderTypeDef = ...,  # (1)
    LambdaProvider: LambdaAvailabilityProviderTypeDef = ...,  # (2)
) -> TestAvailabilityConfigurationResponseTypeDef:  # (3)
    ...
  1. See EwsAvailabilityProviderTypeDef
  2. See LambdaAvailabilityProviderTypeDef
  3. See TestAvailabilityConfigurationResponseTypeDef
# test_availability_configuration method usage example with argument unpacking

kwargs: TestAvailabilityConfigurationRequestTypeDef = {  # (1)
    "OrganizationId": ...,
}

parent.test_availability_configuration(**kwargs)
  1. See TestAvailabilityConfigurationRequestTypeDef

untag_resource#

Untags the specified tags from the specified WorkMail organization resource.

Type annotations and code completion for boto3.client("workmail").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    ResourceARN: str,
    TagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...
# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestTypeDef = {  # (1)
    "ResourceARN": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestTypeDef

update_availability_configuration#

Updates an existing AvailabilityConfiguration for the given WorkMail organization and domain.

Type annotations and code completion for boto3.client("workmail").update_availability_configuration method. boto3 documentation

# update_availability_configuration method definition

def update_availability_configuration(
    self,
    *,
    OrganizationId: str,
    DomainName: str,
    EwsProvider: EwsAvailabilityProviderTypeDef = ...,  # (1)
    LambdaProvider: LambdaAvailabilityProviderTypeDef = ...,  # (2)
) -> Dict[str, Any]:
    ...
  1. See EwsAvailabilityProviderTypeDef
  2. See LambdaAvailabilityProviderTypeDef
# update_availability_configuration method usage example with argument unpacking

kwargs: UpdateAvailabilityConfigurationRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "DomainName": ...,
}

parent.update_availability_configuration(**kwargs)
  1. See UpdateAvailabilityConfigurationRequestTypeDef

update_default_mail_domain#

Updates the default mail domain for an organization.

Type annotations and code completion for boto3.client("workmail").update_default_mail_domain method. boto3 documentation

# update_default_mail_domain method definition

def update_default_mail_domain(
    self,
    *,
    OrganizationId: str,
    DomainName: str,
) -> Dict[str, Any]:
    ...
# update_default_mail_domain method usage example with argument unpacking

kwargs: UpdateDefaultMailDomainRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "DomainName": ...,
}

parent.update_default_mail_domain(**kwargs)
  1. See UpdateDefaultMailDomainRequestTypeDef

update_group#

Updates attributes in a group.

Type annotations and code completion for boto3.client("workmail").update_group method. boto3 documentation

# update_group method definition

def update_group(
    self,
    *,
    OrganizationId: str,
    GroupId: str,
    HiddenFromGlobalAddressList: bool = ...,
) -> Dict[str, Any]:
    ...
# update_group method usage example with argument unpacking

kwargs: UpdateGroupRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "GroupId": ...,
}

parent.update_group(**kwargs)
  1. See UpdateGroupRequestTypeDef

update_impersonation_role#

Updates an impersonation role for the given WorkMail organization.

Type annotations and code completion for boto3.client("workmail").update_impersonation_role method. boto3 documentation

# update_impersonation_role method definition

def update_impersonation_role(
    self,
    *,
    OrganizationId: str,
    ImpersonationRoleId: str,
    Name: str,
    Type: ImpersonationRoleTypeType,  # (1)
    Rules: Sequence[ImpersonationRuleUnionTypeDef],  # (2)
    Description: str = ...,
) -> Dict[str, Any]:
    ...
  1. See ImpersonationRoleTypeType
  2. See Sequence[ImpersonationRuleUnionTypeDef]
# update_impersonation_role method usage example with argument unpacking

kwargs: UpdateImpersonationRoleRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "ImpersonationRoleId": ...,
    "Name": ...,
    "Type": ...,
    "Rules": ...,
}

parent.update_impersonation_role(**kwargs)
  1. See UpdateImpersonationRoleRequestTypeDef

update_mailbox_quota#

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

Type annotations and code completion for boto3.client("workmail").update_mailbox_quota method. boto3 documentation

# update_mailbox_quota method definition

def update_mailbox_quota(
    self,
    *,
    OrganizationId: str,
    UserId: str,
    MailboxQuota: int,
) -> Dict[str, Any]:
    ...
# update_mailbox_quota method usage example with argument unpacking

kwargs: UpdateMailboxQuotaRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "UserId": ...,
    "MailboxQuota": ...,
}

parent.update_mailbox_quota(**kwargs)
  1. See UpdateMailboxQuotaRequestTypeDef

update_mobile_device_access_rule#

Updates a mobile device access rule for the specified WorkMail organization.

Type annotations and code completion for boto3.client("workmail").update_mobile_device_access_rule method. boto3 documentation

# update_mobile_device_access_rule method definition

def update_mobile_device_access_rule(
    self,
    *,
    OrganizationId: str,
    MobileDeviceAccessRuleId: str,
    Name: str,
    Effect: MobileDeviceAccessRuleEffectType,  # (1)
    Description: str = ...,
    DeviceTypes: Sequence[str] = ...,
    NotDeviceTypes: Sequence[str] = ...,
    DeviceModels: Sequence[str] = ...,
    NotDeviceModels: Sequence[str] = ...,
    DeviceOperatingSystems: Sequence[str] = ...,
    NotDeviceOperatingSystems: Sequence[str] = ...,
    DeviceUserAgents: Sequence[str] = ...,
    NotDeviceUserAgents: Sequence[str] = ...,
) -> Dict[str, Any]:
    ...
  1. See MobileDeviceAccessRuleEffectType
# update_mobile_device_access_rule method usage example with argument unpacking

kwargs: UpdateMobileDeviceAccessRuleRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "MobileDeviceAccessRuleId": ...,
    "Name": ...,
    "Effect": ...,
}

parent.update_mobile_device_access_rule(**kwargs)
  1. See UpdateMobileDeviceAccessRuleRequestTypeDef

update_primary_email_address#

Updates the primary email for a user, group, or resource.

Type annotations and code completion for boto3.client("workmail").update_primary_email_address method. boto3 documentation

# update_primary_email_address method definition

def update_primary_email_address(
    self,
    *,
    OrganizationId: str,
    EntityId: str,
    Email: str,
) -> Dict[str, Any]:
    ...
# update_primary_email_address method usage example with argument unpacking

kwargs: UpdatePrimaryEmailAddressRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "EntityId": ...,
    "Email": ...,
}

parent.update_primary_email_address(**kwargs)
  1. See UpdatePrimaryEmailAddressRequestTypeDef

update_resource#

Updates data for the resource.

Type annotations and code completion for boto3.client("workmail").update_resource method. boto3 documentation

# update_resource method definition

def update_resource(
    self,
    *,
    OrganizationId: str,
    ResourceId: str,
    Name: str = ...,
    BookingOptions: BookingOptionsTypeDef = ...,  # (1)
    Description: str = ...,
    Type: ResourceTypeType = ...,  # (2)
    HiddenFromGlobalAddressList: bool = ...,
) -> Dict[str, Any]:
    ...
  1. See BookingOptionsTypeDef
  2. See ResourceTypeType
# update_resource method usage example with argument unpacking

kwargs: UpdateResourceRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "ResourceId": ...,
}

parent.update_resource(**kwargs)
  1. See UpdateResourceRequestTypeDef

update_user#

Updates data for the user.

Type annotations and code completion for boto3.client("workmail").update_user method. boto3 documentation

# update_user method definition

def update_user(
    self,
    *,
    OrganizationId: str,
    UserId: str,
    Role: UserRoleType = ...,  # (1)
    DisplayName: str = ...,
    FirstName: str = ...,
    LastName: str = ...,
    HiddenFromGlobalAddressList: bool = ...,
    Initials: str = ...,
    Telephone: str = ...,
    Street: str = ...,
    JobTitle: str = ...,
    City: str = ...,
    Company: str = ...,
    ZipCode: str = ...,
    Department: str = ...,
    Country: str = ...,
    Office: str = ...,
    IdentityProviderUserId: str = ...,
) -> Dict[str, Any]:
    ...
  1. See UserRoleType
# update_user method usage example with argument unpacking

kwargs: UpdateUserRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "UserId": ...,
}

parent.update_user(**kwargs)
  1. See UpdateUserRequestTypeDef

get_paginator#

Type annotations and code completion for boto3.client("workmail").get_paginator method with overloads.