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

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.

Usage example
client = boto3.client("workmail")

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

Method definition
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 boto3.client("workmail").associate_member_to_group method. boto3 documentation

Method definition
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

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

Method definition
def assume_impersonation_role(
    self,
    *,
    OrganizationId: str,
    ImpersonationRoleId: str,
) -> AssumeImpersonationRoleResponseTypeDef:  # (1)
    ...
  1. See AssumeImpersonationRoleResponseTypeDef
Usage example with kwargs
kwargs: AssumeImpersonationRoleRequestRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "ImpersonationRoleId": ...,
}

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

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.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 boto3.client("workmail").cancel_mailbox_export_job method. boto3 documentation

Method definition
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 boto3.client("workmail").close method. boto3 documentation

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

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

Method definition
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 boto3.client("workmail").create_availability_configuration method. boto3 documentation

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
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 WorkMail by calling the RegisterToWorkMail operation.

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

Method definition
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_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

Method definition
def create_impersonation_role(
    self,
    *,
    OrganizationId: str,
    Name: str,
    Type: ImpersonationRoleTypeType,  # (1)
    Rules: Sequence[ImpersonationRuleTypeDef],  # (2)
    ClientToken: str = ...,
    Description: str = ...,
) -> CreateImpersonationRoleResponseTypeDef:  # (3)
    ...
  1. See ImpersonationRoleTypeType
  2. See ImpersonationRuleTypeDef
  3. See CreateImpersonationRoleResponseTypeDef
Usage example with kwargs
kwargs: CreateImpersonationRoleRequestRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "Name": ...,
    "Type": ...,
    "Rules": ...,
}

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

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

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
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 WorkMail organization.

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

Method definition
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 WorkMail resource.

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

Method definition
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 WorkMail by calling the RegisterToWorkMail operation.

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

Method definition
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 boto3.client("workmail").delete_access_control_rule method. boto3 documentation

Method definition
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 boto3.client("workmail").delete_alias method. boto3 documentation

Method definition
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 boto3.client("workmail").delete_availability_configuration method. boto3 documentation

Method definition
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 boto3.client("workmail").delete_email_monitoring_configuration method. boto3 documentation

Method definition
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 WorkMail.

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

Method definition
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_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

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

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

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

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

Method definition
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 WorkMail organization.

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

Method definition
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 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

Method definition
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 boto3.client("workmail").delete_resource method. boto3 documentation

Method definition
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 boto3.client("workmail").delete_retention_policy method. boto3 documentation

Method definition
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 WorkMail and all subsequent systems.

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

Method definition
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 WorkMail.

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

Method definition
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 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

Method definition
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 boto3.client("workmail").describe_email_monitoring_configuration method. boto3 documentation

Method definition
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 boto3.client("workmail").describe_group method. boto3 documentation

Method definition
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 boto3.client("workmail").describe_inbound_dmarc_settings method. boto3 documentation

Method definition
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 boto3.client("workmail").describe_mailbox_export_job method. boto3 documentation

Method definition
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 boto3.client("workmail").describe_organization method. boto3 documentation

Method definition
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 boto3.client("workmail").describe_resource method. boto3 documentation

Method definition
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 boto3.client("workmail").describe_user method. boto3 documentation

Method definition
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 boto3.client("workmail").disassociate_delegate_from_resource method. boto3 documentation

Method definition
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 boto3.client("workmail").disassociate_member_from_group method. boto3 documentation

Method definition
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 boto3.client("workmail").generate_presigned_url method. boto3 documentation

Method definition
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, and user ID or impersonation role ID.

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

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

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

Method definition
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_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

Method definition
def get_impersonation_role(
    self,
    *,
    OrganizationId: str,
    ImpersonationRoleId: str,
) -> GetImpersonationRoleResponseTypeDef:  # (1)
    ...
  1. See GetImpersonationRoleResponseTypeDef
Usage example with kwargs
kwargs: GetImpersonationRoleRequestRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "ImpersonationRoleId": ...,
}

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

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

Method definition
def get_impersonation_role_effect(
    self,
    *,
    OrganizationId: str,
    ImpersonationRoleId: str,
    TargetUser: str,
) -> GetImpersonationRoleEffectResponseTypeDef:  # (1)
    ...
  1. See GetImpersonationRoleEffectResponseTypeDef
Usage example with kwargs
kwargs: GetImpersonationRoleEffectRequestRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "ImpersonationRoleId": ...,
    "TargetUser": ...,
}

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

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

Method definition
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 boto3.client("workmail").get_mailbox_details method. boto3 documentation

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

Method definition
def get_mobile_device_access_effect(
    self,
    *,
    OrganizationId: str,
    DeviceType: str = ...,
    DeviceModel: str = ...,
    DeviceOperatingSystem: str = ...,
    DeviceUserAgent: str = ...,
) -> GetMobileDeviceAccessEffectResponseTypeDef:  # (1)
    ...
  1. See