Module types

Data structures used by operation inputs/outputs.

Modules

builders

Builders

error

Error types that Amazon WorkMail can respond with.

Structs

AccessControlRule

A rule that controls access to an WorkMail organization.

AvailabilityConfiguration

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

BookingOptions

At least one delegate must be associated to the resource to disable automatic replies from the resource.

Delegate

The name of the attribute, which is one of the values defined in the UserAttribute enumeration.

DnsRecord

A DNS record uploaded to your DNS provider.

Domain

The domain to associate with an WorkMail organization.

When you configure a domain hosted in Amazon Route 53 (Route 53), all recommended DNS records are added to the organization when you create it. For more information, see Adding a domain in the WorkMail Administrator Guide.

EwsAvailabilityProvider

Describes an EWS based availability provider. This is only used as input to the service.

FolderConfiguration

The configuration applied to an organization's folders by its retention policy.

Group

The representation of an WorkMail group.

GroupIdentifier

The identifier that contains the Group ID and name of a group.

IdentityCenterConfiguration

The IAM Identity Center configuration.

ImpersonationMatchedRule

The impersonation rule that matched the input.

ImpersonationRole

An impersonation role for the given WorkMail organization.

ImpersonationRule

The rules for the given impersonation role.

LambdaAvailabilityProvider

Describes a Lambda based availability provider.

ListGroupsFilters

Filtering options for ListGroups operation. This is only used as input to Operation.

ListGroupsForEntityFilters

Filtering options for ListGroupsForEntity operation. This is only used as input to Operation.

ListResourcesFilters

Filtering options for ListResources operation. This is only used as input to Operation.

ListUsersFilters

Filtering options for ListUsers operation. This is only used as input to Operation.

MailDomainSummary

The data for a given domain.

MailboxExportJob

The details of a mailbox export job, including the user or resource ID associated with the mailbox and the S3 bucket that the mailbox contents are exported to.

Member

The representation of a user or group.

MobileDeviceAccessMatchedRule

The rule that a simulated user matches.

MobileDeviceAccessOverride

The override object.

MobileDeviceAccessRule

A rule that controls access to mobile devices for an WorkMail group.

OrganizationSummary

The representation of an organization.

Permission

Permission granted to a user, group, or resource to access a certain aspect of another user, group, or resource mailbox.

PersonalAccessTokenConfiguration

Displays the Personal Access Token status.

PersonalAccessTokenSummary

The summary of the Personal Access Token.

RedactedEwsAvailabilityProvider

Describes an EWS based availability provider when returned from the service. It does not contain the password of the endpoint.

Resource

The representation of a resource.

Tag

Describes a tag applied to a resource.

User

The representation of an WorkMail user.

Enums

AccessControlRuleEffect

When writing a match expression against AccessControlRuleEffect, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

AccessEffect

When writing a match expression against AccessEffect, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

AvailabilityProviderType

When writing a match expression against AvailabilityProviderType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

DnsRecordVerificationStatus

When writing a match expression against DnsRecordVerificationStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

EntityState

When writing a match expression against EntityState, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

EntityType

When writing a match expression against EntityType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

FolderName

When writing a match expression against FolderName, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

IdentityProviderAuthenticationMode

When writing a match expression against IdentityProviderAuthenticationMode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ImpersonationRoleType

When writing a match expression against ImpersonationRoleType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

MailboxExportJobState

When writing a match expression against MailboxExportJobState, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

MemberType

When writing a match expression against MemberType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

MobileDeviceAccessRuleEffect

When writing a match expression against MobileDeviceAccessRuleEffect, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

PermissionType

When writing a match expression against PermissionType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

PersonalAccessTokenConfigurationStatus

When writing a match expression against PersonalAccessTokenConfigurationStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ResourceType

When writing a match expression against ResourceType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

RetentionAction

When writing a match expression against RetentionAction, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

UserRole

When writing a match expression against UserRole, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.