Workmail

This page documents function available when using the Workmail module, created with @service Workmail.

Index

Documentation

Main.Workmail.associate_delegate_to_resourceMethod
associate_delegate_to_resource(entity_id, organization_id, resource_id)
associate_delegate_to_resource(entity_id, organization_id, resource_id, params::Dict{String,<:Any})

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

Arguments

  • entity_id: The member (user or group) to associate to the resource.
  • organization_id: The organization under which the resource exists.
  • resource_id: The resource for which members (users or groups) are associated.
Main.Workmail.associate_member_to_groupMethod
associate_member_to_group(group_id, member_id, organization_id)
associate_member_to_group(group_id, member_id, organization_id, params::Dict{String,<:Any})

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

Arguments

  • group_id: The group to which the member (user or group) is associated.
  • member_id: The member (user or group) to associate to the group.
  • organization_id: The organization under which the group exists.
Main.Workmail.assume_impersonation_roleMethod
assume_impersonation_role(impersonation_role_id, organization_id)
assume_impersonation_role(impersonation_role_id, organization_id, params::Dict{String,<:Any})

Assumes an impersonation role for the given WorkMail organization. This method returns an authentication token you can use to make impersonated calls.

Arguments

  • impersonation_role_id: The impersonation role ID to assume.
  • organization_id: The WorkMail organization under which the impersonation role will be assumed.
Main.Workmail.cancel_mailbox_export_jobMethod
cancel_mailbox_export_job(client_token, job_id, organization_id)
cancel_mailbox_export_job(client_token, job_id, organization_id, params::Dict{String,<:Any})

Cancels a mailbox export job. If the mailbox export job is near completion, it might not be possible to cancel it.

Arguments

  • client_token: The idempotency token for the client request.
  • job_id: The job ID.
  • organization_id: The organization ID.
Main.Workmail.create_aliasMethod
create_alias(alias, entity_id, organization_id)
create_alias(alias, entity_id, organization_id, params::Dict{String,<:Any})

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

Arguments

  • alias: The alias to add to the member set.
  • entity_id: The member (user or group) to which this alias is added.
  • organization_id: The organization under which the member (user or group) exists.
Main.Workmail.create_availability_configurationMethod
create_availability_configuration(domain_name, organization_id)
create_availability_configuration(domain_name, organization_id, params::Dict{String,<:Any})

Creates an AvailabilityConfiguration for the given WorkMail organization and domain.

Arguments

  • domain_name: The domain to which the provider applies.
  • organization_id: The WorkMail organization for which the AvailabilityConfiguration will be created.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ClientToken": An idempotent token that ensures that an API request is executed only once.
  • "EwsProvider": Exchange Web Services (EWS) availability provider definition. The request must contain exactly one provider definition, either EwsProvider or LambdaProvider.
  • "LambdaProvider": Lambda availability provider definition. The request must contain exactly one provider definition, either EwsProvider or LambdaProvider.
Main.Workmail.create_groupMethod
create_group(name, organization_id)
create_group(name, organization_id, params::Dict{String,<:Any})

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

Arguments

  • name: The name of the group.
  • organization_id: The organization under which the group is to be created.
Main.Workmail.create_impersonation_roleMethod
create_impersonation_role(name, organization_id, rules, type)
create_impersonation_role(name, organization_id, rules, type, params::Dict{String,<:Any})

Creates an impersonation role for the given WorkMail organization. Idempotency ensures that an API request completes no more than one time. With an idempotent request, if the original request completes successfully, any subsequent retries also complete successfully without performing any further actions.

Arguments

  • name: The name of the new impersonation role.
  • organization_id: The WorkMail organization to create the new impersonation role within.
  • rules: The list of rules for the impersonation role.
  • type: The impersonation role's type. The available impersonation role types are READONLY or FULLACCESS.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ClientToken": The idempotency token for the client request.
  • "Description": The description of the new impersonation role.
Main.Workmail.create_mobile_device_access_ruleMethod
create_mobile_device_access_rule(effect, name, organization_id)
create_mobile_device_access_rule(effect, name, organization_id, params::Dict{String,<:Any})

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

Arguments

  • effect: The effect of the rule when it matches. Allowed values are ALLOW or DENY.
  • name: The rule name.
  • organization_id: The WorkMail organization under which the rule will be created.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ClientToken": The idempotency token for the client request.
  • "Description": The rule description.
  • "DeviceModels": Device models that the rule will match.
  • "DeviceOperatingSystems": Device operating systems that the rule will match.
  • "DeviceTypes": Device types that the rule will match.
  • "DeviceUserAgents": Device user agents that the rule will match.
  • "NotDeviceModels": Device models that the rule will not match. All other device models will match.
  • "NotDeviceOperatingSystems": Device operating systems that the rule will not match. All other device operating systems will match.
  • "NotDeviceTypes": Device types that the rule will not match. All other device types will match.
  • "NotDeviceUserAgents": Device user agents that the rule will not match. All other device user agents will match.
