Skip to content

WorkMailClient

Index > WorkMail > WorkMailClient

Auto-generated documentation for WorkMail type annotations stubs module types-aiobotocore-workmail.

WorkMailClient

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

Usage example
from aioboto3.session import Session
from types_aiobotocore_workmail.client import WorkMailClient

session = Session()
async with session.client("workmail") as client:
    client: WorkMailClient

Exceptions

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

Usage example
async with session.client("workmail") as client:
    try:
        do_something(client)
    except (
            client.ClientError,
        client.DirectoryInUseException,
        client.DirectoryServiceAuthenticationFailedException,
        client.DirectoryUnavailableException,
        client.EmailAddressInUseException,
        client.EntityAlreadyRegisteredException,
        client.EntityNotFoundException,
        client.EntityStateException,
        client.InvalidConfigurationException,
        client.InvalidCustomSesConfigurationException,
        client.InvalidParameterException,
        client.InvalidPasswordException,
        client.LimitExceededException,
        client.MailDomainInUseException,
        client.MailDomainNotFoundException,
        client.MailDomainStateException,
        client.NameAvailabilityException,
        client.OrganizationNotFoundException,
        client.OrganizationStateException,
        client.ReservedNameException,
        client.ResourceNotFoundException,
        client.TooManyTagsException,
        client.UnsupportedOperationException,
    ) as e:
        print(e)
Type checking example
from types_aiobotocore_workmail.client import Exceptions

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

Methods

associate_delegate_to_resource

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

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

Method definition
await def associate_delegate_to_resource(
    self,
    *,
    OrganizationId: str,
    ResourceId: str,
    EntityId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: AssociateDelegateToResourceRequestRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "ResourceId": ...,
    "EntityId": ...,
}

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

associate_member_to_group

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

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

Method definition
await def associate_member_to_group(
    self,
    *,
    OrganizationId: str,
    GroupId: str,
    MemberId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: AssociateMemberToGroupRequestRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "GroupId": ...,
    "MemberId": ...,
}

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

can_paginate

Check if an operation can be paginated.

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

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

cancel_mailbox_export_job

Cancels a mailbox export job.

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

Method definition
await def cancel_mailbox_export_job(
    self,
    *,
    ClientToken: str,
    JobId: str,
    OrganizationId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: CancelMailboxExportJobRequestRequestTypeDef = {  # (1)
    "ClientToken": ...,
    "JobId": ...,
    "OrganizationId": ...,
}

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

close

Closes underlying endpoint connections.

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

Method definition
await def close(
    self,
) -> None:
    ...

create_alias

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

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

Method definition
await def create_alias(
    self,
    *,
    OrganizationId: str,
    EntityId: str,
    Alias: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: CreateAliasRequestRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "EntityId": ...,
    "Alias": ...,
}

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

create_availability_configuration

Creates an AvailabilityConfiguration for the given WorkMail organization and domain.

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

Method definition
await 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
Usage example with kwargs
kwargs: CreateAvailabilityConfigurationRequestRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "DomainName": ...,
}

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

create_group

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

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

Method definition
await def create_group(
    self,
    *,
    OrganizationId: str,
    Name: str,
) -> CreateGroupResponseTypeDef:  # (1)
    ...
  1. See CreateGroupResponseTypeDef
Usage example with kwargs
kwargs: CreateGroupRequestRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "Name": ...,
}

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

create_mobile_device_access_rule

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

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

Method definition
await 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
Usage example with kwargs
kwargs: CreateMobileDeviceAccessRuleRequestRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "Name": ...,
    "Effect": ...,
}

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

create_organization

Creates a new Amazon WorkMail organization.

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

Method definition
await def create_organization(
    self,
    *,
    Alias: str,
    DirectoryId: str = ...,
    ClientToken: str = ...,
    Domains: Sequence[DomainTypeDef] = ...,  # (1)
    KmsKeyArn: str = ...,
    EnableInteroperability: bool = ...,
) -> CreateOrganizationResponseTypeDef:  # (2)
    ...
  1. See DomainTypeDef
  2. See CreateOrganizationResponseTypeDef
