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#
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: AssociateDelegateToResourceRequestRequestTypeDef = { # (1)
"OrganizationId": ...,
"ResourceId": ...,
"EntityId": ...,
}
parent.associate_delegate_to_resource(**kwargs)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: AssociateMemberToGroupRequestRequestTypeDef = { # (1)
"OrganizationId": ...,
"GroupId": ...,
"MemberId": ...,
}
parent.associate_member_to_group(**kwargs)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)
...# assume_impersonation_role method usage example with argument unpacking
kwargs: AssumeImpersonationRoleRequestRequestTypeDef = { # (1)
"OrganizationId": ...,
"ImpersonationRoleId": ...,
}
parent.assume_impersonation_role(**kwargs)can_paginate#
Check if an operation can be paginated.
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:
...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: CancelMailboxExportJobRequestRequestTypeDef = { # (1)
"ClientToken": ...,
"JobId": ...,
"OrganizationId": ...,
}
parent.cancel_mailbox_export_job(**kwargs)close#
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("workmail").close method.
boto3 documentation
# close 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
# 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: CreateAliasRequestRequestTypeDef = { # (1)
"OrganizationId": ...,
"EntityId": ...,
"Alias": ...,
}
parent.create_alias(**kwargs)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]:
...# create_availability_configuration method usage example with argument unpacking
kwargs: CreateAvailabilityConfigurationRequestRequestTypeDef = { # (1)
"OrganizationId": ...,
"DomainName": ...,
}
parent.create_availability_configuration(**kwargs)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,
) -> CreateGroupResponseTypeDef: # (1)
...# create_group method usage example with argument unpacking
kwargs: CreateGroupRequestRequestTypeDef = { # (1)
"OrganizationId": ...,
"Name": ...,
}
parent.create_group(**kwargs)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[ImpersonationRuleTypeDef], # (2)
ClientToken: str = ...,
Description: str = ...,
) -> CreateImpersonationRoleResponseTypeDef: # (3)
...- See ImpersonationRoleTypeType
- See ImpersonationRuleTypeDef
- See CreateImpersonationRoleResponseTypeDef
# create_impersonation_role method usage example with argument unpacking
kwargs: CreateImpersonationRoleRequestRequestTypeDef = { # (1)
"OrganizationId": ...,
"Name": ...,
"Type": ...,
"Rules": ...,
}
parent.create_impersonation_role(**kwargs)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)
...# create_mobile_device_access_rule method usage example with argument unpacking
kwargs: CreateMobileDeviceAccessRuleRequestRequestTypeDef = { # (1)
"OrganizationId": ...,
"Name": ...,
"Effect": ...,
}
parent.create_mobile_device_access_rule(**kwargs)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)
...# create_organization method usage example with argument unpacking
kwargs: CreateOrganizationRequestRequestTypeDef = { # (1)
"Alias": ...,
}
parent.create_organization(**kwargs)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)
) -> CreateResourceResponseTypeDef: # (2)
...# create_resource method usage example with argument unpacking
kwargs: CreateResourceRequestRequestTypeDef = { # (1)
"OrganizationId": ...,
"Name": ...,
"Type": ...,
}
parent.create_resource(**kwargs)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,
) -> CreateUserResponseTypeDef: # (1)
...# create_user method usage example with argument unpacking
kwargs: CreateUserRequestRequestTypeDef = { # (1)
"OrganizationId": ...,
"Name": ...,
"DisplayName": ...,
"Password": ...,
}
parent.create_user(**kwargs)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: DeleteAccessControlRuleRequestRequestTypeDef = { # (1)
"OrganizationId": ...,
"Name": ...,
}
parent.delete_access_control_rule(**kwargs)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: DeleteAliasRequestRequestTypeDef = { # (1)
"OrganizationId": ...,
"EntityId": ...,
"Alias": ...,
}
parent.delete_alias(**kwargs)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: DeleteAvailabilityConfigurationRequestRequestTypeDef = { # (1)
"OrganizationId": ...,
"DomainName": ...,
}
parent.delete_availability_configuration(**kwargs)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: DeleteEmailMonitoringConfigurationRequestRequestTypeDef = { # (1)
"OrganizationId": ...,
}
parent.delete_email_monitoring_configuration(**kwargs)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: DeleteGroupRequestRequestTypeDef = { # (1)
"OrganizationId": ...,
"GroupId": ...,
}
parent.delete_group(**kwargs)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: DeleteImpersonationRoleRequestRequestTypeDef = { # (1)
"OrganizationId": ...,
"ImpersonationRoleId": ...,
}
parent.delete_impersonation_role(**kwargs)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: DeleteMailboxPermissionsRequestRequestTypeDef = { # (1)
"OrganizationId": ...,
"EntityId": ...,
"GranteeId": ...,
}
parent.delete_mailbox_permissions(**kwargs)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: DeleteMobileDeviceAccessOverrideRequestRequestTypeDef = { # (1)
"OrganizationId": ...,
"UserId": ...,
"DeviceId": ...,
}
parent.delete_mobile_device_access_override(**kwargs)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: DeleteMobileDeviceAccessRuleRequestRequestTypeDef = { # (1)
"OrganizationId": ...,
"MobileDeviceAccessRuleId": ...,
}
parent.delete_mobile_device_access_rule(**kwargs)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 = ...,
) -> DeleteOrganizationResponseTypeDef: # (1)
...# delete_organization method usage example with argument unpacking
kwargs: DeleteOrganizationRequestRequestTypeDef = { # (1)
"OrganizationId": ...,
"DeleteDirectory": ...,
}
parent.delete_organization(**kwargs)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: DeleteResourceRequestRequestTypeDef = { # (1)
"OrganizationId": ...,
"ResourceId": ...,
}
parent.delete_resource(**kwargs)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: DeleteRetentionPolicyRequestRequestTypeDef = { # (1)
"OrganizationId": ...,
"Id": ...,
}
parent.delete_retention_policy(**kwargs)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: DeleteUserRequestRequestTypeDef = { # (1)
"OrganizationId": ...,
"UserId": ...,
}
parent.delete_user(**kwargs)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: DeregisterFromWorkMailRequestRequestTypeDef = { # (1)
"OrganizationId": ...,
"EntityId": ...,
}
parent.deregister_from_work_mail(**kwargs)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: DeregisterMailDomainRequestRequestTypeDef = { # (1)
"OrganizationId": ...,
"DomainName": ...,
}
parent.deregister_mail_domain(**kwargs)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)
...# describe_email_monitoring_configuration method usage example with argument unpacking
kwargs: DescribeEmailMonitoringConfigurationRequestRequestTypeDef = { # (1)
"OrganizationId": ...,
}
parent.describe_email_monitoring_configuration(**kwargs)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)
...# describe_group method usage example with argument unpacking
kwargs: DescribeGroupRequestRequestTypeDef = { # (1)
"OrganizationId": ...,
"GroupId": ...,
}
parent.describe_group(**kwargs)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)
...# describe_inbound_dmarc_settings method usage example with argument unpacking
kwargs: DescribeInboundDmarcSettingsRequestRequestTypeDef = { # (1)
"OrganizationId": ...,
}
parent.describe_inbound_dmarc_settings(**kwargs)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)
...# describe_mailbox_export_job method usage example with argument unpacking
kwargs: DescribeMailboxExportJobRequestRequestTypeDef = { # (1)
"JobId": ...,
"OrganizationId": ...,
}
parent.describe_mailbox_export_job(**kwargs)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)
...# describe_organization method usage example with argument unpacking
kwargs: DescribeOrganizationRequestRequestTypeDef = { # (1)
"OrganizationId": ...,
}
parent.describe_organization(**kwargs)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)
...# describe_resource method usage example with argument unpacking
kwargs: DescribeResourceRequestRequestTypeDef = { # (1)
"OrganizationId": ...,
"ResourceId": ...,
}
parent.describe_resource(**kwargs)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)
...# describe_user method usage example with argument unpacking
kwargs: DescribeUserRequestRequestTypeDef = { # (1)
"OrganizationId": ...,
"UserId": ...,
}
parent.describe_user(**kwargs)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: DisassociateDelegateFromResourceRequestRequestTypeDef = { # (1)
"OrganizationId": ...,
"ResourceId": ...,
"EntityId": ...,
}
parent.disassociate_delegate_from_resource(**kwargs)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: DisassociateMemberFromGroupRequestRequestTypeDef = { # (1)
"OrganizationId": ...,
"GroupId": ...,
"MemberId": ...,
}
parent.disassociate_member_from_group(**kwargs)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
# generate_presigned_url 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
# get_access_control_effect method definition
def get_access_control_effect(
self,
*,
OrganizationId: str,
IpAddress: str,
Action: str,
UserId: str = ...,
ImpersonationRoleId: str = ...,
) -> GetAccessControlEffectResponseTypeDef: # (1)
...# get_access_control_effect method usage example with argument unpacking
kwargs: GetAccessControlEffectRequestRequestTypeDef = { # (1)
"OrganizationId": ...,
"IpAddress": ...,
"Action": ...,
}
parent.get_access_control_effect(**kwargs)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)
...# get_default_retention_policy method usage example with argument unpacking
kwargs: GetDefaultRetentionPolicyRequestRequestTypeDef = { # (1)
"OrganizationId": ...,
}
parent.get_default_retention_policy(**kwargs)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)
...# get_impersonation_role method usage example with argument unpacking
kwargs: GetImpersonationRoleRequestRequestTypeDef = { # (1)
"OrganizationId": ...,
"ImpersonationRoleId": ...,
}
parent.get_impersonation_role(**kwargs)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)
...# get_impersonation_role_effect method usage example with argument unpacking
kwargs: GetImpersonationRoleEffectRequestRequestTypeDef = { # (1)
"OrganizationId": ...,
"ImpersonationRoleId": ...,
"TargetUser": ...,
}
parent.get_impersonation_role_effect(**kwargs)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)
...# get_mail_domain method usage example with argument unpacking
kwargs: GetMailDomainRequestRequestTypeDef = { # (1)
"OrganizationId": ...,
"DomainName": ...,
}
parent.get_mail_domain(**kwargs)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)
...# get_mailbox_details method usage example with argument unpacking
kwargs: GetMailboxDetailsRequestRequestTypeDef = { # (1)
"OrganizationId": ...,
"UserId": ...,
}
parent.get_mailbox_details(**kwargs)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)
...# get_mobile_device_access_effect method usage example with argument unpacking
kwargs: GetMobileDeviceAccessEffectRequestRequestTypeDef = { # (1)
"OrganizationId": ...,
}
parent.get_mobile_device_access_effect(**kwargs)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)
...# get_mobile_device_access_override method usage example with argument unpacking
kwargs: GetMobileDeviceAccessOverrideRequestRequestTypeDef = { # (1)
"OrganizationId": ...,
"UserId": ...,
"DeviceId": ...,
}
parent.get_mobile_device_access_override(**kwargs)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)
...# list_access_control_rules method usage example with argument unpacking
kwargs: ListAccessControlRulesRequestRequestTypeDef = { # (1)
"OrganizationId": ...,
}
parent.list_access_control_rules(**kwargs)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)
...# list_aliases method usage example with argument unpacking
kwargs: ListAliasesRequestRequestTypeDef = { # (1)
"OrganizationId": ...,
"EntityId": ...,
}
parent.list_aliases(**kwargs)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)
...# list_availability_configurations method usage example with argument unpacking
kwargs: ListAvailabilityConfigurationsRequestRequestTypeDef = { # (1)
"OrganizationId": ...,
}
parent.list_availability_configurations(**kwargs)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)
...# list_group_members method usage example with argument unpacking
kwargs: ListGroupMembersRequestRequestTypeDef = { # (1)
"OrganizationId": ...,
"GroupId": ...,
}
parent.list_group_members(**kwargs)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 = ...,
) -> ListGroupsResponseTypeDef: # (1)
...# list_groups method usage example with argument unpacking
kwargs: ListGroupsRequestRequestTypeDef = { # (1)
"OrganizationId": ...,
}
parent.list_groups(**kwargs)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)
...# list_impersonation_roles method usage example with argument unpacking
kwargs: ListImpersonationRolesRequestRequestTypeDef = { # (1)
"OrganizationId": ...,
}
parent.list_impersonation_roles(**kwargs)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)
...# list_mail_domains method usage example with argument unpacking
kwargs: ListMailDomainsRequestRequestTypeDef = { # (1)
"OrganizationId": ...,
}
parent.list_mail_domains(**kwargs)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)
...# list_mailbox_export_jobs method usage example with argument unpacking
kwargs: ListMailboxExportJobsRequestRequestTypeDef = { # (1)
"OrganizationId": ...,
}
parent.list_mailbox_export_jobs(**kwargs)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)
...# list_mailbox_permissions method usage example with argument unpacking
kwargs: ListMailboxPermissionsRequestRequestTypeDef = { # (1)
"OrganizationId": ...,
"EntityId": ...,
}
parent.list_mailbox_permissions(**kwargs)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)
...# list_mobile_device_access_overrides method usage example with argument unpacking
kwargs: ListMobileDeviceAccessOverridesRequestRequestTypeDef = { # (1)
"OrganizationId": ...,
}
parent.list_mobile_device_access_overrides(**kwargs)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)
...# list_mobile_device_access_rules method usage example with argument unpacking
kwargs: ListMobileDeviceAccessRulesRequestRequestTypeDef = { # (1)
"OrganizationId": ...,
}
parent.list_mobile_device_access_rules(**kwargs)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)
...# list_organizations method usage example with argument unpacking
kwargs: ListOrganizationsRequestRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_organizations(**kwargs)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)
...# list_resource_delegates method usage example with argument unpacking
kwargs: ListResourceDelegatesRequestRequestTypeDef = { # (1)
"OrganizationId": ...,
"ResourceId": ...,
}
parent.list_resource_delegates(**kwargs)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 = ...,
) -> ListResourcesResponseTypeDef: # (1)
...# list_resources method usage example with argument unpacking
kwargs: ListResourcesRequestRequestTypeDef = { # (1)
"OrganizationId": ...,
}
parent.list_resources(**kwargs)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)
...# list_tags_for_resource method usage example with argument unpacking
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"ResourceARN": ...,
}
parent.list_tags_for_resource(**kwargs)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 = ...,
) -> ListUsersResponseTypeDef: # (1)
...# list_users method usage example with argument unpacking
kwargs: ListUsersRequestRequestTypeDef = { # (1)
"OrganizationId": ...,
}
parent.list_users(**kwargs)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]:
...# put_access_control_rule method usage example with argument unpacking
kwargs: PutAccessControlRuleRequestRequestTypeDef = { # (1)
"Name": ...,
"Effect": ...,
"Description": ...,
"OrganizationId": ...,
}
parent.put_access_control_rule(**kwargs)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: PutEmailMonitoringConfigurationRequestRequestTypeDef = { # (1)
"OrganizationId": ...,
"RoleArn": ...,
"LogGroupArn": ...,
}
parent.put_email_monitoring_configuration(**kwargs)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: PutInboundDmarcSettingsRequestRequestTypeDef = { # (1)
"OrganizationId": ...,
"Enforced": ...,
}
parent.put_inbound_dmarc_settings(**kwargs)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]:
...# put_mailbox_permissions method usage example with argument unpacking
kwargs: PutMailboxPermissionsRequestRequestTypeDef = { # (1)
"OrganizationId": ...,
"EntityId": ...,
"GranteeId": ...,
"PermissionValues": ...,
}
parent.put_mailbox_permissions(**kwargs)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.