Main.Workmail.create_organizationMethod
create_organization(alias)
create_organization(alias, params::Dict{String,<:Any})

Creates a new WorkMail organization. Optionally, you can choose to associate an existing AWS Directory Service directory with your organization. If an AWS Directory Service directory ID is specified, the organization alias must match the directory alias. If you choose not to associate an existing directory with your organization, then we create a new WorkMail directory for you. For more information, see Adding an organization in the WorkMail Administrator Guide. You can associate multiple email domains with an organization, then choose your default email domain from the WorkMail console. You can also associate a domain that is managed in an Amazon Route 53 public hosted zone. For more information, see Adding a domain and Choosing the default domain in the WorkMail Administrator Guide. Optionally, you can use a customer managed key from AWS Key Management Service (AWS KMS) to encrypt email for your organization. If you don't associate an AWS KMS key, WorkMail creates a default, AWS managed key for you.

Arguments

  • alias: The organization alias.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ClientToken": The idempotency token associated with the request.
  • "DirectoryId": The AWS Directory Service directory ID.
  • "Domains": The email domains to associate with the organization.
  • "EnableInteroperability": When true, allows organization interoperability between WorkMail and Microsoft Exchange. If true, you must include a AD Connector directory ID in the request.
  • "KmsKeyArn": The Amazon Resource Name (ARN) of a customer managed key from AWS KMS.
Main.Workmail.create_resourceMethod
create_resource(name, organization_id, type)
create_resource(name, organization_id, type, params::Dict{String,<:Any})

Creates a new WorkMail resource.

Arguments

  • name: The name of the new resource.
  • organization_id: The identifier associated with the organization for which the resource is created.
  • type: The type of the new resource. The available types are equipment and room.
Main.Workmail.create_userMethod
create_user(display_name, name, organization_id, password)
create_user(display_name, name, organization_id, password, params::Dict{String,<:Any})

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

Arguments

  • display_name: The display name for the new user.
  • name: The name for the new user. WorkMail directory user names have a maximum length of
    1. All others have a maximum length of 20.
  • organization_id: The identifier of the organization for which the user is created.
  • password: The password for the new user.
Main.Workmail.delete_access_control_ruleMethod
delete_access_control_rule(name, organization_id)
delete_access_control_rule(name, organization_id, params::Dict{String,<:Any})

Deletes an access control rule for the specified WorkMail organization. Deleting already deleted and non-existing rules does not produce an error. In those cases, the service sends back an HTTP 200 response with an empty HTTP body.

Arguments

  • name: The name of the access control rule.
  • organization_id: The identifier for the organization.
Main.Workmail.delete_aliasMethod
delete_alias(alias, entity_id, organization_id)
delete_alias(alias, entity_id, organization_id, params::Dict{String,<:Any})

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

Arguments

  • alias: The aliases to be removed from the user's set of aliases. Duplicate entries in the list are collapsed into single entries (the list is transformed into a set).
  • entity_id: The identifier for the member (user or group) from which to have the aliases removed.
  • organization_id: The identifier for the organization under which the user exists.
Main.Workmail.delete_availability_configurationMethod
delete_availability_configuration(domain_name, organization_id)
delete_availability_configuration(domain_name, organization_id, params::Dict{String,<:Any})

Deletes the AvailabilityConfiguration for the given WorkMail organization and domain.

Arguments

  • domain_name: The domain for which the AvailabilityConfiguration will be deleted.
  • organization_id: The WorkMail organization for which the AvailabilityConfiguration will be deleted.
Main.Workmail.delete_email_monitoring_configurationMethod
delete_email_monitoring_configuration(organization_id)
delete_email_monitoring_configuration(organization_id, params::Dict{String,<:Any})

Deletes the email monitoring configuration for a specified organization.

Arguments

  • organization_id: The ID of the organization from which the email monitoring configuration is deleted.
Main.Workmail.delete_groupMethod
delete_group(group_id, organization_id)
delete_group(group_id, organization_id, params::Dict{String,<:Any})

Deletes a group from WorkMail.

Arguments

  • group_id: The identifier of the group to be deleted.
  • organization_id: The organization that contains the group.
Main.Workmail.delete_impersonation_roleMethod
delete_impersonation_role(impersonation_role_id, organization_id)
delete_impersonation_role(impersonation_role_id, organization_id, params::Dict{String,<:Any})

Deletes an impersonation role for the given WorkMail organization.

Arguments

  • impersonation_role_id: The ID of the impersonation role to delete.
  • organization_id: The WorkMail organization from which to delete the impersonation role.
Main.Workmail.delete_mailbox_permissionsMethod
delete_mailbox_permissions(entity_id, grantee_id, organization_id)
delete_mailbox_permissions(entity_id, grantee_id, organization_id, params::Dict{String,<:Any})

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

Arguments

  • entity_id: The identifier of the member (user or group) that owns the mailbox.
  • grantee_id: The identifier of the member (user or group) for which to delete granted permissions.
  • organization_id: The identifier of the organization under which the member (user or group) exists.