Usage example with kwargs
kwargs: CreateOrganizationRequestRequestTypeDef = {  # (1)
    "Alias": ...,
}

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

create_resource

Creates a new Amazon WorkMail resource.

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

Method definition
await def create_resource(
    self,
    *,
    OrganizationId: str,
    Name: str,
    Type: ResourceTypeType,  # (1)
) -> CreateResourceResponseTypeDef:  # (2)
    ...
  1. See ResourceTypeType
  2. See CreateResourceResponseTypeDef
Usage example with kwargs
kwargs: CreateResourceRequestRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "Name": ...,
    "Type": ...,
}

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

create_user

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

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

Method definition
await def create_user(
    self,
    *,
    OrganizationId: str,
    Name: str,
    DisplayName: str,
    Password: str,
) -> CreateUserResponseTypeDef:  # (1)
    ...
  1. See CreateUserResponseTypeDef
Usage example with kwargs
kwargs: CreateUserRequestRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "Name": ...,
    "DisplayName": ...,
    "Password": ...,
}

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

delete_access_control_rule

Deletes an access control rule for the specified WorkMail organization.

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

Method definition
await def delete_access_control_rule(
    self,
    *,
    OrganizationId: str,
    Name: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteAccessControlRuleRequestRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "Name": ...,
}

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

delete_alias

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

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

Method definition
await def delete_alias(
    self,
    *,
    OrganizationId: str,
    EntityId: str,
    Alias: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteAliasRequestRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "EntityId": ...,
    "Alias": ...,
}

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

delete_availability_configuration

Deletes the AvailabilityConfiguration for the given WorkMail organization and domain.

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

Method definition
await def delete_availability_configuration(
    self,
    *,
    OrganizationId: str,
    DomainName: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteAvailabilityConfigurationRequestRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "DomainName": ...,
}

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

delete_email_monitoring_configuration

Deletes the email monitoring configuration for a specified organization.

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

Method definition
await def delete_email_monitoring_configuration(
    self,
    *,
    OrganizationId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteEmailMonitoringConfigurationRequestRequestTypeDef = {  # (1)
    "OrganizationId": ...,
}

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

delete_group

Deletes a group from Amazon WorkMail.

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

Method definition
await def delete_group(
    self,
    *,
    OrganizationId: str,
    GroupId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteGroupRequestRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "GroupId": ...,
}

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

delete_mailbox_permissions

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

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

Method definition
await def delete_mailbox_permissions(
    self,
    *,
    OrganizationId: str,
    EntityId: str,
    GranteeId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteMailboxPermissionsRequestRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "EntityId": ...,
    "GranteeId": ...,
}

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

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 session.client("workmail").delete_mobile_device_access_override method. boto3 documentation

Method definition
await def delete_mobile_device_access_override(
    self,
    *,
    OrganizationId: str,
    UserId: str,
    DeviceId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteMobileDeviceAccessOverrideRequestRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "UserId": ...,
    "DeviceId": ...,
}

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

delete_mobile_device_access_rule

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

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

Method definition
await def delete_mobile_device_access_rule(
    self,
    *,
    OrganizationId: str,
    MobileDeviceAccessRuleId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteMobileDeviceAccessRuleRequestRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "MobileDeviceAccessRuleId": ...,
}

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

delete_organization

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

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

Method definition
await def delete_organization(
    self,
    *,
    OrganizationId: str,
    DeleteDirectory: bool,
    ClientToken: str = ...,
) -> DeleteOrganizationResponseTypeDef:  # (1)
    ...
  1. See DeleteOrganizationResponseTypeDef
Usage example with kwargs
kwargs: DeleteOrganizationRequestRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "DeleteDirectory": ...,
}

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

delete_resource

Deletes the specified resource.

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

Method definition
await def delete_resource(
    self,
    *,
    OrganizationId: str,
    ResourceId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteResourceRequestRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "ResourceId": ...,
}

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

delete_retention_policy

Deletes the specified retention policy from the specified organization.

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

Method definition
await def delete_retention_policy(
    self,
    *,
    OrganizationId: str,
    Id: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteRetentionPolicyRequestRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "Id": ...,
}

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

