openapi: 3.0.0 info: version: '2017-10-01' x-release: v4 title: Amazon WorkMail description: '
WorkMail is a secure, managed business email and calendaring service with support for existing desktop and mobile email clients. You can access your email, contacts, and calendars using Microsoft Outlook, your browser, or other native iOS and Android email applications. You can integrate WorkMail with your existing corporate directory and control both the keys that encrypt your data and the location in which your data is stored.
The WorkMail API is designed for the following scenarios:
Listing and describing organizations
Managing users
Managing groups
Managing resources
All WorkMail API operations are Amazon-authenticated and certificate-signed. They not only require the use of the AWS SDK, but also allow for the exclusive use of AWS Identity and Access Management users and roles to help facilitate access, trust, and permission policies. By creating a role and allowing an IAM user to access the WorkMail site, the IAM user gains full administrative visibility into the entire WorkMail organization (or as set in the IAM policy). This includes, but is not limited to, the ability to create, update, and delete users, groups, and resources. This allows developers to perform the scenarios listed above, as well as give users the ability to grant access on a selective basis using the IAM model.
' x-logo: url: 'https://twitter.com/awscloud/profile_image?size=original' backgroundColor: '#FFFFFF' termsOfService: 'https://aws.amazon.com/service-terms/' contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: 'https://github.com/mermade/aws2openapi' x-twitter: PermittedSoc license: name: Apache 2.0 License url: 'http://www.apache.org/licenses/' x-providerName: amazonaws.com x-serviceName: workmail x-origin: - contentType: application/json url: 'https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/workmail-2017-10-01.normal.json' converter: url: 'https://github.com/mermade/aws2openapi' version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: 'https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct' x-apisguru-categories: - cloud x-preferred: true externalDocs: description: Amazon Web Services documentation url: 'https://docs.aws.amazon.com/workmail/' servers: - url: 'http://workmail.{region}.amazonaws.com' variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon WorkMail multi-region endpoint - url: 'https://workmail.{region}.amazonaws.com' variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon WorkMail multi-region endpoint - url: 'http://workmail.{region}.amazonaws.com.cn' variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon WorkMail endpoint for China (Beijing) and China (Ningxia) - url: 'https://workmail.{region}.amazonaws.com.cn' variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon WorkMail endpoint for China (Beijing) and China (Ningxia) x-hasEquivalentPaths: true paths: /#X-Amz-Target=WorkMailService.AssociateDelegateToResource: post: operationId: AssociateDelegateToResource description: Adds a member (user or group) to the resource's set of delegates. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/AssociateDelegateToResourceResponse' '480': description: EntityNotFoundException content: application/json: schema: $ref: '#/components/schemas/EntityNotFoundException' '481': description: EntityStateException content: application/json: schema: $ref: '#/components/schemas/EntityStateException' '482': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '483': description: OrganizationNotFoundException content: application/json: schema: $ref: '#/components/schemas/OrganizationNotFoundException' '484': description: OrganizationStateException content: application/json: schema: $ref: '#/components/schemas/OrganizationStateException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AssociateDelegateToResourceRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - WorkMailService.AssociateDelegateToResource summary: Amazon WorkMail Associate Delegate to Resource parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /#X-Amz-Target=WorkMailService.AssociateMemberToGroup: post: operationId: AssociateMemberToGroup description: Adds a member (user or group) to the group's set. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/AssociateMemberToGroupResponse' '480': description: DirectoryServiceAuthenticationFailedException content: application/json: schema: $ref: '#/components/schemas/DirectoryServiceAuthenticationFailedException' '481': description: DirectoryUnavailableException content: application/json: schema: $ref: '#/components/schemas/DirectoryUnavailableException' '482': description: EntityNotFoundException content: application/json: schema: $ref: '#/components/schemas/EntityNotFoundException' '483': description: EntityStateException content: application/json: schema: $ref: '#/components/schemas/EntityStateException' '484': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '485': description: OrganizationNotFoundException content: application/json: schema: $ref: '#/components/schemas/OrganizationNotFoundException' '486': description: OrganizationStateException content: application/json: schema: $ref: '#/components/schemas/OrganizationStateException' '487': description: UnsupportedOperationException content: application/json: schema: $ref: '#/components/schemas/UnsupportedOperationException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AssociateMemberToGroupRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - WorkMailService.AssociateMemberToGroup summary: Amazon WorkMail Associate Member to Group parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /#X-Amz-Target=WorkMailService.AssumeImpersonationRole: post: operationId: AssumeImpersonationRole description: Assumes an impersonation role for the given WorkMail organization. This method returns an authentication token you can use to make impersonated calls. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/AssumeImpersonationRoleResponse' '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '481': description: OrganizationNotFoundException content: application/json: schema: $ref: '#/components/schemas/OrganizationNotFoundException' '482': description: OrganizationStateException content: application/json: schema: $ref: '#/components/schemas/OrganizationStateException' '483': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AssumeImpersonationRoleRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - WorkMailService.AssumeImpersonationRole summary: Amazon WorkMail Assume Impersonation Role parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /#X-Amz-Target=WorkMailService.CancelMailboxExportJob: post: operationId: CancelMailboxExportJob description: 'Cancels a mailbox export job.
If the mailbox export job is near completion, it might not be possible to cancel it.
AvailabilityConfiguration for the given WorkMail organization and domain.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateAvailabilityConfigurationResponse'
'480':
description: OrganizationNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationNotFoundException'
'481':
description: OrganizationStateException
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationStateException'
'482':
description: NameAvailabilityException
content:
application/json:
schema:
$ref: '#/components/schemas/NameAvailabilityException'
'483':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'484':
description: LimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/LimitExceededException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateAvailabilityConfigurationRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkMailService.CreateAvailabilityConfiguration
summary: Amazon WorkMail Create Availability Configuration
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/#X-Amz-Target=WorkMailService.CreateGroup:
post:
operationId: CreateGroup
description: Creates a group that can be used in WorkMail by calling the RegisterToWorkMail operation.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateGroupResponse'
'480':
description: DirectoryServiceAuthenticationFailedException
content:
application/json:
schema:
$ref: '#/components/schemas/DirectoryServiceAuthenticationFailedException'
'481':
description: DirectoryUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/DirectoryUnavailableException'
'482':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'483':
description: NameAvailabilityException
content:
application/json:
schema:
$ref: '#/components/schemas/NameAvailabilityException'
'484':
description: OrganizationNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationNotFoundException'
'485':
description: OrganizationStateException
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationStateException'
'486':
description: ReservedNameException
content:
application/json:
schema:
$ref: '#/components/schemas/ReservedNameException'
'487':
description: UnsupportedOperationException
content:
application/json:
schema:
$ref: '#/components/schemas/UnsupportedOperationException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateGroupRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkMailService.CreateGroup
summary: Amazon WorkMail Create Group
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/#X-Amz-Target=WorkMailService.CreateImpersonationRole:
post:
operationId: CreateImpersonationRole
description: '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.
' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateImpersonationRoleResponse' '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '481': description: OrganizationNotFoundException content: application/json: schema: $ref: '#/components/schemas/OrganizationNotFoundException' '482': description: OrganizationStateException content: application/json: schema: $ref: '#/components/schemas/OrganizationStateException' '483': description: EntityNotFoundException content: application/json: schema: $ref: '#/components/schemas/EntityNotFoundException' '484': description: EntityStateException content: application/json: schema: $ref: '#/components/schemas/EntityStateException' '485': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateImpersonationRoleRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - WorkMailService.CreateImpersonationRole summary: Amazon WorkMail Create Impersonation Role parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /#X-Amz-Target=WorkMailService.CreateMobileDeviceAccessRule: post: operationId: CreateMobileDeviceAccessRule description: Creates a new mobile device access rule for the specified WorkMail organization. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateMobileDeviceAccessRuleResponse' '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '481': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '482': description: OrganizationNotFoundException content: application/json: schema: $ref: '#/components/schemas/OrganizationNotFoundException' '483': description: OrganizationStateException content: application/json: schema: $ref: '#/components/schemas/OrganizationStateException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateMobileDeviceAccessRuleRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - WorkMailService.CreateMobileDeviceAccessRule summary: Amazon WorkMail Create Mobile Device Access Rule parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /#X-Amz-Target=WorkMailService.CreateOrganization: post: operationId: CreateOrganization description: '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.
' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateOrganizationResponse' '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '481': description: DirectoryInUseException content: application/json: schema: $ref: '#/components/schemas/DirectoryInUseException' '482': description: DirectoryUnavailableException content: application/json: schema: $ref: '#/components/schemas/DirectoryUnavailableException' '483': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '484': description: NameAvailabilityException content: application/json: schema: $ref: '#/components/schemas/NameAvailabilityException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateOrganizationRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - WorkMailService.CreateOrganization summary: Amazon WorkMail Create Organization parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /#X-Amz-Target=WorkMailService.CreateResource: post: operationId: CreateResource description: Creates a new WorkMail resource. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateResourceResponse' '480': description: DirectoryServiceAuthenticationFailedException content: application/json: schema: $ref: '#/components/schemas/DirectoryServiceAuthenticationFailedException' '481': description: DirectoryUnavailableException content: application/json: schema: $ref: '#/components/schemas/DirectoryUnavailableException' '482': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '483': description: NameAvailabilityException content: application/json: schema: $ref: '#/components/schemas/NameAvailabilityException' '484': description: OrganizationNotFoundException content: application/json: schema: $ref: '#/components/schemas/OrganizationNotFoundException' '485': description: OrganizationStateException content: application/json: schema: $ref: '#/components/schemas/OrganizationStateException' '486': description: ReservedNameException content: application/json: schema: $ref: '#/components/schemas/ReservedNameException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateResourceRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - WorkMailService.CreateResource summary: Amazon WorkMail Create Resource parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /#X-Amz-Target=WorkMailService.CreateUser: post: operationId: CreateUser description: Creates a user who can be used in WorkMail by calling the RegisterToWorkMail operation. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateUserResponse' '480': description: DirectoryServiceAuthenticationFailedException content: application/json: schema: $ref: '#/components/schemas/DirectoryServiceAuthenticationFailedException' '481': description: DirectoryUnavailableException content: application/json: schema: $ref: '#/components/schemas/DirectoryUnavailableException' '482': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '483': description: InvalidPasswordException content: application/json: schema: $ref: '#/components/schemas/InvalidPasswordException' '484': description: NameAvailabilityException content: application/json: schema: $ref: '#/components/schemas/NameAvailabilityException' '485': description: OrganizationNotFoundException content: application/json: schema: $ref: '#/components/schemas/OrganizationNotFoundException' '486': description: OrganizationStateException content: application/json: schema: $ref: '#/components/schemas/OrganizationStateException' '487': description: ReservedNameException content: application/json: schema: $ref: '#/components/schemas/ReservedNameException' '488': description: UnsupportedOperationException content: application/json: schema: $ref: '#/components/schemas/UnsupportedOperationException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateUserRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - WorkMailService.CreateUser summary: Amazon WorkMail Create User parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /#X-Amz-Target=WorkMailService.DeleteAccessControlRule: post: operationId: DeleteAccessControlRule description: '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.
AvailabilityConfiguration for the given WorkMail organization and domain.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteAvailabilityConfigurationResponse'
'480':
description: OrganizationNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationNotFoundException'
'481':
description: OrganizationStateException
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationStateException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteAvailabilityConfigurationRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkMailService.DeleteAvailabilityConfiguration
summary: Amazon WorkMail Delete Availability Configuration
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/#X-Amz-Target=WorkMailService.DeleteEmailMonitoringConfiguration:
post:
operationId: DeleteEmailMonitoringConfiguration
description: Deletes the email monitoring configuration for a specified organization.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteEmailMonitoringConfigurationResponse'
'480':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'481':
description: OrganizationNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationNotFoundException'
'482':
description: OrganizationStateException
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationStateException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteEmailMonitoringConfigurationRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkMailService.DeleteEmailMonitoringConfiguration
summary: Amazon WorkMail Delete Email Monitoring Configuration
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/#X-Amz-Target=WorkMailService.DeleteGroup:
post:
operationId: DeleteGroup
description: Deletes a group from WorkMail.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteGroupResponse'
'480':
description: DirectoryServiceAuthenticationFailedException
content:
application/json:
schema:
$ref: '#/components/schemas/DirectoryServiceAuthenticationFailedException'
'481':
description: DirectoryUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/DirectoryUnavailableException'
'482':
description: EntityStateException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityStateException'
'483':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'484':
description: OrganizationNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationNotFoundException'
'485':
description: OrganizationStateException
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationStateException'
'486':
description: UnsupportedOperationException
content:
application/json:
schema:
$ref: '#/components/schemas/UnsupportedOperationException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteGroupRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkMailService.DeleteGroup
summary: Amazon WorkMail Delete Group
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/#X-Amz-Target=WorkMailService.DeleteImpersonationRole:
post:
operationId: DeleteImpersonationRole
description: Deletes an impersonation role for the given WorkMail organization.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteImpersonationRoleResponse'
'480':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'481':
description: OrganizationNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationNotFoundException'
'482':
description: OrganizationStateException
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationStateException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteImpersonationRoleRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkMailService.DeleteImpersonationRole
summary: Amazon WorkMail Delete Impersonation Role
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/#X-Amz-Target=WorkMailService.DeleteMailboxPermissions:
post:
operationId: DeleteMailboxPermissions
description: Deletes permissions granted to a member (user or group).
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteMailboxPermissionsResponse'
'480':
description: EntityNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityNotFoundException'
'481':
description: EntityStateException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityStateException'
'482':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'483':
description: OrganizationNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationNotFoundException'
'484':
description: OrganizationStateException
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationStateException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteMailboxPermissionsRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkMailService.DeleteMailboxPermissions
summary: Amazon WorkMail Delete Mailbox Permissions
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/#X-Amz-Target=WorkMailService.DeleteMobileDeviceAccessOverride:
post:
operationId: DeleteMobileDeviceAccessOverride
description: '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.
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.
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.
' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteUserResponse' '480': description: DirectoryServiceAuthenticationFailedException content: application/json: schema: $ref: '#/components/schemas/DirectoryServiceAuthenticationFailedException' '481': description: DirectoryUnavailableException content: application/json: schema: $ref: '#/components/schemas/DirectoryUnavailableException' '482': description: EntityStateException content: application/json: schema: $ref: '#/components/schemas/EntityStateException' '483': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '484': description: OrganizationNotFoundException content: application/json: schema: $ref: '#/components/schemas/OrganizationNotFoundException' '485': description: OrganizationStateException content: application/json: schema: $ref: '#/components/schemas/OrganizationStateException' '486': description: UnsupportedOperationException content: application/json: schema: $ref: '#/components/schemas/UnsupportedOperationException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DeleteUserRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - WorkMailService.DeleteUser summary: Amazon WorkMail Delete User parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /#X-Amz-Target=WorkMailService.DeregisterFromWorkMail: post: operationId: DeregisterFromWorkMail description: '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.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeregisterFromWorkMailResponse' '480': description: EntityNotFoundException content: application/json: schema: $ref: '#/components/schemas/EntityNotFoundException' '481': description: EntityStateException content: application/json: schema: $ref: '#/components/schemas/EntityStateException' '482': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '483': description: OrganizationNotFoundException content: application/json: schema: $ref: '#/components/schemas/OrganizationNotFoundException' '484': description: OrganizationStateException content: application/json: schema: $ref: '#/components/schemas/OrganizationStateException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DeregisterFromWorkMailRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - WorkMailService.DeregisterFromWorkMail summary: Amazon WorkMail Deregister from Work Mail parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /#X-Amz-Target=WorkMailService.DeregisterMailDomain: post: operationId: DeregisterMailDomain description: '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.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeregisterMailDomainResponse' '480': description: MailDomainInUseException content: application/json: schema: $ref: '#/components/schemas/MailDomainInUseException' '481': description: OrganizationNotFoundException content: application/json: schema: $ref: '#/components/schemas/OrganizationNotFoundException' '482': description: OrganizationStateException content: application/json: schema: $ref: '#/components/schemas/OrganizationStateException' '483': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '484': description: InvalidCustomSesConfigurationException content: application/json: schema: $ref: '#/components/schemas/InvalidCustomSesConfigurationException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DeregisterMailDomainRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - WorkMailService.DeregisterMailDomain summary: Amazon WorkMail Deregister Mail Domain parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /#X-Amz-Target=WorkMailService.DescribeEmailMonitoringConfiguration: post: operationId: DescribeEmailMonitoringConfiguration description: Describes the current email monitoring configuration for a specified organization. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeEmailMonitoringConfigurationResponse' '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '482': description: OrganizationNotFoundException content: application/json: schema: $ref: '#/components/schemas/OrganizationNotFoundException' '483': description: OrganizationStateException content: application/json: schema: $ref: '#/components/schemas/OrganizationStateException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DescribeEmailMonitoringConfigurationRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - WorkMailService.DescribeEmailMonitoringConfiguration summary: Amazon WorkMail Describe Email Monitoring Configuration parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /#X-Amz-Target=WorkMailService.DescribeGroup: post: operationId: DescribeGroup description: Returns the data available for the group. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeGroupResponse' '480': description: EntityNotFoundException content: application/json: schema: $ref: '#/components/schemas/EntityNotFoundException' '481': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '482': description: OrganizationNotFoundException content: application/json: schema: $ref: '#/components/schemas/OrganizationNotFoundException' '483': description: OrganizationStateException content: application/json: schema: $ref: '#/components/schemas/OrganizationStateException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DescribeGroupRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - WorkMailService.DescribeGroup summary: Amazon WorkMail Describe Group parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /#X-Amz-Target=WorkMailService.DescribeInboundDmarcSettings: post: operationId: DescribeInboundDmarcSettings description: Lists the settings in a DMARC policy for a specified organization. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeInboundDmarcSettingsResponse' '480': description: OrganizationNotFoundException content: application/json: schema: $ref: '#/components/schemas/OrganizationNotFoundException' '481': description: OrganizationStateException content: application/json: schema: $ref: '#/components/schemas/OrganizationStateException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DescribeInboundDmarcSettingsRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - WorkMailService.DescribeInboundDmarcSettings summary: Amazon WorkMail Describe Inbound Dmarc Settings parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /#X-Amz-Target=WorkMailService.DescribeMailboxExportJob: post: operationId: DescribeMailboxExportJob description: Describes the current status of a mailbox export job. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeMailboxExportJobResponse' '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '481': description: OrganizationNotFoundException content: application/json: schema: $ref: '#/components/schemas/OrganizationNotFoundException' '482': description: OrganizationStateException content: application/json: schema: $ref: '#/components/schemas/OrganizationStateException' '483': description: EntityNotFoundException content: application/json: schema: $ref: '#/components/schemas/EntityNotFoundException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DescribeMailboxExportJobRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - WorkMailService.DescribeMailboxExportJob summary: Amazon WorkMail Describe Mailbox Export Job parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /#X-Amz-Target=WorkMailService.DescribeOrganization: post: operationId: DescribeOrganization description: Provides more information regarding a given organization based on its identifier. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeOrganizationResponse' '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '481': description: OrganizationNotFoundException content: application/json: schema: $ref: '#/components/schemas/OrganizationNotFoundException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DescribeOrganizationRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - WorkMailService.DescribeOrganization summary: Amazon WorkMail Describe Organization parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /#X-Amz-Target=WorkMailService.DescribeResource: post: operationId: DescribeResource description: Returns the data available for the resource. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeResourceResponse' '480': description: EntityNotFoundException content: application/json: schema: $ref: '#/components/schemas/EntityNotFoundException' '481': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '482': description: OrganizationNotFoundException content: application/json: schema: $ref: '#/components/schemas/OrganizationNotFoundException' '483': description: OrganizationStateException content: application/json: schema: $ref: '#/components/schemas/OrganizationStateException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DescribeResourceRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - WorkMailService.DescribeResource summary: Amazon WorkMail Describe Resource parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /#X-Amz-Target=WorkMailService.DescribeUser: post: operationId: DescribeUser description: Provides information regarding the user. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeUserResponse' '480': description: EntityNotFoundException content: application/json: schema: $ref: '#/components/schemas/EntityNotFoundException' '481': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '482': description: OrganizationNotFoundException content: application/json: schema: $ref: '#/components/schemas/OrganizationNotFoundException' '483': description: OrganizationStateException content: application/json: schema: $ref: '#/components/schemas/OrganizationStateException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DescribeUserRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - WorkMailService.DescribeUser summary: Amazon WorkMail Describe User parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /#X-Amz-Target=WorkMailService.DisassociateDelegateFromResource: post: operationId: DisassociateDelegateFromResource description: Removes a member from the resource's set of delegates. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DisassociateDelegateFromResourceResponse' '480': description: EntityNotFoundException content: application/json: schema: $ref: '#/components/schemas/EntityNotFoundException' '481': description: EntityStateException content: application/json: schema: $ref: '#/components/schemas/EntityStateException' '482': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '483': description: OrganizationNotFoundException content: application/json: schema: $ref: '#/components/schemas/OrganizationNotFoundException' '484': description: OrganizationStateException content: application/json: schema: $ref: '#/components/schemas/OrganizationStateException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DisassociateDelegateFromResourceRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - WorkMailService.DisassociateDelegateFromResource summary: Amazon WorkMail Disassociate Delegate from Resource parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /#X-Amz-Target=WorkMailService.DisassociateMemberFromGroup: post: operationId: DisassociateMemberFromGroup description: Removes a member from a group. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DisassociateMemberFromGroupResponse' '480': description: DirectoryServiceAuthenticationFailedException content: application/json: schema: $ref: '#/components/schemas/DirectoryServiceAuthenticationFailedException' '481': description: DirectoryUnavailableException content: application/json: schema: $ref: '#/components/schemas/DirectoryUnavailableException' '482': description: EntityNotFoundException content: application/json: schema: $ref: '#/components/schemas/EntityNotFoundException' '483': description: EntityStateException content: application/json: schema: $ref: '#/components/schemas/EntityStateException' '484': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '485': description: OrganizationNotFoundException content: application/json: schema: $ref: '#/components/schemas/OrganizationNotFoundException' '486': description: OrganizationStateException content: application/json: schema: $ref: '#/components/schemas/OrganizationStateException' '487': description: UnsupportedOperationException content: application/json: schema: $ref: '#/components/schemas/UnsupportedOperationException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DisassociateMemberFromGroupRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - WorkMailService.DisassociateMemberFromGroup summary: Amazon WorkMail Disassociate Member from Group parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /#X-Amz-Target=WorkMailService.GetAccessControlEffect: post: operationId: GetAccessControlEffect description: '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.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetAccessControlEffectResponse' '480': description: EntityNotFoundException content: application/json: schema: $ref: '#/components/schemas/EntityNotFoundException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '483': description: OrganizationNotFoundException content: application/json: schema: $ref: '#/components/schemas/OrganizationNotFoundException' '484': description: OrganizationStateException content: application/json: schema: $ref: '#/components/schemas/OrganizationStateException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetAccessControlEffectRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - WorkMailService.GetAccessControlEffect summary: Amazon WorkMail Get Access Control Effect parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /#X-Amz-Target=WorkMailService.GetDefaultRetentionPolicy: post: operationId: GetDefaultRetentionPolicy description: Gets the default retention policy details for the specified organization. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetDefaultRetentionPolicyResponse' '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '481': description: OrganizationNotFoundException content: application/json: schema: $ref: '#/components/schemas/OrganizationNotFoundException' '482': description: OrganizationStateException content: application/json: schema: $ref: '#/components/schemas/OrganizationStateException' '483': description: EntityNotFoundException content: application/json: schema: $ref: '#/components/schemas/EntityNotFoundException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetDefaultRetentionPolicyRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - WorkMailService.GetDefaultRetentionPolicy summary: Amazon WorkMail Get Default Retention Policy parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /#X-Amz-Target=WorkMailService.GetImpersonationRole: post: operationId: GetImpersonationRole description: Gets the impersonation role details for the given WorkMail organization. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetImpersonationRoleResponse' '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '481': description: OrganizationNotFoundException content: application/json: schema: $ref: '#/components/schemas/OrganizationNotFoundException' '482': description: OrganizationStateException content: application/json: schema: $ref: '#/components/schemas/OrganizationStateException' '483': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetImpersonationRoleRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - WorkMailService.GetImpersonationRole summary: Amazon WorkMail Get Impersonation Role parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /#X-Amz-Target=WorkMailService.GetImpersonationRoleEffect: post: operationId: GetImpersonationRoleEffect description: Tests whether the given impersonation role can impersonate a target user. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetImpersonationRoleEffectResponse' '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '481': description: OrganizationNotFoundException content: application/json: schema: $ref: '#/components/schemas/OrganizationNotFoundException' '482': description: OrganizationStateException content: application/json: schema: $ref: '#/components/schemas/OrganizationStateException' '483': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '484': description: EntityNotFoundException content: application/json: schema: $ref: '#/components/schemas/EntityNotFoundException' '485': description: EntityStateException content: application/json: schema: $ref: '#/components/schemas/EntityStateException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetImpersonationRoleEffectRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - WorkMailService.GetImpersonationRoleEffect summary: Amazon WorkMail Get Impersonation Role Effect parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /#X-Amz-Target=WorkMailService.GetMailDomain: post: operationId: GetMailDomain description: 'Gets details for a mail domain, including domain records required to configure your domain with recommended security.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetMailDomainResponse' '480': description: MailDomainNotFoundException content: application/json: schema: $ref: '#/components/schemas/MailDomainNotFoundException' '481': description: OrganizationNotFoundException content: application/json: schema: $ref: '#/components/schemas/OrganizationNotFoundException' '482': description: OrganizationStateException content: application/json: schema: $ref: '#/components/schemas/OrganizationStateException' '483': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetMailDomainRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - WorkMailService.GetMailDomain summary: Amazon WorkMail Get Mail Domain parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /#X-Amz-Target=WorkMailService.GetMailboxDetails: post: operationId: GetMailboxDetails description: Requests a user's mailbox details for a specified organization and user. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetMailboxDetailsResponse' '480': description: OrganizationNotFoundException content: application/json: schema: $ref: '#/components/schemas/OrganizationNotFoundException' '481': description: OrganizationStateException content: application/json: schema: $ref: '#/components/schemas/OrganizationStateException' '482': description: EntityNotFoundException content: application/json: schema: $ref: '#/components/schemas/EntityNotFoundException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetMailboxDetailsRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - WorkMailService.GetMailboxDetails summary: Amazon WorkMail Get Mailbox Details parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /#X-Amz-Target=WorkMailService.GetMobileDeviceAccessEffect: post: operationId: GetMobileDeviceAccessEffect description: 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. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetMobileDeviceAccessEffectResponse' '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '481': description: OrganizationNotFoundException content: application/json: schema: $ref: '#/components/schemas/OrganizationNotFoundException' '482': description: OrganizationStateException content: application/json: schema: $ref: '#/components/schemas/OrganizationStateException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetMobileDeviceAccessEffectRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - WorkMailService.GetMobileDeviceAccessEffect summary: Amazon WorkMail Get Mobile Device Access Effect parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /#X-Amz-Target=WorkMailService.GetMobileDeviceAccessOverride: post: operationId: GetMobileDeviceAccessOverride description: 'Gets the mobile device access override for the given WorkMail organization, user, and device.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetMobileDeviceAccessOverrideResponse' '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '481': description: OrganizationNotFoundException content: application/json: schema: $ref: '#/components/schemas/OrganizationNotFoundException' '482': description: OrganizationStateException content: application/json: schema: $ref: '#/components/schemas/OrganizationStateException' '483': description: EntityNotFoundException content: application/json: schema: $ref: '#/components/schemas/EntityNotFoundException' '484': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetMobileDeviceAccessOverrideRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - WorkMailService.GetMobileDeviceAccessOverride summary: Amazon WorkMail Get Mobile Device Access Override parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /#X-Amz-Target=WorkMailService.ListAccessControlRules: post: operationId: ListAccessControlRules description: Lists the access control rules for the specified organization. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListAccessControlRulesResponse' '480': description: OrganizationNotFoundException content: application/json: schema: $ref: '#/components/schemas/OrganizationNotFoundException' '481': description: OrganizationStateException content: application/json: schema: $ref: '#/components/schemas/OrganizationStateException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ListAccessControlRulesRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - WorkMailService.ListAccessControlRules summary: Amazon WorkMail List Access Control Rules parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /#X-Amz-Target=WorkMailService.ListAliases: post: operationId: ListAliases description: Creates a paginated call to list the aliases associated with a given entity. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListAliasesResponse' '480': description: EntityNotFoundException content: application/json: schema: $ref: '#/components/schemas/EntityNotFoundException' '481': description: EntityStateException content: application/json: schema: $ref: '#/components/schemas/EntityStateException' '482': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '483': description: OrganizationNotFoundException content: application/json: schema: $ref: '#/components/schemas/OrganizationNotFoundException' '484': description: OrganizationStateException content: application/json: schema: $ref: '#/components/schemas/OrganizationStateException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ListAliasesRequest' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - WorkMailService.ListAliases summary: Amazon WorkMail List Aliases parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /#X-Amz-Target=WorkMailService.ListAvailabilityConfigurations: post: operationId: ListAvailabilityConfigurations description: List all theAvailabilityConfiguration's for the given WorkMail organization.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListAvailabilityConfigurationsResponse'
'480':
description: OrganizationNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationNotFoundException'
'481':
description: OrganizationStateException
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationStateException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListAvailabilityConfigurationsRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkMailService.ListAvailabilityConfigurations
summary: Amazon WorkMail List Availability Configurations
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/#X-Amz-Target=WorkMailService.ListGroupMembers:
post:
operationId: ListGroupMembers
description: Returns an overview of the members of a group. Users and groups can be members of a group.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListGroupMembersResponse'
'480':
description: EntityNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityNotFoundException'
'481':
description: EntityStateException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityStateException'
'482':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'483':
description: OrganizationNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationNotFoundException'
'484':
description: OrganizationStateException
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationStateException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListGroupMembersRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkMailService.ListGroupMembers
summary: Amazon WorkMail List Group Members
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/#X-Amz-Target=WorkMailService.ListGroups:
post:
operationId: ListGroups
description: Returns summaries of the organization's groups.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListGroupsResponse'
'480':
description: EntityNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityNotFoundException'
'481':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'482':
description: OrganizationNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationNotFoundException'
'483':
description: OrganizationStateException
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationStateException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListGroupsRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkMailService.ListGroups
summary: Amazon WorkMail List Groups
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/#X-Amz-Target=WorkMailService.ListImpersonationRoles:
post:
operationId: ListImpersonationRoles
description: Lists all the impersonation roles for the given WorkMail organization.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListImpersonationRolesResponse'
'480':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'481':
description: OrganizationNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationNotFoundException'
'482':
description: OrganizationStateException
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationStateException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListImpersonationRolesRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkMailService.ListImpersonationRoles
summary: Amazon WorkMail List Impersonation Roles
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/#X-Amz-Target=WorkMailService.ListMailDomains:
post:
operationId: ListMailDomains
description: Lists the mail domains in a given WorkMail organization.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListMailDomainsResponse'
'480':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'481':
description: OrganizationNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationNotFoundException'
'482':
description: OrganizationStateException
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationStateException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListMailDomainsRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkMailService.ListMailDomains
summary: Amazon WorkMail List Mail Domains
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/#X-Amz-Target=WorkMailService.ListMailboxExportJobs:
post:
operationId: ListMailboxExportJobs
description: Lists the mailbox export jobs started for the specified organization within the last seven days.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListMailboxExportJobsResponse'
'480':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'481':
description: OrganizationNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationNotFoundException'
'482':
description: OrganizationStateException
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationStateException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListMailboxExportJobsRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkMailService.ListMailboxExportJobs
summary: Amazon WorkMail List Mailbox Export Jobs
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/#X-Amz-Target=WorkMailService.ListMailboxPermissions:
post:
operationId: ListMailboxPermissions
description: 'Lists the mailbox permissions associated with a user, group, or resource mailbox.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListMailboxPermissionsResponse'
'480':
description: EntityNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityNotFoundException'
'481':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'482':
description: OrganizationNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationNotFoundException'
'483':
description: OrganizationStateException
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationStateException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListMailboxPermissionsRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkMailService.ListMailboxPermissions
summary: Amazon WorkMail List Mailbox Permissions
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/#X-Amz-Target=WorkMailService.ListMobileDeviceAccessOverrides:
post:
operationId: ListMobileDeviceAccessOverrides
description: 'Lists all the mobile device access overrides for any given combination of WorkMail organization, user, or device.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListMobileDeviceAccessOverridesResponse'
'480':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'481':
description: OrganizationNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationNotFoundException'
'482':
description: OrganizationStateException
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationStateException'
'483':
description: EntityNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityNotFoundException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListMobileDeviceAccessOverridesRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkMailService.ListMobileDeviceAccessOverrides
summary: Amazon WorkMail List Mobile Device Access Overrides
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/#X-Amz-Target=WorkMailService.ListMobileDeviceAccessRules:
post:
operationId: ListMobileDeviceAccessRules
description: Lists the mobile device access rules for the specified WorkMail organization.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListMobileDeviceAccessRulesResponse'
'480':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'481':
description: OrganizationNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationNotFoundException'
'482':
description: OrganizationStateException
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationStateException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListMobileDeviceAccessRulesRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkMailService.ListMobileDeviceAccessRules
summary: Amazon WorkMail List Mobile Device Access Rules
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/#X-Amz-Target=WorkMailService.ListOrganizations:
post:
operationId: ListOrganizations
description: Returns summaries of the customer's organizations.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListOrganizationsResponse'
'480':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListOrganizationsRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkMailService.ListOrganizations
summary: Amazon WorkMail List Organizations
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/#X-Amz-Target=WorkMailService.ListResourceDelegates:
post:
operationId: ListResourceDelegates
description: Lists the delegates associated with a resource. Users and groups can be resource delegates and answer requests on behalf of the resource.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListResourceDelegatesResponse'
'480':
description: EntityNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityNotFoundException'
'481':
description: EntityStateException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityStateException'
'482':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'483':
description: OrganizationNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationNotFoundException'
'484':
description: OrganizationStateException
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationStateException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListResourceDelegatesRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkMailService.ListResourceDelegates
summary: Amazon WorkMail List Resource Delegates
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/#X-Amz-Target=WorkMailService.ListResources:
post:
operationId: ListResources
description: Returns summaries of the organization's resources.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListResourcesResponse'
'480':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'481':
description: OrganizationNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationNotFoundException'
'482':
description: OrganizationStateException
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationStateException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListResourcesRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkMailService.ListResources
summary: Amazon WorkMail List Resources
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/#X-Amz-Target=WorkMailService.ListTagsForResource:
post:
operationId: ListTagsForResource
description: Lists the tags applied to an WorkMail organization resource.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListTagsForResourceResponse'
'480':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListTagsForResourceRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkMailService.ListTagsForResource
summary: Amazon WorkMail List Tags for Resource
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/#X-Amz-Target=WorkMailService.ListUsers:
post:
operationId: ListUsers
description: Returns summaries of the organization's users.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListUsersResponse'
'480':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'481':
description: OrganizationNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationNotFoundException'
'482':
description: OrganizationStateException
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationStateException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListUsersRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkMailService.ListUsers
summary: Amazon WorkMail List Users
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/#X-Amz-Target=WorkMailService.PutAccessControlRule:
post:
operationId: PutAccessControlRule
description: '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.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PutAccessControlRuleResponse'
'480':
description: LimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/LimitExceededException'
'481':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'482':
description: EntityNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityNotFoundException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: OrganizationNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationNotFoundException'
'485':
description: OrganizationStateException
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationStateException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PutAccessControlRuleRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkMailService.PutAccessControlRule
summary: Amazon WorkMail Put Access Control Rule
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/#X-Amz-Target=WorkMailService.PutEmailMonitoringConfiguration:
post:
operationId: PutEmailMonitoringConfiguration
description: Creates or updates the email monitoring configuration for a specified organization.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PutEmailMonitoringConfigurationResponse'
'480':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'481':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'482':
description: OrganizationNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationNotFoundException'
'483':
description: OrganizationStateException
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationStateException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PutEmailMonitoringConfigurationRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkMailService.PutEmailMonitoringConfiguration
summary: Amazon WorkMail Put Email Monitoring Configuration
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/#X-Amz-Target=WorkMailService.PutInboundDmarcSettings:
post:
operationId: PutInboundDmarcSettings
description: Enables or disables a DMARC policy for a given organization.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PutInboundDmarcSettingsResponse'
'480':
description: OrganizationNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationNotFoundException'
'481':
description: OrganizationStateException
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationStateException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PutInboundDmarcSettingsRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkMailService.PutInboundDmarcSettings
summary: Amazon WorkMail Put Inbound Dmarc Settings
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/#X-Amz-Target=WorkMailService.PutMailboxPermissions:
post:
operationId: PutMailboxPermissions
description: 'Sets permissions for a user, group, or resource. This replaces any pre-existing permissions.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PutMailboxPermissionsResponse'
'480':
description: EntityNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityNotFoundException'
'481':
description: EntityStateException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityStateException'
'482':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'483':
description: OrganizationNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationNotFoundException'
'484':
description: OrganizationStateException
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationStateException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PutMailboxPermissionsRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkMailService.PutMailboxPermissions
summary: Amazon WorkMail Put Mailbox Permissions
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/#X-Amz-Target=WorkMailService.PutMobileDeviceAccessOverride:
post:
operationId: PutMobileDeviceAccessOverride
description: 'Creates or updates a mobile device access override for the given WorkMail organization, user, and device.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PutMobileDeviceAccessOverrideResponse'
'480':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'481':
description: OrganizationNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationNotFoundException'
'482':
description: OrganizationStateException
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationStateException'
'483':
description: EntityNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityNotFoundException'
'484':
description: EntityStateException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityStateException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PutMobileDeviceAccessOverrideRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkMailService.PutMobileDeviceAccessOverride
summary: Amazon WorkMail Put Mobile Device Access Override
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/#X-Amz-Target=WorkMailService.PutRetentionPolicy:
post:
operationId: PutRetentionPolicy
description: Puts a retention policy to the specified organization.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PutRetentionPolicyResponse'
'480':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'481':
description: OrganizationNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationNotFoundException'
'482':
description: OrganizationStateException
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationStateException'
'483':
description: LimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/LimitExceededException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PutRetentionPolicyRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkMailService.PutRetentionPolicy
summary: Amazon WorkMail Put Retention Policy
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/#X-Amz-Target=WorkMailService.RegisterMailDomain:
post:
operationId: RegisterMailDomain
description: '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.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/RegisterMailDomainResponse'
'480':
description: MailDomainInUseException
content:
application/json:
schema:
$ref: '#/components/schemas/MailDomainInUseException'
'481':
description: OrganizationNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationNotFoundException'
'482':
description: OrganizationStateException
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationStateException'
'483':
description: LimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/LimitExceededException'
'484':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/RegisterMailDomainRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkMailService.RegisterMailDomain
summary: Amazon WorkMail Register Mail Domain
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/#X-Amz-Target=WorkMailService.RegisterToWorkMail:
post:
operationId: RegisterToWorkMail
description: '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.
' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/RegisterToWorkMailResponse' '480': description: DirectoryServiceAuthenticationFailedException content: application/json: schema: $ref: '#/components/schemas/DirectoryServiceAuthenticationFailedException' '481': description: DirectoryUnavailableException content: application/json: schema: $ref: '#/components/schemas/DirectoryUnavailableException' '482': description: EmailAddressInUseException content: application/json: schema: $ref: '#/components/schemas/EmailAddressInUseException' '483': description: EntityNotFoundException content: application/json: schema: $ref: '#/components/schemas/EntityNotFoundException' '484': description: EntityStateException content: application/json: schema: $ref: '#/components/schemas/EntityStateException' '485': description: EntityAlreadyRegisteredException content: application/json: schema: $ref: '#/components/schemas/EntityAlreadyRegisteredException' '486': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '487': description: MailDomainNotFoundException content: application/json: schema: $ref: '#/components/schemas/MailDomainNotFoundException' '488': description: MailDomainStateException content: application/json: schema: $ref: '#/components/schemas/MailDomainStateException' '489': description: OrganizationNotFoundException content: application/json: schema: $ref: '#/components/schemas/OrganizationNotFoundException' '490': description: OrganizationStateException content: application/json: schema: $ref: '#/components/schemas/OrganizationStateException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RegisterToWorkMailRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - WorkMailService.RegisterToWorkMail summary: Amazon WorkMail Register to Work Mail parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /#X-Amz-Target=WorkMailService.ResetPassword: post: operationId: ResetPassword description: Allows the administrator to reset the password for a user. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ResetPasswordResponse' '480': description: DirectoryServiceAuthenticationFailedException content: application/json: schema: $ref: '#/components/schemas/DirectoryServiceAuthenticationFailedException' '481': description: DirectoryUnavailableException content: application/json: schema: $ref: '#/components/schemas/DirectoryUnavailableException' '482': description: EntityNotFoundException content: application/json: schema: $ref: '#/components/schemas/EntityNotFoundException' '483': description: EntityStateException content: application/json: schema: $ref: '#/components/schemas/EntityStateException' '484': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '485': description: InvalidPasswordException content: application/json: schema: $ref: '#/components/schemas/InvalidPasswordException' '486': description: OrganizationNotFoundException content: application/json: schema: $ref: '#/components/schemas/OrganizationNotFoundException' '487': description: OrganizationStateException content: application/json: schema: $ref: '#/components/schemas/OrganizationStateException' '488': description: UnsupportedOperationException content: application/json: schema: $ref: '#/components/schemas/UnsupportedOperationException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ResetPasswordRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - WorkMailService.ResetPassword summary: Amazon WorkMail Reset Password parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /#X-Amz-Target=WorkMailService.StartMailboxExportJob: post: operationId: StartMailboxExportJob description: '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.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/StartMailboxExportJobResponse' '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '481': description: OrganizationNotFoundException content: application/json: schema: $ref: '#/components/schemas/OrganizationNotFoundException' '482': description: OrganizationStateException content: application/json: schema: $ref: '#/components/schemas/OrganizationStateException' '483': description: EntityNotFoundException content: application/json: schema: $ref: '#/components/schemas/EntityNotFoundException' '484': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StartMailboxExportJobRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - WorkMailService.StartMailboxExportJob summary: Amazon WorkMail Start Mailbox Export Job parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /#X-Amz-Target=WorkMailService.TagResource: post: operationId: TagResource description: Applies the specified tags to the specified WorkMailorganization resource. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/TagResourceResponse' '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: TooManyTagsException content: application/json: schema: $ref: '#/components/schemas/TooManyTagsException' '482': description: OrganizationStateException content: application/json: schema: $ref: '#/components/schemas/OrganizationStateException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TagResourceRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - WorkMailService.TagResource summary: Amazon WorkMail Tag Resource parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /#X-Amz-Target=WorkMailService.TestAvailabilityConfiguration: post: operationId: TestAvailabilityConfiguration description: '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.
AvailabilityConfiguration for the given WorkMail organization and domain.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateAvailabilityConfigurationResponse'
'480':
description: OrganizationNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationNotFoundException'
'481':
description: OrganizationStateException
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationStateException'
'482':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'483':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateAvailabilityConfigurationRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkMailService.UpdateAvailabilityConfiguration
summary: Amazon WorkMail Update Availability Configuration
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/#X-Amz-Target=WorkMailService.UpdateDefaultMailDomain:
post:
operationId: UpdateDefaultMailDomain
description: 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.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateDefaultMailDomainResponse'
'480':
description: MailDomainNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/MailDomainNotFoundException'
'481':
description: MailDomainStateException
content:
application/json:
schema:
$ref: '#/components/schemas/MailDomainStateException'
'482':
description: OrganizationNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationNotFoundException'
'483':
description: OrganizationStateException
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationStateException'
'484':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateDefaultMailDomainRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkMailService.UpdateDefaultMailDomain
summary: Amazon WorkMail Update Default Mail Domain
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/#X-Amz-Target=WorkMailService.UpdateImpersonationRole:
post:
operationId: UpdateImpersonationRole
description: Updates an impersonation role for the given WorkMail organization.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateImpersonationRoleResponse'
'480':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'481':
description: OrganizationNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationNotFoundException'
'482':
description: OrganizationStateException
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationStateException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: EntityNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityNotFoundException'
'485':
description: EntityStateException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityStateException'
'486':
description: LimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/LimitExceededException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateImpersonationRoleRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkMailService.UpdateImpersonationRole
summary: Amazon WorkMail Update Impersonation Role
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/#X-Amz-Target=WorkMailService.UpdateMailboxQuota:
post:
operationId: UpdateMailboxQuota
description: Updates a user's current mailbox quota for a specified organization and user.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateMailboxQuotaResponse'
'480':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'481':
description: OrganizationNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationNotFoundException'
'482':
description: OrganizationStateException
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationStateException'
'483':
description: EntityNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityNotFoundException'
'484':
description: EntityStateException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityStateException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateMailboxQuotaRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkMailService.UpdateMailboxQuota
summary: Amazon WorkMail Update Mailbox Quota
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/#X-Amz-Target=WorkMailService.UpdateMobileDeviceAccessRule:
post:
operationId: UpdateMobileDeviceAccessRule
description: Updates a mobile device access rule for the specified WorkMail organization.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateMobileDeviceAccessRuleResponse'
'480':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'481':
description: EntityNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityNotFoundException'
'482':
description: OrganizationNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationNotFoundException'
'483':
description: OrganizationStateException
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationStateException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateMobileDeviceAccessRuleRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkMailService.UpdateMobileDeviceAccessRule
summary: Amazon WorkMail Update Mobile Device Access Rule
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/#X-Amz-Target=WorkMailService.UpdatePrimaryEmailAddress:
post:
operationId: UpdatePrimaryEmailAddress
description: '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.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdatePrimaryEmailAddressResponse'
'480':
description: DirectoryServiceAuthenticationFailedException
content:
application/json:
schema:
$ref: '#/components/schemas/DirectoryServiceAuthenticationFailedException'
'481':
description: DirectoryUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/DirectoryUnavailableException'
'482':
description: EmailAddressInUseException
content:
application/json:
schema:
$ref: '#/components/schemas/EmailAddressInUseException'
'483':
description: EntityNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityNotFoundException'
'484':
description: EntityStateException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityStateException'
'485':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'486':
description: MailDomainNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/MailDomainNotFoundException'
'487':
description: MailDomainStateException
content:
application/json:
schema:
$ref: '#/components/schemas/MailDomainStateException'
'488':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'489':
description: OrganizationNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationNotFoundException'
'490':
description: OrganizationStateException
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationStateException'
'491':
description: UnsupportedOperationException
content:
application/json:
schema:
$ref: '#/components/schemas/UnsupportedOperationException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdatePrimaryEmailAddressRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkMailService.UpdatePrimaryEmailAddress
summary: Amazon WorkMail Update Primary Email Address
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/#X-Amz-Target=WorkMailService.UpdateResource:
post:
operationId: UpdateResource
description: '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.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateResourceResponse'
'480':
description: DirectoryUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/DirectoryUnavailableException'
'481':
description: EntityNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityNotFoundException'
'482':
description: EntityStateException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityStateException'
'483':
description: InvalidConfigurationException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidConfigurationException'
'484':
description: EmailAddressInUseException
content:
application/json:
schema:
$ref: '#/components/schemas/EmailAddressInUseException'
'485':
description: MailDomainNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/MailDomainNotFoundException'
'486':
description: MailDomainStateException
content:
application/json:
schema:
$ref: '#/components/schemas/MailDomainStateException'
'487':
description: NameAvailabilityException
content:
application/json:
schema:
$ref: '#/components/schemas/NameAvailabilityException'
'488':
description: OrganizationNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationNotFoundException'
'489':
description: OrganizationStateException
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationStateException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateResourceRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkMailService.UpdateResource
summary: Amazon WorkMail Update Resource
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
components:
parameters:
X-Amz-Content-Sha256:
name: X-Amz-Content-Sha256
in: header
schema:
type: string
required: false
X-Amz-Date:
name: X-Amz-Date
in: header
schema:
type: string
required: false
X-Amz-Algorithm:
name: X-Amz-Algorithm
in: header
schema:
type: string
required: false
X-Amz-Credential:
name: X-Amz-Credential
in: header
schema:
type: string
required: false
X-Amz-Security-Token:
name: X-Amz-Security-Token
in: header
schema:
type: string
required: false
X-Amz-Signature:
name: X-Amz-Signature
in: header
schema:
type: string
required: false
X-Amz-SignedHeaders:
name: X-Amz-SignedHeaders
in: header
schema:
type: string
required: false
securitySchemes:
hmac:
type: apiKey
name: Authorization
in: header
description: Amazon Signature authorization v4
x-amazon-apigateway-authtype: awsSigv4
schemas:
AssociateDelegateToResourceResponse:
type: object
properties: {}
AssociateDelegateToResourceRequest:
type: object
required:
- OrganizationId
- ResourceId
- EntityId
title: AssociateDelegateToResourceRequest
properties:
OrganizationId:
allOf:
- $ref: '#/components/schemas/OrganizationId'
- description: The organization under which the resource exists.
ResourceId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The resource for which members (users or groups) are associated.
EntityId:
allOf:
- $ref: '#/components/schemas/WorkMailIdentifier'
- description: The member (user or group) to associate to the resource.
EntityNotFoundException: {}
EntityStateException: {}
InvalidParameterException: {}
OrganizationNotFoundException: {}
OrganizationStateException: {}
AssociateMemberToGroupResponse:
type: object
properties: {}
AssociateMemberToGroupRequest:
type: object
required:
- OrganizationId
- GroupId
- MemberId
title: AssociateMemberToGroupRequest
properties:
OrganizationId:
allOf:
- $ref: '#/components/schemas/OrganizationId'
- description: The organization under which the group exists.
GroupId:
allOf:
- $ref: '#/components/schemas/WorkMailIdentifier'
- description: The group to which the member (user or group) is associated.
MemberId:
allOf:
- $ref: '#/components/schemas/WorkMailIdentifier'
- description: The member (user or group) to associate to the group.
DirectoryServiceAuthenticationFailedException: {}
DirectoryUnavailableException: {}
UnsupportedOperationException: {}
AssumeImpersonationRoleResponse:
type: object
properties:
Token:
allOf:
- $ref: '#/components/schemas/ImpersonationToken'
- description: The authentication token for the impersonation role.
ExpiresIn:
allOf:
- $ref: '#/components/schemas/ExpiresIn'
- description: 'The authentication token''s validity, in seconds.'
AssumeImpersonationRoleRequest:
type: object
required:
- OrganizationId
- ImpersonationRoleId
title: AssumeImpersonationRoleRequest
properties:
OrganizationId:
allOf:
- $ref: '#/components/schemas/OrganizationId'
- description: The WorkMail organization under which the impersonation role will be assumed.
ImpersonationRoleId:
allOf:
- $ref: '#/components/schemas/ImpersonationRoleId'
- description: The impersonation role ID to assume.
ResourceNotFoundException: {}
CancelMailboxExportJobResponse:
type: object
properties: {}
CancelMailboxExportJobRequest:
type: object
required:
- ClientToken
- JobId
- OrganizationId
title: CancelMailboxExportJobRequest
properties:
ClientToken:
allOf:
- $ref: '#/components/schemas/IdempotencyClientToken'
- description: The idempotency token for the client request.
JobId:
allOf:
- $ref: '#/components/schemas/MailboxExportJobId'
- description: The job ID.
OrganizationId:
allOf:
- $ref: '#/components/schemas/OrganizationId'
- description: The organization ID.
CreateAliasResponse:
type: object
properties: {}
CreateAliasRequest:
type: object
required:
- OrganizationId
- EntityId
- Alias
title: CreateAliasRequest
properties:
OrganizationId:
allOf:
- $ref: '#/components/schemas/OrganizationId'
- description: The organization under which the member (user or group) exists.
EntityId:
allOf:
- $ref: '#/components/schemas/WorkMailIdentifier'
- description: The member (user or group) to which this alias is added.
Alias:
allOf:
- $ref: '#/components/schemas/EmailAddress'
- description: The alias to add to the member set.
EmailAddressInUseException: {}
MailDomainNotFoundException: {}
MailDomainStateException: {}
LimitExceededException: {}
CreateAvailabilityConfigurationResponse:
type: object
properties: {}
CreateAvailabilityConfigurationRequest:
type: object
required:
- OrganizationId
- DomainName
title: CreateAvailabilityConfigurationRequest
properties:
ClientToken:
allOf:
- $ref: '#/components/schemas/IdempotencyClientToken'
- description: An idempotent token that ensures that an API request is executed only once.
OrganizationId:
allOf:
- $ref: '#/components/schemas/OrganizationId'
- description: The WorkMail organization for which the AvailabilityConfiguration will be created.
DomainName:
allOf:
- $ref: '#/components/schemas/DomainName'
- description: The domain to which the provider applies.
EwsProvider:
allOf:
- $ref: '#/components/schemas/EwsAvailabilityProvider'
- description: 'Exchange Web Services (EWS) availability provider definition. The request must contain exactly one provider definition, either EwsProvider or LambdaProvider.'
LambdaProvider:
allOf:
- $ref: '#/components/schemas/LambdaAvailabilityProvider'
- description: 'Lambda availability provider definition. The request must contain exactly one provider definition, either EwsProvider or LambdaProvider.'
NameAvailabilityException: {}
CreateGroupResponse:
type: object
properties:
GroupId:
allOf:
- $ref: '#/components/schemas/WorkMailIdentifier'
- description: The identifier of the group.
CreateGroupRequest:
type: object
required:
- OrganizationId
- Name
title: CreateGroupRequest
properties:
OrganizationId:
allOf:
- $ref: '#/components/schemas/OrganizationId'
- description: The organization under which the group is to be created.
Name:
allOf:
- $ref: '#/components/schemas/GroupName'
- description: The name of the group.
ReservedNameException: {}
CreateImpersonationRoleResponse:
type: object
properties:
ImpersonationRoleId:
allOf:
- $ref: '#/components/schemas/ImpersonationRoleId'
- description: The new impersonation role ID.
CreateImpersonationRoleRequest:
type: object
required:
- OrganizationId
- Name
- Type
- Rules
title: CreateImpersonationRoleRequest
properties:
ClientToken:
allOf:
- $ref: '#/components/schemas/IdempotencyClientToken'
- description: The idempotency token for the client request.
OrganizationId:
allOf:
- $ref: '#/components/schemas/OrganizationId'
- description: The WorkMail organization to create the new impersonation role within.
Name:
allOf:
- $ref: '#/components/schemas/ImpersonationRoleName'
- description: The name of the new impersonation role.
Type:
allOf:
- $ref: '#/components/schemas/ImpersonationRoleType'
- description: The impersonation role's type. The available impersonation role types are READ_ONLY or FULL_ACCESS.
Description:
allOf:
- $ref: '#/components/schemas/ImpersonationRoleDescription'
- description: The description of the new impersonation role.
Rules:
allOf:
- $ref: '#/components/schemas/ImpersonationRuleList'
- description: The list of rules for the impersonation role.
CreateMobileDeviceAccessRuleResponse:
type: object
properties:
MobileDeviceAccessRuleId:
allOf:
- $ref: '#/components/schemas/MobileDeviceAccessRuleId'
- description: The identifier for the newly created mobile device access rule.
CreateMobileDeviceAccessRuleRequest:
type: object
required:
- OrganizationId
- Name
- Effect
title: CreateMobileDeviceAccessRuleRequest
properties:
OrganizationId:
allOf:
- $ref: '#/components/schemas/OrganizationId'
- description: The WorkMail organization under which the rule will be created.
ClientToken:
allOf:
- $ref: '#/components/schemas/IdempotencyClientToken'
- description: The idempotency token for the client request.
Name:
allOf:
- $ref: '#/components/schemas/MobileDeviceAccessRuleName'
- description: The rule name.
Description:
allOf:
- $ref: '#/components/schemas/MobileDeviceAccessRuleDescription'
- description: The rule description.
Effect:
allOf:
- $ref: '#/components/schemas/MobileDeviceAccessRuleEffect'
- description: The effect of the rule when it matches. Allowed values are ALLOW or DENY.
DeviceTypes:
allOf:
- $ref: '#/components/schemas/DeviceTypeList'
- description: Device types that the rule will match.
NotDeviceTypes:
allOf:
- $ref: '#/components/schemas/DeviceTypeList'
- description: Device types that the rule will not match. All other device types will match.
DeviceModels:
allOf:
- $ref: '#/components/schemas/DeviceModelList'
- description: Device models that the rule will match.
NotDeviceModels:
allOf:
- $ref: '#/components/schemas/DeviceModelList'
- description: Device models that the rule will not match. All other device models will match.
DeviceOperatingSystems:
allOf:
- $ref: '#/components/schemas/DeviceOperatingSystemList'
- description: Device operating systems that the rule will match.
NotDeviceOperatingSystems:
allOf:
- $ref: '#/components/schemas/DeviceOperatingSystemList'
- description: Device operating systems that the rule will not match. All other device operating systems will match.
DeviceUserAgents:
allOf:
- $ref: '#/components/schemas/DeviceUserAgentList'
- description: Device user agents that the rule will match.
NotDeviceUserAgents:
allOf:
- $ref: '#/components/schemas/DeviceUserAgentList'
- description: Device user agents that the rule will not match. All other device user agents will match.
CreateOrganizationResponse:
type: object
properties:
OrganizationId:
allOf:
- $ref: '#/components/schemas/OrganizationId'
- description: The organization ID.
CreateOrganizationRequest:
type: object
required:
- Alias
title: CreateOrganizationRequest
properties:
DirectoryId:
allOf:
- $ref: '#/components/schemas/DirectoryId'
- description: The AWS Directory Service directory ID.
Alias:
allOf:
- $ref: '#/components/schemas/OrganizationName'
- description: The organization alias.
ClientToken:
allOf:
- $ref: '#/components/schemas/IdempotencyClientToken'
- description: The idempotency token associated with the request.
Domains:
allOf:
- $ref: '#/components/schemas/Domains'
- description: The email domains to associate with the organization.
KmsKeyArn:
allOf:
- $ref: '#/components/schemas/KmsKeyArn'
- description: The Amazon Resource Name (ARN) of a customer managed key from AWS KMS.
EnableInteroperability:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'When true, allows organization interoperability between WorkMail and Microsoft Exchange. If true, you must include a AD Connector directory ID in the
request.'
DirectoryInUseException: {}
CreateResourceResponse:
type: object
properties:
ResourceId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The identifier of the new resource.
CreateResourceRequest:
type: object
required:
- OrganizationId
- Name
- Type
title: CreateResourceRequest
properties:
OrganizationId:
allOf:
- $ref: '#/components/schemas/OrganizationId'
- description: The identifier associated with the organization for which the resource is created.
Name:
allOf:
- $ref: '#/components/schemas/ResourceName'
- description: The name of the new resource.
Type:
allOf:
- $ref: '#/components/schemas/ResourceType'
- description: The type of the new resource. The available types are equipment and room.
CreateUserResponse:
type: object
properties:
UserId:
allOf:
- $ref: '#/components/schemas/WorkMailIdentifier'
- description: The identifier for the new user.
CreateUserRequest:
type: object
required:
- OrganizationId
- Name
- DisplayName
- Password
title: CreateUserRequest
properties:
OrganizationId:
allOf:
- $ref: '#/components/schemas/OrganizationId'
- description: The identifier of the organization for which the user is created.
Name:
allOf:
- $ref: '#/components/schemas/UserName'
- description: The name for the new user. WorkMail directory user names have a maximum length of 64. All others have a maximum length of 20.
DisplayName:
allOf:
- $ref: '#/components/schemas/String'
- description: The display name for the new user.
Password:
allOf:
- $ref: '#/components/schemas/Password'
- description: The password for the new user.
InvalidPasswordException: {}
DeleteAccessControlRuleResponse:
type: object
properties: {}
DeleteAccessControlRuleRequest:
type: object
required:
- OrganizationId
- Name
title: DeleteAccessControlRuleRequest
properties:
OrganizationId:
allOf:
- $ref: '#/components/schemas/OrganizationId'
- description: The identifier for the organization.
Name:
allOf:
- $ref: '#/components/schemas/AccessControlRuleName'
- description: The name of the access control rule.
DeleteAliasResponse:
type: object
properties: {}
DeleteAliasRequest:
type: object
required:
- OrganizationId
- EntityId
- Alias
title: DeleteAliasRequest
properties:
OrganizationId:
allOf:
- $ref: '#/components/schemas/OrganizationId'
- description: The identifier for the organization under which the user exists.
EntityId:
allOf:
- $ref: '#/components/schemas/WorkMailIdentifier'
- description: The identifier for the member (user or group) from which to have the aliases removed.
Alias:
allOf:
- $ref: '#/components/schemas/EmailAddress'
- description: 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).
DeleteAvailabilityConfigurationResponse:
type: object
properties: {}
DeleteAvailabilityConfigurationRequest:
type: object
required:
- OrganizationId
- DomainName
title: DeleteAvailabilityConfigurationRequest
properties:
OrganizationId:
allOf:
- $ref: '#/components/schemas/OrganizationId'
- description: The WorkMail organization for which the AvailabilityConfiguration will be deleted.
DomainName:
allOf:
- $ref: '#/components/schemas/DomainName'
- description: The domain for which the AvailabilityConfiguration will be deleted.
DeleteEmailMonitoringConfigurationResponse:
type: object
properties: {}
DeleteEmailMonitoringConfigurationRequest:
type: object
required:
- OrganizationId
title: DeleteEmailMonitoringConfigurationRequest
properties:
OrganizationId:
allOf:
- $ref: '#/components/schemas/OrganizationId'
- description: The ID of the organization from which the email monitoring configuration is deleted.
DeleteGroupResponse:
type: object
properties: {}
DeleteGroupRequest:
type: object
required:
- OrganizationId
- GroupId
title: DeleteGroupRequest
properties:
OrganizationId:
allOf:
- $ref: '#/components/schemas/OrganizationId'
- description: The organization that contains the group.
GroupId:
allOf:
- $ref: '#/components/schemas/WorkMailIdentifier'
- description: The identifier of the group to be deleted.
DeleteImpersonationRoleResponse:
type: object
properties: {}
DeleteImpersonationRoleRequest:
type: object
required:
- OrganizationId
- ImpersonationRoleId
title: DeleteImpersonationRoleRequest
properties:
OrganizationId:
allOf:
- $ref: '#/components/schemas/OrganizationId'
- description: The WorkMail organization from which to delete the impersonation role.
ImpersonationRoleId:
allOf:
- $ref: '#/components/schemas/ImpersonationRoleId'
- description: The ID of the impersonation role to delete.
DeleteMailboxPermissionsResponse:
type: object
properties: {}
DeleteMailboxPermissionsRequest:
type: object
required:
- OrganizationId
- EntityId
- GranteeId
title: DeleteMailboxPermissionsRequest
properties:
OrganizationId:
allOf:
- $ref: '#/components/schemas/OrganizationId'
- description: The identifier of the organization under which the member (user or group) exists.
EntityId:
allOf:
- $ref: '#/components/schemas/WorkMailIdentifier'
- description: The identifier of the member (user or group) that owns the mailbox.
GranteeId:
allOf:
- $ref: '#/components/schemas/WorkMailIdentifier'
- description: The identifier of the member (user or group) for which to delete granted permissions.
DeleteMobileDeviceAccessOverrideResponse:
type: object
properties: {}
DeleteMobileDeviceAccessOverrideRequest:
type: object
required:
- OrganizationId
- UserId
- DeviceId
title: DeleteMobileDeviceAccessOverrideRequest
properties:
OrganizationId:
allOf:
- $ref: '#/components/schemas/OrganizationId'
- description: The WorkMail organization for which the access override will be deleted.
UserId:
allOf:
- $ref: '#/components/schemas/EntityIdentifier'
- description: '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
DeviceId is case insensitive.
DeleteMobileDeviceAccessRuleResponse:
type: object
properties: {}
DeleteMobileDeviceAccessRuleRequest:
type: object
required:
- OrganizationId
- MobileDeviceAccessRuleId
title: DeleteMobileDeviceAccessRuleRequest
properties:
OrganizationId:
allOf:
- $ref: '#/components/schemas/OrganizationId'
- description: The WorkMail organization under which the rule will be deleted.
MobileDeviceAccessRuleId:
allOf:
- $ref: '#/components/schemas/MobileDeviceAccessRuleId'
- description: The identifier of the rule to be deleted.
DeleteOrganizationResponse:
type: object
properties:
OrganizationId:
allOf:
- $ref: '#/components/schemas/OrganizationId'
- description: The organization ID.
State:
allOf:
- $ref: '#/components/schemas/String'
- description: The state of the organization.
DeleteOrganizationRequest:
type: object
required:
- OrganizationId
- DeleteDirectory
title: DeleteOrganizationRequest
properties:
ClientToken:
allOf:
- $ref: '#/components/schemas/IdempotencyClientToken'
- description: The idempotency token associated with the request.
OrganizationId:
allOf:
- $ref: '#/components/schemas/OrganizationId'
- description: The organization ID.
DeleteDirectory:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'If true, deletes the AWS Directory Service directory associated with the organization.'
DeleteResourceResponse:
type: object
properties: {}
DeleteResourceRequest:
type: object
required:
- OrganizationId
- ResourceId
title: DeleteResourceRequest
properties:
OrganizationId:
allOf:
- $ref: '#/components/schemas/OrganizationId'
- description: The identifier associated with the organization from which the resource is deleted.
ResourceId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The identifier of the resource to be deleted.
DeleteRetentionPolicyResponse:
type: object
properties: {}
DeleteRetentionPolicyRequest:
type: object
required:
- OrganizationId
- Id
title: DeleteRetentionPolicyRequest
properties:
OrganizationId:
allOf:
- $ref: '#/components/schemas/OrganizationId'
- description: The organization ID.
Id:
allOf:
- $ref: '#/components/schemas/ShortString'
- description: The retention policy ID.
DeleteUserResponse:
type: object
properties: {}
DeleteUserRequest:
type: object
required:
- OrganizationId
- UserId
title: DeleteUserRequest
properties:
OrganizationId:
allOf:
- $ref: '#/components/schemas/OrganizationId'
- description: The organization that contains the user to be deleted.
UserId:
allOf:
- $ref: '#/components/schemas/WorkMailIdentifier'
- description: The identifier of the user to be deleted.
DeregisterFromWorkMailResponse:
type: object
properties: {}
DeregisterFromWorkMailRequest:
type: object
required:
- OrganizationId
- EntityId
title: DeregisterFromWorkMailRequest
properties:
OrganizationId:
allOf:
- $ref: '#/components/schemas/OrganizationId'
- description: The identifier for the organization under which the WorkMail entity exists.
EntityId:
allOf:
- $ref: '#/components/schemas/WorkMailIdentifier'
- description: The identifier for the member (user or group) to be updated.
DeregisterMailDomainResponse:
type: object
properties: {}
DeregisterMailDomainRequest:
type: object
required:
- OrganizationId
- DomainName
title: DeregisterMailDomainRequest
properties:
OrganizationId:
allOf:
- $ref: '#/components/schemas/OrganizationId'
- description: The WorkMail organization for which the domain will be deregistered.
DomainName:
allOf:
- $ref: '#/components/schemas/WorkMailDomainName'
- description: The domain to deregister in WorkMail and SES.
MailDomainInUseException: {}
InvalidCustomSesConfigurationException: {}
DescribeEmailMonitoringConfigurationResponse:
type: object
properties:
RoleArn:
allOf:
- $ref: '#/components/schemas/RoleArn'
- description: The Amazon Resource Name (ARN) of the IAM Role associated with the email monitoring configuration.
LogGroupArn:
allOf:
- $ref: '#/components/schemas/LogGroupArn'
- description: The Amazon Resource Name (ARN) of the CloudWatch Log group associated with the email monitoring configuration.
DescribeEmailMonitoringConfigurationRequest:
type: object
required:
- OrganizationId
title: DescribeEmailMonitoringConfigurationRequest
properties:
OrganizationId:
allOf:
- $ref: '#/components/schemas/OrganizationId'
- description: The ID of the organization for which the email monitoring configuration is described.
DescribeGroupResponse:
type: object
properties:
GroupId:
allOf:
- $ref: '#/components/schemas/WorkMailIdentifier'
- description: The identifier of the described group.
Name:
allOf:
- $ref: '#/components/schemas/GroupName'
- description: The name of the described group.
Email:
allOf:
- $ref: '#/components/schemas/EmailAddress'
- description: The email of the described group.
State:
allOf:
- $ref: '#/components/schemas/EntityState'
- description: 'The state of the user: enabled (registered to WorkMail) or disabled (deregistered or never registered to WorkMail).'
EnabledDate:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: 'The date and time when a user was registered to WorkMail, in UNIX epoch time format.'
DisabledDate:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: 'The date and time when a user was deregistered from WorkMail, in UNIX epoch time format.'
DescribeGroupRequest:
type: object
required:
- OrganizationId
- GroupId
title: DescribeGroupRequest
properties:
OrganizationId:
allOf:
- $ref: '#/components/schemas/OrganizationId'
- description: The identifier for the organization under which the group exists.
GroupId:
allOf:
- $ref: '#/components/schemas/WorkMailIdentifier'
- description: The identifier for the group to be described.
DescribeInboundDmarcSettingsResponse:
type: object
properties:
Enforced:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Lists the enforcement setting of the applied policy.
DescribeInboundDmarcSettingsRequest:
type: object
required:
- OrganizationId
title: DescribeInboundDmarcSettingsRequest
properties:
OrganizationId:
allOf:
- $ref: '#/components/schemas/OrganizationId'
- description: Lists the ID of the given organization.
DescribeMailboxExportJobResponse:
type: object
properties:
EntityId:
allOf:
- $ref: '#/components/schemas/WorkMailIdentifier'
- description: The identifier of the user or resource associated with the mailbox.
Description:
allOf:
- $ref: '#/components/schemas/Description'
- description: The mailbox export job description.
RoleArn:
allOf:
- $ref: '#/components/schemas/RoleArn'
- description: The ARN of the AWS Identity and Access Management (IAM) role that grants write permission to the Amazon Simple Storage Service (Amazon S3) bucket.
KmsKeyArn:
allOf:
- $ref: '#/components/schemas/KmsKeyArn'
- description: The Amazon Resource Name (ARN) of the symmetric AWS Key Management Service (AWS KMS) key that encrypts the exported mailbox content.
S3BucketName:
allOf:
- $ref: '#/components/schemas/S3BucketName'
- description: The name of the S3 bucket.
S3Prefix:
allOf:
- $ref: '#/components/schemas/S3ObjectKey'
- description: The S3 bucket prefix.
S3Path:
allOf:
- $ref: '#/components/schemas/S3ObjectKey'
- description: The path to the S3 bucket and file that the mailbox export job is exporting to.
EstimatedProgress:
allOf:
- $ref: '#/components/schemas/Percentage'
- description: 'The estimated progress of the mailbox export job, in percentage points.'
State:
allOf:
- $ref: '#/components/schemas/MailboxExportJobState'
- description: The state of the mailbox export job.
ErrorInfo:
allOf:
- $ref: '#/components/schemas/MailboxExportErrorInfo'
- description: Error information for failed mailbox export jobs.
StartTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The mailbox export job start timestamp.
EndTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The mailbox export job end timestamp.
DescribeMailboxExportJobRequest:
type: object
required:
- JobId
- OrganizationId
title: DescribeMailboxExportJobRequest
properties:
JobId:
allOf:
- $ref: '#/components/schemas/MailboxExportJobId'
- description: The mailbox export job ID.
OrganizationId:
allOf:
- $ref: '#/components/schemas/OrganizationId'
- description: The organization ID.
DescribeOrganizationResponse:
type: object
properties:
OrganizationId:
allOf:
- $ref: '#/components/schemas/OrganizationId'
- description: The identifier of an organization.
Alias:
allOf:
- $ref: '#/components/schemas/OrganizationName'
- description: The alias for an organization.
State:
allOf:
- $ref: '#/components/schemas/String'
- description: The state of an organization.
DirectoryId:
allOf:
- $ref: '#/components/schemas/String'
- description: The identifier for the directory associated with an WorkMail organization.
DirectoryType:
allOf:
- $ref: '#/components/schemas/String'
- description: The type of directory associated with the WorkMail organization.
DefaultMailDomain:
allOf:
- $ref: '#/components/schemas/String'
- description: The default mail domain associated with the organization.
CompletedDate:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: 'The date at which the organization became usable in the WorkMail context, in UNIX epoch time format.'
ErrorMessage:
allOf:
- $ref: '#/components/schemas/String'
- description: (Optional) The error message indicating if unexpected behavior was encountered with regards to the organization.
ARN:
allOf:
- $ref: '#/components/schemas/AmazonResourceName'
- description: The Amazon Resource Name (ARN) of the organization.
DescribeOrganizationRequest:
type: object
required:
- OrganizationId
title: DescribeOrganizationRequest
properties:
OrganizationId:
allOf:
- $ref: '#/components/schemas/OrganizationId'
- description: The identifier for the organization to be described.
DescribeResourceResponse:
type: object
properties:
ResourceId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The identifier of the described resource.
Email:
allOf:
- $ref: '#/components/schemas/EmailAddress'
- description: The email of the described resource.
Name:
allOf:
- $ref: '#/components/schemas/ResourceName'
- description: The name of the described resource.
Type:
allOf:
- $ref: '#/components/schemas/ResourceType'
- description: The type of the described resource.
BookingOptions:
allOf:
- $ref: '#/components/schemas/BookingOptions'
- description: The booking options for the described resource.
State:
allOf:
- $ref: '#/components/schemas/EntityState'
- description: 'The state of the resource: enabled (registered to WorkMail), disabled (deregistered or never registered to WorkMail), or deleted.'
EnabledDate:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: 'The date and time when a resource was enabled for WorkMail, in UNIX epoch time format.'
DisabledDate:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: 'The date and time when a resource was disabled from WorkMail, in UNIX epoch time format.'
DescribeResourceRequest:
type: object
required:
- OrganizationId
- ResourceId
title: DescribeResourceRequest
properties:
OrganizationId:
allOf:
- $ref: '#/components/schemas/OrganizationId'
- description: The identifier associated with the organization for which the resource is described.
ResourceId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The identifier of the resource to be described.
DescribeUserResponse:
type: object
properties:
UserId:
allOf:
- $ref: '#/components/schemas/WorkMailIdentifier'
- description: The identifier for the described user.
Name:
allOf:
- $ref: '#/components/schemas/UserName'
- description: The name for the user.
Email:
allOf:
- $ref: '#/components/schemas/EmailAddress'
- description: The email of the user.
DisplayName:
allOf:
- $ref: '#/components/schemas/String'
- description: The display name of the user.
State:
allOf:
- $ref: '#/components/schemas/EntityState'
- description: 'The state of a user: enabled (registered to WorkMail) or disabled (deregistered or never registered to WorkMail).'
UserRole:
allOf:
- $ref: '#/components/schemas/UserRole'
- description: 'In certain cases, other entities are modeled as users. If interoperability is enabled, resources are imported into WorkMail as users. Because different WorkMail organizations rely
on different directory types, administrators can distinguish between an unregistered user (account is disabled and has a user role) and the directory administrators. The values are USER, RESOURCE,
and SYSTEM_USER.'
EnabledDate:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: 'The date and time at which the user was enabled for WorkMailusage, in UNIX epoch time format.'
DisabledDate:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: 'The date and time at which the user was disabled for WorkMail usage, in UNIX epoch time format.'
DescribeUserRequest:
type: object
required:
- OrganizationId
- UserId
title: DescribeUserRequest
properties:
OrganizationId:
allOf:
- $ref: '#/components/schemas/OrganizationId'
- description: The identifier for the organization under which the user exists.
UserId:
allOf:
- $ref: '#/components/schemas/WorkMailIdentifier'
- description: The identifier for the user to be described.
DisassociateDelegateFromResourceResponse:
type: object
properties: {}
DisassociateDelegateFromResourceRequest:
type: object
required:
- OrganizationId
- ResourceId
- EntityId
title: DisassociateDelegateFromResourceRequest
properties:
OrganizationId:
allOf:
- $ref: '#/components/schemas/OrganizationId'
- description: The identifier for the organization under which the resource exists.
ResourceId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: 'The identifier of the resource from which delegates'' set members are removed. '
EntityId:
allOf:
- $ref: '#/components/schemas/WorkMailIdentifier'
- description: 'The identifier for the member (user, group) to be removed from the resource''s delegates.'
DisassociateMemberFromGroupResponse:
type: object
properties: {}
DisassociateMemberFromGroupRequest:
type: object
required:
- OrganizationId
- GroupId
- MemberId
title: DisassociateMemberFromGroupRequest
properties:
OrganizationId:
allOf:
- $ref: '#/components/schemas/OrganizationId'
- description: The identifier for the organization under which the group exists.
GroupId:
allOf:
- $ref: '#/components/schemas/WorkMailIdentifier'
- description: The identifier for the group from which members are removed.
MemberId:
allOf:
- $ref: '#/components/schemas/WorkMailIdentifier'
- description: The identifier for the member to be removed to the group.
GetAccessControlEffectResponse:
type: object
properties:
Effect:
allOf:
- $ref: '#/components/schemas/AccessControlRuleEffect'
- description: The rule effect.
MatchedRules:
allOf:
- $ref: '#/components/schemas/AccessControlRuleNameList'
- description: 'The rules that match the given parameters, resulting in an effect.'
GetAccessControlEffectRequest:
type: object
required:
- OrganizationId
- IpAddress
- Action
title: GetAccessControlEffectRequest
properties:
OrganizationId:
allOf:
- $ref: '#/components/schemas/OrganizationId'
- description: The identifier for the organization.
IpAddress:
allOf:
- $ref: '#/components/schemas/IpAddress'
- description: The IPv4 address.
Action:
allOf:
- $ref: '#/components/schemas/AccessControlRuleAction'
- description: 'The access protocol action. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook,
and WebMail.'
UserId:
allOf:
- $ref: '#/components/schemas/WorkMailIdentifier'
- description: The user ID.
ImpersonationRoleId:
allOf:
- $ref: '#/components/schemas/ImpersonationRoleId'
- description: The impersonation role ID.
GetDefaultRetentionPolicyResponse:
type: object
properties:
Id:
allOf:
- $ref: '#/components/schemas/ShortString'
- description: The retention policy ID.
Name:
allOf:
- $ref: '#/components/schemas/ShortString'
- description: The retention policy name.
Description:
allOf:
- $ref: '#/components/schemas/String'
- description: The retention policy description.
FolderConfigurations:
allOf:
- $ref: '#/components/schemas/FolderConfigurations'
- description: The retention policy folder configurations.
GetDefaultRetentionPolicyRequest:
type: object
required:
- OrganizationId
title: GetDefaultRetentionPolicyRequest
properties:
OrganizationId:
allOf:
- $ref: '#/components/schemas/OrganizationId'
- description: The organization ID.
GetImpersonationRoleResponse:
type: object
properties:
ImpersonationRoleId:
allOf:
- $ref: '#/components/schemas/ImpersonationRoleId'
- description: The impersonation role ID.
Name:
allOf:
- $ref: '#/components/schemas/ImpersonationRoleName'
- description: The impersonation role name.
Type:
allOf:
- $ref: '#/components/schemas/ImpersonationRoleType'
- description: The impersonation role type.
Description:
allOf:
- $ref: '#/components/schemas/ImpersonationRoleDescription'
- description: The impersonation role description.
Rules:
allOf:
- $ref: '#/components/schemas/ImpersonationRuleList'
- description: The list of rules for the given impersonation role.
DateCreated:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The date when the impersonation role was created.
DateModified:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The date when the impersonation role was last modified.
GetImpersonationRoleRequest:
type: object
required:
- OrganizationId
- ImpersonationRoleId
title: GetImpersonationRoleRequest
properties:
OrganizationId:
allOf:
- $ref: '#/components/schemas/OrganizationId'
- description: The WorkMail organization from which to retrieve the impersonation role.
ImpersonationRoleId:
allOf:
- $ref: '#/components/schemas/ImpersonationRoleId'
- description: The impersonation role ID to retrieve.
GetImpersonationRoleEffectResponse:
type: object
properties:
Type:
allOf:
- $ref: '#/components/schemas/ImpersonationRoleType'
- description: The impersonation role type.
Effect:
allOf:
- $ref: '#/components/schemas/AccessEffect'
- description: ' Effect of the impersonation role on the target user based on its rules. Available effects are ALLOW or DENY.'
MatchedRules:
allOf:
- $ref: '#/components/schemas/ImpersonationMatchedRuleList'
- description: A list of the rules that match the input and produce the configured effect.
GetImpersonationRoleEffectRequest:
type: object
required:
- OrganizationId
- ImpersonationRoleId
- TargetUser
title: GetImpersonationRoleEffectRequest
properties:
OrganizationId:
allOf:
- $ref: '#/components/schemas/OrganizationId'
- description: The WorkMail organization where the impersonation role is defined.
ImpersonationRoleId:
allOf:
- $ref: '#/components/schemas/ImpersonationRoleId'
- description: The impersonation role ID to test.
TargetUser:
allOf:
- $ref: '#/components/schemas/EntityIdentifier'
- description: '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
ALLOW or DENY, after evaluating mobile device access rules in the WorkMail organization for the simulated user parameters.'
MatchedRules:
allOf:
- $ref: '#/components/schemas/MobileDeviceAccessMatchedRuleList'
- description: A list of the rules which matched the simulated user input and produced the effect.
GetMobileDeviceAccessEffectRequest:
type: object
required:
- OrganizationId
title: GetMobileDeviceAccessEffectRequest
properties:
OrganizationId:
allOf:
- $ref: '#/components/schemas/OrganizationId'
- description: The WorkMail organization to simulate the access effect for.
DeviceType:
allOf:
- $ref: '#/components/schemas/DeviceType'
- description: Device type the simulated user will report.
DeviceModel:
allOf:
- $ref: '#/components/schemas/DeviceModel'
- description: Device model the simulated user will report.
DeviceOperatingSystem:
allOf:
- $ref: '#/components/schemas/DeviceOperatingSystem'
- description: Device operating system the simulated user will report.
DeviceUserAgent:
allOf:
- $ref: '#/components/schemas/DeviceUserAgent'
- description: Device user agent the simulated user will report.
GetMobileDeviceAccessOverrideResponse:
type: object
properties:
UserId:
allOf:
- $ref: '#/components/schemas/WorkMailIdentifier'
- description: The WorkMail user to which the access override applies.
DeviceId:
allOf:
- $ref: '#/components/schemas/DeviceId'
- description: The device to which the access override applies.
Effect:
allOf:
- $ref: '#/components/schemas/MobileDeviceAccessRuleEffect'
- description: 'The effect of the override, ALLOW or DENY.'
Description:
allOf:
- $ref: '#/components/schemas/MobileDeviceAccessRuleDescription'
- description: A description of the override.
DateCreated:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The date the override was first created.
DateModified:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The date the description was last modified.
GetMobileDeviceAccessOverrideRequest:
type: object
required:
- OrganizationId
- UserId
- DeviceId
title: GetMobileDeviceAccessOverrideRequest
properties:
OrganizationId:
allOf:
- $ref: '#/components/schemas/OrganizationId'
- description: The WorkMail organization to which you want to apply the override.
UserId:
allOf:
- $ref: '#/components/schemas/EntityIdentifier'
- description: '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
DeviceId is case insensitive.
ListAccessControlRulesResponse:
type: object
properties:
Rules:
allOf:
- $ref: '#/components/schemas/AccessControlRulesList'
- description: The access control rules.
ListAccessControlRulesRequest:
type: object
required:
- OrganizationId
title: ListAccessControlRulesRequest
properties:
OrganizationId:
allOf:
- $ref: '#/components/schemas/OrganizationId'
- description: The identifier for the organization.
ListAliasesResponse:
type: object
properties:
Aliases:
allOf:
- $ref: '#/components/schemas/Aliases'
- description: The entity's paginated aliases.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The token to use to retrieve the next page of results. The value is "null" when there are no more results to return.
ListAliasesRequest:
type: object
required:
- OrganizationId
- EntityId
title: ListAliasesRequest
properties:
OrganizationId:
allOf:
- $ref: '#/components/schemas/OrganizationId'
- description: The identifier for the organization under which the entity exists.
EntityId:
allOf:
- $ref: '#/components/schemas/WorkMailIdentifier'
- description: The identifier for the entity for which to list the aliases.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The token to use to retrieve the next page of results. The first call does not contain any tokens.
MaxResults:
allOf:
- $ref: '#/components/schemas/MaxResults'
- description: The maximum number of results to return in a single call.
ListAvailabilityConfigurationsResponse:
type: object
properties:
AvailabilityConfigurations:
allOf:
- $ref: '#/components/schemas/AvailabilityConfigurationList'
- description: The list of AvailabilityConfiguration's that exist for the specified WorkMail organization.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The token to use to retrieve the next page of results. The value is null when there are no further results to return.
ListAvailabilityConfigurationsRequest:
type: object
required:
- OrganizationId
title: ListAvailabilityConfigurationsRequest
properties:
OrganizationId:
allOf:
- $ref: '#/components/schemas/OrganizationId'
- description: The WorkMail organization for which the AvailabilityConfiguration's will be listed.
MaxResults:
allOf:
- $ref: '#/components/schemas/MaxResults'
- description: The maximum number of results to return in a single call.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The token to use to retrieve the next page of results. The first call does not require a token.
ListGroupMembersResponse:
type: object
properties:
Members:
allOf:
- $ref: '#/components/schemas/Members'
- description: The members associated to the group.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The token to use to retrieve the next page of results. The first call does not contain any tokens.
ListGroupMembersRequest:
type: object
required:
- OrganizationId
- GroupId
title: ListGroupMembersRequest
properties:
OrganizationId:
allOf:
- $ref: '#/components/schemas/OrganizationId'
- description: The identifier for the organization under which the group exists.
GroupId:
allOf:
- $ref: '#/components/schemas/WorkMailIdentifier'
- description: The identifier for the group to which the members (users or groups) are associated.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: ' The token to use to retrieve the next page of results. The first call does not contain any tokens.'
MaxResults:
allOf:
- $ref: '#/components/schemas/MaxResults'
- description: The maximum number of results to return in a single call.
ListGroupsResponse:
type: object
properties:
Groups:
allOf:
- $ref: '#/components/schemas/Groups'
- description: The overview of groups for an organization.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The token to use to retrieve the next page of results. The value is "null" when there are no more results to return.
ListGroupsRequest:
type: object
required:
- OrganizationId
title: ListGroupsRequest
properties:
OrganizationId:
allOf:
- $ref: '#/components/schemas/OrganizationId'
- description: The identifier for the organization under which the groups exist.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The token to use to retrieve the next page of results. The first call does not contain any tokens.
MaxResults:
allOf:
- $ref: '#/components/schemas/MaxResults'
- description: The maximum number of results to return in a single call.
ListImpersonationRolesResponse:
type: object
properties:
Roles:
allOf:
- $ref: '#/components/schemas/ImpersonationRoleList'
- description: The list of impersonation roles under the given WorkMail organization.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The token to retrieve the next page of results. The value is null when there are no results to return.
ListImpersonationRolesRequest:
type: object
required:
- OrganizationId
title: ListImpersonationRolesRequest
properties:
OrganizationId:
allOf:
- $ref: '#/components/schemas/OrganizationId'
- description: The WorkMail organization to which the listed impersonation roles belong.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The token used to retrieve the next page of results. The first call doesn't require a token.
MaxResults:
allOf:
- $ref: '#/components/schemas/MaxResults'
- description: The maximum number of results returned in a single call.
ListMailDomainsResponse:
type: object
properties:
MailDomains:
allOf:
- $ref: '#/components/schemas/MailDomains'
- description: 'The list of mail domain summaries, specifying domains that exist in the specified WorkMail organization, along with the information about whether the domain is or isn''t the default.'
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The token to use to retrieve the next page of results. The value becomes null when there are no more results to return.
ListMailDomainsRequest:
type: object
required:
- OrganizationId
title: ListMailDomainsRequest
properties:
OrganizationId:
allOf:
- $ref: '#/components/schemas/OrganizationId'
- description: The WorkMail organization for which to list domains.
MaxResults:
allOf:
- $ref: '#/components/schemas/MaxResults'
- description: The maximum number of results to return in a single call.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The token to use to retrieve the next page of results. The first call does not require a token.
ListMailboxExportJobsResponse:
type: object
properties:
Jobs:
allOf:
- $ref: '#/components/schemas/Jobs'
- description: The mailbox export job details.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The token to use to retrieve the next page of results.
ListMailboxExportJobsRequest:
type: object
required:
- OrganizationId
title: ListMailboxExportJobsRequest
properties:
OrganizationId:
allOf:
- $ref: '#/components/schemas/OrganizationId'
- description: The organization ID.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The token to use to retrieve the next page of results.
MaxResults:
allOf:
- $ref: '#/components/schemas/MaxResults'
- description: The maximum number of results to return in a single call.
ListMailboxPermissionsResponse:
type: object
properties:
Permissions:
allOf:
- $ref: '#/components/schemas/Permissions'
- description: 'One page of the user, group, or resource mailbox permissions.'
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The token to use to retrieve the next page of results. The value is "null" when there are no more results to return.
ListMailboxPermissionsRequest:
type: object
required:
- OrganizationId
- EntityId
title: ListMailboxPermissionsRequest
properties:
OrganizationId:
allOf:
- $ref: '#/components/schemas/OrganizationId'
- description: 'The identifier of the organization under which the user, group, or resource exists.'
EntityId:
allOf:
- $ref: '#/components/schemas/WorkMailIdentifier'
- description: 'The identifier of the user, group, or resource for which to list mailbox permissions.'
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The token to use to retrieve the next page of results. The first call does not contain any tokens.
MaxResults:
allOf:
- $ref: '#/components/schemas/MaxResults'
- description: The maximum number of results to return in a single call.
ListMobileDeviceAccessOverridesResponse:
type: object
properties:
Overrides:
allOf:
- $ref: '#/components/schemas/MobileDeviceAccessOverridesList'
- description: The list of mobile device access overrides that exist for the specified WorkMail organization and user.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The token to use to retrieve the next page of results. The value is “null” when there are no more results to return.
ListMobileDeviceAccessOverridesRequest:
type: object
required:
- OrganizationId
title: ListMobileDeviceAccessOverridesRequest
properties:
OrganizationId:
allOf:
- $ref: '#/components/schemas/OrganizationId'
- description: The WorkMail organization under which to list mobile device access overrides.
UserId:
allOf:
- $ref: '#/components/schemas/EntityIdentifier'
- description: '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
ActiveSync, AutoDiscover, EWS, IMAP, SMTP,
WindowsOutlook, and WebMail.'
NotActions:
allOf:
- $ref: '#/components/schemas/ActionsList'
- description: 'Access protocol actions to exclude from the rule. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP,
WindowsOutlook, and WebMail.'
UserIds:
allOf:
- $ref: '#/components/schemas/UserIdList'
- description: User IDs to include in the rule.
NotUserIds:
allOf:
- $ref: '#/components/schemas/UserIdList'
- description: User IDs to exclude from the rule.
OrganizationId:
allOf:
- $ref: '#/components/schemas/OrganizationId'
- description: The identifier of the organization.
ImpersonationRoleIds:
allOf:
- $ref: '#/components/schemas/ImpersonationRoleIdList'
- description: Impersonation role IDs to include in the rule.
NotImpersonationRoleIds:
allOf:
- $ref: '#/components/schemas/ImpersonationRoleIdList'
- description: Impersonation role IDs to exclude from the rule.
PutEmailMonitoringConfigurationResponse:
type: object
properties: {}
PutEmailMonitoringConfigurationRequest:
type: object
required:
- OrganizationId
- RoleArn
- LogGroupArn
title: PutEmailMonitoringConfigurationRequest
properties:
OrganizationId:
allOf:
- $ref: '#/components/schemas/OrganizationId'
- description: The ID of the organization for which the email monitoring configuration is set.
RoleArn:
allOf:
- $ref: '#/components/schemas/RoleArn'
- description: The Amazon Resource Name (ARN) of the IAM Role associated with the email monitoring configuration.
LogGroupArn:
allOf:
- $ref: '#/components/schemas/LogGroupArn'
- description: The Amazon Resource Name (ARN) of the CloudWatch Log group associated with the email monitoring configuration.
PutInboundDmarcSettingsResponse:
type: object
properties: {}
PutInboundDmarcSettingsRequest:
type: object
required:
- OrganizationId
- Enforced
title: PutInboundDmarcSettingsRequest
properties:
OrganizationId:
allOf:
- $ref: '#/components/schemas/OrganizationId'
- description: The ID of the organization that you are applying the DMARC policy to.
Enforced:
allOf:
- $ref: '#/components/schemas/BooleanObject'
- description: Enforces or suspends a policy after it's applied.
PutMailboxPermissionsResponse:
type: object
properties: {}
PutMailboxPermissionsRequest:
type: object
required:
- OrganizationId
- EntityId
- GranteeId
- PermissionValues
title: PutMailboxPermissionsRequest
properties:
OrganizationId:
allOf:
- $ref: '#/components/schemas/OrganizationId'
- description: 'The identifier of the organization under which the user, group, or resource exists.'
EntityId:
allOf:
- $ref: '#/components/schemas/WorkMailIdentifier'
- description: 'The identifier of the user, group, or resource for which to update mailbox permissions.'
GranteeId:
allOf:
- $ref: '#/components/schemas/WorkMailIdentifier'
- description: 'The identifier of the user, group, or resource to which to grant the permissions.'
PermissionValues:
allOf:
- $ref: '#/components/schemas/PermissionValues'
- description: 'The permissions granted to the grantee. SEND_AS allows the grantee to send email as the owner of the mailbox (the grantee is not mentioned on these emails). SEND_ON_BEHALF 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). FULL_ACCESS allows the grantee full access to the mailbox,
irrespective of other folder-level permissions set on the mailbox.'
PutMobileDeviceAccessOverrideResponse:
type: object
properties: {}
PutMobileDeviceAccessOverrideRequest:
type: object
required:
- OrganizationId
- UserId
- DeviceId
- Effect
title: PutMobileDeviceAccessOverrideRequest
properties:
OrganizationId:
allOf:
- $ref: '#/components/schemas/OrganizationId'
- description: Identifies the WorkMail organization for which you create the override.
UserId:
allOf:
- $ref: '#/components/schemas/EntityIdentifier'
- description: '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
DeviceId is case insensitive.
Effect:
allOf:
- $ref: '#/components/schemas/MobileDeviceAccessRuleEffect'
- description: 'The effect of the override, ALLOW or DENY.'
Description:
allOf:
- $ref: '#/components/schemas/MobileDeviceAccessRuleDescription'
- description: A description of the override.
PutRetentionPolicyResponse:
type: object
properties: {}
PutRetentionPolicyRequest:
type: object
required:
- OrganizationId
- Name
- FolderConfigurations
title: PutRetentionPolicyRequest
properties:
OrganizationId:
allOf:
- $ref: '#/components/schemas/OrganizationId'
- description: The organization ID.
Id:
allOf:
- $ref: '#/components/schemas/ShortString'
- description: The retention policy ID.
Name:
allOf:
- $ref: '#/components/schemas/ShortString'
- description: The retention policy name.
Description:
allOf:
- $ref: '#/components/schemas/PolicyDescription'
- description: The retention policy description.
FolderConfigurations:
allOf:
- $ref: '#/components/schemas/FolderConfigurations'
- description: The retention policy folder configurations.
RegisterMailDomainResponse:
type: object
properties: {}
RegisterMailDomainRequest:
type: object
required:
- OrganizationId
- DomainName
title: RegisterMailDomainRequest
properties:
ClientToken:
allOf:
- $ref: '#/components/schemas/IdempotencyClientToken'
- description: Idempotency token used when retrying requests.
OrganizationId:
allOf:
- $ref: '#/components/schemas/OrganizationId'
- description: The WorkMail organization under which you're creating the domain.
DomainName:
allOf:
- $ref: '#/components/schemas/WorkMailDomainName'
- description: The name of the mail domain to create in WorkMail and SES.
RegisterToWorkMailResponse:
type: object
properties: {}
RegisterToWorkMailRequest:
type: object
required:
- OrganizationId
- EntityId
- Email
title: RegisterToWorkMailRequest
properties:
OrganizationId:
allOf:
- $ref: '#/components/schemas/OrganizationId'
- description: 'The identifier for the organization under which the user, group, or resource exists.'
EntityId:
allOf:
- $ref: '#/components/schemas/WorkMailIdentifier'
- description: 'The identifier for the user, group, or resource to be updated.'
Email:
allOf:
- $ref: '#/components/schemas/EmailAddress'
- description: 'The email for the user, group, or resource to be updated.'
EntityAlreadyRegisteredException: {}
ResetPasswordResponse:
type: object
properties: {}
ResetPasswordRequest:
type: object
required:
- OrganizationId
- UserId
- Password
title: ResetPasswordRequest
properties:
OrganizationId:
allOf:
- $ref: '#/components/schemas/OrganizationId'
- description: The identifier of the organization that contains the user for which the password is reset.
UserId:
allOf:
- $ref: '#/components/schemas/WorkMailIdentifier'
- description: The identifier of the user for whom the password is reset.
Password:
allOf:
- $ref: '#/components/schemas/Password'
- description: The new password for the user.
StartMailboxExportJobResponse:
type: object
properties:
JobId:
allOf:
- $ref: '#/components/schemas/MailboxExportJobId'
- description: The job ID.
StartMailboxExportJobRequest:
type: object
required:
- ClientToken
- OrganizationId
- EntityId
- RoleArn
- KmsKeyArn
- S3BucketName
- S3Prefix
title: StartMailboxExportJobRequest
properties:
ClientToken:
allOf:
- $ref: '#/components/schemas/IdempotencyClientToken'
- description: The idempotency token for the client request.
OrganizationId:
allOf:
- $ref: '#/components/schemas/OrganizationId'
- description: The identifier associated with the organization.
EntityId:
allOf:
- $ref: '#/components/schemas/WorkMailIdentifier'
- description: The identifier of the user or resource associated with the mailbox.
Description:
allOf:
- $ref: '#/components/schemas/Description'
- description: The mailbox export job description.
RoleArn:
allOf:
- $ref: '#/components/schemas/RoleArn'
- description: The ARN of the AWS Identity and Access Management (IAM) role that grants write permission to the S3 bucket.
KmsKeyArn:
allOf:
- $ref: '#/components/schemas/KmsKeyArn'
- description: The Amazon Resource Name (ARN) of the symmetric AWS Key Management Service (AWS KMS) key that encrypts the exported mailbox content.
S3BucketName:
allOf:
- $ref: '#/components/schemas/S3BucketName'
- description: The name of the S3 bucket.
S3Prefix:
allOf:
- $ref: '#/components/schemas/S3ObjectKey'
- description: The S3 bucket prefix.
TagResourceResponse:
type: object
properties: {}
TagResourceRequest:
type: object
required:
- ResourceARN
- Tags
title: TagResourceRequest
properties:
ResourceARN:
allOf:
- $ref: '#/components/schemas/AmazonResourceName'
- description: The resource ARN.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- description: The tag key-value pairs.
TooManyTagsException: {}
TestAvailabilityConfigurationResponse:
type: object
properties:
TestPassed:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Boolean indicating whether the test passed or failed.
FailureReason:
allOf:
- $ref: '#/components/schemas/String'
- description: String containing the reason for a failed test if TestPassed is false.
TestAvailabilityConfigurationRequest:
type: object
required:
- OrganizationId
title: TestAvailabilityConfigurationRequest
properties:
OrganizationId:
allOf:
- $ref: '#/components/schemas/OrganizationId'
- description: The WorkMail organization where the availability provider will be tested.
DomainName:
allOf:
- $ref: '#/components/schemas/DomainName'
- description: '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:
$ref: '#/components/schemas/EwsAvailabilityProvider'
LambdaProvider:
$ref: '#/components/schemas/LambdaAvailabilityProvider'
UntagResourceResponse:
type: object
properties: {}
UntagResourceRequest:
type: object
required:
- ResourceARN
- TagKeys
title: UntagResourceRequest
properties:
ResourceARN:
allOf:
- $ref: '#/components/schemas/AmazonResourceName'
- description: The resource ARN.
TagKeys:
allOf:
- $ref: '#/components/schemas/TagKeyList'
- description: The tag keys.
UpdateAvailabilityConfigurationResponse:
type: object
properties: {}
UpdateAvailabilityConfigurationRequest:
type: object
required:
- OrganizationId
- DomainName
title: UpdateAvailabilityConfigurationRequest
properties:
OrganizationId:
allOf:
- $ref: '#/components/schemas/OrganizationId'
- description: The WorkMail organization for which the AvailabilityConfiguration will be updated.
DomainName:
allOf:
- $ref: '#/components/schemas/DomainName'
- description: The domain to which the provider applies the availability configuration.
EwsProvider:
allOf:
- $ref: '#/components/schemas/EwsAvailabilityProvider'
- description: '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:
allOf:
- $ref: '#/components/schemas/LambdaAvailabilityProvider'
- description: '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.'
UpdateDefaultMailDomainResponse:
type: object
properties: {}
UpdateDefaultMailDomainRequest:
type: object
required:
- OrganizationId
- DomainName
title: UpdateDefaultMailDomainRequest
properties:
OrganizationId:
allOf:
- $ref: '#/components/schemas/OrganizationId'
- description: The WorkMail organization for which to list domains.
DomainName:
allOf:
- $ref: '#/components/schemas/WorkMailDomainName'
- description: The domain name that will become the default domain.
UpdateImpersonationRoleResponse:
type: object
properties: {}
UpdateImpersonationRoleRequest:
type: object
required:
- OrganizationId
- ImpersonationRoleId
- Name
- Type
- Rules
title: UpdateImpersonationRoleRequest
properties:
OrganizationId:
allOf:
- $ref: '#/components/schemas/OrganizationId'
- description: The WorkMail organization that contains the impersonation role to update.
ImpersonationRoleId:
allOf:
- $ref: '#/components/schemas/ImpersonationRoleId'
- description: The ID of the impersonation role to update.
Name:
allOf:
- $ref: '#/components/schemas/ImpersonationRoleName'
- description: The updated impersonation role name.
Type:
allOf:
- $ref: '#/components/schemas/ImpersonationRoleType'
- description: The updated impersonation role type.
Description:
allOf:
- $ref: '#/components/schemas/ImpersonationRoleDescription'
- description: The updated impersonation role description.
Rules:
allOf:
- $ref: '#/components/schemas/ImpersonationRuleList'
- description: The updated list of rules.
UpdateMailboxQuotaResponse:
type: object
properties: {}
UpdateMailboxQuotaRequest:
type: object
required:
- OrganizationId
- UserId
- MailboxQuota
title: UpdateMailboxQuotaRequest
properties:
OrganizationId:
allOf:
- $ref: '#/components/schemas/OrganizationId'
- description: The identifier for the organization that contains the user for whom to update the mailbox quota.
UserId:
allOf:
- $ref: '#/components/schemas/WorkMailIdentifier'
- description: The identifer for the user for whom to update the mailbox quota.
MailboxQuota:
allOf:
- $ref: '#/components/schemas/MailboxQuota'
- description: 'The updated mailbox quota, in MB, for the specified user.'
UpdateMobileDeviceAccessRuleResponse:
type: object
properties: {}
UpdateMobileDeviceAccessRuleRequest:
type: object
required:
- OrganizationId
- MobileDeviceAccessRuleId
- Name
- Effect
title: UpdateMobileDeviceAccessRuleRequest
properties:
OrganizationId:
allOf:
- $ref: '#/components/schemas/OrganizationId'
- description: The WorkMail organization under which the rule will be updated.
MobileDeviceAccessRuleId:
allOf:
- $ref: '#/components/schemas/MobileDeviceAccessRuleId'
- description: The identifier of the rule to be updated.
Name:
allOf:
- $ref: '#/components/schemas/MobileDeviceAccessRuleName'
- description: The updated rule name.
Description:
allOf:
- $ref: '#/components/schemas/MobileDeviceAccessRuleDescription'
- description: The updated rule description.
Effect:
allOf:
- $ref: '#/components/schemas/MobileDeviceAccessRuleEffect'
- description: The effect of the rule when it matches. Allowed values are ALLOW or DENY.
DeviceTypes:
allOf:
- $ref: '#/components/schemas/DeviceTypeList'
- description: Device types that the updated rule will match.
NotDeviceTypes:
allOf:
- $ref: '#/components/schemas/DeviceTypeList'
- description: Device types that the updated rule will not match. All other device types will match.
DeviceModels:
allOf:
- $ref: '#/components/schemas/DeviceModelList'
- description: Device models that the updated rule will match.
NotDeviceModels:
allOf:
- $ref: '#/components/schemas/DeviceModelList'
- description: Device models that the updated rule will not match. All other device models will match.
DeviceOperatingSystems:
allOf:
- $ref: '#/components/schemas/DeviceOperatingSystemList'
- description: Device operating systems that the updated rule will match.
NotDeviceOperatingSystems:
allOf:
- $ref: '#/components/schemas/DeviceOperatingSystemList'
- description: Device operating systems that the updated rule will not match. All other device operating systems will match.
DeviceUserAgents:
allOf:
- $ref: '#/components/schemas/DeviceUserAgentList'
- description: User agents that the updated rule will match.
NotDeviceUserAgents:
allOf:
- $ref: '#/components/schemas/DeviceUserAgentList'
- description: User agents that the updated rule will not match. All other user agents will match.
UpdatePrimaryEmailAddressResponse:
type: object
properties: {}
UpdatePrimaryEmailAddressRequest:
type: object
required:
- OrganizationId
- EntityId
- Email
title: UpdatePrimaryEmailAddressRequest
properties:
OrganizationId:
allOf:
- $ref: '#/components/schemas/OrganizationId'
- description: 'The organization that contains the user, group, or resource to update.'
EntityId:
allOf:
- $ref: '#/components/schemas/WorkMailIdentifier'
- description: 'The user, group, or resource to update.'
Email:
allOf:
- $ref: '#/components/schemas/EmailAddress'
- description: The value of the email to be updated as primary.
UpdateResourceResponse:
type: object
properties: {}
UpdateResourceRequest:
type: object
required:
- OrganizationId
- ResourceId
title: UpdateResourceRequest
properties:
OrganizationId:
allOf:
- $ref: '#/components/schemas/OrganizationId'
- description: The identifier associated with the organization for which the resource is updated.
ResourceId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The identifier of the resource to be updated.
Name:
allOf:
- $ref: '#/components/schemas/ResourceName'
- description: The name of the resource to be updated.
BookingOptions:
allOf:
- $ref: '#/components/schemas/BookingOptions'
- description: The resource's booking options to be updated.
InvalidConfigurationException: {}
AccessControlRuleName:
type: string
pattern: '[a-zA-Z0-9_-]+'
minLength: 1
maxLength: 64
AccessControlRuleEffect:
type: string
enum:
- ALLOW
- DENY
AccessControlRuleDescription:
type: string
pattern: '[\u0020-\u00FF]+'
minLength: 0
maxLength: 255
IpRangeList:
type: array
items:
$ref: '#/components/schemas/IpRange'
minItems: 0
maxItems: 1024
ActionsList:
type: array
items:
$ref: '#/components/schemas/AccessControlRuleAction'
minItems: 0
maxItems: 10
UserIdList:
type: array
items:
$ref: '#/components/schemas/WorkMailIdentifier'
minItems: 0
maxItems: 10
Timestamp:
type: string
format: date-time
ImpersonationRoleIdList:
type: array
items:
$ref: '#/components/schemas/ImpersonationRoleId'
minItems: 0
maxItems: 10
AccessControlRule:
type: object
properties:
Name:
allOf:
- $ref: '#/components/schemas/AccessControlRuleName'
- description: The rule name.
Effect:
allOf:
- $ref: '#/components/schemas/AccessControlRuleEffect'
- description: The rule effect.
Description:
allOf:
- $ref: '#/components/schemas/AccessControlRuleDescription'
- description: The rule description.
IpRanges:
allOf:
- $ref: '#/components/schemas/IpRangeList'
- description: IPv4 CIDR ranges to include in the rule.
NotIpRanges:
allOf:
- $ref: '#/components/schemas/IpRangeList'
- description: IPv4 CIDR ranges to exclude from the rule.
Actions:
allOf:
- $ref: '#/components/schemas/ActionsList'
- description: 'Access protocol actions to include in the rule. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP,
WindowsOutlook, and WebMail.'
NotActions:
allOf:
- $ref: '#/components/schemas/ActionsList'
- description: 'Access protocol actions to exclude from the rule. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP,
WindowsOutlook, and WebMail.'
UserIds:
allOf:
- $ref: '#/components/schemas/UserIdList'
- description: User IDs to include in the rule.
NotUserIds:
allOf:
- $ref: '#/components/schemas/UserIdList'
- description: User IDs to exclude from the rule.
DateCreated:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The date that the rule was created.
DateModified:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The date that the rule was modified.
ImpersonationRoleIds:
allOf:
- $ref: '#/components/schemas/ImpersonationRoleIdList'
- description: Impersonation role IDs to include in the rule.
NotImpersonationRoleIds:
allOf:
- $ref: '#/components/schemas/ImpersonationRoleIdList'
- description: Impersonation role IDs to exclude from the rule.
description: A rule that controls access to an WorkMail organization.
AccessControlRuleAction:
type: string
pattern: '[a-zA-Z]+'
minLength: 1
maxLength: 64
AccessControlRuleNameList:
type: array
items:
$ref: '#/components/schemas/AccessControlRuleName'
minItems: 0
maxItems: 10
AccessControlRulesList:
type: array
items:
$ref: '#/components/schemas/AccessControlRule'
minItems: 0
maxItems: 10
AccessEffect:
type: string
enum:
- ALLOW
- DENY
EmailAddress:
type: string
pattern: '[a-zA-Z0-9._%+-]{1,64}@[a-zA-Z0-9.-]+\.[a-zA-Z-]{2,}'
minLength: 1
maxLength: 254
Aliases:
type: array
items:
$ref: '#/components/schemas/EmailAddress'
AmazonResourceName:
type: string
minLength: 1
maxLength: 1011
OrganizationId:
type: string
pattern: '^m-[0-9a-f]{32}$'
minLength: 34
maxLength: 34
ResourceId:
type: string
pattern: '^r-[0-9a-f]{32}$'
minLength: 34
maxLength: 34
WorkMailIdentifier:
type: string
minLength: 12
maxLength: 256
ImpersonationRoleId:
type: string
pattern: '[a-zA-Z0-9_-]+'
minLength: 1
maxLength: 64
ImpersonationToken:
type: string
pattern: '[\x21-\x7e]+'
minLength: 1
maxLength: 256
ExpiresIn:
type: integer
DomainName:
type: string
pattern: '[a-zA-Z0-9.-]+\.[a-zA-Z-]{2,}'
minLength: 3
maxLength: 255
AvailabilityProviderType:
type: string
enum:
- EWS
- LAMBDA
RedactedEwsAvailabilityProvider:
type: object
properties:
EwsEndpoint:
allOf:
- $ref: '#/components/schemas/Url'
- description: The endpoint of the remote EWS server.
EwsUsername:
allOf:
- $ref: '#/components/schemas/ExternalUserName'
- description: The username used to authenticate the remote EWS server.
description: Describes an EWS based availability provider when returned from the service. It does not contain the password of the endpoint.
LambdaAvailabilityProvider:
type: object
required:
- LambdaArn
properties:
LambdaArn:
allOf:
- $ref: '#/components/schemas/LambdaArn'
- description: The Amazon Resource Name (ARN) of the Lambda that acts as the availability provider.
description: Describes a Lambda based availability provider.
AvailabilityConfiguration:
type: object
properties:
DomainName:
allOf:
- $ref: '#/components/schemas/DomainName'
- description: Displays the domain to which the provider applies.
ProviderType:
allOf:
- $ref: '#/components/schemas/AvailabilityProviderType'
- description: Displays the provider type that applies to this domain.
EwsProvider:
allOf:
- $ref: '#/components/schemas/RedactedEwsAvailabilityProvider'
- description: 'If ProviderType is EWS, then this field contains RedactedEwsAvailabilityProvider. Otherwise, it is not required.'
LambdaProvider:
allOf:
- $ref: '#/components/schemas/LambdaAvailabilityProvider'
- description: 'If ProviderType is LAMBDA then this field contains LambdaAvailabilityProvider. Otherwise, it is not required.'
DateCreated:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The date and time at which the availability configuration was created.
DateModified:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The date and time at which the availability configuration was last modified.
description: List all the AvailabilityConfiguration's for the given WorkMail organization.
AvailabilityConfigurationList:
type: array
items:
$ref: '#/components/schemas/AvailabilityConfiguration'
Boolean:
type: boolean
BookingOptions:
type: object
properties:
AutoAcceptRequests:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'The resource''s ability to automatically reply to requests. If disabled, delegates must be associated to the resource.'
AutoDeclineRecurringRequests:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: The resource's ability to automatically decline any recurring requests.
AutoDeclineConflictingRequests:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: The resource's ability to automatically decline any conflicting requests.
description: At least one delegate must be associated to the resource to disable automatic replies from the resource.
BooleanObject:
type: boolean
IdempotencyClientToken:
type: string
pattern: '[\x21-\x7e]+'
minLength: 1
maxLength: 128
MailboxExportJobId:
type: string
pattern: '[A-Za-z0-9-]+'
minLength: 1
maxLength: 63
EwsAvailabilityProvider:
type: object
required:
- EwsEndpoint
- EwsUsername
- EwsPassword
properties:
EwsEndpoint:
allOf:
- $ref: '#/components/schemas/Url'
- description: The endpoint of the remote EWS server.
EwsUsername:
allOf:
- $ref: '#/components/schemas/ExternalUserName'
- description: The username used to authenticate the remote EWS server.
EwsPassword:
allOf:
- $ref: '#/components/schemas/Password'
- description: The password used to authenticate the remote EWS server.
description: Describes an EWS based availability provider. This is only used as input to the service.
GroupName:
type: string
pattern: '[\u0020-\u00FF]+'
minLength: 1
maxLength: 256
ImpersonationRoleName:
type: string
pattern: '[^\x00-\x1F\x7F\x3C\x3E\x5C]+'
minLength: 1
maxLength: 64
ImpersonationRoleType:
type: string
enum:
- FULL_ACCESS
- READ_ONLY
ImpersonationRoleDescription:
type: string
pattern: '[^\x00-\x09\x0B\x0C\x0E-\x1F\x7F\x3C\x3E\x5C]+'
minLength: 1
maxLength: 256
ImpersonationRuleList:
type: array
items:
$ref: '#/components/schemas/ImpersonationRule'
minItems: 0
maxItems: 10
MobileDeviceAccessRuleName:
type: string
pattern: '[\S\s]+'
minLength: 1
maxLength: 64
MobileDeviceAccessRuleDescription:
type: string
pattern: '[\S\s]+'
minLength: 1
maxLength: 256
MobileDeviceAccessRuleEffect:
type: string
enum:
- ALLOW
- DENY
DeviceTypeList:
type: array
items:
$ref: '#/components/schemas/DeviceType'
minItems: 1
maxItems: 10
DeviceModelList:
type: array
items:
$ref: '#/components/schemas/DeviceModel'
minItems: 1
maxItems: 10
DeviceOperatingSystemList:
type: array
items:
$ref: '#/components/schemas/DeviceOperatingSystem'
minItems: 1
maxItems: 10
DeviceUserAgentList:
type: array
items:
$ref: '#/components/schemas/DeviceUserAgent'
minItems: 1
maxItems: 10
MobileDeviceAccessRuleId:
type: string
pattern: '[a-zA-Z0-9_-]+'
minLength: 1
maxLength: 64
DirectoryId:
type: string
pattern: '^d-[0-9a-f]{10}$'
minLength: 12
maxLength: 12
OrganizationName:
type: string
pattern: '^(?!d-)([\da-zA-Z]+)([-][\da-zA-Z]+)*'
minLength: 1
maxLength: 62
Domains:
type: array
items:
$ref: '#/components/schemas/Domain'
minItems: 0
maxItems: 5
KmsKeyArn:
type: string
pattern: 'arn:aws:kms:[a-z0-9-]*:[a-z0-9-]+:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}'
minLength: 20
maxLength: 2048
ResourceName:
type: string
pattern: '[\w\-.]+(@[a-zA-Z0-9.\-]+\.[a-zA-Z0-9-]{2,})?'
minLength: 1
maxLength: 20
ResourceType:
type: string
enum:
- ROOM
- EQUIPMENT
UserName:
type: string
pattern: '[\w\-.]+(@[a-zA-Z0-9.\-]+\.[a-zA-Z0-9-]{2,})?'
minLength: 1
maxLength: 64
String:
type: string
maxLength: 256
Password:
type: string
pattern: '[\u0020-\u00FF]+'
maxLength: 256
format: password
MemberType:
type: string
enum:
- GROUP
- USER
Delegate:
type: object
required:
- Id
- Type
properties:
Id:
allOf:
- $ref: '#/components/schemas/String'
- description: The identifier for the user or group associated as the resource's delegate.
Type:
allOf:
- $ref: '#/components/schemas/MemberType'
- description: 'The type of the delegate: user or group.'
description: 'The name of the attribute, which is one of the values defined in the UserAttribute enumeration.'
EntityIdentifier:
type: string
pattern: '[a-zA-Z0-9._%+@-]+'
minLength: 1
maxLength: 256
DeviceId:
type: string
pattern: '[A-Za-z0-9]+'
minLength: 1
maxLength: 32
ShortString:
type: string
pattern: '[a-zA-Z0-9_-]+'
minLength: 1
maxLength: 64
WorkMailDomainName:
type: string
pattern: '[a-zA-Z0-9.-]+\.[a-zA-Z-]{2,}'
minLength: 3
maxLength: 209
RoleArn:
type: string
minLength: 20
maxLength: 2048
LogGroupArn:
type: string
pattern: 'arn:aws:logs:[a-z\-0-9]*:[0-9]{12}:log-group:([\.\-_/#A-Za-z0-9]+):\*$'
minLength: 47
maxLength: 562
EntityState:
type: string
enum:
- ENABLED
- DISABLED
- DELETED
Description:
type: string
pattern: '[\S\s]*'
minLength: 0
maxLength: 1023
S3BucketName:
type: string
pattern: '[A-Za-z0-9.-]+'
minLength: 1
maxLength: 63
S3ObjectKey:
type: string
pattern: '[A-Za-z0-9!_.*''()/-]+'
minLength: 1
maxLength: 1023
Percentage:
type: integer
minimum: 0
maximum: 100
MailboxExportJobState:
type: string
enum:
- RUNNING
- COMPLETED
- FAILED
- CANCELLED
MailboxExportErrorInfo:
type: string
pattern: '[\S\s]*'
minLength: 1
maxLength: 1024
UserRole:
type: string
enum:
- USER
- RESOURCE
- SYSTEM_USER
DeviceModel:
type: string
pattern: '[\u0020-\u00FF]+'
minLength: 1
maxLength: 256
DeviceOperatingSystem:
type: string
pattern: '[\u0020-\u00FF]+'
minLength: 1
maxLength: 256
DeviceType:
type: string
pattern: '[\u0020-\u00FF]+'
minLength: 1
maxLength: 256
DeviceUserAgent:
type: string
pattern: '[\u0020-\u00FF]+'
minLength: 1
maxLength: 256
DnsRecord:
type: object
properties:
Type:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The RFC 1035 record type. Possible values: CNAME, A, MX.'
Hostname:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The DNS hostname.- For example, domain.example.com.'
Value:
allOf:
- $ref: '#/components/schemas/String'
- description: The value returned by the DNS for a query to that hostname and record type.
description: A DNS record uploaded to your DNS provider.
DnsRecordVerificationStatus:
type: string
enum:
- PENDING
- VERIFIED
- FAILED
DnsRecords:
type: array
items:
$ref: '#/components/schemas/DnsRecord'
HostedZoneId:
type: string
pattern: '[\S\s]*'
minLength: 1
maxLength: 32
Domain:
type: object
properties:
DomainName:
allOf:
- $ref: '#/components/schemas/DomainName'
- description: The fully qualified domain name.
HostedZoneId:
allOf:
- $ref: '#/components/schemas/HostedZoneId'
- description: The hosted zone ID for a domain hosted in Route 53. Required when configuring a domain hosted in Route 53.
description: '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.
' Url: type: string pattern: 'https?://[A-Za-z0-9.-]+(:[0-9]+)?/.*' maxLength: 256 ExternalUserName: type: string pattern: '[\u0020-\u00FF]+' maxLength: 256 FolderName: type: string enum: - INBOX - DELETED_ITEMS - SENT_ITEMS - DRAFTS - JUNK_EMAIL RetentionAction: type: string enum: - NONE - DELETE - PERMANENTLY_DELETE RetentionPeriod: type: integer minimum: 1 maximum: 730 FolderConfiguration: type: object required: - Name - Action properties: Name: allOf: - $ref: '#/components/schemas/FolderName' - description: The folder name. Action: allOf: - $ref: '#/components/schemas/RetentionAction' - description: The action to take on the folder contents at the end of the folder configuration period. Period: allOf: - $ref: '#/components/schemas/RetentionPeriod' - description: The number of days for which the folder-configuration action applies. description: The configuration applied to an organization's folders by its retention policy. FolderConfigurations: type: array items: $ref: '#/components/schemas/FolderConfiguration' IpAddress: type: string pattern: '^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$' minLength: 1 maxLength: 15 ImpersonationMatchedRuleList: type: array items: $ref: '#/components/schemas/ImpersonationMatchedRule' minItems: 0 maxItems: 10 MailboxQuota: type: integer minimum: 1 MailboxSize: type: number format: double minimum: 0 MobileDeviceAccessMatchedRuleList: type: array items: $ref: '#/components/schemas/MobileDeviceAccessMatchedRule' minItems: 0 maxItems: 10 Group: type: object properties: Id: allOf: - $ref: '#/components/schemas/WorkMailIdentifier' - description: The identifier of the group. Email: allOf: - $ref: '#/components/schemas/EmailAddress' - description: The email of the group. Name: allOf: - $ref: '#/components/schemas/GroupName' - description: The name of the group. State: allOf: - $ref: '#/components/schemas/EntityState' - description: 'The state of the group, which can be ENABLED, DISABLED, or DELETED.' EnabledDate: allOf: - $ref: '#/components/schemas/Timestamp' - description: The date indicating when the group was enabled for WorkMail use. DisabledDate: allOf: - $ref: '#/components/schemas/Timestamp' - description: The date indicating when the group was disabled from WorkMail use. description: The representation of an WorkMail group. Groups: type: array items: $ref: '#/components/schemas/Group' ImpersonationRuleId: type: string pattern: '[a-zA-Z0-9_-]+' minLength: 1 maxLength: 64 ImpersonationRuleName: type: string pattern: '[^\x00-\x1F\x7F\x3C\x3E\x5C]+' minLength: 1 maxLength: 64 ImpersonationMatchedRule: type: object properties: ImpersonationRuleId: allOf: - $ref: '#/components/schemas/ImpersonationRuleId' - description: The ID of the rule that matched the input Name: allOf: - $ref: '#/components/schemas/ImpersonationRuleName' - description: The name of the rule that matched the input. description: The impersonation rule that matched the input. ImpersonationRole: type: object properties: ImpersonationRoleId: allOf: - $ref: '#/components/schemas/ImpersonationRoleId' - description: The identifier of the impersonation role. Name: allOf: - $ref: '#/components/schemas/ImpersonationRoleName' - description: The impersonation role name. Type: allOf: - $ref: '#/components/schemas/ImpersonationRoleType' - description: The impersonation role type. DateCreated: allOf: - $ref: '#/components/schemas/Timestamp' - description: The date when the impersonation role was created. DateModified: allOf: - $ref: '#/components/schemas/Timestamp' - description: The date when the impersonation role was last modified. description: An impersonation role for the given WorkMail organization. ImpersonationRoleList: type: array items: $ref: '#/components/schemas/ImpersonationRole' minItems: 0 maxItems: 20 ImpersonationRuleDescription: type: string pattern: '[^\x00-\x09\x0B\x0C\x0E-\x1F\x7F\x3C\x3E\x5C]+' minLength: 1 maxLength: 256 TargetUsers: type: array items: $ref: '#/components/schemas/EntityIdentifier' minItems: 1 maxItems: 10 ImpersonationRule: type: object required: - ImpersonationRuleId - Effect properties: ImpersonationRuleId: allOf: - $ref: '#/components/schemas/ImpersonationRuleId' - description: The identifier of the rule. Name: allOf: - $ref: '#/components/schemas/ImpersonationRuleName' - description: The rule name. Description: allOf: - $ref: '#/components/schemas/ImpersonationRuleDescription' - description: The rule description. Effect: allOf: - $ref: '#/components/schemas/AccessEffect' - description: The effect of the rule when it matches the input. Allowed effect values areALLOW or DENY.
TargetUsers:
allOf:
- $ref: '#/components/schemas/TargetUsers'
- description: A list of user IDs that match the rule.
NotTargetUsers:
allOf:
- $ref: '#/components/schemas/TargetUsers'
- description: A list of user IDs that don't match the rule.
description: The rules for the given impersonation role.
IpRange:
type: string
pattern: '^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])/([0-9]|[12][0-9]|3[0-2])$'
minLength: 1
maxLength: 18
MailboxExportJob:
type: object
properties:
JobId:
allOf:
- $ref: '#/components/schemas/MailboxExportJobId'
- description: The identifier of the mailbox export job.
EntityId:
allOf:
- $ref: '#/components/schemas/WorkMailIdentifier'
- description: The identifier of the user or resource associated with the mailbox.
Description:
allOf:
- $ref: '#/components/schemas/Description'
- description: The mailbox export job description.
S3BucketName:
allOf:
- $ref: '#/components/schemas/S3BucketName'
- description: The name of the S3 bucket.
S3Path:
allOf:
- $ref: '#/components/schemas/S3ObjectKey'
- description: The path to the S3 bucket and file that the mailbox export job exports to.
EstimatedProgress:
allOf:
- $ref: '#/components/schemas/Percentage'
- description: 'The estimated progress of the mailbox export job, in percentage points.'
State:
allOf:
- $ref: '#/components/schemas/MailboxExportJobState'
- description: The state of the mailbox export job.
StartTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The mailbox export job start timestamp.
EndTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The mailbox export job end timestamp.
description: '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.'
Jobs:
type: array
items:
$ref: '#/components/schemas/MailboxExportJob'
LambdaArn:
type: string
pattern: 'arn:aws:lambda:[a-z]{2}-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9\-_\.]+(:(\$LATEST|[a-zA-Z0-9\-_]+))?'
minLength: 49
maxLength: 256
NextToken:
type: string
pattern: '[\S\s]*|[a-zA-Z0-9/+=]{1,1024}'
minLength: 1
maxLength: 1024
MaxResults:
type: integer
minimum: 1
maximum: 100
Members:
type: array
items:
$ref: '#/components/schemas/Member'
MailDomains:
type: array
items:
$ref: '#/components/schemas/MailDomainSummary'
Permissions:
type: array
items:
$ref: '#/components/schemas/Permission'
MobileDeviceAccessOverridesList:
type: array
items:
$ref: '#/components/schemas/MobileDeviceAccessOverride'
MobileDeviceAccessRulesList:
type: array
items:
$ref: '#/components/schemas/MobileDeviceAccessRule'
minItems: 0
maxItems: 10
OrganizationSummaries:
type: array
items:
$ref: '#/components/schemas/OrganizationSummary'
ResourceDelegates:
type: array
items:
$ref: '#/components/schemas/Delegate'
Resources:
type: array
items:
$ref: '#/components/schemas/Resource'
TagList:
type: array
items:
$ref: '#/components/schemas/Tag'
minItems: 0
maxItems: 50
Users:
type: array
items:
$ref: '#/components/schemas/User'
MailDomainSummary:
type: object
properties:
DomainName:
allOf:
- $ref: '#/components/schemas/DomainName'
- description: The domain name.
DefaultDomain:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Whether the domain is default or not.
description: The data for a given domain.
Member:
type: object
properties:
Id:
allOf:
- $ref: '#/components/schemas/String'
- description: The identifier of the member.
Name:
allOf:
- $ref: '#/components/schemas/String'
- description: The name of the member.
Type:
allOf:
- $ref: '#/components/schemas/MemberType'
- description: A member can be a user or group.
State:
allOf:
- $ref: '#/components/schemas/EntityState'
- description: 'The state of the member, which can be ENABLED, DISABLED, or DELETED.'
EnabledDate:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The date indicating when the member was enabled for WorkMail use.
DisabledDate:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The date indicating when the member was disabled from WorkMail use.
description: The representation of a user or group.
MobileDeviceAccessMatchedRule:
type: object
properties:
MobileDeviceAccessRuleId:
allOf:
- $ref: '#/components/schemas/MobileDeviceAccessRuleId'
- description: Identifier of the rule that a simulated user matches.
Name:
allOf:
- $ref: '#/components/schemas/MobileDeviceAccessRuleName'
- description: Name of a rule that a simulated user matches.
description: The rule that a simulated user matches.
MobileDeviceAccessOverride:
type: object
properties:
UserId:
allOf:
- $ref: '#/components/schemas/WorkMailIdentifier'
- description: The WorkMail user to which the access override applies.
DeviceId:
allOf:
- $ref: '#/components/schemas/DeviceId'
- description: The device to which the override applies.
Effect:
allOf:
- $ref: '#/components/schemas/MobileDeviceAccessRuleEffect'
- description: 'The effect of the override, ALLOW or DENY.'
Description:
allOf:
- $ref: '#/components/schemas/MobileDeviceAccessRuleDescription'
- description: A description of the override.
DateCreated:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The date the override was first created.
DateModified:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The date the override was last modified.
description: The override object.
MobileDeviceAccessRule:
type: object
properties:
MobileDeviceAccessRuleId:
allOf:
- $ref: '#/components/schemas/MobileDeviceAccessRuleId'
- description: The ID assigned to a mobile access rule.
Name:
allOf:
- $ref: '#/components/schemas/MobileDeviceAccessRuleName'
- description: The name of a mobile access rule.
Description:
allOf:
- $ref: '#/components/schemas/MobileDeviceAccessRuleDescription'
- description: The description of a mobile access rule.
Effect:
allOf:
- $ref: '#/components/schemas/MobileDeviceAccessRuleEffect'
- description: The effect of the rule when it matches. Allowed values are ALLOW or DENY.
DeviceTypes:
allOf:
- $ref: '#/components/schemas/DeviceTypeList'
- description: Device types that a rule will match.
NotDeviceTypes:
allOf:
- $ref: '#/components/schemas/DeviceTypeList'
- description: Device types that a rule will not match. All other device types will match.
DeviceModels:
allOf:
- $ref: '#/components/schemas/DeviceModelList'
- description: Device models that a rule will match.
NotDeviceModels:
allOf:
- $ref: '#/components/schemas/DeviceModelList'
- description: Device models that a rule will not match. All other device models will match.
DeviceOperatingSystems:
allOf:
- $ref: '#/components/schemas/DeviceOperatingSystemList'
- description: Device operating systems that a rule will match.
NotDeviceOperatingSystems:
allOf:
- $ref: '#/components/schemas/DeviceOperatingSystemList'
- description: Device operating systems that a rule will not match. All other device types will match.
DeviceUserAgents:
allOf:
- $ref: '#/components/schemas/DeviceUserAgentList'
- description: Device user agents that a rule will match.
NotDeviceUserAgents:
allOf:
- $ref: '#/components/schemas/DeviceUserAgentList'
- description: Device user agents that a rule will not match. All other device user agents will match.
DateCreated:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The date and time at which an access rule was created.
DateModified:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The date and time at which an access rule was modified.
description: A rule that controls access to mobile devices for an WorkMail group.
OrganizationSummary:
type: object
properties:
OrganizationId:
allOf:
- $ref: '#/components/schemas/OrganizationId'
- description: The identifier associated with the organization.
Alias:
allOf:
- $ref: '#/components/schemas/OrganizationName'
- description: The alias associated with the organization.
DefaultMailDomain:
allOf:
- $ref: '#/components/schemas/DomainName'
- description: The default email domain associated with the organization.
ErrorMessage:
allOf:
- $ref: '#/components/schemas/String'
- description: The error message associated with the organization. It is only present if unexpected behavior has occurred with regards to the organization. It provides insight or solutions
regarding unexpected behavior.
State:
allOf:
- $ref: '#/components/schemas/String'
- description: The state associated with the organization.
description: The representation of an organization.
PermissionValues:
type: array
items:
$ref: '#/components/schemas/PermissionType'
Permission:
type: object
required:
- GranteeId
- GranteeType
- PermissionValues
properties:
GranteeId:
allOf:
- $ref: '#/components/schemas/WorkMailIdentifier'
- description: 'The identifier of the user, group, or resource to which the permissions are granted.'
GranteeType:
allOf:
- $ref: '#/components/schemas/MemberType'
- description: 'The type of user, group, or resource referred to in GranteeId.'
PermissionValues:
allOf:
- $ref: '#/components/schemas/PermissionValues'
- description: 'The permissions granted to the grantee. SEND_AS allows the grantee to send email as the owner of the mailbox (the grantee is not mentioned on these emails). SEND_ON_BEHALF 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). FULL_ACCESS allows the grantee full access to the mailbox,
irrespective of other folder-level permissions set on the mailbox.'
description: 'Permission granted to a user, group, or resource to access a certain aspect of another user, group, or resource mailbox.'
PermissionType:
type: string
enum:
- FULL_ACCESS
- SEND_AS
- SEND_ON_BEHALF
PolicyDescription:
type: string
pattern: '[\w\d\s\S\-!?=,.;:''_]+'
maxLength: 256
format: password
Resource:
type: object
properties:
Id:
allOf:
- $ref: '#/components/schemas/WorkMailIdentifier'
- description: The identifier of the resource.
Email:
allOf:
- $ref: '#/components/schemas/EmailAddress'
- description: The email of the resource.
Name:
allOf:
- $ref: '#/components/schemas/ResourceName'
- description: The name of the resource.
Type:
allOf:
- $ref: '#/components/schemas/ResourceType'
- description: 'The type of the resource: equipment or room.'
State:
allOf:
- $ref: '#/components/schemas/EntityState'
- description: 'The state of the resource, which can be ENABLED, DISABLED, or DELETED.'
EnabledDate:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The date indicating when the resource was enabled for WorkMail use.
DisabledDate:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The date indicating when the resource was disabled from WorkMail use.
description: The representation of a resource.
TagKey:
type: string
minLength: 1
maxLength: 128
TagValue:
type: string
minLength: 0
maxLength: 256
Tag:
type: object
required:
- Key
- Value
properties:
Key:
allOf:
- $ref: '#/components/schemas/TagKey'
- description: The key of the tag.
Value:
allOf:
- $ref: '#/components/schemas/TagValue'
- description: The value of the tag.
description: Describes a tag applied to a resource.
TagKeyList:
type: array
items:
$ref: '#/components/schemas/TagKey'
minItems: 0
maxItems: 50
User:
type: object
properties:
Id:
allOf:
- $ref: '#/components/schemas/WorkMailIdentifier'
- description: The identifier of the user.
Email:
allOf:
- $ref: '#/components/schemas/EmailAddress'
- description: The email of the user.
Name:
allOf:
- $ref: '#/components/schemas/UserName'
- description: The name of the user.
DisplayName:
allOf:
- $ref: '#/components/schemas/String'
- description: The display name of the user.
State:
allOf:
- $ref: '#/components/schemas/EntityState'
- description: 'The state of the user, which can be ENABLED, DISABLED, or DELETED.'
UserRole:
allOf:
- $ref: '#/components/schemas/UserRole'
- description: The role of the user.
EnabledDate:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The date indicating when the user was enabled for WorkMail use.
DisabledDate:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The date indicating when the user was disabled from WorkMail use.
description: The representation of an WorkMail user.
security:
- hmac: []