Main.Workmail.delete_mobile_device_access_overrideMethod
delete_mobile_device_access_override(device_id, organization_id, user_id)
delete_mobile_device_access_override(device_id, organization_id, user_id, params::Dict{String,<:Any})

Deletes the mobile device access override for the given WorkMail organization, user, and device. Deleting already deleted and non-existing overrides does not produce an error. In those cases, the service sends back an HTTP 200 response with an empty HTTP body.

Arguments

  • device_id: The mobile device for which you delete the override. DeviceId is case insensitive.
  • organization_id: The WorkMail organization for which the access override will be deleted.
  • user_id: The WorkMail user for which you want to delete the override. Accepts the following types of user identities: User ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234 Email address: user@domain.tld User name: user
Main.Workmail.delete_mobile_device_access_ruleMethod
delete_mobile_device_access_rule(mobile_device_access_rule_id, organization_id)
delete_mobile_device_access_rule(mobile_device_access_rule_id, organization_id, params::Dict{String,<:Any})

Deletes a mobile device access rule for the specified WorkMail organization. Deleting already deleted and non-existing rules does not produce an error. In those cases, the service sends back an HTTP 200 response with an empty HTTP body.

Arguments

  • mobile_device_access_rule_id: The identifier of the rule to be deleted.
  • organization_id: The WorkMail organization under which the rule will be deleted.
Main.Workmail.delete_organizationMethod
delete_organization(delete_directory, organization_id)
delete_organization(delete_directory, organization_id, params::Dict{String,<:Any})

Deletes an WorkMail organization and all underlying AWS resources managed by WorkMail as part of the organization. You can choose whether to delete the associated directory. For more information, see Removing an organization in the WorkMail Administrator Guide.

Arguments

  • delete_directory: If true, deletes the AWS Directory Service directory associated with the organization.
  • organization_id: The organization ID.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ClientToken": The idempotency token associated with the request.
Main.Workmail.delete_resourceMethod
delete_resource(organization_id, resource_id)
delete_resource(organization_id, resource_id, params::Dict{String,<:Any})

Deletes the specified resource.

Arguments

  • organization_id: The identifier associated with the organization from which the resource is deleted.
  • resource_id: The identifier of the resource to be deleted.
Main.Workmail.delete_retention_policyMethod
delete_retention_policy(id, organization_id)
delete_retention_policy(id, organization_id, params::Dict{String,<:Any})

Deletes the specified retention policy from the specified organization.

Arguments

  • id: The retention policy ID.
  • organization_id: The organization ID.
Main.Workmail.delete_userMethod
delete_user(organization_id, user_id)
delete_user(organization_id, user_id, params::Dict{String,<:Any})

Deletes a user from WorkMail and all subsequent systems. Before you can delete a user, the user state must be DISABLED. Use the DescribeUser action to confirm the user state. Deleting a user is permanent and cannot be undone. WorkMail archives user mailboxes for 30 days before they are permanently removed.

Arguments

  • organization_id: The organization that contains the user to be deleted.
  • user_id: The identifier of the user to be deleted.
Main.Workmail.deregister_from_work_mailMethod
deregister_from_work_mail(entity_id, organization_id)
deregister_from_work_mail(entity_id, organization_id, params::Dict{String,<:Any})

Mark a user, group, or resource as no longer used in WorkMail. This action disassociates the mailbox and schedules it for clean-up. WorkMail keeps mailboxes for 30 days before they are permanently removed. The functionality in the console is Disable.

Arguments

  • entity_id: The identifier for the member (user or group) to be updated.
  • organization_id: The identifier for the organization under which the WorkMail entity exists.
Main.Workmail.deregister_mail_domainMethod
deregister_mail_domain(domain_name, organization_id)
deregister_mail_domain(domain_name, organization_id, params::Dict{String,<:Any})

Removes a domain from WorkMail, stops email routing to WorkMail, and removes the authorization allowing WorkMail use. SES keeps the domain because other applications may use it. You must first remove any email address used by WorkMail entities before you remove the domain.

Arguments

  • domain_name: The domain to deregister in WorkMail and SES.
  • organization_id: The WorkMail organization for which the domain will be deregistered.
Main.Workmail.describe_email_monitoring_configurationMethod
describe_email_monitoring_configuration(organization_id)
describe_email_monitoring_configuration(organization_id, params::Dict{String,<:Any})

Describes the current email monitoring configuration for a specified organization.

Arguments

  • organization_id: The ID of the organization for which the email monitoring configuration is described.
Main.Workmail.describe_groupMethod
describe_group(group_id, organization_id)
describe_group(group_id, organization_id, params::Dict{String,<:Any})

Returns the data available for the group.

Arguments

  • group_id: The identifier for the group to be described.
  • organization_id: The identifier for the organization under which the group exists.
Main.Workmail.describe_inbound_dmarc_settingsMethod
describe_inbound_dmarc_settings(organization_id)
describe_inbound_dmarc_settings(organization_id, params::Dict{String,<:Any})

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