delete_user

Deletes a user from Amazon WorkMail and all subsequent systems.

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

Method definition
await def delete_user(
    self,
    *,
    OrganizationId: str,
    UserId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteUserRequestRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "UserId": ...,
}

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

deregister_from_work_mail

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

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

Method definition
await def deregister_from_work_mail(
    self,
    *,
    OrganizationId: str,
    EntityId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeregisterFromWorkMailRequestRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "EntityId": ...,
}

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

deregister_mail_domain

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

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

Method definition
await def deregister_mail_domain(
    self,
    *,
    OrganizationId: str,
    DomainName: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeregisterMailDomainRequestRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "DomainName": ...,
}

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

describe_email_monitoring_configuration

Describes the current email monitoring configuration for a specified organization.

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

Method definition
await def describe_email_monitoring_configuration(
    self,
    *,
    OrganizationId: str,
) -> DescribeEmailMonitoringConfigurationResponseTypeDef:  # (1)
    ...
  1. See DescribeEmailMonitoringConfigurationResponseTypeDef
Usage example with kwargs
kwargs: DescribeEmailMonitoringConfigurationRequestRequestTypeDef = {  # (1)
    "OrganizationId": ...,
}

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

describe_group

Returns the data available for the group.

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

Method definition
await def describe_group(
    self,
    *,
    OrganizationId: str,
    GroupId: str,
) -> DescribeGroupResponseTypeDef:  # (1)
    ...
  1. See DescribeGroupResponseTypeDef
Usage example with kwargs
kwargs: DescribeGroupRequestRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "GroupId": ...,
}

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

describe_inbound_dmarc_settings

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

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

Method definition
await def describe_inbound_dmarc_settings(
    self,
    *,
    OrganizationId: str,
) -> DescribeInboundDmarcSettingsResponseTypeDef:  # (1)
    ...
  1. See DescribeInboundDmarcSettingsResponseTypeDef
Usage example with kwargs
kwargs: DescribeInboundDmarcSettingsRequestRequestTypeDef = {  # (1)
    "OrganizationId": ...,
}

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

describe_mailbox_export_job

Describes the current status of a mailbox export job.

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

Method definition
await def describe_mailbox_export_job(
    self,
    *,
    JobId: str,
    OrganizationId: str,
) -> DescribeMailboxExportJobResponseTypeDef:  # (1)
    ...
  1. See DescribeMailboxExportJobResponseTypeDef
Usage example with kwargs
kwargs: DescribeMailboxExportJobRequestRequestTypeDef = {  # (1)
    "JobId": ...,
    "OrganizationId": ...,
}

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

describe_organization

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

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

Method definition
await def describe_organization(
    self,
    *,
    OrganizationId: str,
) -> DescribeOrganizationResponseTypeDef:  # (1)
    ...
  1. See DescribeOrganizationResponseTypeDef
Usage example with kwargs
kwargs: DescribeOrganizationRequestRequestTypeDef = {  # (1)
    "OrganizationId": ...,
}

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

describe_resource

Returns the data available for the resource.

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

Method definition
await def describe_resource(
    self,
    *,
    OrganizationId: str,
    ResourceId: str,
) -> DescribeResourceResponseTypeDef:  # (1)
    ...
  1. See DescribeResourceResponseTypeDef
Usage example with kwargs
kwargs: DescribeResourceRequestRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "ResourceId": ...,
}

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

describe_user

Provides information regarding the user.

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

Method definition
await def describe_user(
    self,
    *,
    OrganizationId: str,
    UserId: str,
) -> DescribeUserResponseTypeDef:  # (1)
    ...
  1. See DescribeUserResponseTypeDef
Usage example with kwargs
kwargs: DescribeUserRequestRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "UserId": ...,
}

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

disassociate_delegate_from_resource

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

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

Method definition
await def disassociate_delegate_from_resource(
    self,
    *,
    OrganizationId: str,
    ResourceId: str,
    EntityId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DisassociateDelegateFromResourceRequestRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "ResourceId": ...,
    "EntityId": ...,
}

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

