{"openapi":"3.0.0","info":{"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...","version":[]},"servers":[{"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...","url":"https://api.apirails.com/awsworkmail"}],"paths":{"/AssociateDelegateToResource":{"post":{"tags":["Resources"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_AssociateDelegateToResource.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"Associate delegate to resource","description":"Adds a member (user or group) to the resource's set of delegates.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"EntityId":{"type":"string","description":"The member (user or group) to associate to the resource. The entity ID can accept UserId or GroupID , Username or Groupname , or email . Entity: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234 Email address: entity@domain.tld Entity: entity","required":true},"OrganizationId":{"type":"string","description":"The organization under which the resource exists.","required":true},"ResourceId":{"type":"string","description":"The resource for which members (users or groups) are associated. The identifier can accept ResourceId , Resourcename , or email . The following identity formats are available: Resource ID: r-0123456789a0123456789b0123456789 Email address: resource@domain.tld Resource name: resource","required":true}}},"example":{"EntityId":"","OrganizationId":"","ResourceId":""}}}}}},"/AssociateMemberToGroup":{"post":{"tags":["Groups"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_AssociateMemberToGroup.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"Associate member to group","description":"Adds a member (user or group) to the group's set.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"GroupId":{"type":"string","description":"The group to which the member (user or group) is associated. The identifier can accept GroupId , Groupname , or email . The following identity formats are available: Group ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234 Email address: group@domain.tld Group…","required":true},"MemberId":{"type":"string","description":"The member (user or group) to associate to the group. The member ID can accept UserID or GroupId , Username or Groupname , or email . Member: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234 Email address: member@domain.tld Member name: member","required":true},"OrganizationId":{"type":"string","description":"The organization under which the group exists.","required":true}}},"example":{"GroupId":"","MemberId":"","OrganizationId":""}}}}}},"/AssumeImpersonationRole":{"post":{"tags":["Impersonation Roles"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_AssumeImpersonationRole.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"Assume impersonation role","description":"Assumes an impersonation role for the given WorkMail organization. This method returns an authentication token you can use to make impersonated calls.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ImpersonationRoleId":{"type":"string","description":"The impersonation role ID to assume.","required":true},"OrganizationId":{"type":"string","description":"The WorkMail organization under which the impersonation role will be assumed.","required":true}}},"example":{"ImpersonationRoleId":"","OrganizationId":""}}}}}},"/CancelMailboxExportJob":{"post":{"tags":["Mailbox Export Jobs"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_CancelMailboxExportJob.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"Cancel mailbox export job","description":"Cancels a mailbox export job. If the mailbox export job is near completion, it might not be possible to cancel it.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ClientToken":{"type":"string","description":"The idempotency token for the client request.","required":true},"JobId":{"type":"string","description":"The job ID.","required":true},"OrganizationId":{"type":"string","description":"The organization ID.","required":true}}},"example":{"ClientToken":"","JobId":"","OrganizationId":""}}}}}},"/CreateAlias":{"post":{"tags":["Aliases"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_CreateAlias.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"Create alias","description":"Adds an alias to the set of a given member (user or group) of WorkMail.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Alias":{"type":"string","description":"The alias to add to the member set.","required":true},"EntityId":{"type":"string","description":"The member (user or group) to which this alias is added.","required":true},"OrganizationId":{"type":"string","description":"The organization under which the member (user or group) exists.","required":true}}},"example":{"Alias":"","EntityId":"","OrganizationId":""}}}}}},"/CreateAvailabilityConfiguration":{"post":{"tags":["Availability Configurations"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_CreateAvailabilityConfiguration.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"Create availability configuration","description":"Creates an AvailabilityConfiguration for the given WorkMail organization and domain.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ClientToken":{"type":"string","description":"An idempotent token that ensures that an API request is executed only once."},"DomainName":{"type":"string","description":"The domain to which the provider applies.","required":true},"EwsProvider":{"type":"object","description":"Exchange Web Services (EWS) availability provider definition. The request must contain exactly one provider definition, either EwsProvider or LambdaProvider .","properties":{}},"LambdaProvider":{"type":"object","description":"Lambda availability provider definition. The request must contain exactly one provider definition, either EwsProvider or LambdaProvider .","properties":{}},"OrganizationId":{"type":"string","description":"The WorkMail organization for which the AvailabilityConfiguration will be created.","required":true}}},"example":{"ClientToken":"","DomainName":"","EwsProvider":{"EwsEndpoint":"string","EwsPassword":"string","EwsUsername":"string"},"LambdaProvider":{"LambdaArn":"string"},"OrganizationId":""}}}}}},"/CreateGroup":{"post":{"tags":["Groups"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_CreateGroup.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"Create group","description":"Creates a group that can be used in WorkMail by calling the RegisterToWorkMail operation.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"HiddenFromGlobalAddressList":{"type":"boolean","description":"If this parameter is enabled, the group will be hidden from the address book."},"Name":{"type":"string","description":"The name of the group.","required":true},"OrganizationId":{"type":"string","description":"The organization under which the group is to be created.","required":true}}},"example":{"HiddenFromGlobalAddressList":"","Name":"","OrganizationId":""}}}}}},"/CreateIdentityCenterApplication":{"post":{"tags":["Identity Center"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_CreateIdentityCenterApplication.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"Create identity center application","description":"Creates the WorkMail application in IAM Identity Center that can be used later in the WorkMail - IdC integration. For more information, see PutIdentityProviderConfiguration. This action does not affect the authentication settings for any WorkMail organizations.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ClientToken":{"type":"string","description":"The idempotency token associated with the request."},"InstanceArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the instance.","required":true},"Name":{"type":"string","description":"The name of the IAM Identity Center application.","required":true}}},"example":{"ClientToken":"","InstanceArn":"","Name":""}}}}}},"/CreateImpersonationRole":{"post":{"tags":["Impersonation Roles"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_CreateImpersonationRole.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"Create impersonation role","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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ClientToken":{"type":"string","description":"The idempotency token for the client request."},"Description":{"type":"string","description":"The description of the new impersonation role."},"Name":{"type":"string","description":"The name of the new impersonation role.","required":true},"OrganizationId":{"type":"string","description":"The WorkMail organization to create the new impersonation role within.","required":true},"Rules":{"type":"array","description":"The list of rules for the impersonation role.","required":true,"items":{"type":"object","properties":{"Description":{"type":"string","description":"The rule description."},"Effect":{"type":"string","description":"The effect of the rule when it matches the input. Allowed effect values are ALLOW or DENY .","required":true,"enum":["ALLOW","DENY"]},"ImpersonationRuleId":{"type":"string","description":"The identifier of the rule.","required":true},"Name":{"type":"string","description":"The rule name."},"NotTargetUsers":{"type":"array","description":"A list of user IDs that don't match the rule."},"TargetUsers":{"type":"array","description":"A list of user IDs that match the rule."}}}},"Type":{"type":"enum","description":"The impersonation role's type. The available impersonation role types are READ_ONLY or FULL_ACCESS .","required":true,"enum":["FULL_ACCESS","READ_ONLY"]}}},"example":{"ClientToken":"","Description":"","Name":"","OrganizationId":"","Rules":[],"Type":""}}}}}},"/CreateMobileDeviceAccessRule":{"post":{"tags":["Mobile Device Access"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_CreateMobileDeviceAccessRule.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"Create mobile device access rule","description":"Creates a new mobile device access rule for the specified WorkMail organization.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ClientToken":{"type":"string","description":"The idempotency token for the client request."},"Description":{"type":"string","description":"The rule description."},"DeviceModels":{"type":"array","description":"Device models that the rule will match.","items":{"type":"string"}},"DeviceOperatingSystems":{"type":"array","description":"Device operating systems that the rule will match.","items":{"type":"string"}},"DeviceTypes":{"type":"array","description":"Device types that the rule will match.","items":{"type":"string"}},"DeviceUserAgents":{"type":"array","description":"Device user agents that the rule will match.","items":{"type":"string"}},"Effect":{"type":"enum","description":"The effect of the rule when it matches. Allowed values are ALLOW or DENY .","required":true,"enum":["ALLOW","DENY"]},"Name":{"type":"string","description":"The rule name.","required":true},"NotDeviceModels":{"type":"array","description":"Device models that the rule will not match. All other device models will match.","items":{"type":"string"}},"NotDeviceOperatingSystems":{"type":"array","description":"Device operating systems that the rule will not match. All other device operating systems will match.","items":{"type":"string"}},"NotDeviceTypes":{"type":"array","description":"Device types that the rule will not match. All other device types will match.","items":{"type":"string"}},"NotDeviceUserAgents":{"type":"array","description":"Device user agents that the rule will not match. All other device user agents will match.","items":{"type":"string"}},"OrganizationId":{"type":"string","description":"The WorkMail organization under which the rule will be created.","required":true}}},"example":{"ClientToken":"","Description":"","DeviceModels":[],"DeviceOperatingSystems":[],"DeviceTypes":[],"DeviceUserAgents":[],"Effect":"","Name":"","NotDeviceModels":[],"NotDeviceOperatingSystems":[],"NotDeviceTypes":[],"NotDeviceUserAgents":[],"OrganizationId":""}}}}}},"/CreateOrganization":{"post":{"tags":["Organizations"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_CreateOrganization.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"Create organization","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…","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Alias":{"type":"string","description":"The organization alias.","required":true},"ClientToken":{"type":"string","description":"The idempotency token associated with the request."},"DirectoryId":{"type":"string","description":"The AWS Directory Service directory ID."},"Domains":{"type":"array","description":"The email domains to associate with the organization.","items":{"type":"object","properties":{"DomainName":{"type":"string","description":"The fully qualified domain name.","required":true},"HostedZoneId":{"type":"string","description":"The hosted zone ID for a domain hosted in Route 53. Required when configuring a domain hosted in Route 53."}}}},"EnableInteroperability":{"type":"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."},"KmsKeyArn":{"type":"string","description":"The Amazon Resource Name (ARN) of a customer managed key from AWS KMS."}}},"example":{"Alias":"","ClientToken":"","DirectoryId":"","Domains":[],"EnableInteroperability":"","KmsKeyArn":""}}}}}},"/CreateResource":{"post":{"tags":["Resources"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_CreateResource.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"Create resource","description":"Creates a new WorkMail resource.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Description":{"type":"string","description":"Resource description."},"HiddenFromGlobalAddressList":{"type":"boolean","description":"If this parameter is enabled, the resource will be hidden from the address book."},"Name":{"type":"string","description":"The name of the new resource.","required":true},"OrganizationId":{"type":"string","description":"The identifier associated with the organization for which the resource is created.","required":true},"Type":{"type":"enum","description":"The type of the new resource. The available types are equipment and room .","required":true,"enum":["ROOM","EQUIPMENT"]}}},"example":{"Description":"","HiddenFromGlobalAddressList":"","Name":"","OrganizationId":"","Type":""}}}}}},"/CreateUser":{"post":{"tags":["Users"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_CreateUser.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"Create user","description":"Creates a user who can be used in WorkMail by calling the RegisterToWorkMail operation.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"DisplayName":{"type":"string","description":"The display name for the new user.","required":true},"FirstName":{"type":"string","description":"The first name of the new user."},"HiddenFromGlobalAddressList":{"type":"boolean","description":"If this parameter is enabled, the user will be hidden from the address book."},"IdentityProviderUserId":{"type":"string","description":"User ID from the IAM Identity Center. If this parameter is empty it will be updated automatically when the user logs in for the first time to the mailbox associated with WorkMail."},"LastName":{"type":"string","description":"The last name of the new user."},"Name":{"type":"string","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.","required":true},"OrganizationId":{"type":"string","description":"The identifier of the organization for which the user is created.","required":true},"Password":{"type":"string","description":"The password for the new user."},"Role":{"type":"enum","description":"The role of the new user. You cannot pass SYSTEM_USER or RESOURCE role in a single request. When a user role is not selected, the default role of USER is selected.","enum":["USER","RESOURCE","SYSTEM_USER","REMOTE_USER"]}}},"example":{"DisplayName":"","FirstName":"","HiddenFromGlobalAddressList":"","IdentityProviderUserId":"","LastName":"","Name":"","OrganizationId":"","Password":"","Role":""}}}}}},"/DeleteAccessControlRule":{"post":{"tags":["Access Control Rules"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_DeleteAccessControlRule.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"Delete access control rule","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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Name":{"type":"string","description":"The name of the access control rule.","required":true},"OrganizationId":{"type":"string","description":"The identifier for the organization.","required":true}}},"example":{"Name":"","OrganizationId":""}}}}}},"/DeleteAlias":{"post":{"tags":["Aliases"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_DeleteAlias.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"Delete alias","description":"Remove one or more specified aliases from a set of aliases for a given user.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Alias":{"type":"string","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).","required":true},"EntityId":{"type":"string","description":"The identifier for the member (user or group) from which to have the aliases removed.","required":true},"OrganizationId":{"type":"string","description":"The identifier for the organization under which the user exists.","required":true}}},"example":{"Alias":"","EntityId":"","OrganizationId":""}}}}}},"/DeleteAvailabilityConfiguration":{"post":{"tags":["Availability Configurations"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_DeleteAvailabilityConfiguration.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"Delete availability configuration","description":"Deletes the AvailabilityConfiguration for the given WorkMail organization and domain.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"DomainName":{"type":"string","description":"The domain for which the AvailabilityConfiguration will be deleted.","required":true},"OrganizationId":{"type":"string","description":"The WorkMail organization for which the AvailabilityConfiguration will be deleted.","required":true}}},"example":{"DomainName":"","OrganizationId":""}}}}}},"/DeleteEmailMonitoringConfiguration":{"post":{"tags":["Email Monitoring Configuration"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_DeleteEmailMonitoringConfiguration.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"Delete email monitoring configuration","description":"Deletes the email monitoring configuration for a specified organization.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"OrganizationId":{"type":"string","description":"The ID of the organization from which the email monitoring configuration is deleted.","required":true}}},"example":{"OrganizationId":""}}}}}},"/DeleteGroup":{"post":{"tags":["Groups"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_DeleteGroup.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"Delete group","description":"Deletes a group from WorkMail.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"GroupId":{"type":"string","description":"The identifier of the group to be deleted. The identifier can be the GroupId , or Groupname . The following identity formats are available: Group ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234 Group name: group","required":true},"OrganizationId":{"type":"string","description":"The organization that contains the group.","required":true}}},"example":{"GroupId":"","OrganizationId":""}}}}}},"/DeleteIdentityCenterApplication":{"post":{"tags":["Identity Center"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_DeleteIdentityCenterApplication.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"Delete identity center application","description":"Deletes the IAM Identity Center application from WorkMail. This action does not affect the authentication settings for any WorkMail organizations.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ApplicationArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the application.","required":true}}},"example":{"ApplicationArn":""}}}}}},"/DeleteIdentityProviderConfiguration":{"post":{"tags":["Identity Provider Configuration"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_DeleteIdentityProviderConfiguration.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"Delete identity provider configuration","description":"Disables the integration between IdC and WorkMail. Authentication will continue with the directory as it was before the IdC integration. You might have to reset your directory passwords and reconfigure your desktop and mobile email clients.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"OrganizationId":{"type":"string","description":"The Organization ID.","required":true}}},"example":{"OrganizationId":""}}}}}},"/DeleteImpersonationRole":{"post":{"tags":["Impersonation Roles"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_DeleteImpersonationRole.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"Delete impersonation role","description":"Deletes an impersonation role for the given WorkMail organization.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ImpersonationRoleId":{"type":"string","description":"The ID of the impersonation role to delete.","required":true},"OrganizationId":{"type":"string","description":"The WorkMail organization from which to delete the impersonation role.","required":true}}},"example":{"ImpersonationRoleId":"","OrganizationId":""}}}}}},"/DeleteMailboxPermissions":{"post":{"tags":["Mailbox Permissions"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_DeleteMailboxPermissions.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"Delete mailbox permissions","description":"Deletes permissions granted to a member (user or group).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"EntityId":{"type":"string","description":"The identifier of the entity that owns the mailbox. The identifier can be UserId or Group Id , Username or Groupname , or email . Entity ID: 12345678-1234-1234-1234-123456789012, r-0123456789a0123456789b0123456789, or S-1-1-12-1234567890-123456789-123456789-1234 Email address: entity@domain.tld…","required":true},"GranteeId":{"type":"string","description":"The identifier of the entity for which to delete granted permissions. The identifier can be UserId, ResourceID, or Group Id , Username or Groupname , or email . Grantee ID: 12345678-1234-1234-1234-123456789012,r-0123456789a0123456789b0123456789, or S-1-1-12-1234567890-123456789-123456789-1234 Email…","required":true},"OrganizationId":{"type":"string","description":"The identifier of the organization under which the member (user or group) exists.","required":true}}},"example":{"EntityId":"","GranteeId":"","OrganizationId":""}}}}}},"/DeleteMobileDeviceAccessOverride":{"post":{"tags":["Mobile Device Access"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_DeleteMobileDeviceAccessOverride.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"Delete mobile device access override","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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"DeviceId":{"type":"string","description":"The mobile device for which you delete the override. DeviceId is case insensitive.","required":true},"OrganizationId":{"type":"string","description":"The WorkMail organization for which the access override will be deleted.","required":true},"UserId":{"type":"string","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","required":true}}},"example":{"DeviceId":"","OrganizationId":"","UserId":""}}}}}},"/DeleteMobileDeviceAccessRule":{"post":{"tags":["Mobile Device Access"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_DeleteMobileDeviceAccessRule.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"Delete mobile device access rule","description":"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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"MobileDeviceAccessRuleId":{"type":"string","description":"The identifier of the rule to be deleted.","required":true},"OrganizationId":{"type":"string","description":"The WorkMail organization under which the rule will be deleted.","required":true}}},"example":{"MobileDeviceAccessRuleId":"","OrganizationId":""}}}}}},"/DeleteOrganization":{"post":{"tags":["Organizations"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_DeleteOrganization.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"Delete organization","description":"Deletes an WorkMail organization and all underlying AWS resources managed by WorkMail as part of the organization. You can choose whether to delete the associated directory. For more information, see Removing an organization in the WorkMail Administrator Guide .","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ClientToken":{"type":"string","description":"The idempotency token associated with the request."},"DeleteDirectory":{"type":"boolean","description":"If true, deletes the AWS Directory Service directory associated with the organization.","required":true},"DeleteIdentityCenterApplication":{"type":"boolean","description":"Deletes IAM Identity Center application for WorkMail. This action does not affect authentication settings for any organization."},"ForceDelete":{"type":"boolean","description":"Deletes a WorkMail organization even if the organization has enabled users."},"OrganizationId":{"type":"string","description":"The organization ID.","required":true}}},"example":{"ClientToken":"","DeleteDirectory":"","DeleteIdentityCenterApplication":"","ForceDelete":"","OrganizationId":""}}}}}},"/DeletePersonalAccessToken":{"post":{"tags":["Personal Access Tokens"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_DeletePersonalAccessToken.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"Delete personal access token","description":"Deletes the Personal Access Token from the provided WorkMail Organization.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"OrganizationId":{"type":"string","description":"The Organization ID.","required":true},"PersonalAccessTokenId":{"type":"string","description":"The Personal Access Token ID.","required":true}}},"example":{"OrganizationId":"","PersonalAccessTokenId":""}}}}}},"/DeleteResource":{"post":{"tags":["Resources"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_DeleteResource.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"Delete resource","description":"Deletes the specified resource.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"OrganizationId":{"type":"string","description":"The identifier associated with the organization from which the resource is deleted.","required":true},"ResourceId":{"type":"string","description":"The identifier of the resource to be deleted. The identifier can accept ResourceId , or Resourcename . The following identity formats are available: Resource ID: r-0123456789a0123456789b0123456789 Resource name: resource","required":true}}},"example":{"OrganizationId":"","ResourceId":""}}}}}},"/DeleteRetentionPolicy":{"post":{"tags":["Retention Policies"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_DeleteRetentionPolicy.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"Delete retention policy","description":"Deletes the specified retention policy from the specified organization.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Id":{"type":"string","description":"The retention policy ID.","required":true},"OrganizationId":{"type":"string","description":"The organization ID.","required":true}}},"example":{"Id":"","OrganizationId":""}}}}}},"/DeleteUser":{"post":{"tags":["Users"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_DeleteUser.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"Delete user","description":"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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"OrganizationId":{"type":"string","description":"The organization that contains the user to be deleted.","required":true},"UserId":{"type":"string","description":"The identifier of the user to be deleted. The identifier can be the UserId or Username . The following identity formats are available: User ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234 User name: user","required":true}}},"example":{"OrganizationId":"","UserId":""}}}}}},"/DeregisterFromWorkMail":{"post":{"tags":["Users"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_DeregisterFromWorkMail.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"Deregister from work mail","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 .","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"EntityId":{"type":"string","description":"The identifier for the member to be updated. The identifier can be UserId, ResourceId, or Group Id , Username, Resourcename, or Groupname , or email . Entity ID: 12345678-1234-1234-1234-123456789012, r-0123456789a0123456789b0123456789, or S-1-1-12-1234567890-123456789-123456789-1234 Email address…","required":true},"OrganizationId":{"type":"string","description":"The identifier for the organization under which the WorkMail entity exists.","required":true}}},"example":{"EntityId":"","OrganizationId":""}}}}}},"/DeregisterMailDomain":{"post":{"tags":["Mail Domains"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_DeregisterMailDomain.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"Deregister mail domain","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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"DomainName":{"type":"string","description":"The domain to deregister in WorkMail and SES.","required":true},"OrganizationId":{"type":"string","description":"The WorkMail organization for which the domain will be deregistered.","required":true}}},"example":{"DomainName":"","OrganizationId":""}}}}}},"/DescribeEmailMonitoringConfiguration":{"post":{"tags":["Email Monitoring Configuration"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_DescribeEmailMonitoringConfiguration.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"Describe email monitoring configuration","description":"Describes the current email monitoring configuration for a specified organization.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"OrganizationId":{"type":"string","description":"The ID of the organization for which the email monitoring configuration is described.","required":true}}},"example":{"OrganizationId":""}}}}}},"/DescribeEntity":{"post":{"tags":["Entities"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_DescribeEntity.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"Describe entity","description":"Returns basic details about an entity in WorkMail.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Email":{"type":"string","description":"The email under which the entity exists.","required":true},"OrganizationId":{"type":"string","description":"The identifier for the organization under which the entity exists.","required":true}}},"example":{"Email":"","OrganizationId":""}}}}}},"/DescribeGroup":{"post":{"tags":["Groups"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_DescribeGroup.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"Describe group","description":"Returns the data available for the group.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"GroupId":{"type":"string","description":"The identifier for the group to be described. The identifier can accept GroupId , Groupname , or email . The following identity formats are available: Group ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234 Email address: group@domain.tld Group name: group","required":true},"OrganizationId":{"type":"string","description":"The identifier for the organization under which the group exists.","required":true}}},"example":{"GroupId":"","OrganizationId":""}}}}}},"/DescribeIdentityProviderConfiguration":{"post":{"tags":["Identity Provider Configuration"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_DescribeIdentityProviderConfiguration.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"Describe identity provider configuration","description":"Returns detailed information on the current IdC setup for the WorkMail organization.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"OrganizationId":{"type":"string","description":"The Organization ID.","required":true}}},"example":{"OrganizationId":""}}}}}},"/DescribeInboundDmarcSettings":{"post":{"tags":["Inbound Dmarc Settings"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_DescribeInboundDmarcSettings.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"Describe inbound dmarc settings","description":"Lists the settings in a DMARC policy for a specified organization.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"OrganizationId":{"type":"string","description":"Lists the ID of the given organization.","required":true}}},"example":{"OrganizationId":""}}}}}},"/DescribeMailboxExportJob":{"post":{"tags":["Mailbox Export Jobs"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_DescribeMailboxExportJob.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"Describe mailbox export job","description":"Describes the current status of a mailbox export job.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"JobId":{"type":"string","description":"The mailbox export job ID.","required":true},"OrganizationId":{"type":"string","description":"The organization ID.","required":true}}},"example":{"JobId":"","OrganizationId":""}}}}}},"/DescribeOrganization":{"post":{"tags":["Organizations"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_DescribeOrganization.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"Describe organization","description":"Provides more information regarding a given organization based on its identifier.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"OrganizationId":{"type":"string","description":"The identifier for the organization to be described.","required":true}}},"example":{"OrganizationId":""}}}}}},"/DescribeResource":{"post":{"tags":["Resources"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_DescribeResource.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"Describe resource","description":"Returns the data available for the resource.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"OrganizationId":{"type":"string","description":"The identifier associated with the organization for which the resource is described.","required":true},"ResourceId":{"type":"string","description":"The identifier of the resource to be described. The identifier can accept ResourceId , Resourcename , or email . The following identity formats are available: Resource ID: r-0123456789a0123456789b0123456789 Email address: resource@domain.tld Resource name: resource","required":true}}},"example":{"OrganizationId":"","ResourceId":""}}}}}},"/DescribeUser":{"post":{"tags":["Users"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_DescribeUser.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"Describe user","description":"Provides information regarding the user.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"OrganizationId":{"type":"string","description":"The identifier for the organization under which the user exists.","required":true},"UserId":{"type":"string","description":"The identifier for the user to be described. The identifier can be the UserId , Username , or email . 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","required":true}}},"example":{"OrganizationId":"","UserId":""}}}}}},"/DisassociateDelegateFromResource":{"post":{"tags":["Resources"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_DisassociateDelegateFromResource.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"Disassociate delegate from resource","description":"Removes a member from the resource's set of delegates.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"EntityId":{"type":"string","description":"The identifier for the member (user, group) to be removed from the resource's delegates. The entity ID can accept UserId or GroupID , Username or Groupname , or email . Entity: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234 Email address: entity@domain.tld…","required":true},"OrganizationId":{"type":"string","description":"The identifier for the organization under which the resource exists.","required":true},"ResourceId":{"type":"string","description":"The identifier of the resource from which delegates' set members are removed. The identifier can accept ResourceId , Resourcename , or email . The following identity formats are available: Resource ID: r-0123456789a0123456789b0123456789 Email address: resource@domain.tld Resource name: resource","required":true}}},"example":{"EntityId":"","OrganizationId":"","ResourceId":""}}}}}},"/DisassociateMemberFromGroup":{"post":{"tags":["Groups"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_DisassociateMemberFromGroup.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"Disassociate member from group","description":"Removes a member from a group.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"GroupId":{"type":"string","description":"The identifier for the group from which members are removed. The identifier can accept GroupId , Groupname , or email . The following identity formats are available: Group ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234 Email address: group@domain.tld Group…","required":true},"MemberId":{"type":"string","description":"The identifier for the member to be removed from the group. The member ID can accept UserID or GroupId , Username or Groupname , or email . Member ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234 Email address: member@domain.tld Member name: member","required":true},"OrganizationId":{"type":"string","description":"The identifier for the organization under which the group exists.","required":true}}},"example":{"GroupId":"","MemberId":"","OrganizationId":""}}}}}},"/GetAccessControlEffect":{"post":{"tags":["Access Control Rules"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_GetAccessControlEffect.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"Get access control effect","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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Action":{"type":"string","description":"The access protocol action. Valid values include ActiveSync , AutoDiscover , EWS , IMAP , SMTP , WindowsOutlook , and WebMail .","required":true},"ImpersonationRoleId":{"type":"string","description":"The impersonation role ID."},"IpAddress":{"type":"string","description":"The IPv4 address.","required":true},"OrganizationId":{"type":"string","description":"The identifier for the organization.","required":true},"UserId":{"type":"string","description":"The user ID."}}},"example":{"Action":"","ImpersonationRoleId":"","IpAddress":"","OrganizationId":"","UserId":""}}}}}},"/GetDefaultRetentionPolicy":{"post":{"tags":["Retention Policies"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_GetDefaultRetentionPolicy.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"Get default retention policy","description":"Gets the default retention policy details for the specified organization.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"OrganizationId":{"type":"string","description":"The organization ID.","required":true}}},"example":{"OrganizationId":""}}}}}},"/GetImpersonationRole":{"post":{"tags":["Impersonation Roles"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_GetImpersonationRole.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"Get impersonation role","description":"Gets the impersonation role details for the given WorkMail organization.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ImpersonationRoleId":{"type":"string","description":"The impersonation role ID to retrieve.","required":true},"OrganizationId":{"type":"string","description":"The WorkMail organization from which to retrieve the impersonation role.","required":true}}},"example":{"ImpersonationRoleId":"","OrganizationId":""}}}}}},"/GetImpersonationRoleEffect":{"post":{"tags":["Impersonation Roles"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_GetImpersonationRoleEffect.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"Get impersonation role effect","description":"Tests whether the given impersonation role can impersonate a target user.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ImpersonationRoleId":{"type":"string","description":"The impersonation role ID to test.","required":true},"OrganizationId":{"type":"string","description":"The WorkMail organization where the impersonation role is defined.","required":true},"TargetUser":{"type":"string","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","required":true}}},"example":{"ImpersonationRoleId":"","OrganizationId":"","TargetUser":""}}}}}},"/GetMailDomain":{"post":{"tags":["Mail Domains"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_GetMailDomain.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"Get mail domain","description":"Gets details for a mail domain, including domain records required to configure your domain with recommended security.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"DomainName":{"type":"string","description":"The domain from which you want to retrieve details.","required":true},"OrganizationId":{"type":"string","description":"The WorkMail organization for which the domain is retrieved.","required":true}}},"example":{"DomainName":"","OrganizationId":""}}}}}},"/GetMailboxDetails":{"post":{"tags":["Mailboxes"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_GetMailboxDetails.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"Get mailbox details","description":"Requests a user's mailbox details for a specified organization and user.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"OrganizationId":{"type":"string","description":"The identifier for the organization that contains the user whose mailbox details are being requested.","required":true},"UserId":{"type":"string","description":"The identifier for the user whose mailbox details are being requested. The identifier can be the UserId , Username , or email . 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…","required":true}}},"example":{"OrganizationId":"","UserId":""}}}}}},"/GetMobileDeviceAccessEffect":{"post":{"tags":["Mobile Device Access"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_GetMobileDeviceAccessEffect.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"Get mobile device access effect","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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"DeviceModel":{"type":"string","description":"Device model the simulated user will report."},"DeviceOperatingSystem":{"type":"string","description":"Device operating system the simulated user will report."},"DeviceType":{"type":"string","description":"Device type the simulated user will report."},"DeviceUserAgent":{"type":"string","description":"Device user agent the simulated user will report."},"OrganizationId":{"type":"string","description":"The WorkMail organization to simulate the access effect for.","required":true}}},"example":{"DeviceModel":"","DeviceOperatingSystem":"","DeviceType":"","DeviceUserAgent":"","OrganizationId":""}}}}}},"/GetMobileDeviceAccessOverride":{"post":{"tags":["Mobile Device Access"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_GetMobileDeviceAccessOverride.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"Get mobile device access override","description":"Gets the mobile device access override for the given WorkMail organization, user, and device.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"DeviceId":{"type":"string","description":"The mobile device to which the override applies. DeviceId is case insensitive.","required":true},"OrganizationId":{"type":"string","description":"The WorkMail organization to which you want to apply the override.","required":true},"UserId":{"type":"string","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","required":true}}},"example":{"DeviceId":"","OrganizationId":"","UserId":""}}}}}},"/GetPersonalAccessTokenMetadata":{"post":{"tags":["Personal Access Tokens"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_GetPersonalAccessTokenMetadata.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"Get personal access token metadata","description":"Requests details of a specific Personal Access Token within the WorkMail organization.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"OrganizationId":{"type":"string","description":"The Organization ID.","required":true},"PersonalAccessTokenId":{"type":"string","description":"The Personal Access Token ID.","required":true}}},"example":{"OrganizationId":"","PersonalAccessTokenId":""}}}}}},"/ListAccessControlRules":{"post":{"tags":["Access Control Rules"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_ListAccessControlRules.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"List access control rules","description":"Lists the access control rules for the specified organization.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"OrganizationId":{"type":"string","description":"The identifier for the organization.","required":true}}},"example":{"OrganizationId":""}}}}}},"/ListAliases":{"post":{"tags":["Aliases"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_ListAliases.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"List aliases","description":"Creates a paginated call to list the aliases associated with a given entity.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"EntityId":{"type":"string","description":"The identifier for the entity for which to list the aliases.","required":true},"MaxResults":{"type":"number","description":"The maximum number of results to return in a single call."},"NextToken":{"type":"string","description":"The token to use to retrieve the next page of results. The first call does not contain any tokens."},"OrganizationId":{"type":"string","description":"The identifier for the organization under which the entity exists.","required":true}}},"example":{"EntityId":"","MaxResults":"","NextToken":"","OrganizationId":""}}}}}},"/ListAvailabilityConfigurations":{"post":{"tags":["Availability Configurations"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_ListAvailabilityConfigurations.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"List availability configurations","description":"List all the AvailabilityConfiguration 's for the given WorkMail organization.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"MaxResults":{"type":"number","description":"The maximum number of results to return in a single call."},"NextToken":{"type":"string","description":"The token to use to retrieve the next page of results. The first call does not require a token."},"OrganizationId":{"type":"string","description":"The WorkMail organization for which the AvailabilityConfiguration 's will be listed.","required":true}}},"example":{"MaxResults":"","NextToken":"","OrganizationId":""}}}}}},"/ListGroupMembers":{"post":{"tags":["Groups"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_ListGroupMembers.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"List group members","description":"Returns an overview of the members of a group. Users and groups can be members of a group.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"GroupId":{"type":"string","description":"The identifier for the group to which the members (users or groups) are associated. The identifier can accept GroupId , Groupname , or email . The following identity formats are available: Group ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234 Email address…","required":true},"MaxResults":{"type":"number","description":"The maximum number of results to return in a single call."},"NextToken":{"type":"string","description":"The token to use to retrieve the next page of results. The first call does not contain any tokens."},"OrganizationId":{"type":"string","description":"The identifier for the organization under which the group exists.","required":true}}},"example":{"GroupId":"","MaxResults":"","NextToken":"","OrganizationId":""}}}}}},"/ListGroups":{"post":{"tags":["Groups"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_ListGroups.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"List groups","description":"Returns summaries of the organization's groups.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Filters":{"type":"object","description":"Limit the search results based on the filter criteria. Only one filter per request is supported.","properties":{}},"MaxResults":{"type":"number","description":"The maximum number of results to return in a single call."},"NextToken":{"type":"string","description":"The token to use to retrieve the next page of results. The first call does not contain any tokens."},"OrganizationId":{"type":"string","description":"The identifier for the organization under which the groups exist.","required":true}}},"example":{"Filters":{"NamePrefix":"string","PrimaryEmailPrefix":"string","State":"ENABLED"},"MaxResults":"","NextToken":"","OrganizationId":""}}}}}},"/ListGroupsForEntity":{"post":{"tags":["Groups"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_ListGroupsForEntity.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"List groups for entity","description":"Returns all the groups to which an entity belongs.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"EntityId":{"type":"string","description":"The identifier for the entity. The entity ID can accept UserId or GroupID , Username or Groupname , or email . Entity ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234 Email address: entity@domain.tld Entity name: entity","required":true},"Filters":{"type":"object","description":"Limit the search results based on the filter criteria.","properties":{}},"MaxResults":{"type":"number","description":"The maximum number of results to return in a single call."},"NextToken":{"type":"string","description":"The token to use to retrieve the next page of results. The first call does not contain any tokens."},"OrganizationId":{"type":"string","description":"The identifier for the organization under which the entity exists.","required":true}}},"example":{"EntityId":"","Filters":{"GroupNamePrefix":"string"},"MaxResults":"","NextToken":"","OrganizationId":""}}}}}},"/ListImpersonationRoles":{"post":{"tags":["Impersonation Roles"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_ListImpersonationRoles.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"List impersonation roles","description":"Lists all the impersonation roles for the given WorkMail organization.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"MaxResults":{"type":"number","description":"The maximum number of results returned in a single call."},"NextToken":{"type":"string","description":"The token used to retrieve the next page of results. The first call doesn't require a token."},"OrganizationId":{"type":"string","description":"The WorkMail organization to which the listed impersonation roles belong.","required":true}}},"example":{"MaxResults":"","NextToken":"","OrganizationId":""}}}}}},"/ListMailDomains":{"post":{"tags":["Mail Domains"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_ListMailDomains.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"List mail domains","description":"Lists the mail domains in a given WorkMail organization.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"MaxResults":{"type":"number","description":"The maximum number of results to return in a single call."},"NextToken":{"type":"string","description":"The token to use to retrieve the next page of results. The first call does not require a token."},"OrganizationId":{"type":"string","description":"The WorkMail organization for which to list domains.","required":true}}},"example":{"MaxResults":"","NextToken":"","OrganizationId":""}}}}}},"/ListMailboxExportJobs":{"post":{"tags":["Mailbox Export Jobs"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_ListMailboxExportJobs.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"List mailbox export jobs","description":"Lists the mailbox export jobs started for the specified organization within the last seven days.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"MaxResults":{"type":"number","description":"The maximum number of results to return in a single call."},"NextToken":{"type":"string","description":"The token to use to retrieve the next page of results."},"OrganizationId":{"type":"string","description":"The organization ID.","required":true}}},"example":{"MaxResults":"","NextToken":"","OrganizationId":""}}}}}},"/ListMailboxPermissions":{"post":{"tags":["Mailbox Permissions"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_ListMailboxPermissions.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"List mailbox permissions","description":"Lists the mailbox permissions associated with a user, group, or resource mailbox.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"EntityId":{"type":"string","description":"The identifier of the user, or resource for which to list mailbox permissions. The entity ID can accept UserId or ResourceId , Username or Resourcename , or email . Entity ID: 12345678-1234-1234-1234-123456789012, or r-0123456789a0123456789b0123456789 Email address: entity@domain.tld Entity name…","required":true},"MaxResults":{"type":"number","description":"The maximum number of results to return in a single call."},"NextToken":{"type":"string","description":"The token to use to retrieve the next page of results. The first call does not contain any tokens."},"OrganizationId":{"type":"string","description":"The identifier of the organization under which the user, group, or resource exists.","required":true}}},"example":{"EntityId":"","MaxResults":"","NextToken":"","OrganizationId":""}}}}}},"/ListMobileDeviceAccessOverrides":{"post":{"tags":["Mobile Device Access"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_ListMobileDeviceAccessOverrides.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"List mobile device access overrides","description":"Lists all the mobile device access overrides for any given combination of WorkMail organization, user, or device.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"DeviceId":{"type":"string","description":"The mobile device to which the access override applies."},"MaxResults":{"type":"number","description":"The maximum number of results to return in a single call."},"NextToken":{"type":"string","description":"The token to use to retrieve the next page of results. The first call does not require a token."},"OrganizationId":{"type":"string","description":"The WorkMail organization under which to list mobile device access overrides.","required":true},"UserId":{"type":"string","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"}}},"example":{"DeviceId":"","MaxResults":"","NextToken":"","OrganizationId":"","UserId":""}}}}}},"/ListMobileDeviceAccessRules":{"post":{"tags":["Mobile Device Access"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_ListMobileDeviceAccessRules.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"List mobile device access rules","description":"Lists the mobile device access rules for the specified WorkMail organization.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"OrganizationId":{"type":"string","description":"The WorkMail organization for which to list the rules.","required":true}}},"example":{"OrganizationId":""}}}}}},"/ListOrganizations":{"post":{"tags":["Organizations"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_ListOrganizations.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"List organizations","description":"Returns summaries of the customer's organizations.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"MaxResults":{"type":"number","description":"The maximum number of results to return in a single call."},"NextToken":{"type":"string","description":"The token to use to retrieve the next page of results. The first call does not contain any tokens."}}},"example":{"MaxResults":"","NextToken":""}}}}}},"/ListPersonalAccessTokens":{"post":{"tags":["Personal Access Tokens"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_ListPersonalAccessTokens.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"List personal access tokens","description":"Returns a summary of your Personal Access Tokens.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"MaxResults":{"type":"number","description":"The maximum amount of items that should be returned in a response."},"NextToken":{"type":"string","description":"The token from the previous response to query the next page."},"OrganizationId":{"type":"string","description":"The Organization ID.","required":true},"UserId":{"type":"string","description":"The WorkMail User ID."}}},"example":{"MaxResults":"","NextToken":"","OrganizationId":"","UserId":""}}}}}},"/ListResourceDelegates":{"post":{"tags":["Resources"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_ListResourceDelegates.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"List resource delegates","description":"Lists the delegates associated with a resource. Users and groups can be resource delegates and answer requests on behalf of the resource.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"MaxResults":{"type":"number","description":"The number of maximum results in a page."},"NextToken":{"type":"string","description":"The token used to paginate through the delegates associated with a resource."},"OrganizationId":{"type":"string","description":"The identifier for the organization that contains the resource for which delegates are listed.","required":true},"ResourceId":{"type":"string","description":"The identifier for the resource whose delegates are listed. The identifier can accept ResourceId , Resourcename , or email . The following identity formats are available: Resource ID: r-0123456789a0123456789b0123456789 Email address: resource@domain.tld Resource name: resource","required":true}}},"example":{"MaxResults":"","NextToken":"","OrganizationId":"","ResourceId":""}}}}}},"/ListResources":{"post":{"tags":["Resources"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_ListResources.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"List resources","description":"Returns summaries of the organization's resources.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Filters":{"type":"object","description":"Limit the resource search results based on the filter criteria. You can only use one filter per request.","properties":{}},"MaxResults":{"type":"number","description":"The maximum number of results to return in a single call."},"NextToken":{"type":"string","description":"The token to use to retrieve the next page of results. The first call does not contain any tokens."},"OrganizationId":{"type":"string","description":"The identifier for the organization under which the resources exist.","required":true}}},"example":{"Filters":{"NamePrefix":"string","PrimaryEmailPrefix":"string","State":"ENABLED"},"MaxResults":"","NextToken":"","OrganizationId":""}}}}}},"/ListTagsForResource":{"post":{"tags":["Tags"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_ListTagsForResource.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"List tags for resource","description":"Lists the tags applied to an WorkMail organization resource.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ResourceARN":{"type":"string","description":"The resource ARN.","required":true}}},"example":{"ResourceARN":""}}}}}},"/ListUsers":{"post":{"tags":["Users"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_ListUsers.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"List users","description":"Returns summaries of the organization's users.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Filters":{"type":"object","description":"Limit the user search results based on the filter criteria. You can only use one filter per request.","properties":{}},"MaxResults":{"type":"number","description":"The maximum number of results to return in a single call."},"NextToken":{"type":"string","description":"The token to use to retrieve the next page of results. The first call does not contain any tokens."},"OrganizationId":{"type":"string","description":"The identifier for the organization under which the users exist.","required":true}}},"example":{"Filters":{"DisplayNamePrefix":"string","PrimaryEmailPrefix":"string","State":"ENABLED","UsernamePrefix":"string"},"MaxResults":"","NextToken":"","OrganizationId":""}}}}}},"/PutAccessControlRule":{"post":{"tags":["Access Control Rules"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_PutAccessControlRule.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"Put access control rule","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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Actions":{"type":"array","description":"Access protocol actions to include in the rule. Valid values include ActiveSync , AutoDiscover , EWS , IMAP , SMTP , WindowsOutlook , and WebMail .","items":{"type":"string"}},"Description":{"type":"string","description":"The rule description.","required":true},"Effect":{"type":"enum","description":"The rule effect.","required":true,"enum":["ALLOW","DENY"]},"ImpersonationRoleIds":{"type":"array","description":"Impersonation role IDs to include in the rule.","items":{"type":"string"}},"IpRanges":{"type":"array","description":"IPv4 CIDR ranges to include in the rule.","items":{"type":"string"}},"Name":{"type":"string","description":"The rule name.","required":true},"NotActions":{"type":"array","description":"Access protocol actions to exclude from the rule. Valid values include ActiveSync , AutoDiscover , EWS , IMAP , SMTP , WindowsOutlook , and WebMail .","items":{"type":"string"}},"NotImpersonationRoleIds":{"type":"array","description":"Impersonation role IDs to exclude from the rule.","items":{"type":"string"}},"NotIpRanges":{"type":"array","description":"IPv4 CIDR ranges to exclude from the rule.","items":{"type":"string"}},"NotUserIds":{"type":"array","description":"User IDs to exclude from the rule.","items":{"type":"string"}},"OrganizationId":{"type":"string","description":"The identifier of the organization.","required":true},"UserIds":{"type":"array","description":"User IDs to include in the rule.","items":{"type":"string"}}}},"example":{"Actions":[],"Description":"","Effect":"","ImpersonationRoleIds":[],"IpRanges":[],"Name":"","NotActions":[],"NotImpersonationRoleIds":[],"NotIpRanges":[],"NotUserIds":[],"OrganizationId":"","UserIds":[]}}}}}},"/PutEmailMonitoringConfiguration":{"post":{"tags":["Email Monitoring Configuration"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_PutEmailMonitoringConfiguration.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"Put email monitoring configuration","description":"Creates or updates the email monitoring configuration for a specified organization.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"LogGroupArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the CloudWatch Log group associated with the email monitoring configuration.","required":true},"OrganizationId":{"type":"string","description":"The ID of the organization for which the email monitoring configuration is set.","required":true},"RoleArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the IAM Role associated with the email monitoring configuration. If absent, the IAM Role Arn of AWSServiceRoleForAmazonWorkMailEvents will be used."}}},"example":{"LogGroupArn":"","OrganizationId":"","RoleArn":""}}}}}},"/PutIdentityProviderConfiguration":{"post":{"tags":["Identity Provider Configuration"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_PutIdentityProviderConfiguration.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"Put identity provider configuration","description":"Enables integration between IAM Identity Center (IdC) and WorkMail to proxy authentication requests for mailbox users. You can connect your IdC directory or your external directory to WorkMail through IdC and manage access to WorkMail mailboxes in a single place. For enhanced protection, you could enable Multifactor Authentication (MFA) and…","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"AuthenticationMode":{"type":"enum","description":"The authentication mode used in WorkMail.","required":true,"enum":["IDENTITY_PROVIDER_ONLY","IDENTITY_PROVIDER_AND_DIRECTORY"]},"IdentityCenterConfiguration":{"type":"object","description":"The details of the IAM Identity Center configuration.","required":true,"properties":{}},"OrganizationId":{"type":"string","description":"The ID of the WorkMail Organization.","required":true},"PersonalAccessTokenConfiguration":{"type":"object","description":"The details of the Personal Access Token configuration.","required":true,"properties":{}}}},"example":{"AuthenticationMode":"","IdentityCenterConfiguration":{"ApplicationArn":"string","InstanceArn":"string"},"OrganizationId":"","PersonalAccessTokenConfiguration":{"Status":"ACTIVE"}}}}}}},"/PutInboundDmarcSettings":{"post":{"tags":["Inbound Dmarc Settings"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_PutInboundDmarcSettings.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"Put inbound dmarc settings","description":"Enables or disables a DMARC policy for a given organization.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Enforced":{"type":"boolean","description":"Enforces or suspends a policy after it's applied.","required":true},"OrganizationId":{"type":"string","description":"The ID of the organization that you are applying the DMARC policy to.","required":true}}},"example":{"Enforced":"","OrganizationId":""}}}}}},"/PutMailboxPermissions":{"post":{"tags":["Mailbox Permissions"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_PutMailboxPermissions.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"Put mailbox permissions","description":"Sets permissions for a user, group, or resource. This replaces any pre-existing permissions.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"EntityId":{"type":"string","description":"The identifier of the user or resource for which to update mailbox permissions. The identifier can be UserId, ResourceID, or Group Id , Username, Resourcename, or Groupname , or email . Entity ID: 12345678-1234-1234-1234-123456789012, r-0123456789a0123456789b0123456789, or…","required":true},"GranteeId":{"type":"string","description":"The identifier of the user, group, or resource to which to grant the permissions. The identifier can be UserId, ResourceID, or Group Id , Username, Resourcename, or Groupname , or email . Grantee ID: 12345678-1234-1234-1234-123456789012, r-0123456789a0123456789b0123456789, or…","required":true},"OrganizationId":{"type":"string","description":"The identifier of the organization under which the user, group, or resource exists.","required":true},"PermissionValues":{"type":"array","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…","required":true,"items":{"type":"string"}}}},"example":{"EntityId":"","GranteeId":"","OrganizationId":"","PermissionValues":[]}}}}}},"/PutMobileDeviceAccessOverride":{"post":{"tags":["Mobile Device Access"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_PutMobileDeviceAccessOverride.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"Put mobile device access override","description":"Creates or updates a mobile device access override for the given WorkMail organization, user, and device.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Description":{"type":"string","description":"A description of the override."},"DeviceId":{"type":"string","description":"The mobile device for which you create the override. DeviceId is case insensitive.","required":true},"Effect":{"type":"enum","description":"The effect of the override, ALLOW or DENY .","required":true,"enum":["ALLOW","DENY"]},"OrganizationId":{"type":"string","description":"Identifies the WorkMail organization for which you create the override.","required":true},"UserId":{"type":"string","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","required":true}}},"example":{"Description":"","DeviceId":"","Effect":"","OrganizationId":"","UserId":""}}}}}},"/PutRetentionPolicy":{"post":{"tags":["Retention Policies"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_PutRetentionPolicy.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"Put retention policy","description":"Puts a retention policy to the specified organization.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Description":{"type":"string","description":"The retention policy description."},"FolderConfigurations":{"type":"array","description":"The retention policy folder configurations.","required":true,"items":{"type":"object","properties":{"Action":{"type":"string","description":"The action to take on the folder contents at the end of the folder configuration period.","required":true,"enum":["NONE","DELETE","PERMANENTLY_DELETE"]},"Name":{"type":"string","description":"The folder name.","required":true,"enum":["INBOX","DELETED_ITEMS","SENT_ITEMS","DRAFTS","JUNK_EMAIL"]},"Period":{"type":"number","description":"The number of days for which the folder-configuration action applies."}}}},"Id":{"type":"string","description":"The retention policy ID."},"Name":{"type":"string","description":"The retention policy name.","required":true},"OrganizationId":{"type":"string","description":"The organization ID.","required":true}}},"example":{"Description":"","FolderConfigurations":[],"Id":"","Name":"","OrganizationId":""}}}}}},"/RegisterMailDomain":{"post":{"tags":["Mail Domains"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_RegisterMailDomain.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"Register mail domain","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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ClientToken":{"type":"string","description":"Idempotency token used when retrying requests."},"DomainName":{"type":"string","description":"The name of the mail domain to create in WorkMail and SES.","required":true},"OrganizationId":{"type":"string","description":"The WorkMail organization under which you're creating the domain.","required":true}}},"example":{"ClientToken":"","DomainName":"","OrganizationId":""}}}}}},"/RegisterToWorkMail":{"post":{"tags":["Users"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_RegisterToWorkMail.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"Register to work mail","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…","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Email":{"type":"string","description":"The email for the user, group, or resource to be updated.","required":true},"EntityId":{"type":"string","description":"The identifier for the user, group, or resource to be updated. The identifier can accept UserId, ResourceId, or GroupId , or Username, Resourcename, or Groupname . The following identity formats are available: Entity ID: 12345678-1234-1234-1234-123456789012, r-0123456789a0123456789b0123456789, or…","required":true},"OrganizationId":{"type":"string","description":"The identifier for the organization under which the user, group, or resource exists.","required":true}}},"example":{"Email":"","EntityId":"","OrganizationId":""}}}}}},"/ResetPassword":{"post":{"tags":["Users"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_ResetPassword.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"Reset password","description":"Allows the administrator to reset the password for a user.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"OrganizationId":{"type":"string","description":"The identifier of the organization that contains the user for which the password is reset.","required":true},"Password":{"type":"string","description":"The new password for the user.","required":true},"UserId":{"type":"string","description":"The identifier of the user for whom the password is reset.","required":true}}},"example":{"OrganizationId":"","Password":"","UserId":""}}}}}},"/StartMailboxExportJob":{"post":{"tags":["Mailbox Export Jobs"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_StartMailboxExportJob.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"Start mailbox export job","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 .","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ClientToken":{"type":"string","description":"The idempotency token for the client request.","required":true},"Description":{"type":"string","description":"The mailbox export job description."},"EntityId":{"type":"string","description":"The identifier of the user or resource associated with the mailbox. The identifier can accept UserId or ResourceId , Username or Resourcename , or email . The following identity formats are available: Entity ID: 12345678-1234-1234-1234-123456789012, r-0123456789a0123456789b0123456789 , or…","required":true},"KmsKeyArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the symmetric AWS Key Management Service (AWS KMS) key that encrypts the exported mailbox content.","required":true},"OrganizationId":{"type":"string","description":"The identifier associated with the organization.","required":true},"RoleArn":{"type":"string","description":"The ARN of the AWS Identity and Access Management (IAM) role that grants write permission to the S3 bucket.","required":true},"S3BucketName":{"type":"string","description":"The name of the S3 bucket.","required":true},"S3Prefix":{"type":"string","description":"The S3 bucket prefix.","required":true}}},"example":{"ClientToken":"","Description":"","EntityId":"","KmsKeyArn":"","OrganizationId":"","RoleArn":"","S3BucketName":"","S3Prefix":""}}}}}},"/TagResource":{"post":{"tags":["Tags"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_TagResource.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"Tag resource","description":"Applies the specified tags to the specified WorkMailorganization resource.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ResourceARN":{"type":"string","description":"The resource ARN.","required":true},"Tags":{"type":"array","description":"The tag key-value pairs.","required":true,"items":{"type":"object","properties":{"Key":{"type":"string","description":"The key of the tag.","required":true},"Value":{"type":"string","description":"The value of the tag.","required":true}}}}}},"example":{"ResourceARN":"","Tags":[]}}}}}},"/TestAvailabilityConfiguration":{"post":{"tags":["Availability Configurations"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_TestAvailabilityConfiguration.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"Test availability configuration","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…","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"DomainName":{"type":"string","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":{"type":"object","description":"Ews provider","properties":{}},"LambdaProvider":{"type":"object","description":"Lambda provider","properties":{}},"OrganizationId":{"type":"string","description":"The WorkMail organization where the availability provider will be tested.","required":true}}},"example":{"DomainName":"","EwsProvider":{"EwsEndpoint":"string","EwsPassword":"string","EwsUsername":"string"},"LambdaProvider":{"LambdaArn":"string"},"OrganizationId":""}}}}}},"/UntagResource":{"post":{"tags":["Tags"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_UntagResource.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"Untag resource","description":"Untags the specified tags from the specified WorkMail organization resource.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ResourceARN":{"type":"string","description":"The resource ARN.","required":true},"TagKeys":{"type":"array","description":"The tag keys.","required":true,"items":{"type":"string"}}}},"example":{"ResourceARN":"","TagKeys":[]}}}}}},"/UpdateAvailabilityConfiguration":{"post":{"tags":["Availability Configurations"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_UpdateAvailabilityConfiguration.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"Update availability configuration","description":"Updates an existing AvailabilityConfiguration for the given WorkMail organization and domain.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"DomainName":{"type":"string","description":"The domain to which the provider applies the availability configuration.","required":true},"EwsProvider":{"type":"object","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.","properties":{}},"LambdaProvider":{"type":"object","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.","properties":{}},"OrganizationId":{"type":"string","description":"The WorkMail organization for which the AvailabilityConfiguration will be updated.","required":true}}},"example":{"DomainName":"","EwsProvider":{"EwsEndpoint":"string","EwsPassword":"string","EwsUsername":"string"},"LambdaProvider":{"LambdaArn":"string"},"OrganizationId":""}}}}}},"/UpdateDefaultMailDomain":{"post":{"tags":["Mail Domains"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_UpdateDefaultMailDomain.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"Update default mail domain","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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"DomainName":{"type":"string","description":"The domain name that will become the default domain.","required":true},"OrganizationId":{"type":"string","description":"The WorkMail organization for which to list domains.","required":true}}},"example":{"DomainName":"","OrganizationId":""}}}}}},"/UpdateGroup":{"post":{"tags":["Groups"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_UpdateGroup.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"Update group","description":"Updates attributes in a group.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"GroupId":{"type":"string","description":"The identifier for the group to be updated. The identifier can accept GroupId , Groupname , or email . The following identity formats are available: Group ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234 Email address: group@domain.tld Group name: group","required":true},"HiddenFromGlobalAddressList":{"type":"boolean","description":"If enabled, the group is hidden from the global address list."},"OrganizationId":{"type":"string","description":"The identifier for the organization under which the group exists.","required":true}}},"example":{"GroupId":"","HiddenFromGlobalAddressList":"","OrganizationId":""}}}}}},"/UpdateImpersonationRole":{"post":{"tags":["Impersonation Roles"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_UpdateImpersonationRole.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"Update impersonation role","description":"Updates an impersonation role for the given WorkMail organization.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Description":{"type":"string","description":"The updated impersonation role description."},"ImpersonationRoleId":{"type":"string","description":"The ID of the impersonation role to update.","required":true},"Name":{"type":"string","description":"The updated impersonation role name.","required":true},"OrganizationId":{"type":"string","description":"The WorkMail organization that contains the impersonation role to update.","required":true},"Rules":{"type":"array","description":"The updated list of rules.","required":true,"items":{"type":"object","properties":{"Description":{"type":"string","description":"The rule description."},"Effect":{"type":"string","description":"The effect of the rule when it matches the input. Allowed effect values are ALLOW or DENY .","required":true,"enum":["ALLOW","DENY"]},"ImpersonationRuleId":{"type":"string","description":"The identifier of the rule.","required":true},"Name":{"type":"string","description":"The rule name."},"NotTargetUsers":{"type":"array","description":"A list of user IDs that don't match the rule."},"TargetUsers":{"type":"array","description":"A list of user IDs that match the rule."}}}},"Type":{"type":"enum","description":"The updated impersonation role type.","required":true,"enum":["FULL_ACCESS","READ_ONLY"]}}},"example":{"Description":"","ImpersonationRoleId":"","Name":"","OrganizationId":"","Rules":[],"Type":""}}}}}},"/UpdateMailboxQuota":{"post":{"tags":["Mailboxes"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_UpdateMailboxQuota.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"Update mailbox quota","description":"Updates a user's current mailbox quota for a specified organization and user.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"MailboxQuota":{"type":"number","description":"The updated mailbox quota, in MB, for the specified user.","required":true},"OrganizationId":{"type":"string","description":"The identifier for the organization that contains the user for whom to update the mailbox quota.","required":true},"UserId":{"type":"string","description":"The identifer for the user for whom to update the mailbox quota. The identifier can be the UserId , Username , or email . 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…","required":true}}},"example":{"MailboxQuota":"","OrganizationId":"","UserId":""}}}}}},"/UpdateMobileDeviceAccessRule":{"post":{"tags":["Mobile Device Access"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_UpdateMobileDeviceAccessRule.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"Update mobile device access rule","description":"Updates a mobile device access rule for the specified WorkMail organization.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Description":{"type":"string","description":"The updated rule description."},"DeviceModels":{"type":"array","description":"Device models that the updated rule will match.","items":{"type":"string"}},"DeviceOperatingSystems":{"type":"array","description":"Device operating systems that the updated rule will match.","items":{"type":"string"}},"DeviceTypes":{"type":"array","description":"Device types that the updated rule will match.","items":{"type":"string"}},"DeviceUserAgents":{"type":"array","description":"User agents that the updated rule will match.","items":{"type":"string"}},"Effect":{"type":"enum","description":"The effect of the rule when it matches. Allowed values are ALLOW or DENY .","required":true,"enum":["ALLOW","DENY"]},"MobileDeviceAccessRuleId":{"type":"string","description":"The identifier of the rule to be updated.","required":true},"Name":{"type":"string","description":"The updated rule name.","required":true},"NotDeviceModels":{"type":"array","description":"Device models that the updated rule will not match. All other device models will match.","items":{"type":"string"}},"NotDeviceOperatingSystems":{"type":"array","description":"Device operating systems that the updated rule will not match. All other device operating systems will match.","items":{"type":"string"}},"NotDeviceTypes":{"type":"array","description":"Device types that the updated rule will not match. All other device types will match.","items":{"type":"string"}},"NotDeviceUserAgents":{"type":"array","description":"User agents that the updated rule will not match. All other user agents will match.","items":{"type":"string"}},"OrganizationId":{"type":"string","description":"The WorkMail organization under which the rule will be updated.","required":true}}},"example":{"Description":"","DeviceModels":[],"DeviceOperatingSystems":[],"DeviceTypes":[],"DeviceUserAgents":[],"Effect":"","MobileDeviceAccessRuleId":"","Name":"","NotDeviceModels":[],"NotDeviceOperatingSystems":[],"NotDeviceTypes":[],"NotDeviceUserAgents":[],"OrganizationId":""}}}}}},"/UpdatePrimaryEmailAddress":{"post":{"tags":["Users"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_UpdatePrimaryEmailAddress.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"Update primary email address","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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Email":{"type":"string","description":"The value of the email to be updated as primary.","required":true},"EntityId":{"type":"string","description":"The user, group, or resource to update. The identifier can accept UseriD, ResourceId, or GroupId , Username, Resourcename, or Groupname , or email . The following identity formats are available: Entity ID: 12345678-1234-1234-1234-123456789012, r-0123456789a0123456789b0123456789, or…","required":true},"OrganizationId":{"type":"string","description":"The organization that contains the user, group, or resource to update.","required":true}}},"example":{"Email":"","EntityId":"","OrganizationId":""}}}}}},"/UpdateResource":{"post":{"tags":["Resources"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_UpdateResource.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"Update resource","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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"BookingOptions":{"type":"object","description":"The resource's booking options to be updated.","properties":{}},"Description":{"type":"string","description":"Updates the resource description."},"HiddenFromGlobalAddressList":{"type":"boolean","description":"If enabled, the resource is hidden from the global address list."},"Name":{"type":"string","description":"The name of the resource to be updated."},"OrganizationId":{"type":"string","description":"The identifier associated with the organization for which the resource is updated.","required":true},"ResourceId":{"type":"string","description":"The identifier of the resource to be updated. The identifier can accept ResourceId , Resourcename , or email . The following identity formats are available: Resource ID: r-0123456789a0123456789b0123456789 Email address: resource@domain.tld Resource name: resource","required":true},"Type":{"type":"enum","description":"Updates the resource type.","enum":["ROOM","EQUIPMENT"]}}},"example":{"BookingOptions":{"AutoAcceptRequests":true,"AutoDeclineConflictingRequests":true,"AutoDeclineRecurringRequests":true},"Description":"","HiddenFromGlobalAddressList":"","Name":"","OrganizationId":"","ResourceId":"","Type":""}}}}}},"/UpdateUser":{"post":{"tags":["Users"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.aws.amazon.com/workmail/latest/APIReference/API_UpdateUser.html","api_endpoint":"https://workmail.{region}.amazonaws.com/"},"summary":"Update user","description":"Updates data for the user. To have the latest information, it must be preceded by a DescribeUser call. The dataset in the request should be the one expected when performing another DescribeUser call.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"City":{"type":"string","description":"Updates the user's city."},"Company":{"type":"string","description":"Updates the user's company."},"Country":{"type":"string","description":"Updates the user's country."},"Department":{"type":"string","description":"Updates the user's department."},"DisplayName":{"type":"string","description":"Updates the display name of the user."},"FirstName":{"type":"string","description":"Updates the user's first name."},"HiddenFromGlobalAddressList":{"type":"boolean","description":"If enabled, the user is hidden from the global address list."},"IdentityProviderUserId":{"type":"string","description":"User ID from the IAM Identity Center. If this parameter is empty it will be updated automatically when the user logs in for the first time to the mailbox associated with WorkMail."},"Initials":{"type":"string","description":"Updates the user's initials."},"JobTitle":{"type":"string","description":"Updates the user's job title."},"LastName":{"type":"string","description":"Updates the user's last name."},"Office":{"type":"string","description":"Updates the user's office."},"OrganizationId":{"type":"string","description":"The identifier for the organization under which the user exists.","required":true},"Role":{"type":"enum","description":"Updates the user role. You cannot pass SYSTEM_USER or RESOURCE .","enum":["USER","RESOURCE","SYSTEM_USER","REMOTE_USER"]},"Street":{"type":"string","description":"Updates the user's street address."},"Telephone":{"type":"string","description":"Updates the user's contact details."},"UserId":{"type":"string","description":"The identifier for the user to be updated. The identifier can be the UserId , Username , or email . 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","required":true},"ZipCode":{"type":"string","description":"Updates the user's zip code."}}},"example":{"City":"","Company":"","Country":"","Department":"","DisplayName":"","FirstName":"","HiddenFromGlobalAddressList":"","IdentityProviderUserId":"","Initials":"","JobTitle":"","LastName":"","Office":"","OrganizationId":"","Role":"","Street":"","Telephone":"","UserId":"","ZipCode":""}}}}}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"security":[{"bearerAuth":[]}]}