Arguments

  • organization_id: Lists the ID of the given organization.
Main.Workmail.describe_mailbox_export_jobMethod
describe_mailbox_export_job(job_id, organization_id)
describe_mailbox_export_job(job_id, organization_id, params::Dict{String,<:Any})

Describes the current status of a mailbox export job.

Arguments

  • job_id: The mailbox export job ID.
  • organization_id: The organization ID.
Main.Workmail.describe_organizationMethod
describe_organization(organization_id)
describe_organization(organization_id, params::Dict{String,<:Any})

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

Arguments

  • organization_id: The identifier for the organization to be described.
Main.Workmail.describe_resourceMethod
describe_resource(organization_id, resource_id)
describe_resource(organization_id, resource_id, params::Dict{String,<:Any})

Returns the data available for the resource.

Arguments

  • organization_id: The identifier associated with the organization for which the resource is described.
  • resource_id: The identifier of the resource to be described.
Main.Workmail.describe_userMethod
describe_user(organization_id, user_id)
describe_user(organization_id, user_id, params::Dict{String,<:Any})

Provides information regarding the user.

Arguments

  • organization_id: The identifier for the organization under which the user exists.
  • user_id: The identifier for the user to be described.
Main.Workmail.disassociate_delegate_from_resourceMethod
disassociate_delegate_from_resource(entity_id, organization_id, resource_id)
disassociate_delegate_from_resource(entity_id, organization_id, resource_id, params::Dict{String,<:Any})

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

Arguments

  • entity_id: The identifier for the member (user, group) to be removed from the resource's delegates.
  • organization_id: The identifier for the organization under which the resource exists.
  • resource_id: The identifier of the resource from which delegates' set members are removed.
Main.Workmail.disassociate_member_from_groupMethod
disassociate_member_from_group(group_id, member_id, organization_id)
disassociate_member_from_group(group_id, member_id, organization_id, params::Dict{String,<:Any})

Removes a member from a group.

Arguments

  • group_id: The identifier for the group from which members are removed.
  • member_id: The identifier for the member to be removed to the group.
  • organization_id: The identifier for the organization under which the group exists.
Main.Workmail.get_access_control_effectMethod
get_access_control_effect(action, ip_address, organization_id)
get_access_control_effect(action, ip_address, organization_id, params::Dict{String,<:Any})

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. You must provide either the user ID or impersonation role ID. Impersonation role ID can only be used with Action EWS.

Arguments

  • action: The access protocol action. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail.
  • ip_address: The IPv4 address.
  • organization_id: The identifier for the organization.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ImpersonationRoleId": The impersonation role ID.
  • "UserId": The user ID.
Main.Workmail.get_default_retention_policyMethod
get_default_retention_policy(organization_id)
get_default_retention_policy(organization_id, params::Dict{String,<:Any})

Gets the default retention policy details for the specified organization.

Arguments

  • organization_id: The organization ID.
Main.Workmail.get_impersonation_roleMethod
get_impersonation_role(impersonation_role_id, organization_id)
get_impersonation_role(impersonation_role_id, organization_id, params::Dict{String,<:Any})

Gets the impersonation role details for the given WorkMail organization.

Arguments

  • impersonation_role_id: The impersonation role ID to retrieve.
  • organization_id: The WorkMail organization from which to retrieve the impersonation role.
Main.Workmail.get_impersonation_role_effectMethod
get_impersonation_role_effect(impersonation_role_id, organization_id, target_user)
get_impersonation_role_effect(impersonation_role_id, organization_id, target_user, params::Dict{String,<:Any})

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

Arguments

  • impersonation_role_id: The impersonation role ID to test.
  • organization_id: The WorkMail organization where the impersonation role is defined.
  • target_user: The WorkMail organization user chosen to test the impersonation role. The following identity formats are available: User ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234 Email address: user@domain.tld User name: user
Main.Workmail.get_mail_domainMethod
get_mail_domain(domain_name, organization_id)
get_mail_domain(domain_name, organization_id, params::Dict{String,<:Any})

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

Arguments

  • domain_name: The domain from which you want to retrieve details.
  • organization_id: The WorkMail organization for which the domain is retrieved.
Main.Workmail.get_mailbox_detailsMethod
get_mailbox_details(organization_id, user_id)
get_mailbox_details(organization_id, user_id, params::Dict{String,<:Any})

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

Arguments

  • organization_id: The identifier for the organization that contains the user whose mailbox details are being requested.
  • user_id: The identifier for the user whose mailbox details are being requested.
Main.Workmail.get_mobile_device_access_effectMethod
get_mobile_device_access_effect(organization_id)
get_mobile_device_access_effect(organization_id, params::Dict{String,<:Any})

Simulates the effect of the mobile device access rules for the given attributes of a sample access event. Use this method to test the effects of the current set of mobile device access rules for the WorkMail organization for a particular user's attributes.