disassociate_member_from_group

Removes a member from a group.

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

Method definition
await def disassociate_member_from_group(
    self,
    *,
    OrganizationId: str,
    GroupId: str,
    MemberId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DisassociateMemberFromGroupRequestRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "GroupId": ...,
    "MemberId": ...,
}

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

generate_presigned_url

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

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

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

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, or user ID.

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

Method definition
await def get_access_control_effect(
    self,
    *,
    OrganizationId: str,
    IpAddress: str,
    Action: str,
    UserId: str,
) -> GetAccessControlEffectResponseTypeDef:  # (1)
    ...
  1. See GetAccessControlEffectResponseTypeDef
Usage example with kwargs
kwargs: GetAccessControlEffectRequestRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "IpAddress": ...,
    "Action": ...,
    "UserId": ...,
}

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

get_default_retention_policy

Gets the default retention policy details for the specified organization.

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

Method definition
await def get_default_retention_policy(
    self,
    *,
    OrganizationId: str,
) -> GetDefaultRetentionPolicyResponseTypeDef:  # (1)
    ...
  1. See GetDefaultRetentionPolicyResponseTypeDef
Usage example with kwargs
kwargs: GetDefaultRetentionPolicyRequestRequestTypeDef = {  # (1)
    "OrganizationId": ...,
}

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

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 session.client("workmail").get_mail_domain method. boto3 documentation

Method definition
await def get_mail_domain(
    self,
    *,
    OrganizationId: str,
    DomainName: str,
) -> GetMailDomainResponseTypeDef:  # (1)
    ...
  1. See GetMailDomainResponseTypeDef
Usage example with kwargs
kwargs: GetMailDomainRequestRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "DomainName": ...,
}

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

get_mailbox_details

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

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

Method definition
await def get_mailbox_details(
    self,
    *,
    OrganizationId: str,
    UserId: str,
) -> GetMailboxDetailsResponseTypeDef:  # (1)
    ...
  1. See GetMailboxDetailsResponseTypeDef
Usage example with kwargs
kwargs: GetMailboxDetailsRequestRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "UserId": ...,
}

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

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 session.client("workmail").get_mobile_device_access_effect method. boto3 documentation

Method definition
await def get_mobile_device_access_effect(
    self,
    *,
    OrganizationId: str,
    DeviceType: str = ...,
    DeviceModel: str = ...,
    DeviceOperatingSystem: str = ...,
    DeviceUserAgent: str = ...,
) -> GetMobileDeviceAccessEffectResponseTypeDef:  # (1)
    ...
  1. See GetMobileDeviceAccessEffectResponseTypeDef
Usage example with kwargs
kwargs: GetMobileDeviceAccessEffectRequestRequestTypeDef = {  # (1)
    "OrganizationId": ...,
}

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

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 session.client("workmail").get_mobile_device_access_override method. boto3 documentation

Method definition
await def get_mobile_device_access_override(
    self,
    *,
    OrganizationId: str,
    UserId: str,
    DeviceId: str,
) -> GetMobileDeviceAccessOverrideResponseTypeDef:  # (1)
    ...
  1. See GetMobileDeviceAccessOverrideResponseTypeDef
Usage example with kwargs
kwargs: GetMobileDeviceAccessOverrideRequestRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "UserId": ...,
    "DeviceId": ...,
}

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

list_access_control_rules

Lists the access control rules for the specified organization.

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

Method definition
await def list_access_control_rules(
    self,
    *,
    OrganizationId: str,
) -> ListAccessControlRulesResponseTypeDef:  # (1)
    ...
  1. See ListAccessControlRulesResponseTypeDef
Usage example with kwargs
kwargs: ListAccessControlRulesRequestRequestTypeDef = {  # (1)
    "OrganizationId": ...,
}

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

list_aliases

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

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

Method definition
await def list_aliases(
    self,
    *,
    OrganizationId: str,
    EntityId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListAliasesResponseTypeDef:  # (1)
    ...
  1. See ListAliasesResponseTypeDef
Usage example with kwargs
kwargs: ListAliasesRequestRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "EntityId": ...,
}

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