Arguments

  • organization_id: The WorkMail organization to simulate the access effect for.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "DeviceModel": Device model the simulated user will report.
  • "DeviceOperatingSystem": Device operating system the simulated user will report.
  • "DeviceType": Device type the simulated user will report.
  • "DeviceUserAgent": Device user agent the simulated user will report.
Main.Workmail.get_mobile_device_access_overrideMethod
get_mobile_device_access_override(device_id, organization_id, user_id)
get_mobile_device_access_override(device_id, organization_id, user_id, params::Dict{String,<:Any})

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

Arguments

  • device_id: The mobile device to which the override applies. DeviceId is case insensitive.
  • organization_id: The WorkMail organization to which you want to apply the override.
  • user_id: Identifies the WorkMail user for the override. Accepts the following types of user identities: User ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234 Email address: user@domain.tld User name: user
Main.Workmail.list_access_control_rulesMethod
list_access_control_rules(organization_id)
list_access_control_rules(organization_id, params::Dict{String,<:Any})

Lists the access control rules for the specified organization.

Arguments

  • organization_id: The identifier for the organization.
Main.Workmail.list_aliasesMethod
list_aliases(entity_id, organization_id)
list_aliases(entity_id, organization_id, params::Dict{String,<:Any})

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

Arguments

  • entity_id: The identifier for the entity for which to list the aliases.
  • organization_id: The identifier for the organization under which the entity exists.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "MaxResults": The maximum number of results to return in a single call.
  • "NextToken": The token to use to retrieve the next page of results. The first call does not contain any tokens.
Main.Workmail.list_availability_configurationsMethod
list_availability_configurations(organization_id)
list_availability_configurations(organization_id, params::Dict{String,<:Any})

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

Arguments

  • organization_id: The WorkMail organization for which the AvailabilityConfiguration's will be listed.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "MaxResults": The maximum number of results to return in a single call.
  • "NextToken": The token to use to retrieve the next page of results. The first call does not require a token.
Main.Workmail.list_group_membersMethod
list_group_members(group_id, organization_id)
list_group_members(group_id, organization_id, params::Dict{String,<:Any})

Returns an overview of the members of a group. Users and groups can be members of a group.

Arguments

  • group_id: The identifier for the group to which the members (users or groups) are associated.
  • organization_id: The identifier for the organization under which the group exists.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "MaxResults": The maximum number of results to return in a single call.
  • "NextToken": The token to use to retrieve the next page of results. The first call does not contain any tokens.
Main.Workmail.list_groupsMethod
list_groups(organization_id)
list_groups(organization_id, params::Dict{String,<:Any})

Returns summaries of the organization's groups.

Arguments

  • organization_id: The identifier for the organization under which the groups exist.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "MaxResults": The maximum number of results to return in a single call.
  • "NextToken": The token to use to retrieve the next page of results. The first call does not contain any tokens.
Main.Workmail.list_impersonation_rolesMethod
list_impersonation_roles(organization_id)
list_impersonation_roles(organization_id, params::Dict{String,<:Any})

Lists all the impersonation roles for the given WorkMail organization.

Arguments

  • organization_id: The WorkMail organization to which the listed impersonation roles belong.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "MaxResults": The maximum number of results returned in a single call.
  • "NextToken": The token used to retrieve the next page of results. The first call doesn't require a token.
Main.Workmail.list_mail_domainsMethod
list_mail_domains(organization_id)
list_mail_domains(organization_id, params::Dict{String,<:Any})

Lists the mail domains in a given WorkMail organization.

Arguments

  • organization_id: The WorkMail organization for which to list domains.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "MaxResults": The maximum number of results to return in a single call.
  • "NextToken": The token to use to retrieve the next page of results. The first call does not require a token.
Main.Workmail.list_mailbox_export_jobsMethod
list_mailbox_export_jobs(organization_id)
list_mailbox_export_jobs(organization_id, params::Dict{String,<:Any})

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

Arguments

  • organization_id: The organization ID.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "MaxResults": The maximum number of results to return in a single call.
  • "NextToken": The token to use to retrieve the next page of results.
Main.Workmail.list_mailbox_permissionsMethod
list_mailbox_permissions(entity_id, organization_id)
list_mailbox_permissions(entity_id, organization_id, params::Dict{String,<:Any})

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

Arguments

  • entity_id: The identifier of the user, group, or resource for which to list mailbox permissions.
  • organization_id: The identifier of the organization under which the user, group, or resource exists.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "MaxResults": The maximum number of results to return in a single call.
  • "NextToken": The token to use to retrieve the next page of results. The first call does not contain any tokens.
Main.Workmail.list_mobile_device_access_overridesMethod
list_mobile_device_access_overrides(organization_id)
list_mobile_device_access_overrides(organization_id, params::Dict{String,<:Any})

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

Arguments

  • organization_id: The WorkMail organization under which to list mobile device access overrides.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "DeviceId": The mobile device to which the access override applies.
  • "MaxResults": The maximum number of results to return in a single call.
  • "NextToken": The token to use to retrieve the next page of results. The first call does not require a token.
  • "UserId": The WorkMail user under which you list the mobile device access overrides. Accepts the following types of user identities: User ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234 Email address: user@domain.tld User name: user
Main.Workmail.list_mobile_device_access_rulesMethod
list_mobile_device_access_rules(organization_id)
list_mobile_device_access_rules(organization_id, params::Dict{String,<:Any})

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

Arguments

  • organization_id: The WorkMail organization for which to list the rules.
Main.Workmail.list_organizationsMethod
list_organizations()
list_organizations(params::Dict{String,<:Any})

Returns summaries of the customer's organizations.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "MaxResults": The maximum number of results to return in a single call.
  • "NextToken": The token to use to retrieve the next page of results. The first call does not contain any tokens.
Main.Workmail.list_resource_delegatesMethod
list_resource_delegates(organization_id, resource_id)
list_resource_delegates(organization_id, resource_id, params::Dict{String,<:Any})

Lists the delegates associated with a resource. Users and groups can be resource delegates and answer requests on behalf of the resource.

Arguments

  • organization_id: The identifier for the organization that contains the resource for which delegates are listed.
  • resource_id: The identifier for the resource whose delegates are listed.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "MaxResults": The number of maximum results in a page.
  • "NextToken": The token used to paginate through the delegates associated with a resource.
Main.Workmail.list_resourcesMethod
list_resources(organization_id)
list_resources(organization_id, params::Dict{String,<:Any})

Returns summaries of the organization's resources.

Arguments

  • organization_id: The identifier for the organization under which the resources exist.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "MaxResults": The maximum number of results to return in a single call.
  • "NextToken": The token to use to retrieve the next page of results. The first call does not contain any tokens.
Main.Workmail.list_tags_for_resourceMethod
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})

Lists the tags applied to an WorkMail organization resource.

Arguments

  • resource_arn: The resource ARN.
Main.Workmail.list_usersMethod
list_users(organization_id)
list_users(organization_id, params::Dict{String,<:Any})

Returns summaries of the organization's users.

Arguments

  • organization_id: The identifier for the organization under which the users exist.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "MaxResults": The maximum number of results to return in a single call.
  • "NextToken": The token to use to retrieve the next page of results. The first call does not contain any tokens.
Main.Workmail.put_access_control_ruleMethod
put_access_control_rule(description, effect, name, organization_id)
put_access_control_rule(description, effect, name, organization_id, params::Dict{String,<:Any})

Adds a new access control rule for the specified organization. The rule allows or denies access to the organization for the specified IPv4 addresses, access protocol actions, user IDs and impersonation IDs. Adding a new rule with the same name as an existing rule replaces the older rule.

Arguments

  • description: The rule description.
  • effect: The rule effect.
  • name: The rule name.
  • organization_id: The identifier of the organization.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Actions": Access protocol actions to include in the rule. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail.
  • "ImpersonationRoleIds": Impersonation role IDs to include in the rule.
  • "IpRanges": IPv4 CIDR ranges to include in the rule.
  • "NotActions": Access protocol actions to exclude from the rule. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail.
  • "NotImpersonationRoleIds": Impersonation role IDs to exclude from the rule.
  • "NotIpRanges": IPv4 CIDR ranges to exclude from the rule.
  • "NotUserIds": User IDs to exclude from the rule.
  • "UserIds": User IDs to include in the rule.
Main.Workmail.put_email_monitoring_configurationMethod
put_email_monitoring_configuration(log_group_arn, organization_id, role_arn)
put_email_monitoring_configuration(log_group_arn, organization_id, role_arn, params::Dict{String,<:Any})

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

Arguments

  • log_group_arn: The Amazon Resource Name (ARN) of the CloudWatch Log group associated with the email monitoring configuration.
  • organization_id: The ID of the organization for which the email monitoring configuration is set.
  • role_arn: The Amazon Resource Name (ARN) of the IAM Role associated with the email monitoring configuration.
Main.Workmail.put_inbound_dmarc_settingsMethod
put_inbound_dmarc_settings(enforced, organization_id)
put_inbound_dmarc_settings(enforced, organization_id, params::Dict{String,<:Any})

Enables or disables a DMARC policy for a given organization.

Arguments

  • enforced: Enforces or suspends a policy after it's applied.
  • organization_id: The ID of the organization that you are applying the DMARC policy to.
Main.Workmail.put_mailbox_permissionsMethod
put_mailbox_permissions(entity_id, grantee_id, organization_id, permission_values)
put_mailbox_permissions(entity_id, grantee_id, organization_id, permission_values, params::Dict{String,<:Any})

Sets permissions for a user, group, or resource. This replaces any pre-existing permissions.

Arguments

  • entity_id: The identifier of the user, group, or resource for which to update mailbox permissions.
  • grantee_id: The identifier of the user, group, or resource to which to grant the permissions.
  • organization_id: The identifier of the organization under which the user, group, or resource exists.
  • permission_values: The permissions granted to the grantee. SENDAS allows the grantee to send email as the owner of the mailbox (the grantee is not mentioned on these emails). SENDONBEHALF allows the grantee to send email on behalf of the owner of the mailbox (the grantee is not mentioned as the physical sender of these emails). FULLACCESS allows the grantee full access to the mailbox, irrespective of other folder-level permissions set on the mailbox.