list_availability_configurations

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

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

Method definition
await def list_availability_configurations(
    self,
    *,
    OrganizationId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListAvailabilityConfigurationsResponseTypeDef:  # (1)
    ...
  1. See ListAvailabilityConfigurationsResponseTypeDef
Usage example with kwargs
kwargs: ListAvailabilityConfigurationsRequestRequestTypeDef = {  # (1)
    "OrganizationId": ...,
}

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

list_group_members

Returns an overview of the members of a group.

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

Method definition
await def list_group_members(
    self,
    *,
    OrganizationId: str,
    GroupId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListGroupMembersResponseTypeDef:  # (1)
    ...
  1. See ListGroupMembersResponseTypeDef
Usage example with kwargs
kwargs: ListGroupMembersRequestRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "GroupId": ...,
}

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

list_groups

Returns summaries of the organization's groups.

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

Method definition
await def list_groups(
    self,
    *,
    OrganizationId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListGroupsResponseTypeDef:  # (1)
    ...
  1. See ListGroupsResponseTypeDef
Usage example with kwargs
kwargs: ListGroupsRequestRequestTypeDef = {  # (1)
    "OrganizationId": ...,
}

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

list_mail_domains

Lists the mail domains in a given Amazon WorkMail organization.

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

Method definition
await def list_mail_domains(
    self,
    *,
    OrganizationId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListMailDomainsResponseTypeDef:  # (1)
    ...
  1. See ListMailDomainsResponseTypeDef
Usage example with kwargs
kwargs: ListMailDomainsRequestRequestTypeDef = {  # (1)
    "OrganizationId": ...,
}

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

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 session.client("workmail").list_mailbox_export_jobs method. boto3 documentation

Method definition
await def list_mailbox_export_jobs(
    self,
    *,
    OrganizationId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListMailboxExportJobsResponseTypeDef:  # (1)
    ...
  1. See ListMailboxExportJobsResponseTypeDef
Usage example with kwargs
kwargs: ListMailboxExportJobsRequestRequestTypeDef = {  # (1)
    "OrganizationId": ...,
}

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

list_mailbox_permissions

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

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

Method definition
await def list_mailbox_permissions(
    self,
    *,
    OrganizationId: str,
    EntityId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListMailboxPermissionsResponseTypeDef:  # (1)
    ...
  1. See ListMailboxPermissionsResponseTypeDef
Usage example with kwargs
kwargs: ListMailboxPermissionsRequestRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "EntityId": ...,
}

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

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 session.client("workmail").list_mobile_device_access_overrides method. boto3 documentation

Method definition
await def list_mobile_device_access_overrides(
    self,
    *,
    OrganizationId: str,
    UserId: str = ...,
    DeviceId: str = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListMobileDeviceAccessOverridesResponseTypeDef:  # (1)
    ...
  1. See ListMobileDeviceAccessOverridesResponseTypeDef
Usage example with kwargs
kwargs: ListMobileDeviceAccessOverridesRequestRequestTypeDef = {  # (1)
    "OrganizationId": ...,
}

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

list_mobile_device_access_rules

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

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

Method definition
await def list_mobile_device_access_rules(
    self,
    *,
    OrganizationId: str,
) -> ListMobileDeviceAccessRulesResponseTypeDef:  # (1)
    ...
  1. See ListMobileDeviceAccessRulesResponseTypeDef
Usage example with kwargs
kwargs: ListMobileDeviceAccessRulesRequestRequestTypeDef = {  # (1)
    "OrganizationId": ...,
}

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

list_organizations

Returns summaries of the customer's organizations.

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

Method definition
await def list_organizations(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListOrganizationsResponseTypeDef:  # (1)
    ...
  1. See ListOrganizationsResponseTypeDef
Usage example with kwargs
kwargs: ListOrganizationsRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

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

list_resource_delegates

Lists the delegates associated with a resource.

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

Method definition
await def list_resource_delegates(
    self,
    *,
    OrganizationId: str,
    ResourceId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListResourceDelegatesResponseTypeDef:  # (1)
    ...
  1. See ListResourceDelegatesResponseTypeDef
Usage example with kwargs
kwargs: ListResourceDelegatesRequestRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "ResourceId": ...,
}

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

list_resources

Returns summaries of the organization's resources.

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

Method definition
await def list_resources(
    self,
    *,
    OrganizationId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListResourcesResponseTypeDef:  # (1)
    ...
  1. See ListResourcesResponseTypeDef
Usage example with kwargs
kwargs: ListResourcesRequestRequestTypeDef = {  # (1)
    "OrganizationId": ...,
}

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

list_tags_for_resource

Lists the tags applied to an Amazon WorkMail organization resource.

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

Method definition
await def list_tags_for_resource(
    self,
    *,
    ResourceARN: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef
Usage example with kwargs
kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "ResourceARN": ...,
}

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

list_users

Returns summaries of the organization's users.

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

Method definition
await def list_users(
    self,
    *,
    OrganizationId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListUsersResponseTypeDef:  # (1)
    ...
  1. See ListUsersResponseTypeDef
Usage example with kwargs
kwargs: ListUsersRequestRequestTypeDef = {  # (1)
    "OrganizationId": ...,
}

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

put_access_control_rule

Adds a new access control rule for the specified organization.

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

Method definition
await 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] = ...,
) -> Dict[str, Any]:
    ...
  1. See AccessControlRuleEffectType
Usage example with kwargs
kwargs: PutAccessControlRuleRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "Effect": ...,
    "Description": ...,
    "OrganizationId": ...,
}

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

put_email_monitoring_configuration

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

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

Method definition
await def put_email_monitoring_configuration(
    self,
    *,
    OrganizationId: str,
    RoleArn: str,
    LogGroupArn: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: PutEmailMonitoringConfigurationRequestRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "RoleArn": ...,
    "LogGroupArn": ...,
}

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

put_inbound_dmarc_settings

Enables or disables a DMARC policy for a given organization.

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

Method definition
await def put_inbound_dmarc_settings(
    self,
    *,
    OrganizationId: str,
    Enforced: bool,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: PutInboundDmarcSettingsRequestRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "Enforced": ...,
}

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

put_mailbox_permissions

Sets permissions for a user, group, or resource.

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

Method definition
await def put_mailbox_permissions(
    self,
    *,
    OrganizationId: str,
    EntityId: str,
    GranteeId: str,
    PermissionValues: Sequence[PermissionTypeType],  # (1)
) -> Dict[str, Any]:
    ...
  1. See PermissionTypeType
Usage example with kwargs
kwargs: PutMailboxPermissionsRequestRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "EntityId": ...,
    "GranteeId": ...,
    "PermissionValues": ...,
}

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

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 session.client("workmail").put_mobile_device_access_override method. boto3 documentation

Method definition
await def put_mobile_device_access_override(
    self,
    *,
    OrganizationId: str,
    UserId: str,
    DeviceId: str,
    Effect: MobileDeviceAccessRuleEffectType,  # (1)
    Description: str = ...,
) -> Dict[str, Any]:
    ...
  1. See MobileDeviceAccessRuleEffectType
Usage example with kwargs
kwargs: PutMobileDeviceAccessOverrideRequestRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "UserId": ...,
    "DeviceId": ...,
    "Effect": ...,
}

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

put_retention_policy

Puts a retention policy to the specified organization.

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

Method definition
await def put_retention_policy(
    self,
    *,
    OrganizationId: str,
    Name: str,
    FolderConfigurations: Sequence[FolderConfigurationTypeDef],  # (1)
    Id: str = ...,
    Description: str = ...,
) -> Dict[str, Any]:
    ...
  1. See FolderConfigurationTypeDef
Usage example with kwargs
kwargs: PutRetentionPolicyRequestRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "Name": ...,
    "FolderConfigurations": ...,
}

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

register_mail_domain

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

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

Method definition
await def register_mail_domain(
    self,
    *,
    OrganizationId: str,
    DomainName: str,
    ClientToken: str = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: RegisterMailDomainRequestRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "DomainName": ...,
}

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

register_to_work_mail

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

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

Method definition
await def register_to_work_mail(
    self,
    *,
    OrganizationId: str,
    EntityId: str,
    Email: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: RegisterToWorkMailRequestRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "EntityId": ...,
    "Email": ...,
}

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

reset_password

Allows the administrator to reset the password for a user.

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

Method definition
await def reset_password(
    self,
    *,
    OrganizationId: str,
    UserId: str,
    Password: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: ResetPasswordRequestRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "UserId": ...,
    "Password": ...,
}

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

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 session.client("workmail").start_mailbox_export_job method. boto3 documentation

Method definition
await 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
Usage example with kwargs
kwargs: StartMailboxExportJobRequestRequestTypeDef = {  # (1)
    "ClientToken": ...,
    "OrganizationId": ...,
    "EntityId": ...,
    "RoleArn": ...,
    "KmsKeyArn": ...,
    "S3BucketName": ...,
    "S3Prefix": ...,
}

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

tag_resource

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

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

Method definition
await def tag_resource(
    self,
    *,
    ResourceARN: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...
  1. See TagTypeDef
Usage example with kwargs
kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "ResourceARN": ...,
    "Tags": ...,
}

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

test_availability_configuration

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

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

Method definition
await 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
Usage example with kwargs
kwargs: TestAvailabilityConfigurationRequestRequestTypeDef = {  # (1)
    "OrganizationId": ...,
}

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

untag_resource

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

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

Method definition
await def untag_resource(
    self,
    *,
    ResourceARN: str,
    TagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "ResourceARN": ...,
    "TagKeys": ...,
}

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

update_availability_configuration

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

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

Method definition
await def update_availability_configuration(
    self,
    *,
    OrganizationId: str,
    DomainName: str,
    EwsProvider: EwsAvailabilityProviderTypeDef = ...,  # (1)
    LambdaProvider: LambdaAvailabilityProviderTypeDef = ...,  # (2)
) -> Dict[str, Any]:
    ...
  1. See EwsAvailabilityProviderTypeDef
  2. See LambdaAvailabilityProviderTypeDef
Usage example with kwargs
kwargs: UpdateAvailabilityConfigurationRequestRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "DomainName": ...,
}

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

update_default_mail_domain

Updates the default mail domain for an organization.

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

Method definition
await def update_default_mail_domain(
    self,
    *,
    OrganizationId: str,
    DomainName: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: UpdateDefaultMailDomainRequestRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "DomainName": ...,
}

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

update_mailbox_quota

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

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

Method definition
await def update_mailbox_quota(
    self,
    *,
    OrganizationId: str,
    UserId: str,
    MailboxQuota: int,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: UpdateMailboxQuotaRequestRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "UserId": ...,
    "MailboxQuota": ...,
}

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

update_mobile_device_access_rule

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

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

Method definition
await 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
Usage example with kwargs
kwargs: UpdateMobileDeviceAccessRuleRequestRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "MobileDeviceAccessRuleId": ...,
    "Name": ...,
    "Effect": ...,
}

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

update_primary_email_address

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

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

Method definition
await def update_primary_email_address(
    self,
    *,
    OrganizationId: str,
    EntityId: str,
    Email: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: UpdatePrimaryEmailAddressRequestRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "EntityId": ...,
    "Email": ...,
}

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

update_resource

Updates data for the resource.

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

Method definition
await def update_resource(
    self,
    *,
    OrganizationId: str,
    ResourceId: str,
    Name: str = ...,
    BookingOptions: BookingOptionsTypeDef = ...,  # (1)
) -> Dict[str, Any]:
    ...
  1. See BookingOptionsTypeDef
Usage example with kwargs
kwargs: UpdateResourceRequestRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "ResourceId": ...,
}

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

__aenter__

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

Method definition
await def __aenter__(
    self,
) -> WorkMailClient:
    ...

__aexit__

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

Method definition
await def __aexit__(
    self,
    exc_type: Any,
    exc_val: Any,
    exc_tb: Any,
) -> Any:
    ...

get_paginator

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