Main.Workmail.put_mobile_device_access_overrideMethod
put_mobile_device_access_override(device_id, effect, organization_id, user_id)
put_mobile_device_access_override(device_id, effect, organization_id, user_id, params::Dict{String,<:Any})

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

Arguments

  • device_id: The mobile device for which you create the override. DeviceId is case insensitive.
  • effect: The effect of the override, ALLOW or DENY.
  • organization_id: Identifies the WorkMail organization for which you create the override.
  • user_id: The WorkMail user for which you create the override. Accepts the following types of user identities: User ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234 Email address: user@domain.tld User name: user

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Description": A description of the override.
Main.Workmail.put_retention_policyMethod
put_retention_policy(folder_configurations, name, organization_id)
put_retention_policy(folder_configurations, name, organization_id, params::Dict{String,<:Any})

Puts a retention policy to the specified organization.

Arguments

  • folder_configurations: The retention policy folder configurations.
  • name: The retention policy name.
  • organization_id: The organization ID.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Description": The retention policy description.
  • "Id": The retention policy ID.
Main.Workmail.register_mail_domainMethod
register_mail_domain(domain_name, organization_id)
register_mail_domain(domain_name, organization_id, params::Dict{String,<:Any})

Registers a new domain in WorkMail and SES, and configures it for use by WorkMail. Emails received by SES for this domain are routed to the specified WorkMail organization, and WorkMail has permanent permission to use the specified domain for sending your users' emails.

Arguments

  • domain_name: The name of the mail domain to create in WorkMail and SES.
  • organization_id: The WorkMail organization under which you're creating the domain.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ClientToken": Idempotency token used when retrying requests.
Main.Workmail.register_to_work_mailMethod
register_to_work_mail(email, entity_id, organization_id)
register_to_work_mail(email, entity_id, organization_id, params::Dict{String,<:Any})

Registers an existing and disabled user, group, or resource for WorkMail use by associating a mailbox and calendaring capabilities. It performs no change if the user, group, or resource is enabled and fails if the user, group, or resource is deleted. This operation results in the accumulation of costs. For more information, see Pricing. The equivalent console functionality for this operation is Enable. Users can either be created by calling the CreateUser API operation or they can be synchronized from your directory. For more information, see DeregisterFromWorkMail.

Arguments

  • email: The email for the user, group, or resource to be updated.
  • entity_id: The identifier for the user, group, or resource to be updated.
  • organization_id: The identifier for the organization under which the user, group, or resource exists.
Main.Workmail.reset_passwordMethod
reset_password(organization_id, password, user_id)
reset_password(organization_id, password, user_id, params::Dict{String,<:Any})

Allows the administrator to reset the password for a user.

Arguments

  • organization_id: The identifier of the organization that contains the user for which the password is reset.
  • password: The new password for the user.
  • user_id: The identifier of the user for whom the password is reset.
Main.Workmail.start_mailbox_export_jobMethod
start_mailbox_export_job(client_token, entity_id, kms_key_arn, organization_id, role_arn, s3_bucket_name, s3_prefix)
start_mailbox_export_job(client_token, entity_id, kms_key_arn, organization_id, role_arn, s3_bucket_name, s3_prefix, params::Dict{String,<:Any})

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. For more information, see Exporting mailbox content in the WorkMail Administrator Guide.

Arguments

  • client_token: The idempotency token for the client request.
  • entity_id: The identifier of the user or resource associated with the mailbox.
  • kms_key_arn: The Amazon Resource Name (ARN) of the symmetric AWS Key Management Service (AWS KMS) key that encrypts the exported mailbox content.
  • organization_id: The identifier associated with the organization.
  • role_arn: The ARN of the AWS Identity and Access Management (IAM) role that grants write permission to the S3 bucket.
  • s3_bucket_name: The name of the S3 bucket.
  • s3_prefix: The S3 bucket prefix.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Description": The mailbox export job description.
Main.Workmail.tag_resourceMethod
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})

Applies the specified tags to the specified WorkMailorganization resource.

Arguments

  • resource_arn: The resource ARN.
  • tags: The tag key-value pairs.
Main.Workmail.test_availability_configurationMethod
test_availability_configuration(organization_id)
test_availability_configuration(organization_id, params::Dict{String,<:Any})

Performs a test on an availability provider to ensure that access is allowed. For EWS, it verifies the provided credentials can be used to successfully log in. For Lambda, it verifies that the Lambda function can be invoked and that the resource access policy was configured to deny anonymous access. An anonymous invocation is one done without providing either a SourceArn or SourceAccount header. The request must contain either one provider definition (EwsProvider or LambdaProvider) or the DomainName parameter. If the DomainName parameter is provided, the configuration stored under the DomainName will be tested.

Arguments

  • organization_id: The WorkMail organization where the availability provider will be tested.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "DomainName": The domain to which the provider applies. If this field is provided, a stored availability provider associated to this domain name will be tested.
  • "EwsProvider":
  • "LambdaProvider":
Main.Workmail.untag_resourceMethod
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})

Untags the specified tags from the specified WorkMail organization resource.

Arguments

  • resource_arn: The resource ARN.
  • tag_keys: The tag keys.
Main.Workmail.update_availability_configurationMethod
update_availability_configuration(domain_name, organization_id)
update_availability_configuration(domain_name, organization_id, params::Dict{String,<:Any})

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

Arguments

  • domain_name: The domain to which the provider applies the availability configuration.
  • organization_id: The WorkMail organization for which the AvailabilityConfiguration will be updated.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "EwsProvider": The EWS availability provider definition. The request must contain exactly one provider definition, either EwsProvider or LambdaProvider. The previously stored provider will be overridden by the one provided.
  • "LambdaProvider": The Lambda availability provider definition. The request must contain exactly one provider definition, either EwsProvider or LambdaProvider. The previously stored provider will be overridden by the one provided.
Main.Workmail.update_default_mail_domainMethod
update_default_mail_domain(domain_name, organization_id)
update_default_mail_domain(domain_name, organization_id, params::Dict{String,<:Any})

Updates the default mail domain for an organization. The default mail domain is used by the WorkMail AWS Console to suggest an email address when enabling a mail user. You can only have one default domain.

Arguments

  • domain_name: The domain name that will become the default domain.
  • organization_id: The WorkMail organization for which to list domains.
Main.Workmail.update_impersonation_roleMethod
update_impersonation_role(impersonation_role_id, name, organization_id, rules, type)
update_impersonation_role(impersonation_role_id, name, organization_id, rules, type, params::Dict{String,<:Any})

Updates an impersonation role for the given WorkMail organization.

Arguments

  • impersonation_role_id: The ID of the impersonation role to update.
  • name: The updated impersonation role name.
  • organization_id: The WorkMail organization that contains the impersonation role to update.
  • rules: The updated list of rules.
  • type: The updated impersonation role type.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Description": The updated impersonation role description.
Main.Workmail.update_mailbox_quotaMethod
update_mailbox_quota(mailbox_quota, organization_id, user_id)
update_mailbox_quota(mailbox_quota, organization_id, user_id, params::Dict{String,<:Any})

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

Arguments

  • mailbox_quota: The updated mailbox quota, in MB, for the specified user.
  • organization_id: The identifier for the organization that contains the user for whom to update the mailbox quota.
  • user_id: The identifer for the user for whom to update the mailbox quota.
Main.Workmail.update_mobile_device_access_ruleMethod
update_mobile_device_access_rule(effect, mobile_device_access_rule_id, name, organization_id)
update_mobile_device_access_rule(effect, mobile_device_access_rule_id, name, organization_id, params::Dict{String,<:Any})

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

Arguments

  • effect: The effect of the rule when it matches. Allowed values are ALLOW or DENY.
  • mobile_device_access_rule_id: The identifier of the rule to be updated.
  • name: The updated rule name.
  • organization_id: The WorkMail organization under which the rule will be updated.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Description": The updated rule description.
  • "DeviceModels": Device models that the updated rule will match.
  • "DeviceOperatingSystems": Device operating systems that the updated rule will match.
  • "DeviceTypes": Device types that the updated rule will match.
  • "DeviceUserAgents": User agents that the updated rule will match.
  • "NotDeviceModels": Device models that the updated rule will not match. All other device models will match.
  • "NotDeviceOperatingSystems": Device operating systems that the updated rule will not match. All other device operating systems will match.
  • "NotDeviceTypes": Device types that the updated rule will not match. All other device types will match.
  • "NotDeviceUserAgents": User agents that the updated rule will not match. All other user agents will match.
Main.Workmail.update_primary_email_addressMethod
update_primary_email_address(email, entity_id, organization_id)
update_primary_email_address(email, entity_id, organization_id, params::Dict{String,<:Any})

Updates the primary email for a user, group, or resource. The current email is moved into the list of aliases (or swapped between an existing alias and the current primary email), and the email provided in the input is promoted as the primary.

Arguments

  • email: The value of the email to be updated as primary.
  • entity_id: The user, group, or resource to update.
  • organization_id: The organization that contains the user, group, or resource to update.
Main.Workmail.update_resourceMethod
update_resource(organization_id, resource_id)
update_resource(organization_id, resource_id, params::Dict{String,<:Any})

Updates data for the resource. To have the latest information, it must be preceded by a DescribeResource call. The dataset in the request should be the one expected when performing another DescribeResource call.

Arguments

  • organization_id: The identifier associated with the organization for which the resource is updated.
  • resource_id: The identifier of the resource to be updated.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "BookingOptions": The resource's booking options to be updated.
  • "Name": The name of the resource to be updated.