id
stringlengths 8
78
| source
stringclasses 743
values | chunk_id
int64 1
5.05k
| text
stringlengths 593
49.7k
|
|---|---|---|---|
workmail-api-004 | workmail-api.pdf | 4 | AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 AssociateMemberToGroup 16 Amazon WorkMail API Reference AssumeImpersonationRole Service: Amazon WorkMail Assumes an impersonation role for the given WorkMail organization. This method returns an authentication token you can use to make impersonated calls. Request Syntax { "ImpersonationRoleId": "string", "OrganizationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ImpersonationRoleId The impersonation role ID to assume. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [a-zA-Z0-9_-]+ Required: Yes OrganizationId The WorkMail organization under which the impersonation role will be assumed. Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes AssumeImpersonationRole 17 API Reference Amazon WorkMail Response Syntax { "ExpiresIn": number, "Token": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ExpiresIn The authentication token's validity, in seconds. Type: Long Token The authentication token for the impersonation role. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [\x21-\x7e]+ Errors For information about the errors that are common to all actions, see Common Errors. InvalidParameterException One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. AssumeImpersonationRole 18 Amazon WorkMail HTTP Status Code: 400 OrganizationStateException API Reference The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 ResourceNotFoundException The resource cannot be found. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 AssumeImpersonationRole 19 Amazon WorkMail API Reference CancelMailboxExportJob Service: Amazon WorkMail Cancels a mailbox export job. Note If the mailbox export job is near completion, it might not be possible to cancel it. Request Syntax { "ClientToken": "string", "JobId": "string", "OrganizationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ClientToken The idempotency token for the client request. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [\x21-\x7e]+ Required: Yes JobId The job ID. Type: String CancelMailboxExportJob 20 Amazon WorkMail API Reference Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: [A-Za-z0-9-]+ Required: Yes OrganizationId The organization ID. Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization. HTTP Status Code: 400 InvalidParameterException One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 CancelMailboxExportJob 21 Amazon WorkMail OrganizationStateException API Reference The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 CancelMailboxExportJob 22 Amazon WorkMail CreateAlias Service: Amazon WorkMail Adds an alias to the set of a given member (user or group) of WorkMail. API Reference Request Syntax { "Alias": "string", "EntityId": "string", "OrganizationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Alias The alias to add to the member set. Type: |
workmail-api-005 | workmail-api.pdf | 5 | Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 CancelMailboxExportJob 22 Amazon WorkMail CreateAlias Service: Amazon WorkMail Adds an alias to the set of a given member (user or group) of WorkMail. API Reference Request Syntax { "Alias": "string", "EntityId": "string", "OrganizationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Alias The alias to add to the member set. Type: String Length Constraints: Minimum length of 1. Maximum length of 254. Pattern: [a-zA-Z0-9._%+-]{1,64}@[a-zA-Z0-9.-]+\.[a-zA-Z-]{2,} Required: Yes EntityId The member (user or group) to which this alias is added. Type: String Length Constraints: Minimum length of 12. Maximum length of 256. Required: Yes OrganizationId The organization under which the member (user or group) exists. CreateAlias 23 Amazon WorkMail Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. EmailAddressInUseException The email address that you're trying to assign is already created for a different user, group, or resource. HTTP Status Code: 400 EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization. HTTP Status Code: 400 EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user. HTTP Status Code: 400 InvalidParameterException One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 LimitExceededException The request exceeds the limit of the resource. CreateAlias 24 Amazon WorkMail HTTP Status Code: 400 MailDomainNotFoundException The domain specified is not found in your organization. HTTP Status Code: 400 MailDomainStateException API Reference After a domain has been added to the organization, it must be verified. The domain is not yet verified. HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin CreateAlias 25 Amazon WorkMail • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference CreateAlias 26 Amazon WorkMail API Reference CreateAvailabilityConfiguration Service: Amazon WorkMail Creates an AvailabilityConfiguration for the given WorkMail organization and domain. Request Syntax { "ClientToken": "string", "DomainName": "string", "EwsProvider": { "EwsEndpoint": "string", "EwsPassword": "string", "EwsUsername": "string" }, "LambdaProvider": { "LambdaArn": "string" }, "OrganizationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ClientToken An idempotent token that ensures that an API request is executed only once. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [\x21-\x7e]+ Required: No DomainName The domain to which the provider applies. CreateAvailabilityConfiguration 27 Amazon WorkMail Type: String API Reference Length Constraints: Minimum length of 3. Maximum length of 255. Pattern: [a-zA-Z0-9.-]+ Required: Yes EwsProvider Exchange Web Services (EWS) availability provider definition. The request must contain exactly one provider definition, either EwsProvider or LambdaProvider. Type: EwsAvailabilityProvider object Required: No LambdaProvider Lambda availability provider definition. The request must contain exactly one provider definition, either EwsProvider or LambdaProvider. Type: LambdaAvailabilityProvider object Required: No OrganizationId The WorkMail organization for which the AvailabilityConfiguration will be created. Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. CreateAvailabilityConfiguration 28 Amazon WorkMail InvalidParameterException API Reference One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 LimitExceededException The request exceeds the limit of the resource. HTTP Status Code: 400 NameAvailabilityException The user, group, or resource name isn't unique in WorkMail. HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members. HTTP |
workmail-api-006 | workmail-api.pdf | 6 | that are common to all actions, see Common Errors. CreateAvailabilityConfiguration 28 Amazon WorkMail InvalidParameterException API Reference One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 LimitExceededException The request exceeds the limit of the resource. HTTP Status Code: 400 NameAvailabilityException The user, group, or resource name isn't unique in WorkMail. HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 CreateAvailabilityConfiguration 29 Amazon WorkMail • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference CreateAvailabilityConfiguration 30 Amazon WorkMail CreateGroup Service: Amazon WorkMail API Reference Creates a group that can be used in WorkMail by calling the RegisterToWorkMail operation. Request Syntax { "HiddenFromGlobalAddressList": boolean, "Name": "string", "OrganizationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. HiddenFromGlobalAddressList If this parameter is enabled, the group will be hidden from the address book. Type: Boolean Required: No Name The name of the group. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [\u0020-\u00FF]+ Required: Yes OrganizationId The organization under which the group is to be created. Type: String CreateGroup 31 Amazon WorkMail API Reference Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes Response Syntax { "GroupId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. GroupId The identifier of the group. Type: String Length Constraints: Minimum length of 12. Maximum length of 256. Errors For information about the errors that are common to all actions, see Common Errors. DirectoryServiceAuthenticationFailedException The directory service doesn't recognize the credentials supplied by WorkMail. HTTP Status Code: 400 DirectoryUnavailableException The directory is unavailable. It might be located in another Region or deleted. HTTP Status Code: 400 CreateGroup 32 Amazon WorkMail InvalidParameterException API Reference One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 NameAvailabilityException The user, group, or resource name isn't unique in WorkMail. HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 ReservedNameException This user, group, or resource name is not allowed in WorkMail. HTTP Status Code: 400 UnsupportedOperationException You can't perform a write operation against a read-only directory. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET CreateGroup 33 API Reference Amazon WorkMail • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 CreateGroup 34 Amazon WorkMail API Reference CreateIdentityCenterApplication Service: Amazon WorkMail 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. Request Syntax { "ClientToken": "string", "InstanceArn": "string", "Name": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ClientToken The idempotency token associated with the request. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [\x21-\x7e]+ Required: No InstanceArn The Amazon Resource Name (ARN) of the instance. Type: String Length Constraints: Minimum length of 10. Maximum length of 1124. Pattern: ^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/ (sso)?ins-[a-zA-Z0-9-.]{16}$ CreateIdentityCenterApplication 35 Amazon WorkMail Required: Yes Name API Reference The name of the IAM Identity Center application. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. Pattern: ^[\w+=,.@-]+$ Required: Yes Response Syntax { "ApplicationArn": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ApplicationArn The Amazon Resource |
workmail-api-007 | workmail-api.pdf | 7 | length of 128. Pattern: [\x21-\x7e]+ Required: No InstanceArn The Amazon Resource Name (ARN) of the instance. Type: String Length Constraints: Minimum length of 10. Maximum length of 1124. Pattern: ^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/ (sso)?ins-[a-zA-Z0-9-.]{16}$ CreateIdentityCenterApplication 35 Amazon WorkMail Required: Yes Name API Reference The name of the IAM Identity Center application. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. Pattern: ^[\w+=,.@-]+$ Required: Yes Response Syntax { "ApplicationArn": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ApplicationArn The Amazon Resource Name (ARN) of the application. Type: String Length Constraints: Minimum length of 10. Maximum length of 1224. Pattern: ^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:: \d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}$ Errors For information about the errors that are common to all actions, see Common Errors. CreateIdentityCenterApplication 36 Amazon WorkMail InvalidParameterException API Reference One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 CreateIdentityCenterApplication 37 Amazon WorkMail API Reference CreateImpersonationRole Service: Amazon WorkMail 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. Request Syntax { "ClientToken": "string", "Description": "string", "Name": "string", "OrganizationId": "string", "Rules": [ { "Description": "string", "Effect": "string", "ImpersonationRuleId": "string", "Name": "string", "NotTargetUsers": [ "string" ], "TargetUsers": [ "string" ] } ], "Type": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ClientToken The idempotency token for the client request. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. CreateImpersonationRole 38 API Reference Amazon WorkMail Pattern: [\x21-\x7e]+ Required: No Description The description of the new impersonation role. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [^\x00-\x09\x0B\x0C\x0E-\x1F\x7F\x3C\x3E\x5C]+ Required: No Name The name of the new impersonation role. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [^\x00-\x1F\x7F\x3C\x3E\x5C]+ Required: Yes OrganizationId The WorkMail organization to create the new impersonation role within. Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes Rules The list of rules for the impersonation role. Type: Array of ImpersonationRule objects Array Members: Minimum number of 0 items. Maximum number of 10 items. CreateImpersonationRole 39 Amazon WorkMail Required: Yes Type API Reference The impersonation role's type. The available impersonation role types are READ_ONLY or FULL_ACCESS. Type: String Valid Values: FULL_ACCESS | READ_ONLY Required: Yes Response Syntax { "ImpersonationRoleId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ImpersonationRoleId The new impersonation role ID. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [a-zA-Z0-9_-]+ Errors For information about the errors that are common to all actions, see Common Errors. EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization. CreateImpersonationRole 40 Amazon WorkMail HTTP Status Code: 400 EntityStateException API Reference You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user. HTTP Status Code: 400 InvalidParameterException One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 LimitExceededException The request exceeds the limit of the resource. HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 CreateImpersonationRole 41 Amazon WorkMail • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference CreateImpersonationRole 42 Amazon WorkMail API Reference CreateMobileDeviceAccessRule Service: Amazon WorkMail Creates a new mobile device access rule for the specified WorkMail organization. |
workmail-api-008 | workmail-api.pdf | 8 | For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 CreateImpersonationRole 41 Amazon WorkMail • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference CreateImpersonationRole 42 Amazon WorkMail API Reference CreateMobileDeviceAccessRule Service: Amazon WorkMail Creates a new mobile device access rule for the specified WorkMail organization. Request Syntax { "ClientToken": "string", "Description": "string", "DeviceModels": [ "string" ], "DeviceOperatingSystems": [ "string" ], "DeviceTypes": [ "string" ], "DeviceUserAgents": [ "string" ], "Effect": "string", "Name": "string", "NotDeviceModels": [ "string" ], "NotDeviceOperatingSystems": [ "string" ], "NotDeviceTypes": [ "string" ], "NotDeviceUserAgents": [ "string" ], "OrganizationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ClientToken The idempotency token for the client request. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [\x21-\x7e]+ Required: No Description The rule description. CreateMobileDeviceAccessRule 43 Amazon WorkMail Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [\S\s]+ Required: No DeviceModels Device models that the rule will match. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 10 items. Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [\u0020-\u00FF]+ Required: No DeviceOperatingSystems Device operating systems that the rule will match. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 10 items. Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [\u0020-\u00FF]+ Required: No DeviceTypes Device types that the rule will match. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 10 items. Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [\u0020-\u00FF]+ CreateMobileDeviceAccessRule 44 API Reference Amazon WorkMail Required: No DeviceUserAgents Device user agents that the rule will match. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 10 items. Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [\u0020-\u00FF]+ Required: No Effect The effect of the rule when it matches. Allowed values are ALLOW or DENY. Type: String Valid Values: ALLOW | DENY Required: Yes Name The rule name. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [\S\s]+ Required: Yes NotDeviceModels Device models that the rule will not match. All other device models will match. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 10 items. Length Constraints: Minimum length of 1. Maximum length of 256. CreateMobileDeviceAccessRule 45 Amazon WorkMail API Reference Pattern: [\u0020-\u00FF]+ Required: No NotDeviceOperatingSystems Device operating systems that the rule will not match. All other device operating systems will match. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 10 items. Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [\u0020-\u00FF]+ Required: No NotDeviceTypes Device types that the rule will not match. All other device types will match. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 10 items. Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [\u0020-\u00FF]+ Required: No NotDeviceUserAgents Device user agents that the rule will not match. All other device user agents will match. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 10 items. Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [\u0020-\u00FF]+ Required: No CreateMobileDeviceAccessRule 46 Amazon WorkMail OrganizationId API Reference The WorkMail organization under which the rule will be created. Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes Response Syntax { "MobileDeviceAccessRuleId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. MobileDeviceAccessRuleId The identifier for the newly created mobile device access rule. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [a-zA-Z0-9_-]+ Errors For information about the errors that are common to all actions, see Common Errors. InvalidParameterException One or more of the input parameters don't match the service's restrictions. CreateMobileDeviceAccessRule 47 Amazon WorkMail HTTP Status Code: 400 LimitExceededException The request exceeds the limit of the resource. HTTP Status Code: 400 OrganizationNotFoundException API Reference An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 See Also For more information |
workmail-api-009 | workmail-api.pdf | 9 | [a-zA-Z0-9_-]+ Errors For information about the errors that are common to all actions, see Common Errors. InvalidParameterException One or more of the input parameters don't match the service's restrictions. CreateMobileDeviceAccessRule 47 Amazon WorkMail HTTP Status Code: 400 LimitExceededException The request exceeds the limit of the resource. HTTP Status Code: 400 OrganizationNotFoundException API Reference An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 CreateMobileDeviceAccessRule 48 Amazon WorkMail CreateOrganization Service: Amazon WorkMail API Reference Creates a new WorkMail organization. Optionally, you can choose to associate an existing AWS Directory Service directory with your organization. If an AWS Directory Service directory ID is specified, the organization alias must match the directory alias. If you choose not to associate an existing directory with your organization, then we create a new WorkMail directory for you. For more information, see Adding an organization in the WorkMail Administrator Guide. You can associate multiple email domains with an organization, then choose your default email domain from the WorkMail console. You can also associate a domain that is managed in an Amazon Route 53 public hosted zone. For more information, see Adding a domain and Choosing the default domain in the WorkMail Administrator Guide. Optionally, you can use a customer managed key from AWS Key Management Service (AWS KMS) to encrypt email for your organization. If you don't associate an AWS KMS key, WorkMail creates a default, AWS managed key for you. Request Syntax { "Alias": "string", "ClientToken": "string", "DirectoryId": "string", "Domains": [ { "DomainName": "string", "HostedZoneId": "string" } ], "EnableInteroperability": boolean, "KmsKeyArn": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. CreateOrganization 49 API Reference Amazon WorkMail Alias The organization alias. Type: String Length Constraints: Minimum length of 1. Maximum length of 62. Pattern: ^(?!d-)([\da-zA-Z]+)([-][\da-zA-Z]+)* Required: Yes ClientToken The idempotency token associated with the request. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [\x21-\x7e]+ Required: No DirectoryId The AWS Directory Service directory ID. Type: String Length Constraints: Fixed length of 12. Pattern: ^d-[0-9a-f]{10}$ Required: No Domains The email domains to associate with the organization. Type: Array of Domain objects Array Members: Minimum number of 0 items. Maximum number of 5 items. Required: No CreateOrganization 50 Amazon WorkMail EnableInteroperability API Reference When true, allows organization interoperability between WorkMail and Microsoft Exchange. If true, you must include a AD Connector directory ID in the request. Type: Boolean Required: No KmsKeyArn The Amazon Resource Name (ARN) of a customer managed key from AWS KMS. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:aws:kms:[a-z0-9-]*:[a-z0-9-]+:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-] {0,1023} Required: No Response Syntax { "OrganizationId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. OrganizationId The organization ID. Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ CreateOrganization 51 Amazon WorkMail Errors API Reference For information about the errors that are common to all actions, see Common Errors. DirectoryInUseException The directory is already in use by another WorkMail organization in the same account and Region. HTTP Status Code: 400 DirectoryUnavailableException The directory is unavailable. It might be located in another Region or deleted. HTTP Status Code: 400 InvalidParameterException One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 LimitExceededException The request exceeds the limit of the resource. HTTP Status Code: 400 NameAvailabilityException The user, group, or resource name isn't unique in WorkMail. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 CreateOrganization 52 Amazon WorkMail • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference CreateOrganization 53 API Reference Amazon WorkMail CreateResource Service: Amazon WorkMail Creates a new WorkMail resource. Request Syntax { "Description": |
workmail-api-010 | workmail-api.pdf | 10 | 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 CreateOrganization 52 Amazon WorkMail • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference CreateOrganization 53 API Reference Amazon WorkMail CreateResource Service: Amazon WorkMail Creates a new WorkMail resource. Request Syntax { "Description": "string", "HiddenFromGlobalAddressList": boolean, "Name": "string", "OrganizationId": "string", "Type": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Description Resource description. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: No HiddenFromGlobalAddressList If this parameter is enabled, the resource will be hidden from the address book. Type: Boolean Required: No Name The name of the new resource. Type: String CreateResource 54 Amazon WorkMail API Reference Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: [\w\-.]+(@[a-zA-Z0-9.\-]+\.[a-zA-Z0-9-]{2,})? Required: Yes OrganizationId The identifier associated with the organization for which the resource is created. Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes Type The type of the new resource. The available types are equipment and room. Type: String Valid Values: ROOM | EQUIPMENT Required: Yes Response Syntax { "ResourceId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ResourceId The identifier of the new resource. CreateResource 55 Amazon WorkMail Type: String Length Constraints: Fixed length of 34. Pattern: ^r-[0-9a-f]{32}$ Errors API Reference For information about the errors that are common to all actions, see Common Errors. DirectoryServiceAuthenticationFailedException The directory service doesn't recognize the credentials supplied by WorkMail. HTTP Status Code: 400 DirectoryUnavailableException The directory is unavailable. It might be located in another Region or deleted. HTTP Status Code: 400 InvalidParameterException One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 NameAvailabilityException The user, group, or resource name isn't unique in WorkMail. HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members. CreateResource 56 API Reference Amazon WorkMail HTTP Status Code: 400 ReservedNameException This user, group, or resource name is not allowed in WorkMail. HTTP Status Code: 400 UnsupportedOperationException You can't perform a write operation against a read-only directory. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 CreateResource 57 Amazon WorkMail CreateUser Service: Amazon WorkMail API Reference Creates a user who can be used in WorkMail by calling the RegisterToWorkMail operation. Request Syntax { "DisplayName": "string", "FirstName": "string", "HiddenFromGlobalAddressList": boolean, "IdentityProviderUserId": "string", "LastName": "string", "Name": "string", "OrganizationId": "string", "Password": "string", "Role": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. DisplayName The display name for the new user. Type: String Length Constraints: Maximum length of 256. Required: Yes FirstName The first name of the new user. Type: String Length Constraints: Maximum length of 256. CreateUser 58 Amazon WorkMail Required: No HiddenFromGlobalAddressList API Reference If this parameter is enabled, the user will be hidden from the address book. Type: Boolean Required: No IdentityProviderUserId 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 47. Pattern: ^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A- Fa-f0-9]{4}-[A-Fa-f0-9]{12}$ Required: No LastName The last name of the new user. Type: String Length Constraints: Maximum length of 256. Required: No Name The name for the new user. WorkMail directory user names have a maximum length of 64. All others have a maximum length of 20. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [\w\-.]+(@[a-zA-Z0-9.\-]+\.[a-zA-Z0-9-]{2,})? Required: Yes CreateUser 59 Amazon WorkMail OrganizationId API Reference The identifier of the organization for which the user is created. Type: String Length Constraints: |
workmail-api-011 | workmail-api.pdf | 11 | with WorkMail. Type: String Length Constraints: Minimum length of 1. Maximum length of 47. Pattern: ^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A- Fa-f0-9]{4}-[A-Fa-f0-9]{12}$ Required: No LastName The last name of the new user. Type: String Length Constraints: Maximum length of 256. Required: No Name The name for the new user. WorkMail directory user names have a maximum length of 64. All others have a maximum length of 20. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [\w\-.]+(@[a-zA-Z0-9.\-]+\.[a-zA-Z0-9-]{2,})? Required: Yes CreateUser 59 Amazon WorkMail OrganizationId API Reference The identifier of the organization for which the user is created. Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes Password The password for the new user. Type: String Length Constraints: Maximum length of 256. Pattern: [\u0020-\u00FF]+ Required: No Role 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. Type: String Valid Values: USER | RESOURCE | SYSTEM_USER | REMOTE_USER Required: No Response Syntax { "UserId": "string" } CreateUser 60 Amazon WorkMail Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. UserId The identifier for the new user. Type: String Length Constraints: Minimum length of 12. Maximum length of 256. Errors For information about the errors that are common to all actions, see Common Errors. DirectoryServiceAuthenticationFailedException The directory service doesn't recognize the credentials supplied by WorkMail. HTTP Status Code: 400 DirectoryUnavailableException The directory is unavailable. It might be located in another Region or deleted. HTTP Status Code: 400 InvalidParameterException One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 InvalidPasswordException The supplied password doesn't match the minimum security constraints, such as length or use of special characters. HTTP Status Code: 400 NameAvailabilityException The user, group, or resource name isn't unique in WorkMail. CreateUser 61 Amazon WorkMail API Reference HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 ReservedNameException This user, group, or resource name is not allowed in WorkMail. HTTP Status Code: 400 UnsupportedOperationException You can't perform a write operation against a read-only directory. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 CreateUser 62 Amazon WorkMail • AWS SDK for Python • AWS SDK for Ruby V3 API Reference CreateUser 63 Amazon WorkMail API Reference DeleteAccessControlRule Service: Amazon WorkMail Deletes an access control rule for the specified WorkMail organization. Note 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. Request Syntax { "Name": "string", "OrganizationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Name The name of the access control rule. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [a-zA-Z0-9_-]+ Required: Yes OrganizationId The identifier for the organization. Type: String DeleteAccessControlRule 64 Amazon WorkMail API Reference Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 DeleteAccessControlRule 65 Amazon WorkMail • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference DeleteAccessControlRule 66 Amazon WorkMail DeleteAlias Service: Amazon WorkMail API Reference Remove one or more specified aliases from a set of aliases for |
workmail-api-012 | workmail-api.pdf | 12 | For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 DeleteAccessControlRule 65 Amazon WorkMail • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference DeleteAccessControlRule 66 Amazon WorkMail DeleteAlias Service: Amazon WorkMail API Reference Remove one or more specified aliases from a set of aliases for a given user. Request Syntax { "Alias": "string", "EntityId": "string", "OrganizationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Alias The aliases to be removed from the user's set of aliases. Duplicate entries in the list are collapsed into single entries (the list is transformed into a set). Type: String Length Constraints: Minimum length of 1. Maximum length of 254. Pattern: [a-zA-Z0-9._%+-]{1,64}@[a-zA-Z0-9.-]+\.[a-zA-Z-]{2,} Required: Yes EntityId The identifier for the member (user or group) from which to have the aliases removed. Type: String Length Constraints: Minimum length of 12. Maximum length of 256. Required: Yes DeleteAlias 67 Amazon WorkMail OrganizationId API Reference The identifier for the organization under which the user exists. Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization. HTTP Status Code: 400 EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user. HTTP Status Code: 400 InvalidParameterException One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 DeleteAlias 68 Amazon WorkMail OrganizationStateException API Reference The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 DeleteAlias 69 Amazon WorkMail API Reference DeleteAvailabilityConfiguration Service: Amazon WorkMail Deletes the AvailabilityConfiguration for the given WorkMail organization and domain. Request Syntax { "DomainName": "string", "OrganizationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. DomainName The domain for which the AvailabilityConfiguration will be deleted. Type: String Length Constraints: Minimum length of 3. Maximum length of 255. Pattern: [a-zA-Z0-9.-]+ Required: Yes OrganizationId The WorkMail organization for which the AvailabilityConfiguration will be deleted. Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes DeleteAvailabilityConfiguration 70 Amazon WorkMail Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 DeleteAvailabilityConfiguration 71 Amazon WorkMail API Reference DeleteEmailMonitoringConfiguration Service: Amazon WorkMail Deletes the email monitoring configuration for a specified organization. Request Syntax { "OrganizationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. OrganizationId The ID of the organization from which the email monitoring configuration is deleted. Type: String Length Constraints: Fixed length of 34. Pattern: |
workmail-api-013 | workmail-api.pdf | 13 | AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 DeleteAvailabilityConfiguration 71 Amazon WorkMail API Reference DeleteEmailMonitoringConfiguration Service: Amazon WorkMail Deletes the email monitoring configuration for a specified organization. Request Syntax { "OrganizationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. OrganizationId The ID of the organization from which the email monitoring configuration is deleted. Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. InvalidParameterException One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 DeleteEmailMonitoringConfiguration 72 Amazon WorkMail API Reference OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 DeleteEmailMonitoringConfiguration 73 API Reference Amazon WorkMail DeleteGroup Service: Amazon WorkMail Deletes a group from WorkMail. Request Syntax { "GroupId": "string", "OrganizationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. GroupId 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 Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [a-zA-Z0-9._%+@-]+ Required: Yes OrganizationId The organization that contains the group. Type: String Length Constraints: Fixed length of 34. DeleteGroup 74 Amazon WorkMail API Reference Pattern: ^m-[0-9a-f]{32}$ Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. DirectoryServiceAuthenticationFailedException The directory service doesn't recognize the credentials supplied by WorkMail. HTTP Status Code: 400 DirectoryUnavailableException The directory is unavailable. It might be located in another Region or deleted. HTTP Status Code: 400 EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user. HTTP Status Code: 400 InvalidParameterException One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 DeleteGroup 75 Amazon WorkMail OrganizationStateException API Reference The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 UnsupportedOperationException You can't perform a write operation against a read-only directory. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 DeleteGroup 76 Amazon WorkMail API Reference DeleteIdentityCenterApplication Service: Amazon WorkMail Deletes the IAM Identity Center application from WorkMail. This action does not affect the authentication settings for any WorkMail organizations. Request Syntax { "ApplicationArn": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ApplicationArn The Amazon Resource Name (ARN) of the application. Type: String Length Constraints: Minimum length of 10. Maximum length of 1224. Pattern: ^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:: \d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}$ Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. InvalidParameterException One or more of the input parameters don't match the service's restrictions. DeleteIdentityCenterApplication 77 Amazon WorkMail HTTP Status Code: 400 OrganizationStateException API Reference The |
workmail-api-014 | workmail-api.pdf | 14 | all actions, see Common Parameters. The request accepts the following data in JSON format. ApplicationArn The Amazon Resource Name (ARN) of the application. Type: String Length Constraints: Minimum length of 10. Maximum length of 1224. Pattern: ^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:: \d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}$ Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. InvalidParameterException One or more of the input parameters don't match the service's restrictions. DeleteIdentityCenterApplication 77 Amazon WorkMail HTTP Status Code: 400 OrganizationStateException API Reference The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 DeleteIdentityCenterApplication 78 Amazon WorkMail API Reference DeleteIdentityProviderConfiguration Service: Amazon WorkMail 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. Request Syntax { "OrganizationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. OrganizationId The Organization ID. Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. InvalidParameterException One or more of the input parameters don't match the service's restrictions. DeleteIdentityProviderConfiguration 79 Amazon WorkMail API Reference HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 DeleteIdentityProviderConfiguration 80 Amazon WorkMail API Reference DeleteImpersonationRole Service: Amazon WorkMail Deletes an impersonation role for the given WorkMail organization. Request Syntax { "ImpersonationRoleId": "string", "OrganizationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ImpersonationRoleId The ID of the impersonation role to delete. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [a-zA-Z0-9_-]+ Required: Yes OrganizationId The WorkMail organization from which to delete the impersonation role. Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes DeleteImpersonationRole 81 Amazon WorkMail Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. InvalidParameterException One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin DeleteImpersonationRole 82 Amazon WorkMail • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference DeleteImpersonationRole 83 Amazon WorkMail API Reference DeleteMailboxPermissions Service: Amazon WorkMail Deletes permissions granted to a member (user or group). Request Syntax { "EntityId": "string", "GranteeId": "string", "OrganizationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. EntityId The identifier |
workmail-api-015 | workmail-api.pdf | 15 | for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin DeleteImpersonationRole 82 Amazon WorkMail • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference DeleteImpersonationRole 83 Amazon WorkMail API Reference DeleteMailboxPermissions Service: Amazon WorkMail Deletes permissions granted to a member (user or group). Request Syntax { "EntityId": "string", "GranteeId": "string", "OrganizationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. EntityId 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: [email protected] • Entity name: entity Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [a-zA-Z0-9._%+@-]+ Required: Yes GranteeId The identifier of the entity for which to delete granted permissions. DeleteMailboxPermissions 84 Amazon WorkMail API Reference 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 address: [email protected] • Grantee name: grantee Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [a-zA-Z0-9._%+@-]+ Required: Yes OrganizationId The identifier of the organization under which the member (user or group) exists. Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization. HTTP Status Code: 400 DeleteMailboxPermissions 85 Amazon WorkMail EntityStateException API Reference You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user. HTTP Status Code: 400 InvalidParameterException One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 DeleteMailboxPermissions 86 Amazon WorkMail • AWS SDK for Python • AWS SDK for Ruby V3 API Reference DeleteMailboxPermissions 87 Amazon WorkMail API Reference DeleteMobileDeviceAccessOverride Service: Amazon WorkMail Deletes the mobile device access override for the given WorkMail organization, user, and device. Note 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. Request Syntax { "DeviceId": "string", "OrganizationId": "string", "UserId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. DeviceId The mobile device for which you delete the override. DeviceId is case insensitive. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. Pattern: [A-Za-z0-9]+ Required: Yes OrganizationId The WorkMail organization for which the access override will be deleted. Type: String DeleteMobileDeviceAccessOverride 88 Amazon WorkMail API Reference Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes UserId 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: [email protected] • User name: user Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [a-zA-Z0-9._%+@-]+ Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization. HTTP Status Code: 400 InvalidParameterException One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 DeleteMobileDeviceAccessOverride 89 Amazon WorkMail API Reference OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 See Also For more information about using this API in one of the |
workmail-api-016 | workmail-api.pdf | 16 | Errors. EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization. HTTP Status Code: 400 InvalidParameterException One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 DeleteMobileDeviceAccessOverride 89 Amazon WorkMail API Reference OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 DeleteMobileDeviceAccessOverride 90 Amazon WorkMail API Reference DeleteMobileDeviceAccessRule Service: Amazon WorkMail Deletes a mobile device access rule for the specified WorkMail organization. Note 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. Request Syntax { "MobileDeviceAccessRuleId": "string", "OrganizationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. MobileDeviceAccessRuleId The identifier of the rule to be deleted. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [a-zA-Z0-9_-]+ Required: Yes OrganizationId The WorkMail organization under which the rule will be deleted. Type: String DeleteMobileDeviceAccessRule 91 Amazon WorkMail API Reference Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. InvalidParameterException One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ DeleteMobileDeviceAccessRule 92 Amazon WorkMail • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference DeleteMobileDeviceAccessRule 93 Amazon WorkMail DeleteOrganization Service: Amazon WorkMail API Reference 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. Request Syntax { "ClientToken": "string", "DeleteDirectory": boolean, "DeleteIdentityCenterApplication": boolean, "ForceDelete": boolean, "OrganizationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ClientToken The idempotency token associated with the request. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [\x21-\x7e]+ Required: No DeleteDirectory If true, deletes the AWS Directory Service directory associated with the organization. Type: Boolean Required: Yes DeleteOrganization 94 Amazon WorkMail API Reference DeleteIdentityCenterApplication Deletes IAM Identity Center application for WorkMail. This action does not affect authentication settings for any organization. Type: Boolean Required: No ForceDelete Deletes a WorkMail organization even if the organization has enabled users. Type: Boolean Required: No OrganizationId The organization ID. Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes Response Syntax { "OrganizationId": "string", "State": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. OrganizationId The organization ID. DeleteOrganization 95 API Reference Amazon WorkMail Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ State The state of the organization. Type: String Length Constraints: Maximum length of 256. Errors For information about the errors that are common to all actions, see Common Errors. InvalidParameterException One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members. HTTP |
workmail-api-017 | workmail-api.pdf | 17 | API Reference Amazon WorkMail Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ State The state of the organization. Type: String Length Constraints: Maximum length of 256. Errors For information about the errors that are common to all actions, see Common Errors. InvalidParameterException One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface DeleteOrganization 96 API Reference Amazon WorkMail • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 DeleteOrganization 97 Amazon WorkMail API Reference DeletePersonalAccessToken Service: Amazon WorkMail Deletes the Personal Access Token from the provided WorkMail Organization. Request Syntax { "OrganizationId": "string", "PersonalAccessTokenId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. OrganizationId The Organization ID. Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes PersonalAccessTokenId The Personal Access Token ID. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [a-zA-Z0-9_-]+ Required: Yes DeletePersonalAccessToken 98 Amazon WorkMail Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. InvalidParameterException One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin DeletePersonalAccessToken 99 Amazon WorkMail • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference DeletePersonalAccessToken 100 API Reference Amazon WorkMail DeleteResource Service: Amazon WorkMail Deletes the specified resource. Request Syntax { "OrganizationId": "string", "ResourceId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. OrganizationId The identifier associated with the organization from which the resource is deleted. Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes ResourceId 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 Type: String Length Constraints: Minimum length of 1. Maximum length of 256. DeleteResource 101 Amazon WorkMail API Reference Pattern: [a-zA-Z0-9._%+@-]+ Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user. HTTP Status Code: 400 InvalidParameterException One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 UnsupportedOperationException You can't perform a write operation against a read-only directory. HTTP Status Code: 400 DeleteResource 102 Amazon WorkMail See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 DeleteResource |
workmail-api-018 | workmail-api.pdf | 18 | HTTP Status Code: 400 UnsupportedOperationException You can't perform a write operation against a read-only directory. HTTP Status Code: 400 DeleteResource 102 Amazon WorkMail See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 DeleteResource 103 Amazon WorkMail DeleteRetentionPolicy Service: Amazon WorkMail Deletes the specified retention policy from the specified organization. API Reference Request Syntax { "Id": "string", "OrganizationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Id The retention policy ID. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [a-zA-Z0-9_-]+ Required: Yes OrganizationId The organization ID. Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes DeleteRetentionPolicy 104 Amazon WorkMail Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. InvalidParameterException One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin DeleteRetentionPolicy 105 Amazon WorkMail • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference DeleteRetentionPolicy 106 Amazon WorkMail DeleteUser Service: Amazon WorkMail API Reference 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. Request Syntax { "OrganizationId": "string", "UserId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. OrganizationId The organization that contains the user to be deleted. Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes UserId 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 DeleteUser 107 Amazon WorkMail Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [a-zA-Z0-9._%+@-]+ Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. DirectoryServiceAuthenticationFailedException The directory service doesn't recognize the credentials supplied by WorkMail. HTTP Status Code: 400 DirectoryUnavailableException The directory is unavailable. It might be located in another Region or deleted. HTTP Status Code: 400 EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user. HTTP Status Code: 400 InvalidParameterException One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. DeleteUser 108 Amazon WorkMail HTTP Status Code: 400 OrganizationStateException API Reference The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 UnsupportedOperationException You can't perform a write operation against a read-only directory. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 DeleteUser 109 Amazon WorkMail API Reference DeregisterFromWorkMail |
workmail-api-019 | workmail-api.pdf | 19 | HTTP Status Code: 400 UnsupportedOperationException You can't perform a write operation against a read-only directory. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 DeleteUser 109 Amazon WorkMail API Reference DeregisterFromWorkMail Service: Amazon WorkMail 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. Request Syntax { "EntityId": "string", "OrganizationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. EntityId 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: [email protected] • Entity name: entity Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [a-zA-Z0-9._%+@-]+ Required: Yes DeregisterFromWorkMail 110 Amazon WorkMail OrganizationId API Reference The identifier for the organization under which the WorkMail entity exists. Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization. HTTP Status Code: 400 EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user. HTTP Status Code: 400 InvalidParameterException One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 DeregisterFromWorkMail 111 Amazon WorkMail OrganizationStateException API Reference The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 DeregisterFromWorkMail 112 Amazon WorkMail DeregisterMailDomain Service: Amazon WorkMail API Reference 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. Request Syntax { "DomainName": "string", "OrganizationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. DomainName The domain to deregister in WorkMail and SES. Type: String Length Constraints: Minimum length of 3. Maximum length of 209. Pattern: [a-zA-Z0-9.-]+ Required: Yes OrganizationId The WorkMail organization for which the domain will be deregistered. Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ DeregisterMailDomain 113 Amazon WorkMail Required: Yes Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. InvalidCustomSesConfigurationException You SES configuration has customizations that WorkMail cannot save. The error message lists the invalid setting. For examples of invalid settings, refer to CreateReceiptRule. HTTP Status Code: 400 InvalidParameterException One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 MailDomainInUseException The domain you're trying to change is in use by another user or organization in your account. See the error message for details. HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 DeregisterMailDomain 114 Amazon WorkMail See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, |
workmail-api-020 | workmail-api.pdf | 20 | the service's restrictions. HTTP Status Code: 400 MailDomainInUseException The domain you're trying to change is in use by another user or organization in your account. See the error message for details. HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 DeregisterMailDomain 114 Amazon WorkMail See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 DeregisterMailDomain 115 Amazon WorkMail API Reference DescribeEmailMonitoringConfiguration Service: Amazon WorkMail Describes the current email monitoring configuration for a specified organization. Request Syntax { "OrganizationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. OrganizationId The ID of the organization for which the email monitoring configuration is described. Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes Response Syntax { "LogGroupArn": "string", "RoleArn": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. DescribeEmailMonitoringConfiguration 116 Amazon WorkMail LogGroupArn API Reference The Amazon Resource Name (ARN) of the CloudWatch Log group associated with the email monitoring configuration. Type: String Length Constraints: Minimum length of 47. Maximum length of 562. Pattern: arn:aws:logs:[a-z\-0-9]*:[0-9]{12}:log-group:([\.\-_/#A-Za- z0-9]+):\*$ RoleArn The Amazon Resource Name (ARN) of the IAM Role associated with the email monitoring configuration. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:aws:iam:[a-z0-9-]*:[a-z0-9-]+:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-] {0,1023} Errors For information about the errors that are common to all actions, see Common Errors. InvalidParameterException One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members. DescribeEmailMonitoringConfiguration 117 Amazon WorkMail HTTP Status Code: 400 ResourceNotFoundException The resource cannot be found. HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 DescribeEmailMonitoringConfiguration 118 API Reference Amazon WorkMail DescribeEntity Service: Amazon WorkMail Returns basic details about an entity in WorkMail. Request Syntax { "Email": "string", "OrganizationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Email The email under which the entity exists. Type: String Length Constraints: Minimum length of 1. Maximum length of 254. Pattern: [a-zA-Z0-9._%+-]{1,64}@[a-zA-Z0-9.-]+\.[a-zA-Z-]{2,} Required: Yes OrganizationId The identifier for the organization under which the entity exists. Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes DescribeEntity 119 API Reference Amazon WorkMail Response Syntax { "EntityId": "string", "Name": "string", "Type": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. EntityId The entity ID under which the entity exists. Type: String Length Constraints: Minimum length of 12. Maximum length of 256. Name Username, GroupName, or ResourceName based on entity type. Type: String Length Constraints: Maximum length of 256. Type Entity type. Type: String Valid Values: GROUP | USER | RESOURCE Errors For information about the errors that are common to all actions, see Common Errors. EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization. DescribeEntity 120 Amazon WorkMail HTTP Status Code: 400 InvalidParameterException API Reference One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 See Also For more information about |
workmail-api-021 | workmail-api.pdf | 21 | are common to all actions, see Common Errors. EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization. DescribeEntity 120 Amazon WorkMail HTTP Status Code: 400 InvalidParameterException API Reference One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 DescribeEntity 121 API Reference Amazon WorkMail DescribeGroup Service: Amazon WorkMail Returns the data available for the group. Request Syntax { "GroupId": "string", "OrganizationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. GroupId 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: [email protected] • Group name: group Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [a-zA-Z0-9._%+@-]+ Required: Yes OrganizationId The identifier for the organization under which the group exists. Type: String DescribeGroup 122 Amazon WorkMail API Reference Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes Response Syntax { "DisabledDate": number, "Email": "string", "EnabledDate": number, "GroupId": "string", "HiddenFromGlobalAddressList": boolean, "Name": "string", "State": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. DisabledDate The date and time when a user was deregistered from WorkMail, in UNIX epoch time format. Type: Timestamp Email The email of the described group. Type: String Length Constraints: Minimum length of 1. Maximum length of 254. Pattern: [a-zA-Z0-9._%+-]{1,64}@[a-zA-Z0-9.-]+\.[a-zA-Z-]{2,} EnabledDate The date and time when a user was registered to WorkMail, in UNIX epoch time format. DescribeGroup 123 API Reference Amazon WorkMail Type: Timestamp GroupId The identifier of the described group. Type: String Length Constraints: Minimum length of 12. Maximum length of 256. HiddenFromGlobalAddressList If the value is set to true, the group is hidden from the address book. Type: Boolean Name The name of the described group. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [\u0020-\u00FF]+ State The state of the user: enabled (registered to WorkMail) or disabled (deregistered or never registered to WorkMail). Type: String Valid Values: ENABLED | DISABLED | DELETED Errors For information about the errors that are common to all actions, see Common Errors. EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization. HTTP Status Code: 400 DescribeGroup 124 Amazon WorkMail InvalidParameterException API Reference One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 DescribeGroup 125 Amazon WorkMail API Reference DescribeIdentityProviderConfiguration Service: Amazon WorkMail Returns detailed information on the current IdC setup for the WorkMail organization. Request Syntax { "OrganizationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. OrganizationId The Organization ID. Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes Response Syntax { "AuthenticationMode": "string", "IdentityCenterConfiguration": { "ApplicationArn": "string", "InstanceArn": "string" }, "PersonalAccessTokenConfiguration": { "LifetimeInDays": number, "Status": "string" } DescribeIdentityProviderConfiguration 126 Amazon WorkMail } Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. AuthenticationMode The authentication mode used in WorkMail. Type: String Valid |
workmail-api-022 | workmail-api.pdf | 22 | information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. OrganizationId The Organization ID. Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes Response Syntax { "AuthenticationMode": "string", "IdentityCenterConfiguration": { "ApplicationArn": "string", "InstanceArn": "string" }, "PersonalAccessTokenConfiguration": { "LifetimeInDays": number, "Status": "string" } DescribeIdentityProviderConfiguration 126 Amazon WorkMail } Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. AuthenticationMode The authentication mode used in WorkMail. Type: String Valid Values: IDENTITY_PROVIDER_ONLY | IDENTITY_PROVIDER_AND_DIRECTORY IdentityCenterConfiguration The details of the IAM Identity Center configuration. Type: IdentityCenterConfiguration object PersonalAccessTokenConfiguration The details of the Personal Access Token configuration. Type: PersonalAccessTokenConfiguration object Errors For information about the errors that are common to all actions, see Common Errors. InvalidParameterException One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 DescribeIdentityProviderConfiguration 127 Amazon WorkMail OrganizationStateException API Reference The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 ResourceNotFoundException The resource cannot be found. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 DescribeIdentityProviderConfiguration 128 Amazon WorkMail API Reference DescribeInboundDmarcSettings Service: Amazon WorkMail Lists the settings in a DMARC policy for a specified organization. Request Syntax { "OrganizationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. OrganizationId Lists the ID of the given organization. Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes Response Syntax { "Enforced": boolean } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. DescribeInboundDmarcSettings 129 Amazon WorkMail Enforced Lists the enforcement setting of the applied policy. API Reference Type: Boolean Errors For information about the errors that are common to all actions, see Common Errors. OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python DescribeInboundDmarcSettings 130 Amazon WorkMail • AWS SDK for Ruby V3 API Reference DescribeInboundDmarcSettings 131 Amazon WorkMail API Reference DescribeMailboxExportJob Service: Amazon WorkMail Describes the current status of a mailbox export job. Request Syntax { "JobId": "string", "OrganizationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. JobId The mailbox export job ID. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: [A-Za-z0-9-]+ Required: Yes OrganizationId The organization ID. Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes DescribeMailboxExportJob 132 API Reference Amazon WorkMail Response Syntax { "Description": "string", "EndTime": number, "EntityId": "string", "ErrorInfo": "string", "EstimatedProgress": number, "KmsKeyArn": "string", "RoleArn": "string", "S3BucketName": "string", "S3Path": "string", "S3Prefix": "string", "StartTime": number, "State": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Description The mailbox export job description. Type: String Length Constraints: Minimum length of 0. Maximum length of 1023. Pattern: [\S\s]* EndTime The mailbox export job end timestamp. Type: Timestamp EntityId The identifier of the user or resource associated with the mailbox. Type: String DescribeMailboxExportJob 133 Amazon WorkMail API Reference Length Constraints: Minimum length of 12. Maximum length of 256. ErrorInfo Error information for failed mailbox export jobs. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: [\S\s]* EstimatedProgress The estimated progress of the mailbox export job, in percentage points. Type: Integer Valid Range: Minimum |
workmail-api-023 | workmail-api.pdf | 23 | the service. Description The mailbox export job description. Type: String Length Constraints: Minimum length of 0. Maximum length of 1023. Pattern: [\S\s]* EndTime The mailbox export job end timestamp. Type: Timestamp EntityId The identifier of the user or resource associated with the mailbox. Type: String DescribeMailboxExportJob 133 Amazon WorkMail API Reference Length Constraints: Minimum length of 12. Maximum length of 256. ErrorInfo Error information for failed mailbox export jobs. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: [\S\s]* EstimatedProgress The estimated progress of the mailbox export job, in percentage points. Type: Integer Valid Range: Minimum value of 0. Maximum value of 100. KmsKeyArn The Amazon Resource Name (ARN) of the symmetric AWS Key Management Service (AWS KMS) key that encrypts the exported mailbox content. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:aws:kms:[a-z0-9-]*:[a-z0-9-]+:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-] {0,1023} RoleArn The ARN of the AWS Identity and Access Management (IAM) role that grants write permission to the Amazon Simple Storage Service (Amazon S3) bucket. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:aws:iam:[a-z0-9-]*:[a-z0-9-]+:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-] {0,1023} S3BucketName The name of the S3 bucket. DescribeMailboxExportJob 134 Amazon WorkMail Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: [A-Za-z0-9.-]+ S3Path The path to the S3 bucket and file that the mailbox export job is exporting to. Type: String Length Constraints: Minimum length of 1. Maximum length of 1023. Pattern: [A-Za-z0-9!_.*'()/-]+ S3Prefix The S3 bucket prefix. Type: String Length Constraints: Minimum length of 1. Maximum length of 1023. Pattern: [A-Za-z0-9!_.*'()/-]+ StartTime The mailbox export job start timestamp. Type: Timestamp State The state of the mailbox export job. Type: String Valid Values: RUNNING | COMPLETED | FAILED | CANCELLED Errors For information about the errors that are common to all actions, see Common Errors. EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization. DescribeMailboxExportJob 135 Amazon WorkMail HTTP Status Code: 400 InvalidParameterException API Reference One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 DescribeMailboxExportJob 136 Amazon WorkMail DescribeOrganization Service: Amazon WorkMail API Reference Provides more information regarding a given organization based on its identifier. Request Syntax { "OrganizationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. OrganizationId The identifier for the organization to be described. Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes Response Syntax { "Alias": "string", "ARN": "string", "CompletedDate": number, "DefaultMailDomain": "string", "DirectoryId": "string", "DirectoryType": "string", "ErrorMessage": "string", "InteroperabilityEnabled": boolean, "MigrationAdmin": "string", DescribeOrganization 137 Amazon WorkMail API Reference "OrganizationId": "string", "State": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Alias The alias for an organization. Type: String Length Constraints: Minimum length of 1. Maximum length of 62. Pattern: ^(?!d-)([\da-zA-Z]+)([-][\da-zA-Z]+)* ARN The Amazon Resource Name (ARN) of the organization. Type: String Length Constraints: Minimum length of 1. Maximum length of 1011. Pattern: arn:aws:workmail:[a-z0-9-]*:[a-z0-9-]+:[A-Za-z0-9][A-Za-z0-9:_/ +=,@.-]{0,1023} CompletedDate The date at which the organization became usable in the WorkMail context, in UNIX epoch time format. Type: Timestamp DefaultMailDomain The default mail domain associated with the organization. Type: String Length Constraints: Maximum length of 256. DescribeOrganization 138 Amazon WorkMail DirectoryId API Reference The identifier for the directory associated with an WorkMail organization. Type: String Length Constraints: Maximum length of 256. DirectoryType The type of directory associated with the WorkMail organization. Type: String Length Constraints: Maximum length of 256. ErrorMessage (Optional) The error message indicating if unexpected behavior was encountered with regards to the organization. Type: String Length Constraints: Maximum length of 256. InteroperabilityEnabled Indicates if interoperability is enabled for this organization. Type: Boolean MigrationAdmin The user ID of the migration admin if migration is enabled for the organization. Type: String Length Constraints: Minimum length of 12. Maximum length of 256. OrganizationId The identifier of an organization. Type: String Length Constraints: Fixed length of 34. DescribeOrganization 139 Amazon WorkMail API |
workmail-api-024 | workmail-api.pdf | 24 | 256. DirectoryType The type of directory associated with the WorkMail organization. Type: String Length Constraints: Maximum length of 256. ErrorMessage (Optional) The error message indicating if unexpected behavior was encountered with regards to the organization. Type: String Length Constraints: Maximum length of 256. InteroperabilityEnabled Indicates if interoperability is enabled for this organization. Type: Boolean MigrationAdmin The user ID of the migration admin if migration is enabled for the organization. Type: String Length Constraints: Minimum length of 12. Maximum length of 256. OrganizationId The identifier of an organization. Type: String Length Constraints: Fixed length of 34. DescribeOrganization 139 Amazon WorkMail API Reference Pattern: ^m-[0-9a-f]{32}$ State The state of an organization. Type: String Length Constraints: Maximum length of 256. Errors For information about the errors that are common to all actions, see Common Errors. InvalidParameterException One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 DescribeOrganization 140 Amazon WorkMail • AWS SDK for Python • AWS SDK for Ruby V3 API Reference DescribeOrganization 141 API Reference Amazon WorkMail DescribeResource Service: Amazon WorkMail Returns the data available for the resource. Request Syntax { "OrganizationId": "string", "ResourceId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. OrganizationId The identifier associated with the organization for which the resource is described. Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes ResourceId 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: [email protected] • Resource name: resource Type: String DescribeResource 142 Amazon WorkMail API Reference Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [a-zA-Z0-9._%+@-]+ Required: Yes Response Syntax { "BookingOptions": { "AutoAcceptRequests": boolean, "AutoDeclineConflictingRequests": boolean, "AutoDeclineRecurringRequests": boolean }, "Description": "string", "DisabledDate": number, "Email": "string", "EnabledDate": number, "HiddenFromGlobalAddressList": boolean, "Name": "string", "ResourceId": "string", "State": "string", "Type": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. BookingOptions The booking options for the described resource. Type: BookingOptions object Description Description of the resource. Type: String DescribeResource 143 Amazon WorkMail API Reference Length Constraints: Minimum length of 1. Maximum length of 64. DisabledDate The date and time when a resource was disabled from WorkMail, in UNIX epoch time format. Type: Timestamp Email The email of the described resource. Type: String Length Constraints: Minimum length of 1. Maximum length of 254. Pattern: [a-zA-Z0-9._%+-]{1,64}@[a-zA-Z0-9.-]+\.[a-zA-Z-]{2,} EnabledDate The date and time when a resource was enabled for WorkMail, in UNIX epoch time format. Type: Timestamp HiddenFromGlobalAddressList If enabled, the resource is hidden from the global address list. Type: Boolean Name The name of the described resource. Type: String Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: [\w\-.]+(@[a-zA-Z0-9.\-]+\.[a-zA-Z0-9-]{2,})? ResourceId The identifier of the described resource. Type: String Length Constraints: Fixed length of 34. DescribeResource 144 Amazon WorkMail API Reference Pattern: ^r-[0-9a-f]{32}$ State The state of the resource: enabled (registered to WorkMail), disabled (deregistered or never registered to WorkMail), or deleted. Type: String Valid Values: ENABLED | DISABLED | DELETED Type The type of the described resource. Type: String Valid Values: ROOM | EQUIPMENT Errors For information about the errors that are common to all actions, see Common Errors. EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization. HTTP Status Code: 400 InvalidParameterException One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members. DescribeResource 145 Amazon WorkMail API Reference HTTP Status Code: 400 UnsupportedOperationException You can't perform a write operation against a read-only directory. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 |
workmail-api-025 | workmail-api.pdf | 25 | system. HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members. DescribeResource 145 Amazon WorkMail API Reference HTTP Status Code: 400 UnsupportedOperationException You can't perform a write operation against a read-only directory. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 DescribeResource 146 API Reference Amazon WorkMail DescribeUser Service: Amazon WorkMail Provides information regarding the user. Request Syntax { "OrganizationId": "string", "UserId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. OrganizationId The identifier for the organization under which the user exists. Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes UserId 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: [email protected] • User name: user DescribeUser 147 Amazon WorkMail Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [a-zA-Z0-9._%+@-]+ Required: Yes Response Syntax { "City": "string", "Company": "string", "Country": "string", "Department": "string", "DisabledDate": number, "DisplayName": "string", "Email": "string", "EnabledDate": number, "FirstName": "string", "HiddenFromGlobalAddressList": boolean, "IdentityProviderIdentityStoreId": "string", "IdentityProviderUserId": "string", "Initials": "string", "JobTitle": "string", "LastName": "string", "MailboxDeprovisionedDate": number, "MailboxProvisionedDate": number, "Name": "string", "Office": "string", "State": "string", "Street": "string", "Telephone": "string", "UserId": "string", "UserRole": "string", "ZipCode": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. DescribeUser 148 Amazon WorkMail API Reference The following data is returned in JSON format by the service. City City where the user is located. Type: String Length Constraints: Maximum length of 256. Company Company of the user. Type: String Length Constraints: Maximum length of 256. Country Country where the user is located. Type: String Length Constraints: Maximum length of 256. Department Department of the user. Type: String Length Constraints: Maximum length of 256. DisabledDate The date and time at which the user was disabled for WorkMail usage, in UNIX epoch time format. Type: Timestamp DisplayName The display name of the user. Type: String Length Constraints: Maximum length of 256. DescribeUser 149 Amazon WorkMail Email The email of the user. Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 254. Pattern: [a-zA-Z0-9._%+-]{1,64}@[a-zA-Z0-9.-]+\.[a-zA-Z-]{2,} EnabledDate The date and time at which the user was enabled for WorkMailusage, in UNIX epoch time format. Type: Timestamp FirstName First name of the user. Type: String Length Constraints: Maximum length of 256. HiddenFromGlobalAddressList If enabled, the user is hidden from the global address list. Type: Boolean IdentityProviderIdentityStoreId Identity Store 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 36. Pattern: ^d-[0-9a-f]{10}$|^[0-9a-f]{8}\\b-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f] {4}-\\b[0-9a-f]{12}$ IdentityProviderUserId 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. DescribeUser 150 Amazon WorkMail Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 47. Pattern: ^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A- Fa-f0-9]{4}-[A-Fa-f0-9]{12}$ Initials Initials of the user. Type: String Length Constraints: Maximum length of 256. JobTitle Job title of the user. Type: String Length Constraints: Maximum length of 256. LastName Last name of the user. Type: String Length Constraints: Maximum length of 256. MailboxDeprovisionedDate The date when the mailbox was removed for the user. Type: Timestamp MailboxProvisionedDate The date when the mailbox was created for the user. Type: Timestamp Name The name for the user. DescribeUser 151 Amazon WorkMail Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [\w\-.]+(@[a-zA-Z0-9.\-]+\.[a-zA-Z0-9-]{2,})? Office Office where the user is located. Type: String Length Constraints: Maximum length of 256. State The state of a user: enabled (registered to WorkMail) or disabled (deregistered or never registered to WorkMail). Type: String Valid Values: ENABLED | DISABLED | DELETED Street Street where the user is located. Type: String Length Constraints: Maximum length of 256. Telephone User's contact number. Type: String Length Constraints: Maximum length of 256. UserId The identifier for the described user. Type: String Length Constraints: Minimum length of 12. Maximum length of 256. DescribeUser 152 Amazon WorkMail UserRole API Reference In certain cases, other |
workmail-api-026 | workmail-api.pdf | 26 | [\w\-.]+(@[a-zA-Z0-9.\-]+\.[a-zA-Z0-9-]{2,})? Office Office where the user is located. Type: String Length Constraints: Maximum length of 256. State The state of a user: enabled (registered to WorkMail) or disabled (deregistered or never registered to WorkMail). Type: String Valid Values: ENABLED | DISABLED | DELETED Street Street where the user is located. Type: String Length Constraints: Maximum length of 256. Telephone User's contact number. Type: String Length Constraints: Maximum length of 256. UserId The identifier for the described user. Type: String Length Constraints: Minimum length of 12. Maximum length of 256. DescribeUser 152 Amazon WorkMail UserRole API Reference In certain cases, other entities are modeled as users. If interoperability is enabled, resources are imported into WorkMail as users. Because different WorkMail organizations rely on different directory types, administrators can distinguish between an unregistered user (account is disabled and has a user role) and the directory administrators. The values are USER, RESOURCE, SYSTEM_USER, and REMOTE_USER. Type: String Valid Values: USER | RESOURCE | SYSTEM_USER | REMOTE_USER ZipCode Zip code of the user. Type: String Length Constraints: Maximum length of 256. Errors For information about the errors that are common to all actions, see Common Errors. DirectoryServiceAuthenticationFailedException The directory service doesn't recognize the credentials supplied by WorkMail. HTTP Status Code: 400 DirectoryUnavailableException The directory is unavailable. It might be located in another Region or deleted. HTTP Status Code: 400 EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization. HTTP Status Code: 400 InvalidParameterException One or more of the input parameters don't match the service's restrictions. DescribeUser 153 Amazon WorkMail API Reference HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 DescribeUser 154 Amazon WorkMail API Reference DisassociateDelegateFromResource Service: Amazon WorkMail Removes a member from the resource's set of delegates. Request Syntax { "EntityId": "string", "OrganizationId": "string", "ResourceId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. EntityId 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: [email protected] • Entity: entity Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [a-zA-Z0-9._%+@-]+ Required: Yes OrganizationId The identifier for the organization under which the resource exists. Type: String DisassociateDelegateFromResource 155 Amazon WorkMail API Reference Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes ResourceId 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: [email protected] • Resource name: resource Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [a-zA-Z0-9._%+@-]+ Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization. HTTP Status Code: 400 EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user. DisassociateDelegateFromResource 156 Amazon WorkMail HTTP Status Code: 400 InvalidParameterException API Reference One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 UnsupportedOperationException You can't perform a write operation against a read-only directory. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK |
workmail-api-027 | workmail-api.pdf | 27 | exist in the system. HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 UnsupportedOperationException You can't perform a write operation against a read-only directory. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 DisassociateDelegateFromResource 157 Amazon WorkMail • AWS SDK for Python • AWS SDK for Ruby V3 API Reference DisassociateDelegateFromResource 158 Amazon WorkMail API Reference DisassociateMemberFromGroup Service: Amazon WorkMail Removes a member from a group. Request Syntax { "GroupId": "string", "MemberId": "string", "OrganizationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. GroupId 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: [email protected] • Group name: group Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [a-zA-Z0-9._%+@-]+ Required: Yes MemberId The identifier for the member to be removed from the group. DisassociateMemberFromGroup 159 Amazon WorkMail API Reference 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: [email protected] • Member name: member Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [a-zA-Z0-9._%+@-]+ Required: Yes OrganizationId The identifier for the organization under which the group exists. Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. DirectoryServiceAuthenticationFailedException The directory service doesn't recognize the credentials supplied by WorkMail. HTTP Status Code: 400 DirectoryUnavailableException The directory is unavailable. It might be located in another Region or deleted. DisassociateMemberFromGroup 160 Amazon WorkMail HTTP Status Code: 400 EntityNotFoundException API Reference The identifier supplied for the user, group, or resource does not exist in your organization. HTTP Status Code: 400 EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user. HTTP Status Code: 400 InvalidParameterException One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 UnsupportedOperationException You can't perform a write operation against a read-only directory. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: DisassociateMemberFromGroup 161 API Reference Amazon WorkMail • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 DisassociateMemberFromGroup 162 Amazon WorkMail API Reference GetAccessControlEffect Service: Amazon WorkMail 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. Request Syntax { "Action": "string", "ImpersonationRoleId": "string", "IpAddress": "string", "OrganizationId": "string", "UserId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Action The access protocol action. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [a-zA-Z]+ Required: Yes ImpersonationRoleId The impersonation role ID. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. GetAccessControlEffect 163 Amazon WorkMail Pattern: [a-zA-Z0-9_-]+ Required: No IpAddress The IPv4 address. Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 15. Pattern: ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]| [1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$ Required: Yes OrganizationId The identifier for the organization. Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes UserId The user ID. Type: String Length Constraints: Minimum length of |
workmail-api-028 | workmail-api.pdf | 28 | AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [a-zA-Z]+ Required: Yes ImpersonationRoleId The impersonation role ID. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. GetAccessControlEffect 163 Amazon WorkMail Pattern: [a-zA-Z0-9_-]+ Required: No IpAddress The IPv4 address. Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 15. Pattern: ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]| [1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$ Required: Yes OrganizationId The identifier for the organization. Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes UserId The user ID. Type: String Length Constraints: Minimum length of 12. Maximum length of 256. Required: No Response Syntax { "Effect": "string", "MatchedRules": [ "string" ] GetAccessControlEffect 164 Amazon WorkMail } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. API Reference Effect The rule effect. Type: String Valid Values: ALLOW | DENY MatchedRules The rules that match the given parameters, resulting in an effect. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 10 items. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [a-zA-Z0-9_-]+ Errors For information about the errors that are common to all actions, see Common Errors. EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization. HTTP Status Code: 400 InvalidParameterException One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 GetAccessControlEffect 165 Amazon WorkMail API Reference OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 ResourceNotFoundException The resource cannot be found. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 GetAccessControlEffect 166 Amazon WorkMail API Reference GetDefaultRetentionPolicy Service: Amazon WorkMail Gets the default retention policy details for the specified organization. Request Syntax { "OrganizationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. OrganizationId The organization ID. Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes Response Syntax { "Description": "string", "FolderConfigurations": [ { "Action": "string", "Name": "string", "Period": number } ], "Id": "string", "Name": "string" GetDefaultRetentionPolicy 167 Amazon WorkMail } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. API Reference Description The retention policy description. Type: String Length Constraints: Maximum length of 256. FolderConfigurations The retention policy folder configurations. Type: Array of FolderConfiguration objects Id The retention policy ID. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [a-zA-Z0-9_-]+ Name The retention policy name. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [a-zA-Z0-9_-]+ Errors For information about the errors that are common to all actions, see Common Errors. GetDefaultRetentionPolicy 168 Amazon WorkMail EntityNotFoundException API Reference The identifier supplied for the user, group, or resource does not exist in your organization. HTTP Status Code: 400 InvalidParameterException One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python GetDefaultRetentionPolicy 169 Amazon WorkMail • AWS SDK for Ruby V3 API Reference GetDefaultRetentionPolicy 170 Amazon WorkMail GetImpersonationRole Service: Amazon WorkMail Gets the impersonation role details for the given WorkMail organization. API Reference Request Syntax { "ImpersonationRoleId": "string", "OrganizationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON |
workmail-api-029 | workmail-api.pdf | 29 | for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python GetDefaultRetentionPolicy 169 Amazon WorkMail • AWS SDK for Ruby V3 API Reference GetDefaultRetentionPolicy 170 Amazon WorkMail GetImpersonationRole Service: Amazon WorkMail Gets the impersonation role details for the given WorkMail organization. API Reference Request Syntax { "ImpersonationRoleId": "string", "OrganizationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ImpersonationRoleId The impersonation role ID to retrieve. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [a-zA-Z0-9_-]+ Required: Yes OrganizationId The WorkMail organization from which to retrieve the impersonation role. Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes GetImpersonationRole 171 Amazon WorkMail Response Syntax { "DateCreated": number, "DateModified": number, "Description": "string", "ImpersonationRoleId": "string", "Name": "string", "Rules": [ { "Description": "string", "Effect": "string", "ImpersonationRuleId": "string", "Name": "string", "NotTargetUsers": [ "string" ], "TargetUsers": [ "string" ] } ], "Type": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. DateCreated The date when the impersonation role was created. Type: Timestamp DateModified The date when the impersonation role was last modified. Type: Timestamp Description The impersonation role description. Type: String GetImpersonationRole API Reference 172 Amazon WorkMail API Reference Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [^\x00-\x09\x0B\x0C\x0E-\x1F\x7F\x3C\x3E\x5C]+ ImpersonationRoleId The impersonation role ID. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [a-zA-Z0-9_-]+ Name The impersonation role name. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [^\x00-\x1F\x7F\x3C\x3E\x5C]+ Rules The list of rules for the given impersonation role. Type: Array of ImpersonationRule objects Array Members: Minimum number of 0 items. Maximum number of 10 items. Type The impersonation role type. Type: String Valid Values: FULL_ACCESS | READ_ONLY Errors For information about the errors that are common to all actions, see Common Errors. InvalidParameterException One or more of the input parameters don't match the service's restrictions. GetImpersonationRole 173 Amazon WorkMail API Reference HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 ResourceNotFoundException The resource cannot be found. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 GetImpersonationRole 174 Amazon WorkMail API Reference GetImpersonationRoleEffect Service: Amazon WorkMail Tests whether the given impersonation role can impersonate a target user. Request Syntax { "ImpersonationRoleId": "string", "OrganizationId": "string", "TargetUser": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ImpersonationRoleId The impersonation role ID to test. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [a-zA-Z0-9_-]+ Required: Yes OrganizationId The WorkMail organization where the impersonation role is defined. Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes GetImpersonationRoleEffect 175 Amazon WorkMail TargetUser API Reference 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: [email protected] • User name: user Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [a-zA-Z0-9._%+@-]+ Required: Yes Response Syntax { "Effect": "string", "MatchedRules": [ { "ImpersonationRuleId": "string", "Name": "string" } ], "Type": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Effect Effect of the impersonation role on the target user based on its rules. Available effects are ALLOW or DENY. GetImpersonationRoleEffect 176 Amazon WorkMail Type: String Valid Values: ALLOW | DENY MatchedRules A list of the rules that match the input and produce the configured effect. Type: Array of ImpersonationMatchedRule objects Array Members: Minimum number of 0 items. Maximum number of 10 items. API Reference Type The impersonation role type. Type: String Valid Values: FULL_ACCESS | READ_ONLY Errors For information about the errors that are common to all actions, see Common Errors. EntityNotFoundException The identifier supplied for |
workmail-api-030 | workmail-api.pdf | 30 | by the service. Effect Effect of the impersonation role on the target user based on its rules. Available effects are ALLOW or DENY. GetImpersonationRoleEffect 176 Amazon WorkMail Type: String Valid Values: ALLOW | DENY MatchedRules A list of the rules that match the input and produce the configured effect. Type: Array of ImpersonationMatchedRule objects Array Members: Minimum number of 0 items. Maximum number of 10 items. API Reference Type The impersonation role type. Type: String Valid Values: FULL_ACCESS | READ_ONLY Errors For information about the errors that are common to all actions, see Common Errors. EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization. HTTP Status Code: 400 EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user. HTTP Status Code: 400 InvalidParameterException One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. GetImpersonationRoleEffect 177 Amazon WorkMail HTTP Status Code: 400 OrganizationStateException API Reference The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 ResourceNotFoundException The resource cannot be found. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 GetImpersonationRoleEffect 178 Amazon WorkMail GetMailboxDetails Service: Amazon WorkMail Requests a user's mailbox details for a specified organization and user. API Reference Request Syntax { "OrganizationId": "string", "UserId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. OrganizationId The identifier for the organization that contains the user whose mailbox details are being requested. Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes UserId 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: [email protected] GetMailboxDetails 179 Amazon WorkMail • User name: user Type: String Length Constraints: Minimum length of 1. Maximum length of 256. API Reference Pattern: [a-zA-Z0-9._%+@-]+ Required: Yes Response Syntax { "MailboxQuota": number, "MailboxSize": number } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. MailboxQuota The maximum allowed mailbox size, in MB, for the specified user. Type: Integer Valid Range: Minimum value of 1. MailboxSize The current mailbox size, in MB, for the specified user. Type: Double Valid Range: Minimum value of 0. Errors For information about the errors that are common to all actions, see Common Errors. GetMailboxDetails 180 Amazon WorkMail EntityNotFoundException API Reference The identifier supplied for the user, group, or resource does not exist in your organization. HTTP Status Code: 400 InvalidParameterException One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python GetMailboxDetails 181 Amazon WorkMail • AWS SDK for Ruby V3 API Reference GetMailboxDetails 182 Amazon WorkMail GetMailDomain Service: Amazon WorkMail API Reference Gets details for a mail domain, including domain records required to configure your domain with recommended security. Request Syntax { "DomainName": "string", "OrganizationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. DomainName The domain from which you want to retrieve details. Type: String Length Constraints: Minimum length of 3. Maximum length of 209. Pattern: [a-zA-Z0-9.-]+ Required: Yes OrganizationId The WorkMail organization for which the domain is retrieved. Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ |
workmail-api-031 | workmail-api.pdf | 31 | Amazon WorkMail API Reference Gets details for a mail domain, including domain records required to configure your domain with recommended security. Request Syntax { "DomainName": "string", "OrganizationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. DomainName The domain from which you want to retrieve details. Type: String Length Constraints: Minimum length of 3. Maximum length of 209. Pattern: [a-zA-Z0-9.-]+ Required: Yes OrganizationId The WorkMail organization for which the domain is retrieved. Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes GetMailDomain 183 API Reference Amazon WorkMail Response Syntax { "DkimVerificationStatus": "string", "IsDefault": boolean, "IsTestDomain": boolean, "OwnershipVerificationStatus": "string", "Records": [ { "Hostname": "string", "Type": "string", "Value": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. DkimVerificationStatus Indicates the status of a DKIM verification. Type: String Valid Values: PENDING | VERIFIED | FAILED IsDefault Specifies whether the domain is the default domain for your organization. Type: Boolean IsTestDomain Specifies whether the domain is a test domain provided by WorkMail, or a custom domain. Type: Boolean OwnershipVerificationStatus Indicates the status of the domain ownership verification. GetMailDomain 184 Amazon WorkMail Type: String Valid Values: PENDING | VERIFIED | FAILED Records API Reference A list of the DNS records that WorkMail recommends adding in your DNS provider for the best user experience. The records configure your domain with DMARC, SPF, DKIM, and direct incoming email traffic to SES. See admin guide for more details. Type: Array of DnsRecord objects Errors For information about the errors that are common to all actions, see Common Errors. InvalidParameterException One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 MailDomainNotFoundException The domain specified is not found in your organization. HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 GetMailDomain 185 Amazon WorkMail See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 GetMailDomain 186 Amazon WorkMail API Reference GetMobileDeviceAccessEffect Service: Amazon WorkMail 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. Request Syntax { "DeviceModel": "string", "DeviceOperatingSystem": "string", "DeviceType": "string", "DeviceUserAgent": "string", "OrganizationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. DeviceModel Device model the simulated user will report. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [\u0020-\u00FF]+ Required: No DeviceOperatingSystem Device operating system the simulated user will report. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. GetMobileDeviceAccessEffect 187 Amazon WorkMail API Reference Pattern: [\u0020-\u00FF]+ Required: No DeviceType Device type the simulated user will report. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [\u0020-\u00FF]+ Required: No DeviceUserAgent Device user agent the simulated user will report. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [\u0020-\u00FF]+ Required: No OrganizationId The WorkMail organization to simulate the access effect for. Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes Response Syntax { "Effect": "string", "MatchedRules": [ GetMobileDeviceAccessEffect 188 Amazon WorkMail API Reference { "MobileDeviceAccessRuleId": "string", "Name": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Effect The effect of the simulated access, ALLOW or DENY, after evaluating mobile device access rules in the WorkMail organization for the simulated user parameters. Type: String Valid Values: ALLOW | DENY MatchedRules A list of the rules which matched the simulated user input and produced the effect. Type: Array of MobileDeviceAccessMatchedRule objects Array Members: Minimum number of 0 items. Maximum number of 10 items. Errors For information about the errors that are common to all actions, see Common Errors. InvalidParameterException One or more of the input parameters don't |
workmail-api-032 | workmail-api.pdf | 32 | The following data is returned in JSON format by the service. Effect The effect of the simulated access, ALLOW or DENY, after evaluating mobile device access rules in the WorkMail organization for the simulated user parameters. Type: String Valid Values: ALLOW | DENY MatchedRules A list of the rules which matched the simulated user input and produced the effect. Type: Array of MobileDeviceAccessMatchedRule objects Array Members: Minimum number of 0 items. Maximum number of 10 items. Errors For information about the errors that are common to all actions, see Common Errors. InvalidParameterException One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. GetMobileDeviceAccessEffect 189 Amazon WorkMail HTTP Status Code: 400 OrganizationStateException API Reference The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 GetMobileDeviceAccessEffect 190 Amazon WorkMail API Reference GetMobileDeviceAccessOverride Service: Amazon WorkMail Gets the mobile device access override for the given WorkMail organization, user, and device. Request Syntax { "DeviceId": "string", "OrganizationId": "string", "UserId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. DeviceId The mobile device to which the override applies. DeviceId is case insensitive. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. Pattern: [A-Za-z0-9]+ Required: Yes OrganizationId The WorkMail organization to which you want to apply the override. Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes GetMobileDeviceAccessOverride 191 Amazon WorkMail UserId API Reference 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: [email protected] • User name: user Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [a-zA-Z0-9._%+@-]+ Required: Yes Response Syntax { "DateCreated": number, "DateModified": number, "Description": "string", "DeviceId": "string", "Effect": "string", "UserId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. DateCreated The date the override was first created. Type: Timestamp DateModified The date the description was last modified. GetMobileDeviceAccessOverride 192 API Reference Amazon WorkMail Type: Timestamp Description A description of the override. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [\S\s]+ DeviceId The device to which the access override applies. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. Pattern: [A-Za-z0-9]+ Effect The effect of the override, ALLOW or DENY. Type: String Valid Values: ALLOW | DENY UserId The WorkMail user to which the access override applies. Type: String Length Constraints: Minimum length of 12. Maximum length of 256. Errors For information about the errors that are common to all actions, see Common Errors. EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization. GetMobileDeviceAccessOverride 193 Amazon WorkMail HTTP Status Code: 400 InvalidParameterException API Reference One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 ResourceNotFoundException The resource cannot be found. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 GetMobileDeviceAccessOverride 194 Amazon WorkMail • AWS SDK for Python • AWS SDK for Ruby V3 API Reference GetMobileDeviceAccessOverride 195 Amazon WorkMail API Reference GetPersonalAccessTokenMetadata Service: Amazon WorkMail Requests details of a specific Personal Access Token within the WorkMail organization. Request Syntax { "OrganizationId": "string", "PersonalAccessTokenId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. OrganizationId The Organization ID. Type: String Length Constraints: Fixed length of |
workmail-api-033 | workmail-api.pdf | 33 | • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 GetMobileDeviceAccessOverride 194 Amazon WorkMail • AWS SDK for Python • AWS SDK for Ruby V3 API Reference GetMobileDeviceAccessOverride 195 Amazon WorkMail API Reference GetPersonalAccessTokenMetadata Service: Amazon WorkMail Requests details of a specific Personal Access Token within the WorkMail organization. Request Syntax { "OrganizationId": "string", "PersonalAccessTokenId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. OrganizationId The Organization ID. Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes PersonalAccessTokenId The Personal Access Token ID. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [a-zA-Z0-9_-]+ Required: Yes GetPersonalAccessTokenMetadata 196 API Reference Amazon WorkMail Response Syntax { "DateCreated": number, "DateLastUsed": number, "ExpiresTime": number, "Name": "string", "PersonalAccessTokenId": "string", "Scopes": [ "string" ], "UserId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. DateCreated The date when the Personal Access Token ID was created. Type: Timestamp DateLastUsed The date when the Personal Access Token ID was last used. Type: Timestamp ExpiresTime The time when the Personal Access Token ID will expire. Type: Timestamp Name The Personal Access Token name. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [^\x00-\x1F\x7F\x3C\x3E\x5C]+ GetPersonalAccessTokenMetadata 197 Amazon WorkMail PersonalAccessTokenId The Personal Access Token ID. Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [a-zA-Z0-9_-]+ Scopes Lists all the Personal Access Token permissions for a mailbox. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 10 items. Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [^\x00-\x1F\x7F\x3C\x3E\x5C]+ UserId The WorkMail User ID. Type: String Length Constraints: Minimum length of 12. Maximum length of 256. Errors For information about the errors that are common to all actions, see Common Errors. InvalidParameterException One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. GetPersonalAccessTokenMetadata 198 Amazon WorkMail HTTP Status Code: 400 OrganizationStateException API Reference The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 ResourceNotFoundException The resource cannot be found. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 GetPersonalAccessTokenMetadata 199 Amazon WorkMail ListAccessControlRules Service: Amazon WorkMail Lists the access control rules for the specified organization. API Reference Request Syntax { "OrganizationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. OrganizationId The identifier for the organization. Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes Response Syntax { "Rules": [ { "Actions": [ "string" ], "DateCreated": number, "DateModified": number, "Description": "string", "Effect": "string", "ImpersonationRoleIds": [ "string" ], ListAccessControlRules 200 Amazon WorkMail API Reference "IpRanges": [ "string" ], "Name": "string", "NotActions": [ "string" ], "NotImpersonationRoleIds": [ "string" ], "NotIpRanges": [ "string" ], "NotUserIds": [ "string" ], "UserIds": [ "string" ] } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Rules The access control rules. Type: Array of AccessControlRule objects Array Members: Minimum number of 0 items. Maximum number of 10 items. Errors For information about the errors that are common to all actions, see Common Errors. OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 ListAccessControlRules 201 Amazon WorkMail See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 ListAccessControlRules 202 Amazon |
workmail-api-034 | workmail-api.pdf | 34 | a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 ListAccessControlRules 201 Amazon WorkMail See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 ListAccessControlRules 202 Amazon WorkMail ListAliases Service: Amazon WorkMail Creates a paginated call to list the aliases associated with a given entity. API Reference Request Syntax { "EntityId": "string", "MaxResults": number, "NextToken": "string", "OrganizationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. EntityId The identifier for the entity for which to list the aliases. Type: String Length Constraints: Minimum length of 12. Maximum length of 256. Required: Yes MaxResults The maximum number of results to return in a single call. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No NextToken The token to use to retrieve the next page of results. The first call does not contain any tokens. ListAliases 203 Amazon WorkMail Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: [\S\s]*|[a-zA-Z0-9/+=]{1,1024} Required: No OrganizationId The identifier for the organization under which the entity exists. Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes Response Syntax { "Aliases": [ "string" ], "NextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Aliases The entity's paginated aliases. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 254. Pattern: [a-zA-Z0-9._%+-]{1,64}@[a-zA-Z0-9.-]+\.[a-zA-Z-]{2,} ListAliases 204 Amazon WorkMail NextToken API Reference The token to use to retrieve the next page of results. The value is "null" when there are no more results to return. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: [\S\s]*|[a-zA-Z0-9/+=]{1,1024} Errors For information about the errors that are common to all actions, see Common Errors. EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization. HTTP Status Code: 400 EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user. HTTP Status Code: 400 InvalidParameterException One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members. ListAliases 205 Amazon WorkMail HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 ListAliases 206 Amazon WorkMail API Reference ListAvailabilityConfigurations Service: Amazon WorkMail List all the AvailabilityConfiguration's for the given WorkMail organization. Request Syntax { "MaxResults": number, "NextToken": "string", "OrganizationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. MaxResults The maximum number of results to return in a single call. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No NextToken The token to use to retrieve the next page of results. The first call does not require a token. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: [\S\s]*|[a-zA-Z0-9/+=]{1,1024} Required: No OrganizationId The WorkMail organization for which the AvailabilityConfiguration's will be listed. Type: String ListAvailabilityConfigurations 207 Amazon WorkMail API Reference Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes Response Syntax { "AvailabilityConfigurations": [ { "DateCreated": number, "DateModified": number, "DomainName": "string", "EwsProvider": { "EwsEndpoint": "string", "EwsUsername": "string" }, "LambdaProvider": { "LambdaArn": "string" }, "ProviderType": "string" } ], "NextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. AvailabilityConfigurations The list of AvailabilityConfiguration's that exist for the specified WorkMail organization. Type: Array of AvailabilityConfiguration objects NextToken |
workmail-api-035 | workmail-api.pdf | 35 | for which the AvailabilityConfiguration's will be listed. Type: String ListAvailabilityConfigurations 207 Amazon WorkMail API Reference Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes Response Syntax { "AvailabilityConfigurations": [ { "DateCreated": number, "DateModified": number, "DomainName": "string", "EwsProvider": { "EwsEndpoint": "string", "EwsUsername": "string" }, "LambdaProvider": { "LambdaArn": "string" }, "ProviderType": "string" } ], "NextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. AvailabilityConfigurations The list of AvailabilityConfiguration's that exist for the specified WorkMail organization. Type: Array of AvailabilityConfiguration objects NextToken The token to use to retrieve the next page of results. The value is null when there are no further results to return. ListAvailabilityConfigurations 208 Amazon WorkMail Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: [\S\s]*|[a-zA-Z0-9/+=]{1,1024} Errors For information about the errors that are common to all actions, see Common Errors. InvalidParameterException One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 ListAvailabilityConfigurations 209 Amazon WorkMail • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference ListAvailabilityConfigurations 210 Amazon WorkMail ListGroupMembers Service: Amazon WorkMail API Reference Returns an overview of the members of a group. Users and groups can be members of a group. Request Syntax { "GroupId": "string", "MaxResults": number, "NextToken": "string", "OrganizationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. GroupId 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: [email protected] • Group name: group Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [a-zA-Z0-9._%+@-]+ Required: Yes MaxResults The maximum number of results to return in a single call. ListGroupMembers 211 Amazon WorkMail Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. API Reference Required: No NextToken The token to use to retrieve the next page of results. The first call does not contain any tokens. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: [\S\s]*|[a-zA-Z0-9/+=]{1,1024} Required: No OrganizationId The identifier for the organization under which the group exists. Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes Response Syntax { "Members": [ { "DisabledDate": number, "EnabledDate": number, "Id": "string", "Name": "string", "State": "string", "Type": "string" } ], "NextToken": "string" ListGroupMembers 212 API Reference Amazon WorkMail } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Members The members associated to the group. Type: Array of Member objects NextToken The token to use to retrieve the next page of results. The first call does not contain any tokens. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: [\S\s]*|[a-zA-Z0-9/+=]{1,1024} Errors For information about the errors that are common to all actions, see Common Errors. EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization. HTTP Status Code: 400 EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user. HTTP Status Code: 400 InvalidParameterException One or more of the input parameters don't match the service's restrictions. ListGroupMembers 213 Amazon WorkMail API Reference HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK |
workmail-api-036 | workmail-api.pdf | 36 | Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 ListGroupMembers 214 API Reference Amazon WorkMail ListGroups Service: Amazon WorkMail Returns summaries of the organization's groups. Request Syntax { "Filters": { "NamePrefix": "string", "PrimaryEmailPrefix": "string", "State": "string" }, "MaxResults": number, "NextToken": "string", "OrganizationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Filters Limit the search results based on the filter criteria. Only one filter per request is supported. Type: ListGroupsFilters object Required: No MaxResults The maximum number of results to return in a single call. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No NextToken The token to use to retrieve the next page of results. The first call does not contain any tokens. ListGroups 215 Amazon WorkMail Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: [\S\s]*|[a-zA-Z0-9/+=]{1,1024} Required: No OrganizationId The identifier for the organization under which the groups exist. Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes Response Syntax { "Groups": [ { "DisabledDate": number, "Email": "string", "EnabledDate": number, "Id": "string", "Name": "string", "State": "string" } ], "NextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ListGroups 216 Amazon WorkMail Groups The overview of groups for an organization. Type: Array of Group objects NextToken API Reference The token to use to retrieve the next page of results. The value is "null" when there are no more results to return. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: [\S\s]*|[a-zA-Z0-9/+=]{1,1024} Errors For information about the errors that are common to all actions, see Common Errors. EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization. HTTP Status Code: 400 InvalidParameterException One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members. ListGroups 217 Amazon WorkMail HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 ListGroups 218 API Reference Amazon WorkMail ListGroupsForEntity Service: Amazon WorkMail Returns all the groups to which an entity belongs. Request Syntax { "EntityId": "string", "Filters": { "GroupNamePrefix": "string" }, "MaxResults": number, "NextToken": "string", "OrganizationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. EntityId 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: [email protected] • Entity name: entity Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [a-zA-Z0-9._%+@-]+ Required: Yes ListGroupsForEntity 219 API Reference Amazon WorkMail Filters Limit the search results based on the filter criteria. Type: ListGroupsForEntityFilters object Required: No MaxResults The maximum number of results to return in a single call. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No NextToken The token to use to retrieve the next page of results. The first call does not contain any tokens. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: [\S\s]*|[a-zA-Z0-9/+=]{1,1024} Required: No OrganizationId The identifier for the organization under which the entity exists. Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes Response Syntax { "Groups": [ ListGroupsForEntity 220 Amazon WorkMail API Reference |
workmail-api-037 | workmail-api.pdf | 37 | ListGroupsForEntityFilters object Required: No MaxResults The maximum number of results to return in a single call. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No NextToken The token to use to retrieve the next page of results. The first call does not contain any tokens. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: [\S\s]*|[a-zA-Z0-9/+=]{1,1024} Required: No OrganizationId The identifier for the organization under which the entity exists. Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes Response Syntax { "Groups": [ ListGroupsForEntity 220 Amazon WorkMail API Reference { "GroupId": "string", "GroupName": "string" } ], "NextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Groups The overview of groups in an organization. Type: Array of GroupIdentifier objects NextToken The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: [\S\s]*|[a-zA-Z0-9/+=]{1,1024} Errors For information about the errors that are common to all actions, see Common Errors. EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization. HTTP Status Code: 400 EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user. ListGroupsForEntity 221 Amazon WorkMail HTTP Status Code: 400 InvalidParameterException API Reference One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 ListGroupsForEntity 222 Amazon WorkMail API Reference ListImpersonationRoles Service: Amazon WorkMail Lists all the impersonation roles for the given WorkMail organization. Request Syntax { "MaxResults": number, "NextToken": "string", "OrganizationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. MaxResults The maximum number of results returned in a single call. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No NextToken The token used to retrieve the next page of results. The first call doesn't require a token. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: [\S\s]*|[a-zA-Z0-9/+=]{1,1024} Required: No OrganizationId The WorkMail organization to which the listed impersonation roles belong. ListImpersonationRoles 223 API Reference Amazon WorkMail Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes Response Syntax { "NextToken": "string", "Roles": [ { "DateCreated": number, "DateModified": number, "ImpersonationRoleId": "string", "Name": "string", "Type": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextToken The token to retrieve the next page of results. The value is null when there are no results to return. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: [\S\s]*|[a-zA-Z0-9/+=]{1,1024} Roles The list of impersonation roles under the given WorkMail organization. ListImpersonationRoles 224 Amazon WorkMail API Reference Type: Array of ImpersonationRole objects Array Members: Minimum number of 0 items. Maximum number of 20 items. Errors For information about the errors that are common to all actions, see Common Errors. InvalidParameterException One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin ListImpersonationRoles 225 Amazon WorkMail • AWS SDK for PHP V3 • AWS SDK for Python • AWS |
workmail-api-038 | workmail-api.pdf | 38 | HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin ListImpersonationRoles 225 Amazon WorkMail • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference ListImpersonationRoles 226 Amazon WorkMail ListMailboxExportJobs Service: Amazon WorkMail API Reference Lists the mailbox export jobs started for the specified organization within the last seven days. Request Syntax { "MaxResults": number, "NextToken": "string", "OrganizationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. MaxResults The maximum number of results to return in a single call. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No NextToken The token to use to retrieve the next page of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: [\S\s]*|[a-zA-Z0-9/+=]{1,1024} Required: No OrganizationId The organization ID. ListMailboxExportJobs 227 API Reference Amazon WorkMail Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes Response Syntax { "Jobs": [ { "Description": "string", "EndTime": number, "EntityId": "string", "EstimatedProgress": number, "JobId": "string", "S3BucketName": "string", "S3Path": "string", "StartTime": number, "State": "string" } ], "NextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Jobs The mailbox export job details. Type: Array of MailboxExportJob objects NextToken The token to use to retrieve the next page of results. ListMailboxExportJobs 228 Amazon WorkMail Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: [\S\s]*|[a-zA-Z0-9/+=]{1,1024} Errors For information about the errors that are common to all actions, see Common Errors. InvalidParameterException One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 ListMailboxExportJobs 229 Amazon WorkMail • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference ListMailboxExportJobs 230 Amazon WorkMail API Reference ListMailboxPermissions Service: Amazon WorkMail Lists the mailbox permissions associated with a user, group, or resource mailbox. Request Syntax { "EntityId": "string", "MaxResults": number, "NextToken": "string", "OrganizationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. EntityId 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: [email protected] • Entity name: entity Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [a-zA-Z0-9._%+@-]+ Required: Yes MaxResults The maximum number of results to return in a single call. ListMailboxPermissions 231 Amazon WorkMail Type: Integer API Reference Valid Range: Minimum value of 1. Maximum value of 100. Required: No NextToken The token to use to retrieve the next page of results. The first call does not contain any tokens. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: [\S\s]*|[a-zA-Z0-9/+=]{1,1024} Required: No OrganizationId The identifier of the organization under which the user, group, or resource exists. Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes Response Syntax { "NextToken": "string", "Permissions": [ { "GranteeId": "string", "GranteeType": "string", "PermissionValues": [ "string" ] } ] } ListMailboxPermissions 232 Amazon WorkMail Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextToken The token to use to retrieve the next page of results. The value is "null" when there are no more results to return. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: [\S\s]*|[a-zA-Z0-9/+=]{1,1024} Permissions One page of the user, |
workmail-api-039 | workmail-api.pdf | 39 | 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes Response Syntax { "NextToken": "string", "Permissions": [ { "GranteeId": "string", "GranteeType": "string", "PermissionValues": [ "string" ] } ] } ListMailboxPermissions 232 Amazon WorkMail Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextToken The token to use to retrieve the next page of results. The value is "null" when there are no more results to return. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: [\S\s]*|[a-zA-Z0-9/+=]{1,1024} Permissions One page of the user, group, or resource mailbox permissions. Type: Array of Permission objects Errors For information about the errors that are common to all actions, see Common Errors. EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization. HTTP Status Code: 400 InvalidParameterException One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 ListMailboxPermissions 233 Amazon WorkMail OrganizationStateException API Reference The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 ListMailboxPermissions 234 Amazon WorkMail ListMailDomains Service: Amazon WorkMail Lists the mail domains in a given WorkMail organization. API Reference Request Syntax { "MaxResults": number, "NextToken": "string", "OrganizationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. MaxResults The maximum number of results to return in a single call. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No NextToken The token to use to retrieve the next page of results. The first call does not require a token. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: [\S\s]*|[a-zA-Z0-9/+=]{1,1024} Required: No OrganizationId The WorkMail organization for which to list domains. ListMailDomains 235 API Reference Amazon WorkMail Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes Response Syntax { "MailDomains": [ { "DefaultDomain": boolean, "DomainName": "string" } ], "NextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. MailDomains The list of mail domain summaries, specifying domains that exist in the specified WorkMail organization, along with the information about whether the domain is or isn't the default. Type: Array of MailDomainSummary objects NextToken The token to use to retrieve the next page of results. The value becomes null when there are no more results to return. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: [\S\s]*|[a-zA-Z0-9/+=]{1,1024} ListMailDomains 236 Amazon WorkMail Errors API Reference For information about the errors that are common to all actions, see Common Errors. InvalidParameterException One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 ListMailDomains 237 Amazon WorkMail API Reference ListMailDomains 238 Amazon WorkMail API Reference ListMobileDeviceAccessOverrides Service: Amazon WorkMail Lists all the mobile device access overrides for any given combination of WorkMail organization, user, or device. Request Syntax { "DeviceId": "string", "MaxResults": number, "NextToken": "string", "OrganizationId": "string", "UserId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. DeviceId The mobile device to which the access override applies. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. Pattern: [A-Za-z0-9]+ Required: No MaxResults The maximum number of results |
workmail-api-040 | workmail-api.pdf | 40 | API Reference ListMailDomains 238 Amazon WorkMail API Reference ListMobileDeviceAccessOverrides Service: Amazon WorkMail Lists all the mobile device access overrides for any given combination of WorkMail organization, user, or device. Request Syntax { "DeviceId": "string", "MaxResults": number, "NextToken": "string", "OrganizationId": "string", "UserId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. DeviceId The mobile device to which the access override applies. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. Pattern: [A-Za-z0-9]+ Required: No MaxResults The maximum number of results to return in a single call. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. ListMobileDeviceAccessOverrides 239 Amazon WorkMail Required: No NextToken API Reference The token to use to retrieve the next page of results. The first call does not require a token. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: [\S\s]*|[a-zA-Z0-9/+=]{1,1024} Required: No OrganizationId The WorkMail organization under which to list mobile device access overrides. Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes UserId The WorkMail user under which you list the mobile device access overrides. Accepts the following types of user identities: • User ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234 • Email address: [email protected] • User name: user Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [a-zA-Z0-9._%+@-]+ Required: No ListMobileDeviceAccessOverrides 240 API Reference Amazon WorkMail Response Syntax { "NextToken": "string", "Overrides": [ { "DateCreated": number, "DateModified": number, "Description": "string", "DeviceId": "string", "Effect": "string", "UserId": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextToken The token to use to retrieve the next page of results. The value is “null” when there are no more results to return. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: [\S\s]*|[a-zA-Z0-9/+=]{1,1024} Overrides The list of mobile device access overrides that exist for the specified WorkMail organization and user. Type: Array of MobileDeviceAccessOverride objects Errors For information about the errors that are common to all actions, see Common Errors. ListMobileDeviceAccessOverrides 241 Amazon WorkMail EntityNotFoundException API Reference The identifier supplied for the user, group, or resource does not exist in your organization. HTTP Status Code: 400 InvalidParameterException One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python ListMobileDeviceAccessOverrides 242 Amazon WorkMail • AWS SDK for Ruby V3 API Reference ListMobileDeviceAccessOverrides 243 Amazon WorkMail API Reference ListMobileDeviceAccessRules Service: Amazon WorkMail Lists the mobile device access rules for the specified WorkMail organization. Request Syntax { "OrganizationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. OrganizationId The WorkMail organization for which to list the rules. Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes Response Syntax { "Rules": [ { "DateCreated": number, "DateModified": number, "Description": "string", "DeviceModels": [ "string" ], "DeviceOperatingSystems": [ "string" ], "DeviceTypes": [ "string" ], ListMobileDeviceAccessRules 244 Amazon WorkMail API Reference "DeviceUserAgents": [ "string" ], "Effect": "string", "MobileDeviceAccessRuleId": "string", "Name": "string", "NotDeviceModels": [ "string" ], "NotDeviceOperatingSystems": [ "string" ], "NotDeviceTypes": [ "string" ], "NotDeviceUserAgents": [ "string" ] } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Rules The list of mobile device access rules that exist under the specified WorkMail organization. Type: Array of MobileDeviceAccessRule objects Array Members: Minimum number of 0 items. Maximum number of 10 items. Errors For information about the errors that are common to all actions, see Common Errors. InvalidParameterException One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 ListMobileDeviceAccessRules 245 Amazon WorkMail OrganizationStateException API Reference The organization must have a valid state to perform certain operations on the organization or its members. |
workmail-api-041 | workmail-api.pdf | 41 | exist under the specified WorkMail organization. Type: Array of MobileDeviceAccessRule objects Array Members: Minimum number of 0 items. Maximum number of 10 items. Errors For information about the errors that are common to all actions, see Common Errors. InvalidParameterException One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 ListMobileDeviceAccessRules 245 Amazon WorkMail OrganizationStateException API Reference The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 ListMobileDeviceAccessRules 246 API Reference Amazon WorkMail ListOrganizations Service: Amazon WorkMail Returns summaries of the customer's organizations. Request Syntax { "MaxResults": number, "NextToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. MaxResults The maximum number of results to return in a single call. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No NextToken The token to use to retrieve the next page of results. The first call does not contain any tokens. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: [\S\s]*|[a-zA-Z0-9/+=]{1,1024} Required: No Response Syntax { ListOrganizations 247 Amazon WorkMail API Reference "NextToken": "string", "OrganizationSummaries": [ { "Alias": "string", "DefaultMailDomain": "string", "ErrorMessage": "string", "OrganizationId": "string", "State": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextToken The token to use to retrieve the next page of results. The value is "null" when there are no more results to return. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: [\S\s]*|[a-zA-Z0-9/+=]{1,1024} OrganizationSummaries The overview of owned organizations presented as a list of organization summaries. Type: Array of OrganizationSummary objects Errors For information about the errors that are common to all actions, see Common Errors. InvalidParameterException One or more of the input parameters don't match the service's restrictions. ListOrganizations 248 Amazon WorkMail HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 ListOrganizations 249 Amazon WorkMail API Reference ListPersonalAccessTokens Service: Amazon WorkMail Returns a summary of your Personal Access Tokens. Request Syntax { "MaxResults": number, "NextToken": "string", "OrganizationId": "string", "UserId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. MaxResults The maximum amount of items that should be returned in a response. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No NextToken The token from the previous response to query the next page. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: [\S\s]*|[a-zA-Z0-9/+=]{1,1024} Required: No OrganizationId The Organization ID. ListPersonalAccessTokens 250 API Reference Amazon WorkMail Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes UserId The WorkMail User ID. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [a-zA-Z0-9._%+@-]+ Required: No Response Syntax { "NextToken": "string", "PersonalAccessTokenSummaries": [ { "DateCreated": number, "DateLastUsed": number, "ExpiresTime": number, "Name": "string", "PersonalAccessTokenId": "string", "Scopes": [ "string" ], "UserId": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ListPersonalAccessTokens 251 Amazon WorkMail NextToken API Reference The token from the previous response to query the next page. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: [\S\s]*|[a-zA-Z0-9/+=]{1,1024} PersonalAccessTokenSummaries Lists all the personal tokens in an organization or user, if user ID is provided. Type: Array of PersonalAccessTokenSummary objects Errors For information about the errors that are common to all actions, see Common Errors. EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization. |
workmail-api-042 | workmail-api.pdf | 42 | back an HTTP 200 response. The following data is returned in JSON format by the service. ListPersonalAccessTokens 251 Amazon WorkMail NextToken API Reference The token from the previous response to query the next page. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: [\S\s]*|[a-zA-Z0-9/+=]{1,1024} PersonalAccessTokenSummaries Lists all the personal tokens in an organization or user, if user ID is provided. Type: Array of PersonalAccessTokenSummary objects Errors For information about the errors that are common to all actions, see Common Errors. EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization. HTTP Status Code: 400 EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user. HTTP Status Code: 400 InvalidParameterException One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 ListPersonalAccessTokens 252 Amazon WorkMail OrganizationStateException API Reference The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 ListPersonalAccessTokens 253 Amazon WorkMail ListResourceDelegates Service: Amazon WorkMail API Reference Lists the delegates associated with a resource. Users and groups can be resource delegates and answer requests on behalf of the resource. Request Syntax { "MaxResults": number, "NextToken": "string", "OrganizationId": "string", "ResourceId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. MaxResults The number of maximum results in a page. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No NextToken The token used to paginate through the delegates associated with a resource. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: [\S\s]*|[a-zA-Z0-9/+=]{1,1024} Required: No ListResourceDelegates 254 Amazon WorkMail OrganizationId API Reference The identifier for the organization that contains the resource for which delegates are listed. Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes ResourceId 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: [email protected] • Resource name: resource Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [a-zA-Z0-9._%+@-]+ Required: Yes Response Syntax { "Delegates": [ { "Id": "string", "Type": "string" } ], "NextToken": "string" } ListResourceDelegates 255 Amazon WorkMail Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Delegates One page of the resource's delegates. Type: Array of Delegate objects NextToken The token used to paginate through the delegates associated with a resource. While results are still available, it has an associated value. When the last page is reached, the token is empty. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: [\S\s]*|[a-zA-Z0-9/+=]{1,1024} Errors For information about the errors that are common to all actions, see Common Errors. EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization. HTTP Status Code: 400 EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user. HTTP Status Code: 400 InvalidParameterException One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 ListResourceDelegates 256 Amazon WorkMail API Reference OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 UnsupportedOperationException You can't perform a write operation against a read-only directory. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python |
workmail-api-043 | workmail-api.pdf | 43 | a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 UnsupportedOperationException You can't perform a write operation against a read-only directory. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 ListResourceDelegates 257 API Reference Amazon WorkMail ListResources Service: Amazon WorkMail Returns summaries of the organization's resources. Request Syntax { "Filters": { "NamePrefix": "string", "PrimaryEmailPrefix": "string", "State": "string" }, "MaxResults": number, "NextToken": "string", "OrganizationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Filters Limit the resource search results based on the filter criteria. You can only use one filter per request. Type: ListResourcesFilters object Required: No MaxResults The maximum number of results to return in a single call. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ListResources 258 Amazon WorkMail NextToken API Reference The token to use to retrieve the next page of results. The first call does not contain any tokens. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: [\S\s]*|[a-zA-Z0-9/+=]{1,1024} Required: No OrganizationId The identifier for the organization under which the resources exist. Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes Response Syntax { "NextToken": "string", "Resources": [ { "Description": "string", "DisabledDate": number, "Email": "string", "EnabledDate": number, "Id": "string", "Name": "string", "State": "string", "Type": "string" } ] } ListResources 259 Amazon WorkMail Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextToken The token used to paginate through all the organization's resources. While results are still available, it has an associated value. When the last page is reached, the token is empty. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: [\S\s]*|[a-zA-Z0-9/+=]{1,1024} Resources One page of the organization's resource representation. Type: Array of Resource objects Errors For information about the errors that are common to all actions, see Common Errors. InvalidParameterException One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members. ListResources 260 Amazon WorkMail API Reference HTTP Status Code: 400 UnsupportedOperationException You can't perform a write operation against a read-only directory. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 ListResources 261 Amazon WorkMail ListTagsForResource Service: Amazon WorkMail Lists the tags applied to an WorkMail organization resource. API Reference Request Syntax { "ResourceARN": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ResourceARN The resource ARN. Type: String Length Constraints: Minimum length of 1. Maximum length of 1011. Pattern: arn:aws:workmail:[a-z0-9-]*:[a-z0-9-]+:[A-Za-z0-9][A-Za-z0-9:_/ +=,@.-]{0,1023} Required: Yes Response Syntax { "Tags": [ { "Key": "string", "Value": "string" } ] } ListTagsForResource 262 Amazon WorkMail Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Tags A list of tag key-value pairs. Type: Array of Tag objects Array Members: Minimum number of 0 items. Maximum number of 50 items. Errors For information about the errors that are common to all actions, see Common Errors. ResourceNotFoundException The resource cannot be found. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for |
workmail-api-044 | workmail-api.pdf | 44 | of 0 items. Maximum number of 50 items. Errors For information about the errors that are common to all actions, see Common Errors. ResourceNotFoundException The resource cannot be found. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python ListTagsForResource 263 Amazon WorkMail • AWS SDK for Ruby V3 API Reference ListTagsForResource 264 API Reference Amazon WorkMail ListUsers Service: Amazon WorkMail Returns summaries of the organization's users. Request Syntax { "Filters": { "DisplayNamePrefix": "string", "IdentityProviderUserIdPrefix": "string", "PrimaryEmailPrefix": "string", "State": "string", "UsernamePrefix": "string" }, "MaxResults": number, "NextToken": "string", "OrganizationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Filters Limit the user search results based on the filter criteria. You can only use one filter per request. Type: ListUsersFilters object Required: No MaxResults The maximum number of results to return in a single call. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ListUsers 265 Amazon WorkMail NextToken API Reference The token to use to retrieve the next page of results. The first call does not contain any tokens. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: [\S\s]*|[a-zA-Z0-9/+=]{1,1024} Required: No OrganizationId The identifier for the organization under which the users exist. Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes Response Syntax { "NextToken": "string", "Users": [ { "DisabledDate": number, "DisplayName": "string", "Email": "string", "EnabledDate": number, "Id": "string", "IdentityProviderIdentityStoreId": "string", "IdentityProviderUserId": "string", "Name": "string", "State": "string", "UserRole": "string" } ] } ListUsers 266 Amazon WorkMail Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextToken The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: [\S\s]*|[a-zA-Z0-9/+=]{1,1024} Users The overview of users for an organization. Type: Array of User objects Errors For information about the errors that are common to all actions, see Common Errors. InvalidParameterException One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members. ListUsers 267 Amazon WorkMail HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 ListUsers 268 Amazon WorkMail PutAccessControlRule Service: Amazon WorkMail API Reference 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. Request Syntax { "Actions": [ "string" ], "Description": "string", "Effect": "string", "ImpersonationRoleIds": [ "string" ], "IpRanges": [ "string" ], "Name": "string", "NotActions": [ "string" ], "NotImpersonationRoleIds": [ "string" ], "NotIpRanges": [ "string" ], "NotUserIds": [ "string" ], "OrganizationId": "string", "UserIds": [ "string" ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Actions Access protocol actions to include in the rule. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 10 items. Length Constraints: Minimum length of 1. Maximum length of 64. PutAccessControlRule 269 API Reference Amazon WorkMail Pattern: [a-zA-Z]+ Required: No Description The rule description. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. Pattern: [\u0020-\u00FF]+ Required: Yes Effect The rule effect. Type: String Valid Values: ALLOW | DENY Required: Yes ImpersonationRoleIds Impersonation role IDs to include in the rule. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of |
workmail-api-045 | workmail-api.pdf | 45 | ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 10 items. Length Constraints: Minimum length of 1. Maximum length of 64. PutAccessControlRule 269 API Reference Amazon WorkMail Pattern: [a-zA-Z]+ Required: No Description The rule description. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. Pattern: [\u0020-\u00FF]+ Required: Yes Effect The rule effect. Type: String Valid Values: ALLOW | DENY Required: Yes ImpersonationRoleIds Impersonation role IDs to include in the rule. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 10 items. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [a-zA-Z0-9_-]+ Required: No IpRanges IPv4 CIDR ranges to include in the rule. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 1024 items. PutAccessControlRule 270 Amazon WorkMail API Reference Length Constraints: Minimum length of 1. Maximum length of 18. Pattern: ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]| [1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])/([0-9]|[12][0-9]|3[0-2])$ Required: No Name The rule name. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [a-zA-Z0-9_-]+ Required: Yes NotActions Access protocol actions to exclude from the rule. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 10 items. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [a-zA-Z]+ Required: No NotImpersonationRoleIds Impersonation role IDs to exclude from the rule. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 10 items. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [a-zA-Z0-9_-]+ PutAccessControlRule 271 Amazon WorkMail Required: No NotIpRanges IPv4 CIDR ranges to exclude from the rule. Type: Array of strings API Reference Array Members: Minimum number of 0 items. Maximum number of 1024 items. Length Constraints: Minimum length of 1. Maximum length of 18. Pattern: ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]| [1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])/([0-9]|[12][0-9]|3[0-2])$ Required: No NotUserIds User IDs to exclude from the rule. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 10 items. Length Constraints: Minimum length of 12. Maximum length of 256. Required: No OrganizationId The identifier of the organization. Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes UserIds User IDs to include in the rule. Type: Array of strings PutAccessControlRule 272 Amazon WorkMail API Reference Array Members: Minimum number of 0 items. Maximum number of 10 items. Length Constraints: Minimum length of 12. Maximum length of 256. Required: No Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization. HTTP Status Code: 400 InvalidParameterException One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 LimitExceededException The request exceeds the limit of the resource. HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 PutAccessControlRule 273 Amazon WorkMail ResourceNotFoundException The resource cannot be found. HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 PutAccessControlRule 274 Amazon WorkMail API Reference PutEmailMonitoringConfiguration Service: Amazon WorkMail Creates or updates the email monitoring configuration for a specified organization. Request Syntax { "LogGroupArn": "string", "OrganizationId": "string", "RoleArn": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. LogGroupArn The Amazon Resource Name (ARN) of the CloudWatch Log group associated with the email monitoring configuration. Type: String Length Constraints: Minimum length of 47. Maximum length of 562. Pattern: arn:aws:logs:[a-z\-0-9]*:[0-9]{12}:log-group:([\.\-_/#A-Za- z0-9]+):\*$ Required: Yes OrganizationId The ID of the organization for which the email monitoring configuration is set. Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ PutEmailMonitoringConfiguration 275 Amazon WorkMail Required: Yes RoleArn API Reference The Amazon Resource Name (ARN) of the IAM Role associated with the email monitoring configuration. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:aws:iam:[a-z0-9-]*:[a-z0-9-]+:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-] {0,1023} Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 |
workmail-api-046 | workmail-api.pdf | 46 | the email monitoring configuration. Type: String Length Constraints: Minimum length of 47. Maximum length of 562. Pattern: arn:aws:logs:[a-z\-0-9]*:[0-9]{12}:log-group:([\.\-_/#A-Za- z0-9]+):\*$ Required: Yes OrganizationId The ID of the organization for which the email monitoring configuration is set. Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ PutEmailMonitoringConfiguration 275 Amazon WorkMail Required: Yes RoleArn API Reference The Amazon Resource Name (ARN) of the IAM Role associated with the email monitoring configuration. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:aws:iam:[a-z0-9-]*:[a-z0-9-]+:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-] {0,1023} Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. InvalidParameterException One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 PutEmailMonitoringConfiguration 276 Amazon WorkMail ResourceNotFoundException The resource cannot be found. HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 PutEmailMonitoringConfiguration 277 Amazon WorkMail API Reference PutIdentityProviderConfiguration Service: Amazon WorkMail 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 Personal Access Tokens. Request Syntax { "AuthenticationMode": "string", "IdentityCenterConfiguration": { "ApplicationArn": "string", "InstanceArn": "string" }, "OrganizationId": "string", "PersonalAccessTokenConfiguration": { "LifetimeInDays": number, "Status": "string" } } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. AuthenticationMode The authentication mode used in WorkMail. Type: String Valid Values: IDENTITY_PROVIDER_ONLY | IDENTITY_PROVIDER_AND_DIRECTORY Required: Yes IdentityCenterConfiguration The details of the IAM Identity Center configuration. PutIdentityProviderConfiguration 278 Amazon WorkMail API Reference Type: IdentityCenterConfiguration object Required: Yes OrganizationId The ID of the WorkMail Organization. Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes PersonalAccessTokenConfiguration The details of the Personal Access Token configuration. Type: PersonalAccessTokenConfiguration object Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. InvalidParameterException One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 PutIdentityProviderConfiguration 279 Amazon WorkMail OrganizationStateException API Reference The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 ResourceNotFoundException The resource cannot be found. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 PutIdentityProviderConfiguration 280 Amazon WorkMail API Reference PutInboundDmarcSettings Service: Amazon WorkMail Enables or disables a DMARC policy for a given organization. Request Syntax { "Enforced": boolean, "OrganizationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Enforced Enforces or suspends a policy after it's applied. Type: Boolean Required: Yes OrganizationId The ID of the organization that you are applying the DMARC policy to. Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. PutInboundDmarcSettings 281 Amazon WorkMail Errors API Reference For information about the errors that are common to all actions, see Common Errors. OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain |
workmail-api-047 | workmail-api.pdf | 47 | Yes OrganizationId The ID of the organization that you are applying the DMARC policy to. Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. PutInboundDmarcSettings 281 Amazon WorkMail Errors API Reference For information about the errors that are common to all actions, see Common Errors. OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 PutInboundDmarcSettings 282 Amazon WorkMail API Reference PutMailboxPermissions Service: Amazon WorkMail Sets permissions for a user, group, or resource. This replaces any pre-existing permissions. Request Syntax { "EntityId": "string", "GranteeId": "string", "OrganizationId": "string", "PermissionValues": [ "string" ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. EntityId 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 S-1-1-12-1234567890-123456789-123456789-1234 • Email address: [email protected] • Entity name: entity Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [a-zA-Z0-9._%+@-]+ Required: Yes PutMailboxPermissions 283 Amazon WorkMail GranteeId API Reference 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 S-1-1-12-1234567890-123456789-123456789-1234 • Email address: [email protected] • Grantee name: grantee Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [a-zA-Z0-9._%+@-]+ Required: Yes OrganizationId The identifier of the organization under which the user, group, or resource exists. Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes PermissionValues The permissions granted to the grantee. SEND_AS allows the grantee to send email as the owner of the mailbox (the grantee is not mentioned on these emails). SEND_ON_BEHALF allows the grantee to send email on behalf of the owner of the mailbox (the grantee is not mentioned as the physical sender of these emails). FULL_ACCESS allows the grantee full access to the mailbox, irrespective of other folder-level permissions set on the mailbox. Type: Array of strings PutMailboxPermissions 284 Amazon WorkMail API Reference Valid Values: FULL_ACCESS | SEND_AS | SEND_ON_BEHALF Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization. HTTP Status Code: 400 EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user. HTTP Status Code: 400 InvalidParameterException One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 PutMailboxPermissions 285 Amazon WorkMail See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 PutMailboxPermissions 286 Amazon WorkMail API Reference PutMobileDeviceAccessOverride Service: Amazon WorkMail Creates or updates a mobile device access override for the given WorkMail organization, user, and device. Request Syntax { "Description": "string", "DeviceId": "string", "Effect": "string", "OrganizationId": "string", "UserId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Description A description of the override. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. |
workmail-api-048 | workmail-api.pdf | 48 | • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 PutMailboxPermissions 286 Amazon WorkMail API Reference PutMobileDeviceAccessOverride Service: Amazon WorkMail Creates or updates a mobile device access override for the given WorkMail organization, user, and device. Request Syntax { "Description": "string", "DeviceId": "string", "Effect": "string", "OrganizationId": "string", "UserId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Description A description of the override. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [\S\s]+ Required: No DeviceId The mobile device for which you create the override. DeviceId is case insensitive. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. Pattern: [A-Za-z0-9]+ PutMobileDeviceAccessOverride 287 API Reference Amazon WorkMail Required: Yes Effect The effect of the override, ALLOW or DENY. Type: String Valid Values: ALLOW | DENY Required: Yes OrganizationId Identifies the WorkMail organization for which you create the override. Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes UserId 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: [email protected] • User name: user Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [a-zA-Z0-9._%+@-]+ Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. PutMobileDeviceAccessOverride 288 Amazon WorkMail Errors API Reference For information about the errors that are common to all actions, see Common Errors. EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization. HTTP Status Code: 400 EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user. HTTP Status Code: 400 InvalidParameterException One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET PutMobileDeviceAccessOverride 289 API Reference Amazon WorkMail • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 PutMobileDeviceAccessOverride 290 Amazon WorkMail PutRetentionPolicy Service: Amazon WorkMail Puts a retention policy to the specified organization. API Reference Request Syntax { "Description": "string", "FolderConfigurations": [ { "Action": "string", "Name": "string", "Period": number } ], "Id": "string", "Name": "string", "OrganizationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Description The retention policy description. Type: String Length Constraints: Maximum length of 256. Pattern: [\w\d\s\S\-!?=,.;:'_]+ Required: No FolderConfigurations The retention policy folder configurations. Type: Array of FolderConfiguration objects PutRetentionPolicy 291 API Reference Amazon WorkMail Required: Yes Id The retention policy ID. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [a-zA-Z0-9_-]+ Required: No Name The retention policy name. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [a-zA-Z0-9_-]+ Required: Yes OrganizationId The organization ID. Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. PutRetentionPolicy 292 Amazon WorkMail InvalidParameterException API Reference One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 LimitExceededException The request exceeds the limit of the resource. HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for |
workmail-api-049 | workmail-api.pdf | 49 | doesn't belong or exist in the system. HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python PutRetentionPolicy 293 Amazon WorkMail • AWS SDK for Ruby V3 API Reference PutRetentionPolicy 294 Amazon WorkMail RegisterMailDomain Service: Amazon WorkMail API Reference 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. Request Syntax { "ClientToken": "string", "DomainName": "string", "OrganizationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ClientToken Idempotency token used when retrying requests. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [\x21-\x7e]+ Required: No DomainName The name of the mail domain to create in WorkMail and SES. Type: String Length Constraints: Minimum length of 3. Maximum length of 209. Pattern: [a-zA-Z0-9.-]+ RegisterMailDomain 295 Amazon WorkMail Required: Yes OrganizationId The WorkMail organization under which you're creating the domain. API Reference Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. InvalidParameterException One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 LimitExceededException The request exceeds the limit of the resource. HTTP Status Code: 400 MailDomainInUseException The domain you're trying to change is in use by another user or organization in your account. See the error message for details. HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. RegisterMailDomain 296 Amazon WorkMail HTTP Status Code: 400 OrganizationStateException API Reference The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 RegisterMailDomain 297 Amazon WorkMail RegisterToWorkMail Service: Amazon WorkMail API Reference Registers an existing and disabled user, group, or resource for WorkMail use by associating a mailbox and calendaring capabilities. It performs no change if the user, group, or resource is enabled and fails if the user, group, or resource is deleted. This operation results in the accumulation of costs. For more information, see Pricing. The equivalent console functionality for this operation is Enable. Users can either be created by calling the CreateUser API operation or they can be synchronized from your directory. For more information, see DeregisterFromWorkMail. Request Syntax { "Email": "string", "EntityId": "string", "OrganizationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Email The email for the user, group, or resource to be updated. Type: String Length Constraints: Minimum length of 1. Maximum length of 254. Pattern: [a-zA-Z0-9._%+-]{1,64}@[a-zA-Z0-9.-]+\.[a-zA-Z-]{2,} Required: Yes EntityId The identifier for the user, group, or resource to be updated. RegisterToWorkMail 298 Amazon WorkMail API Reference 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 S-1-1-12-1234567890-123456789-123456789-1234 • Entity name: entity Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [a-zA-Z0-9._%+@-]+ Required: Yes OrganizationId The identifier for the organization under which the user, group, or resource exists. Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. DirectoryServiceAuthenticationFailedException The directory service doesn't recognize the credentials supplied by WorkMail. HTTP Status Code: 400 DirectoryUnavailableException The |
workmail-api-050 | workmail-api.pdf | 50 | or S-1-1-12-1234567890-123456789-123456789-1234 • Entity name: entity Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [a-zA-Z0-9._%+@-]+ Required: Yes OrganizationId The identifier for the organization under which the user, group, or resource exists. Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. DirectoryServiceAuthenticationFailedException The directory service doesn't recognize the credentials supplied by WorkMail. HTTP Status Code: 400 DirectoryUnavailableException The directory is unavailable. It might be located in another Region or deleted. RegisterToWorkMail 299 Amazon WorkMail HTTP Status Code: 400 EmailAddressInUseException API Reference The email address that you're trying to assign is already created for a different user, group, or resource. HTTP Status Code: 400 EntityAlreadyRegisteredException The user, group, or resource that you're trying to register is already registered. HTTP Status Code: 400 EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization. HTTP Status Code: 400 EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user. HTTP Status Code: 400 InvalidParameterException One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 MailDomainNotFoundException The domain specified is not found in your organization. HTTP Status Code: 400 MailDomainStateException After a domain has been added to the organization, it must be verified. The domain is not yet verified. HTTP Status Code: 400 RegisterToWorkMail 300 Amazon WorkMail API Reference OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 RegisterToWorkMail 301 Amazon WorkMail ResetPassword Service: Amazon WorkMail Allows the administrator to reset the password for a user. API Reference Request Syntax { "OrganizationId": "string", "Password": "string", "UserId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. OrganizationId The identifier of the organization that contains the user for which the password is reset. Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes Password The new password for the user. Type: String Length Constraints: Maximum length of 256. Pattern: [\u0020-\u00FF]+ Required: Yes ResetPassword 302 Amazon WorkMail UserId API Reference The identifier of the user for whom the password is reset. Type: String Length Constraints: Minimum length of 12. Maximum length of 256. Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. DirectoryServiceAuthenticationFailedException The directory service doesn't recognize the credentials supplied by WorkMail. HTTP Status Code: 400 DirectoryUnavailableException The directory is unavailable. It might be located in another Region or deleted. HTTP Status Code: 400 EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization. HTTP Status Code: 400 EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user. HTTP Status Code: 400 InvalidParameterException One or more of the input parameters don't match the service's restrictions. ResetPassword 303 Amazon WorkMail HTTP Status Code: 400 InvalidPasswordException API Reference The supplied password doesn't match the minimum security constraints, such as length or use of special characters. HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 UnsupportedOperationException You can't perform a write operation against a read-only directory. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS |
workmail-api-051 | workmail-api.pdf | 51 | or exist in the system. HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 UnsupportedOperationException You can't perform a write operation against a read-only directory. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin ResetPassword 304 Amazon WorkMail • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference ResetPassword 305 Amazon WorkMail API Reference StartMailboxExportJob Service: Amazon WorkMail 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. Request Syntax { "ClientToken": "string", "Description": "string", "EntityId": "string", "KmsKeyArn": "string", "OrganizationId": "string", "RoleArn": "string", "S3BucketName": "string", "S3Prefix": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ClientToken The idempotency token for the client request. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [\x21-\x7e]+ Required: Yes Description The mailbox export job description. Type: String StartMailboxExportJob 306 Amazon WorkMail API Reference Length Constraints: Minimum length of 0. Maximum length of 1023. Pattern: [\S\s]* Required: No EntityId 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 S-1-1-12-1234567890-123456789-123456789-1234 • Email address: [email protected] • Entity name: entity Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [a-zA-Z0-9._%+@-]+ Required: Yes KmsKeyArn The Amazon Resource Name (ARN) of the symmetric AWS Key Management Service (AWS KMS) key that encrypts the exported mailbox content. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:aws:kms:[a-z0-9-]*:[a-z0-9-]+:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-] {0,1023} Required: Yes OrganizationId The identifier associated with the organization. StartMailboxExportJob 307 Amazon WorkMail Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes RoleArn API Reference The ARN of the AWS Identity and Access Management (IAM) role that grants write permission to the S3 bucket. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:aws:iam:[a-z0-9-]*:[a-z0-9-]+:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-] {0,1023} Required: Yes S3BucketName The name of the S3 bucket. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: [A-Za-z0-9.-]+ Required: Yes S3Prefix The S3 bucket prefix. Type: String Length Constraints: Minimum length of 1. Maximum length of 1023. Pattern: [A-Za-z0-9!_.*'()/-]+ Required: Yes StartMailboxExportJob 308 Amazon WorkMail Response Syntax { "JobId": "string" } Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. JobId The job ID. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: [A-Za-z0-9-]+ Errors For information about the errors that are common to all actions, see Common Errors. EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization. HTTP Status Code: 400 InvalidParameterException One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 LimitExceededException The request exceeds the limit of the resource. HTTP Status Code: 400 StartMailboxExportJob 309 Amazon WorkMail API Reference OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 StartMailboxExportJob 310 Amazon WorkMail TagResource Service: Amazon WorkMail Applies the specified tags to the specified WorkMailorganization resource. API Reference Request Syntax { "ResourceARN": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ResourceARN The resource ARN. Type: String Length Constraints: Minimum length of 1. Maximum length of 1011. Pattern: arn:aws:workmail:[a-z0-9-]*:[a-z0-9-]+:[A-Za-z0-9][A-Za-z0-9:_/ |
workmail-api-052 | workmail-api.pdf | 52 | V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 StartMailboxExportJob 310 Amazon WorkMail TagResource Service: Amazon WorkMail Applies the specified tags to the specified WorkMailorganization resource. API Reference Request Syntax { "ResourceARN": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ResourceARN The resource ARN. Type: String Length Constraints: Minimum length of 1. Maximum length of 1011. Pattern: arn:aws:workmail:[a-z0-9-]*:[a-z0-9-]+:[A-Za-z0-9][A-Za-z0-9:_/ +=,@.-]{0,1023} Required: Yes Tags The tag key-value pairs. Type: Array of Tag objects Array Members: Minimum number of 0 items. Maximum number of 50 items. TagResource 311 Amazon WorkMail Required: Yes Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. InvalidParameterException One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 ResourceNotFoundException The resource cannot be found. HTTP Status Code: 400 TooManyTagsException The resource can have up to 50 user-applied tags. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET TagResource 312 API Reference Amazon WorkMail • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 TagResource 313 Amazon WorkMail API Reference TestAvailabilityConfiguration Service: Amazon WorkMail Performs a test on an availability provider to ensure that access is allowed. For EWS, it verifies the provided credentials can be used to successfully log in. For Lambda, it verifies that the Lambda function can be invoked and that the resource access policy was configured to deny anonymous access. An anonymous invocation is one done without providing either a SourceArn or SourceAccount header. Note The request must contain either one provider definition (EwsProvider or LambdaProvider) or the DomainName parameter. If the DomainName parameter is provided, the configuration stored under the DomainName will be tested. Request Syntax { "DomainName": "string", "EwsProvider": { "EwsEndpoint": "string", "EwsPassword": "string", "EwsUsername": "string" }, "LambdaProvider": { "LambdaArn": "string" }, "OrganizationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. DomainName The domain to which the provider applies. If this field is provided, a stored availability provider associated to this domain name will be tested. TestAvailabilityConfiguration 314 Amazon WorkMail Type: String API Reference Length Constraints: Minimum length of 3. Maximum length of 255. Pattern: [a-zA-Z0-9.-]+ Required: No EwsProvider Describes an EWS based availability provider. This is only used as input to the service. Type: EwsAvailabilityProvider object Required: No LambdaProvider Describes a Lambda based availability provider. Type: LambdaAvailabilityProvider object Required: No OrganizationId The WorkMail organization where the availability provider will be tested. Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes Response Syntax { "FailureReason": "string", "TestPassed": boolean } TestAvailabilityConfiguration 315 Amazon WorkMail Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. FailureReason String containing the reason for a failed test if TestPassed is false. Type: String Length Constraints: Maximum length of 256. TestPassed Boolean indicating whether the test passed or failed. Type: Boolean Errors For information about the errors that are common to all actions, see Common Errors. InvalidParameterException One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 TestAvailabilityConfiguration 316 Amazon WorkMail ResourceNotFoundException The resource cannot be found. HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK |
workmail-api-053 | workmail-api.pdf | 53 | perform certain operations on the organization or its members. HTTP Status Code: 400 TestAvailabilityConfiguration 316 Amazon WorkMail ResourceNotFoundException The resource cannot be found. HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 TestAvailabilityConfiguration 317 Amazon WorkMail UntagResource Service: Amazon WorkMail API Reference Untags the specified tags from the specified WorkMail organization resource. Request Syntax { "ResourceARN": "string", "TagKeys": [ "string" ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ResourceARN The resource ARN. Type: String Length Constraints: Minimum length of 1. Maximum length of 1011. Pattern: arn:aws:workmail:[a-z0-9-]*:[a-z0-9-]+:[A-Za-z0-9][A-Za-z0-9:_/ +=,@.-]{0,1023} Required: Yes TagKeys The tag keys. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 50 items. Length Constraints: Minimum length of 1. Maximum length of 128. Required: Yes UntagResource 318 Amazon WorkMail Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. ResourceNotFoundException The resource cannot be found. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 UntagResource 319 Amazon WorkMail API Reference UpdateAvailabilityConfiguration Service: Amazon WorkMail Updates an existing AvailabilityConfiguration for the given WorkMail organization and domain. Request Syntax { "DomainName": "string", "EwsProvider": { "EwsEndpoint": "string", "EwsPassword": "string", "EwsUsername": "string" }, "LambdaProvider": { "LambdaArn": "string" }, "OrganizationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. DomainName The domain to which the provider applies the availability configuration. Type: String Length Constraints: Minimum length of 3. Maximum length of 255. Pattern: [a-zA-Z0-9.-]+ Required: Yes EwsProvider The EWS availability provider definition. The request must contain exactly one provider definition, either EwsProvider or LambdaProvider. The previously stored provider will be overridden by the one provided. UpdateAvailabilityConfiguration 320 Amazon WorkMail API Reference Type: EwsAvailabilityProvider object Required: No LambdaProvider The Lambda availability provider definition. The request must contain exactly one provider definition, either EwsProvider or LambdaProvider. The previously stored provider will be overridden by the one provided. Type: LambdaAvailabilityProvider object Required: No OrganizationId The WorkMail organization for which the AvailabilityConfiguration will be updated. Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. InvalidParameterException One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. UpdateAvailabilityConfiguration 321 Amazon WorkMail HTTP Status Code: 400 OrganizationStateException API Reference The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 ResourceNotFoundException The resource cannot be found. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 UpdateAvailabilityConfiguration 322 Amazon WorkMail API Reference UpdateDefaultMailDomain Service: Amazon WorkMail 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. Request Syntax { "DomainName": "string", "OrganizationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. DomainName The domain name that will become the |
workmail-api-054 | workmail-api.pdf | 54 | PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 UpdateAvailabilityConfiguration 322 Amazon WorkMail API Reference UpdateDefaultMailDomain Service: Amazon WorkMail 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. Request Syntax { "DomainName": "string", "OrganizationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. DomainName The domain name that will become the default domain. Type: String Length Constraints: Minimum length of 3. Maximum length of 209. Pattern: [a-zA-Z0-9.-]+ Required: Yes OrganizationId The WorkMail organization for which to list domains. Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes UpdateDefaultMailDomain 323 Amazon WorkMail Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. InvalidParameterException One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 MailDomainNotFoundException The domain specified is not found in your organization. HTTP Status Code: 400 MailDomainStateException After a domain has been added to the organization, it must be verified. The domain is not yet verified. HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: UpdateDefaultMailDomain 324 API Reference Amazon WorkMail • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 UpdateDefaultMailDomain 325 API Reference Amazon WorkMail UpdateGroup Service: Amazon WorkMail Updates attributes in a group. Request Syntax { "GroupId": "string", "HiddenFromGlobalAddressList": boolean, "OrganizationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. GroupId 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: [email protected] • Group name: group Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [a-zA-Z0-9._%+@-]+ Required: Yes HiddenFromGlobalAddressList If enabled, the group is hidden from the global address list. Type: Boolean UpdateGroup 326 Amazon WorkMail Required: No OrganizationId The identifier for the organization under which the group exists. API Reference Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization. HTTP Status Code: 400 EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user. HTTP Status Code: 400 InvalidParameterException One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. UpdateGroup 327 Amazon WorkMail HTTP Status Code: 400 OrganizationStateException API Reference The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 UnsupportedOperationException You can't perform a write operation against a read-only directory. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 UpdateGroup 328 Amazon WorkMail API Reference UpdateImpersonationRole Service: Amazon WorkMail Updates an impersonation role for the given WorkMail organization. Request Syntax { "Description": "string", "ImpersonationRoleId": "string", "Name": "string", "OrganizationId": "string", "Rules": [ { "Description": "string", "Effect": "string", "ImpersonationRuleId": "string", "Name": "string", "NotTargetUsers": [ "string" ], "TargetUsers": [ "string" ] } ], "Type": "string" } |
workmail-api-055 | workmail-api.pdf | 55 | .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 UpdateGroup 328 Amazon WorkMail API Reference UpdateImpersonationRole Service: Amazon WorkMail Updates an impersonation role for the given WorkMail organization. Request Syntax { "Description": "string", "ImpersonationRoleId": "string", "Name": "string", "OrganizationId": "string", "Rules": [ { "Description": "string", "Effect": "string", "ImpersonationRuleId": "string", "Name": "string", "NotTargetUsers": [ "string" ], "TargetUsers": [ "string" ] } ], "Type": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Description The updated impersonation role description. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [^\x00-\x09\x0B\x0C\x0E-\x1F\x7F\x3C\x3E\x5C]+ Required: No UpdateImpersonationRole 329 Amazon WorkMail ImpersonationRoleId The ID of the impersonation role to update. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. API Reference Pattern: [a-zA-Z0-9_-]+ Required: Yes Name The updated impersonation role name. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [^\x00-\x1F\x7F\x3C\x3E\x5C]+ Required: Yes OrganizationId The WorkMail organization that contains the impersonation role to update. Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes Rules The updated list of rules. Type: Array of ImpersonationRule objects Array Members: Minimum number of 0 items. Maximum number of 10 items. Required: Yes Type The updated impersonation role type. UpdateImpersonationRole 330 Amazon WorkMail Type: String Valid Values: FULL_ACCESS | READ_ONLY Required: Yes Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization. HTTP Status Code: 400 EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user. HTTP Status Code: 400 InvalidParameterException One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 LimitExceededException The request exceeds the limit of the resource. HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 UpdateImpersonationRole 331 Amazon WorkMail OrganizationStateException API Reference The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 ResourceNotFoundException The resource cannot be found. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 UpdateImpersonationRole 332 Amazon WorkMail UpdateMailboxQuota Service: Amazon WorkMail API Reference Updates a user's current mailbox quota for a specified organization and user. Request Syntax { "MailboxQuota": number, "OrganizationId": "string", "UserId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. MailboxQuota The updated mailbox quota, in MB, for the specified user. Type: Integer Valid Range: Minimum value of 1. Required: Yes OrganizationId The identifier for the organization that contains the user for whom to update the mailbox quota. Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes UserId The identifer for the user for whom to update the mailbox quota. UpdateMailboxQuota 333 Amazon WorkMail API Reference 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: [email protected] • User name: user Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [a-zA-Z0-9._%+@-]+ Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization. HTTP Status Code: 400 EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user. HTTP Status Code: 400 InvalidParameterException One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 UpdateMailboxQuota 334 Amazon WorkMail API Reference OrganizationNotFoundException An operation received |
workmail-api-056 | workmail-api.pdf | 56 | HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization. HTTP Status Code: 400 EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user. HTTP Status Code: 400 InvalidParameterException One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 UpdateMailboxQuota 334 Amazon WorkMail API Reference OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 UpdateMailboxQuota 335 Amazon WorkMail API Reference UpdateMobileDeviceAccessRule Service: Amazon WorkMail Updates a mobile device access rule for the specified WorkMail organization. Request Syntax { "Description": "string", "DeviceModels": [ "string" ], "DeviceOperatingSystems": [ "string" ], "DeviceTypes": [ "string" ], "DeviceUserAgents": [ "string" ], "Effect": "string", "MobileDeviceAccessRuleId": "string", "Name": "string", "NotDeviceModels": [ "string" ], "NotDeviceOperatingSystems": [ "string" ], "NotDeviceTypes": [ "string" ], "NotDeviceUserAgents": [ "string" ], "OrganizationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Description The updated rule description. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [\S\s]+ Required: No DeviceModels Device models that the updated rule will match. UpdateMobileDeviceAccessRule 336 Amazon WorkMail Type: Array of strings API Reference Array Members: Minimum number of 1 item. Maximum number of 10 items. Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [\u0020-\u00FF]+ Required: No DeviceOperatingSystems Device operating systems that the updated rule will match. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 10 items. Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [\u0020-\u00FF]+ Required: No DeviceTypes Device types that the updated rule will match. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 10 items. Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [\u0020-\u00FF]+ Required: No DeviceUserAgents User agents that the updated rule will match. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 10 items. UpdateMobileDeviceAccessRule 337 Amazon WorkMail API Reference Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [\u0020-\u00FF]+ Required: No Effect The effect of the rule when it matches. Allowed values are ALLOW or DENY. Type: String Valid Values: ALLOW | DENY Required: Yes MobileDeviceAccessRuleId The identifier of the rule to be updated. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [a-zA-Z0-9_-]+ Required: Yes Name The updated rule name. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [\S\s]+ Required: Yes NotDeviceModels Device models that the updated rule will not match. All other device models will match. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 10 items. UpdateMobileDeviceAccessRule 338 Amazon WorkMail API Reference Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [\u0020-\u00FF]+ Required: No NotDeviceOperatingSystems Device operating systems that the updated rule will not match. All other device operating systems will match. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 10 items. Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [\u0020-\u00FF]+ Required: No NotDeviceTypes Device types that the updated rule will not match. All other device types will match. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 10 items. Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [\u0020-\u00FF]+ Required: No NotDeviceUserAgents User agents that the updated rule will not match. All other user agents will match. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 10 items. Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [\u0020-\u00FF]+ UpdateMobileDeviceAccessRule 339 Amazon WorkMail Required: No OrganizationId The WorkMail organization under which the rule will be updated. API Reference Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 |
workmail-api-057 | workmail-api.pdf | 57 | length of 1. Maximum length of 256. Pattern: [\u0020-\u00FF]+ Required: No NotDeviceUserAgents User agents that the updated rule will not match. All other user agents will match. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 10 items. Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [\u0020-\u00FF]+ UpdateMobileDeviceAccessRule 339 Amazon WorkMail Required: No OrganizationId The WorkMail organization under which the rule will be updated. API Reference Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization. HTTP Status Code: 400 InvalidParameterException One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members. UpdateMobileDeviceAccessRule 340 Amazon WorkMail HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 UpdateMobileDeviceAccessRule 341 Amazon WorkMail API Reference UpdatePrimaryEmailAddress Service: Amazon WorkMail 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. Request Syntax { "Email": "string", "EntityId": "string", "OrganizationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Email The value of the email to be updated as primary. Type: String Length Constraints: Minimum length of 1. Maximum length of 254. Pattern: [a-zA-Z0-9._%+-]{1,64}@[a-zA-Z0-9.-]+\.[a-zA-Z-]{2,} Required: Yes EntityId 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 S-1-1-12-1234567890-123456789-123456789-1234 UpdatePrimaryEmailAddress 342 Amazon WorkMail API Reference • Email address: [email protected] • Entity name: entity Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [a-zA-Z0-9._%+@-]+ Required: Yes OrganizationId The organization that contains the user, group, or resource to update. Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. DirectoryServiceAuthenticationFailedException The directory service doesn't recognize the credentials supplied by WorkMail. HTTP Status Code: 400 DirectoryUnavailableException The directory is unavailable. It might be located in another Region or deleted. HTTP Status Code: 400 UpdatePrimaryEmailAddress 343 Amazon WorkMail EmailAddressInUseException API Reference The email address that you're trying to assign is already created for a different user, group, or resource. HTTP Status Code: 400 EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization. HTTP Status Code: 400 EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user. HTTP Status Code: 400 InvalidParameterException One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 InvalidParameterException One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 MailDomainNotFoundException The domain specified is not found in your organization. HTTP Status Code: 400 MailDomainStateException After a domain has been added to the organization, it must be verified. The domain is not yet verified. HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. UpdatePrimaryEmailAddress 344 Amazon WorkMail HTTP Status Code: 400 OrganizationStateException API Reference The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 UnsupportedOperationException You can't perform a write operation against a read-only directory. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK |
workmail-api-058 | workmail-api.pdf | 58 | HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. UpdatePrimaryEmailAddress 344 Amazon WorkMail HTTP Status Code: 400 OrganizationStateException API Reference The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 UnsupportedOperationException You can't perform a write operation against a read-only directory. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 UpdatePrimaryEmailAddress 345 Amazon WorkMail UpdateResource Service: Amazon WorkMail API Reference 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. Request Syntax { "BookingOptions": { "AutoAcceptRequests": boolean, "AutoDeclineConflictingRequests": boolean, "AutoDeclineRecurringRequests": boolean }, "Description": "string", "HiddenFromGlobalAddressList": boolean, "Name": "string", "OrganizationId": "string", "ResourceId": "string", "Type": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. BookingOptions The resource's booking options to be updated. Type: BookingOptions object Required: No Description Updates the resource description. Type: String UpdateResource 346 Amazon WorkMail API Reference Length Constraints: Minimum length of 0. Maximum length of 64. Required: No HiddenFromGlobalAddressList If enabled, the resource is hidden from the global address list. Type: Boolean Required: No Name The name of the resource to be updated. Type: String Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: [\w\-.]+(@[a-zA-Z0-9.\-]+\.[a-zA-Z0-9-]{2,})? Required: No OrganizationId The identifier associated with the organization for which the resource is updated. Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes ResourceId 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: [email protected] UpdateResource 347 Amazon WorkMail • Resource name: resource Type: String Length Constraints: Minimum length of 1. Maximum length of 256. API Reference Pattern: [a-zA-Z0-9._%+@-]+ Required: Yes Type Updates the resource type. Type: String Valid Values: ROOM | EQUIPMENT Required: No Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. DirectoryUnavailableException The directory is unavailable. It might be located in another Region or deleted. HTTP Status Code: 400 EmailAddressInUseException The email address that you're trying to assign is already created for a different user, group, or resource. HTTP Status Code: 400 EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization. UpdateResource 348 Amazon WorkMail HTTP Status Code: 400 EntityStateException API Reference You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user. HTTP Status Code: 400 InvalidConfigurationException The configuration for a resource isn't valid. A resource must either be able to auto-respond to requests or have at least one delegate associated that can do so on its behalf. HTTP Status Code: 400 InvalidParameterException One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 MailDomainNotFoundException The domain specified is not found in your organization. HTTP Status Code: 400 MailDomainStateException After a domain has been added to the organization, it must be verified. The domain is not yet verified. HTTP Status Code: 400 NameAvailabilityException The user, group, or resource name isn't unique in WorkMail. HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 UpdateResource 349 Amazon WorkMail OrganizationStateException API Reference The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 UnsupportedOperationException You can't perform a write operation against a read-only directory. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 UpdateResource 350 Amazon WorkMail UpdateUser Service: Amazon WorkMail API Reference Updates data for the |
workmail-api-059 | workmail-api.pdf | 59 | perform a write operation against a read-only directory. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 UpdateResource 350 Amazon WorkMail UpdateUser Service: Amazon WorkMail API Reference 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. Request Syntax { "City": "string", "Company": "string", "Country": "string", "Department": "string", "DisplayName": "string", "FirstName": "string", "HiddenFromGlobalAddressList": boolean, "IdentityProviderUserId": "string", "Initials": "string", "JobTitle": "string", "LastName": "string", "Office": "string", "OrganizationId": "string", "Role": "string", "Street": "string", "Telephone": "string", "UserId": "string", "ZipCode": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. City Updates the user's city. Type: String Length Constraints: Maximum length of 256. UpdateUser 351 Amazon WorkMail Required: No Company Updates the user's company. Type: String Length Constraints: Maximum length of 256. Required: No Country Updates the user's country. Type: String Length Constraints: Maximum length of 256. Required: No Department Updates the user's department. Type: String Length Constraints: Maximum length of 256. Required: No DisplayName Updates the display name of the user. Type: String Length Constraints: Maximum length of 256. Required: No FirstName Updates the user's first name. Type: String UpdateUser API Reference 352 Amazon WorkMail API Reference Length Constraints: Maximum length of 256. Required: No HiddenFromGlobalAddressList If enabled, the user is hidden from the global address list. Type: Boolean Required: No IdentityProviderUserId 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. Type: String Length Constraints: Minimum length of 0. Maximum length of 47. Pattern: ^$|^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}- [A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$ Required: No Initials Updates the user's initials. Type: String Length Constraints: Maximum length of 256. Required: No JobTitle Updates the user's job title. Type: String Length Constraints: Maximum length of 256. Required: No UpdateUser 353 API Reference Amazon WorkMail LastName Updates the user's last name. Type: String Length Constraints: Maximum length of 256. Required: No Office Updates the user's office. Type: String Length Constraints: Maximum length of 256. Required: No OrganizationId The identifier for the organization under which the user exists. Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: Yes Role Updates the user role. You cannot pass SYSTEM_USER or RESOURCE. Type: String Valid Values: USER | RESOURCE | SYSTEM_USER | REMOTE_USER Required: No Street Updates the user's street address. UpdateUser 354 API Reference Amazon WorkMail Type: String Length Constraints: Maximum length of 256. Required: No Telephone Updates the user's contact details. Type: String Length Constraints: Maximum length of 256. Required: No UserId 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: [email protected] • User name: user Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [a-zA-Z0-9._%+@-]+ Required: Yes ZipCode Updates the user's zip code. Type: String Length Constraints: Maximum length of 256. Required: No UpdateUser 355 Amazon WorkMail Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. DirectoryServiceAuthenticationFailedException The directory service doesn't recognize the credentials supplied by WorkMail. HTTP Status Code: 400 DirectoryUnavailableException The directory is unavailable. It might be located in another Region or deleted. HTTP Status Code: 400 EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization. HTTP Status Code: 400 EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user. HTTP Status Code: 400 InvalidParameterException One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 UpdateUser 356 Amazon WorkMail OrganizationStateException API Reference The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 UnsupportedOperationException You can't perform a write operation against a read-only directory. HTTP Status Code: 400 See Also For more information about |
workmail-api-060 | workmail-api.pdf | 60 | state, such as trying to delete an active user. HTTP Status Code: 400 InvalidParameterException One or more of the input parameters don't match the service's restrictions. HTTP Status Code: 400 OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system. HTTP Status Code: 400 UpdateUser 356 Amazon WorkMail OrganizationStateException API Reference The organization must have a valid state to perform certain operations on the organization or its members. HTTP Status Code: 400 UnsupportedOperationException You can't perform a write operation against a read-only directory. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 Amazon WorkMail Message Flow The following actions are supported by Amazon WorkMail Message Flow: • GetRawMessageContent • PutRawMessageContent Amazon WorkMail Message Flow 357 Amazon WorkMail API Reference GetRawMessageContent Service: Amazon WorkMail Message Flow Retrieves the raw content of an in-transit email message, in MIME format. Request Syntax GET /messages/messageId HTTP/1.1 URI Request Parameters The request uses the following URI parameters. messageId The identifier of the email message to retrieve. Length Constraints: Minimum length of 1. Maximum length of 120. Pattern: [a-z0-9\-]* Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 messageContent Response Elements If the action is successful, the service sends back an HTTP 200 response. The response returns the following as the HTTP body. GetRawMessageContent 358 Amazon WorkMail messageContent The raw content of the email message, in MIME format. Errors API Reference For information about the errors that are common to all actions, see Common Errors. ResourceNotFoundException The requested email message is not found. HTTP Status Code: 404 Examples In the following examples, the Authorization header contents (AUTHPARAMS) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see Signature Version 4 Signing Process in the AWS General Reference. You only need to learn how to sign HTTP requests if you intend to manually create them. When you use the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself. Example This example gets the raw content of an in-transit email message and sends it to a text file named "test". Sample Request GET /messages/a1b2cd34-ef5g-6h7j-kl8m-npq9012345rs HTTP/1.1 Host: workmailmessageflow.us-east-1.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/1.16.273 Python/3.6.0 Windows/10 botocore/1.13.9 X-Amz-Date: 20191107T195012Z Authorization: AUTHPARAMS GetRawMessageContent 359 Amazon WorkMail Sample Response API Reference HTTP/1.1 200 OK Cache-Control: no-cache Content-Type: application/json Date: Thu, 07 Nov 2019 19:50:12 GMT x-amzn-RequestId: ea71f214-79c5-4f89-9d4e-1ab4c43ae0df Content-Length: 1344 Connection: keep-alive Subject: Hello World From: =?UTF-8?Q?marymajor_marymajor?= <[email protected]> To: =?UTF-8?Q?mateojackson=40example=2Enet?= <[email protected]> Date: Thu, 7 Nov 2019 19:22:46 +0000 Mime-Version: 1.0 Content-Type: multipart/alternative; boundary="=_EXAMPLE+" References: <[email protected]> X-Priority: 3 (Normal) X-Mailer: Amazon WorkMail Thread-Index: EXAMPLE Thread-Topic: Hello World Message-Id: <[email protected]> This is a multi-part message in MIME format. Your mail reader does not understand MIME message format. --=_EXAMPLE+ Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 7bit hello world --=_EXAMPLE+ Content-Type: text/html; charset=utf-8 Content-Transfer-Encoding: quoted-printable <!DOCTYPE HTML><html> <head> <meta name=3D"Generator" content=3D"Amazon WorkMail v3.0-4510"> <meta http-equiv=3D"Content-Type" content=3D"text/html; charset=3Dutf-8">= <title>testing</title> </head> GetRawMessageContent 360 Amazon WorkMail <body> API Reference <p style=3D"margin: 0px; font-family: Arial, Tahoma, Helvetica, sans-serif; font-size: small;">hello world</p> </body> </html> --=_EXAMPLE+-- See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 GetRawMessageContent 361 Amazon WorkMail API Reference PutRawMessageContent Service: Amazon WorkMail Message Flow Updates the raw content of an in-transit email message, in MIME format. For more information and examples for using this API, see Updating message content with AWS Lambda. Note Updates to an in-transit message only appear when you call PutRawMessageContent from an AWS Lambda function configured with a synchronous Run Lambda rule. If you call PutRawMessageContent on a delivered or sent message, the message remains unchanged, even though GetRawMessageContent returns an updated message. Request Syntax POST /messages/messageId HTTP/1.1 Content-type: application/json { "content": { "s3Reference": { "bucket": "string", "key": "string", "objectVersion": "string" } } } URI Request Parameters The request uses |
workmail-api-061 | workmail-api.pdf | 61 | Updates the raw content of an in-transit email message, in MIME format. For more information and examples for using this API, see Updating message content with AWS Lambda. Note Updates to an in-transit message only appear when you call PutRawMessageContent from an AWS Lambda function configured with a synchronous Run Lambda rule. If you call PutRawMessageContent on a delivered or sent message, the message remains unchanged, even though GetRawMessageContent returns an updated message. Request Syntax POST /messages/messageId HTTP/1.1 Content-type: application/json { "content": { "s3Reference": { "bucket": "string", "key": "string", "objectVersion": "string" } } } URI Request Parameters The request uses the following URI parameters. messageId The identifier of the email message being updated. Length Constraints: Minimum length of 1. Maximum length of 120. PutRawMessageContent 362 API Reference Amazon WorkMail Pattern: [a-z0-9\-]* Required: Yes Request Body The request accepts the following data in JSON format. content Describes the raw message content of the updated email message. Type: RawMessageContent object Required: Yes Response Syntax HTTP/1.1 200 Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. InvalidContentLocation WorkMail could not access the updated email content. Possible reasons: • You made the request in a region other than your S3 bucket region. • The S3 bucket owner is not the same as the calling AWS account. • You have an incomplete or missing S3 bucket policy. For more information about policies, see Updating message content with AWS Lambda in the WorkMail Administrator Guide. HTTP Status Code: 400 MessageFrozen The requested email is not eligible for update. This is usually the case for a redirected email. PutRawMessageContent 363 Amazon WorkMail HTTP Status Code: 400 MessageRejected API Reference The requested email could not be updated due to an error in the MIME content. Check the error message for more information about what caused the error. HTTP Status Code: 400 ResourceNotFoundException The requested email message is not found. HTTP Status Code: 404 Examples In the following examples, the Authorization header contents (AUTHPARAMS) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see Signature Version 4 Signing Process in the AWS General Reference. You only need to learn how to sign HTTP requests if you intend to manually create them. When you use the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself. Example This example illustrates one usage of PutRawMessageContent. Sample Request POST /messages/4e87856b-f02f-39d5-a029-9e39ace5b6f1 HTTP/1.1 Host: workmailmessageflow.us-east-1.amazonaws.com Accept-Encoding: gzip, deflate User-Agent: aws-cli/1.16.230 Python/3.7.5 Darwin/18.7.0 botocore/1.12.220 X-Amz-Date: 20210127T151129Z Authorization: AUTHPARAMS Content-Length: 81 Connection: close PutRawMessageContent 364 Amazon WorkMail API Reference {"content": {"s3Reference": {"bucket": "My-S3-Bucket", "key": "My-S3-Object-Key"}}} Sample Response HTTP/1.1 200 OK Cache-Control: no-cache Content-Type: application/json Date: Wed, 27 Jan 2021 15:11:30 GMT x-amzn-RequestId: ddd7de94-a4eb-4af8-8c3f-1d16cf98b458 Content-Length: 2 Connection: Close {} See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 PutRawMessageContent 365 Amazon WorkMail Data Types The following data types are supported by Amazon WorkMail: API Reference • AccessControlRule • AvailabilityConfiguration • BookingOptions • Delegate • DnsRecord • Domain • EwsAvailabilityProvider • FolderConfiguration • Group • GroupIdentifier • IdentityCenterConfiguration • ImpersonationMatchedRule • ImpersonationRole • ImpersonationRule • LambdaAvailabilityProvider • ListGroupsFilters • ListGroupsForEntityFilters • ListResourcesFilters • ListUsersFilters • MailboxExportJob • MailDomainSummary • Member • MobileDeviceAccessMatchedRule • MobileDeviceAccessOverride • MobileDeviceAccessRule • OrganizationSummary • Permission 366 Amazon WorkMail API Reference • PersonalAccessTokenConfiguration • PersonalAccessTokenSummary • RedactedEwsAvailabilityProvider • Resource • Tag • User The following data types are supported by Amazon WorkMail Message Flow: • RawMessageContent • S3Reference Amazon WorkMail The following data types are supported by Amazon WorkMail: • AccessControlRule • AvailabilityConfiguration • BookingOptions • Delegate • DnsRecord • Domain • EwsAvailabilityProvider • FolderConfiguration • Group • GroupIdentifier • IdentityCenterConfiguration • ImpersonationMatchedRule • ImpersonationRole • ImpersonationRule • LambdaAvailabilityProvider • ListGroupsFilters Amazon WorkMail 367 API Reference Amazon WorkMail • ListGroupsForEntityFilters • ListResourcesFilters • ListUsersFilters • MailboxExportJob • MailDomainSummary • Member • MobileDeviceAccessMatchedRule • MobileDeviceAccessOverride • MobileDeviceAccessRule • OrganizationSummary • Permission • PersonalAccessTokenConfiguration • PersonalAccessTokenSummary • RedactedEwsAvailabilityProvider • Resource • Tag • User Amazon WorkMail 368 API Reference Amazon WorkMail AccessControlRule Service: Amazon WorkMail A rule that controls access to an WorkMail organization. Contents |
workmail-api-062 | workmail-api.pdf | 62 | types are supported by Amazon WorkMail: • AccessControlRule • AvailabilityConfiguration • BookingOptions • Delegate • DnsRecord • Domain • EwsAvailabilityProvider • FolderConfiguration • Group • GroupIdentifier • IdentityCenterConfiguration • ImpersonationMatchedRule • ImpersonationRole • ImpersonationRule • LambdaAvailabilityProvider • ListGroupsFilters Amazon WorkMail 367 API Reference Amazon WorkMail • ListGroupsForEntityFilters • ListResourcesFilters • ListUsersFilters • MailboxExportJob • MailDomainSummary • Member • MobileDeviceAccessMatchedRule • MobileDeviceAccessOverride • MobileDeviceAccessRule • OrganizationSummary • Permission • PersonalAccessTokenConfiguration • PersonalAccessTokenSummary • RedactedEwsAvailabilityProvider • Resource • Tag • User Amazon WorkMail 368 API Reference Amazon WorkMail AccessControlRule Service: Amazon WorkMail A rule that controls access to an WorkMail organization. Contents Actions Access protocol actions to include in the rule. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 10 items. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [a-zA-Z]+ Required: No DateCreated The date that the rule was created. Type: Timestamp Required: No DateModified The date that the rule was modified. Type: Timestamp Required: No Description The rule description. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. AccessControlRule 369 Amazon WorkMail API Reference Pattern: [\u0020-\u00FF]+ Required: No Effect The rule effect. Type: String Valid Values: ALLOW | DENY Required: No ImpersonationRoleIds Impersonation role IDs to include in the rule. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 10 items. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [a-zA-Z0-9_-]+ Required: No IpRanges IPv4 CIDR ranges to include in the rule. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 1024 items. Length Constraints: Minimum length of 1. Maximum length of 18. Pattern: ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]| [1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])/([0-9]|[12][0-9]|3[0-2])$ Required: No Name The rule name. AccessControlRule 370 Amazon WorkMail Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [a-zA-Z0-9_-]+ Required: No NotActions Access protocol actions to exclude from the rule. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 10 items. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [a-zA-Z]+ Required: No NotImpersonationRoleIds Impersonation role IDs to exclude from the rule. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 10 items. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [a-zA-Z0-9_-]+ Required: No NotIpRanges IPv4 CIDR ranges to exclude from the rule. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 1024 items. Length Constraints: Minimum length of 1. Maximum length of 18. AccessControlRule 371 Amazon WorkMail API Reference Pattern: ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]| [1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])/([0-9]|[12][0-9]|3[0-2])$ Required: No NotUserIds User IDs to exclude from the rule. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 10 items. Length Constraints: Minimum length of 12. Maximum length of 256. Required: No UserIds User IDs to include in the rule. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 10 items. Length Constraints: Minimum length of 12. Maximum length of 256. Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 AccessControlRule 372 Amazon WorkMail API Reference AvailabilityConfiguration Service: Amazon WorkMail List all the AvailabilityConfiguration's for the given WorkMail organization. Contents DateCreated The date and time at which the availability configuration was created. Type: Timestamp Required: No DateModified The date and time at which the availability configuration was last modified. Type: Timestamp Required: No DomainName Displays the domain to which the provider applies. Type: String Length Constraints: Minimum length of 3. Maximum length of 255. Pattern: [a-zA-Z0-9.-]+ Required: No EwsProvider If ProviderType is EWS, then this field contains RedactedEwsAvailabilityProvider. Otherwise, it is not required. Type: RedactedEwsAvailabilityProvider object Required: No AvailabilityConfiguration 373 Amazon WorkMail LambdaProvider API Reference If ProviderType is LAMBDA then this field contains LambdaAvailabilityProvider. Otherwise, it is not required. Type: LambdaAvailabilityProvider object Required: No ProviderType Displays the provider type that applies to this domain. Type: String Valid Values: EWS | LAMBDA Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 AvailabilityConfiguration 374 Amazon WorkMail BookingOptions Service: Amazon WorkMail API Reference At least one delegate must be associated to the resource to disable automatic replies from the resource. Contents AutoAcceptRequests The resource's ability to automatically reply to requests. If disabled, delegates must be associated to the resource. Type: Boolean Required: No AutoDeclineConflictingRequests The resource's ability to automatically decline any conflicting requests. |
workmail-api-063 | workmail-api.pdf | 63 | | LAMBDA Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 AvailabilityConfiguration 374 Amazon WorkMail BookingOptions Service: Amazon WorkMail API Reference At least one delegate must be associated to the resource to disable automatic replies from the resource. Contents AutoAcceptRequests The resource's ability to automatically reply to requests. If disabled, delegates must be associated to the resource. Type: Boolean Required: No AutoDeclineConflictingRequests The resource's ability to automatically decline any conflicting requests. Type: Boolean Required: No AutoDeclineRecurringRequests The resource's ability to automatically decline any recurring requests. Type: Boolean Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 BookingOptions 375 Amazon WorkMail Delegate Service: Amazon WorkMail API Reference The name of the attribute, which is one of the values defined in the UserAttribute enumeration. Contents Id The identifier for the user or group associated as the resource's delegate. Type: String Length Constraints: Maximum length of 256. Required: Yes Type The type of the delegate: user or group. Type: String Valid Values: GROUP | USER Required: Yes See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Delegate 376 API Reference Amazon WorkMail DnsRecord Service: Amazon WorkMail A DNS record uploaded to your DNS provider. Contents Hostname The DNS hostname.- For example, domain.example.com. Type: String Length Constraints: Maximum length of 256. Required: No Type The RFC 1035 record type. Possible values: CNAME, A, MX. Type: String Length Constraints: Maximum length of 256. Required: No Value The value returned by the DNS for a query to that hostname and record type. Type: String Length Constraints: Maximum length of 256. Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ DnsRecord 377 Amazon WorkMail • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference DnsRecord 378 Amazon WorkMail Domain Service: Amazon WorkMail API Reference The domain to associate with an WorkMail organization. When you configure a domain hosted in Amazon Route 53 (Route 53), all recommended DNS records are added to the organization when you create it. For more information, see Adding a domain in the WorkMail Administrator Guide. Contents DomainName The fully qualified domain name. Type: String Length Constraints: Minimum length of 3. Maximum length of 255. Pattern: [a-zA-Z0-9.-]+ Required: Yes HostedZoneId The hosted zone ID for a domain hosted in Route 53. Required when configuring a domain hosted in Route 53. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. Pattern: [^/\\]* Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ Domain 379 Amazon WorkMail • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference Domain 380 Amazon WorkMail API Reference EwsAvailabilityProvider Service: Amazon WorkMail Describes an EWS based availability provider. This is only used as input to the service. Contents EwsEndpoint The endpoint of the remote EWS server. Type: String Length Constraints: Maximum length of 256. Pattern: https?://[A-Za-z0-9.-]+(:[0-9]+)?/.* Required: Yes EwsPassword The password used to authenticate the remote EWS server. Type: String Length Constraints: Maximum length of 256. Pattern: [\u0020-\u00FF]+ Required: Yes EwsUsername The username used to authenticate the remote EWS server. Type: String Length Constraints: Maximum length of 256. Pattern: [\u0020-\u00FF]+ Required: Yes EwsAvailabilityProvider 381 Amazon WorkMail See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 EwsAvailabilityProvider 382 Amazon WorkMail FolderConfiguration Service: Amazon WorkMail API Reference The configuration applied to an organization's folders by its retention policy. Contents Action The action to take on the folder contents at the end of the folder configuration period. Type: String Valid Values: NONE | DELETE | PERMANENTLY_DELETE Required: Yes Name The folder name. Type: String Valid Values: INBOX | DELETED_ITEMS | SENT_ITEMS | DRAFTS | JUNK_EMAIL Required: Yes Period The number of days for which the folder-configuration action applies. Type: Integer Valid Range: Minimum value of 1. Maximum value of 730. Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ FolderConfiguration 383 Amazon WorkMail • AWS SDK for Java V2 |
workmail-api-064 | workmail-api.pdf | 64 | the folder contents at the end of the folder configuration period. Type: String Valid Values: NONE | DELETE | PERMANENTLY_DELETE Required: Yes Name The folder name. Type: String Valid Values: INBOX | DELETED_ITEMS | SENT_ITEMS | DRAFTS | JUNK_EMAIL Required: Yes Period The number of days for which the folder-configuration action applies. Type: Integer Valid Range: Minimum value of 1. Maximum value of 730. Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ FolderConfiguration 383 Amazon WorkMail • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference FolderConfiguration 384 API Reference Amazon WorkMail Group Service: Amazon WorkMail The representation of an WorkMail group. Contents DisabledDate The date indicating when the group was disabled from WorkMail use. Type: Timestamp Required: No Email The email of the group. Type: String Length Constraints: Minimum length of 1. Maximum length of 254. Pattern: [a-zA-Z0-9._%+-]{1,64}@[a-zA-Z0-9.-]+\.[a-zA-Z-]{2,} Required: No EnabledDate The date indicating when the group was enabled for WorkMail use. Type: Timestamp Required: No Id The identifier of the group. Type: String Length Constraints: Minimum length of 12. Maximum length of 256. Required: No Group 385 API Reference Amazon WorkMail Name The name of the group. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [\u0020-\u00FF]+ Required: No State The state of the group, which can be ENABLED, DISABLED, or DELETED. Type: String Valid Values: ENABLED | DISABLED | DELETED Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Group 386 Amazon WorkMail GroupIdentifier Service: Amazon WorkMail The identifier that contains the Group ID and name of a group. API Reference Contents GroupId Group ID that matched the group. Type: String Length Constraints: Minimum length of 12. Maximum length of 256. Required: No GroupName Group name that matched the group. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [\u0020-\u00FF]+ Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 GroupIdentifier 387 Amazon WorkMail API Reference IdentityCenterConfiguration Service: Amazon WorkMail The IAM Identity Center configuration. Contents ApplicationArn The Amazon Resource Name (ARN) of IAMIdentity Center Application for WorkMail. Must be created by the WorkMail API, see CreateIdentityCenterApplication. Type: String Length Constraints: Minimum length of 10. Maximum length of 1224. Pattern: ^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:: \d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}$ Required: Yes InstanceArn The Amazon Resource Name (ARN) of the of IAM Identity Center instance. Must be in the same AWS account and region as WorkMail organization. Type: String Length Constraints: Minimum length of 10. Maximum length of 1124. Pattern: ^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/ (sso)?ins-[a-zA-Z0-9-.]{16}$ Required: Yes See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 IdentityCenterConfiguration 388 Amazon WorkMail • AWS SDK for Ruby V3 API Reference IdentityCenterConfiguration 389 Amazon WorkMail API Reference ImpersonationMatchedRule Service: Amazon WorkMail The impersonation rule that matched the input. Contents ImpersonationRuleId The ID of the rule that matched the input Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [a-zA-Z0-9_-]+ Required: No Name The name of the rule that matched the input. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [^\x00-\x1F\x7F\x3C\x3E\x5C]+ Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ImpersonationMatchedRule 390 API Reference Amazon WorkMail ImpersonationRole Service: Amazon WorkMail An impersonation role for the given WorkMail organization. Contents DateCreated The date when the impersonation role was created. Type: Timestamp Required: No DateModified The date when the impersonation role was last modified. Type: Timestamp Required: No ImpersonationRoleId The identifier of the impersonation role. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [a-zA-Z0-9_-]+ Required: No Name The impersonation role name. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [^\x00-\x1F\x7F\x3C\x3E\x5C]+ ImpersonationRole 391 API Reference Amazon WorkMail Required: No Type The impersonation role type. Type: String Valid Values: FULL_ACCESS | READ_ONLY Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ImpersonationRole 392 Amazon WorkMail ImpersonationRule Service: Amazon WorkMail The rules for the given impersonation role. Contents Effect API Reference The |
workmail-api-065 | workmail-api.pdf | 65 | [a-zA-Z0-9_-]+ Required: No Name The impersonation role name. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [^\x00-\x1F\x7F\x3C\x3E\x5C]+ ImpersonationRole 391 API Reference Amazon WorkMail Required: No Type The impersonation role type. Type: String Valid Values: FULL_ACCESS | READ_ONLY Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ImpersonationRole 392 Amazon WorkMail ImpersonationRule Service: Amazon WorkMail The rules for the given impersonation role. Contents Effect API Reference The effect of the rule when it matches the input. Allowed effect values are ALLOW or DENY. Type: String Valid Values: ALLOW | DENY Required: Yes ImpersonationRuleId The identifier of the rule. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [a-zA-Z0-9_-]+ Required: Yes Description The rule description. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [^\x00-\x09\x0B\x0C\x0E-\x1F\x7F\x3C\x3E\x5C]+ Required: No Name The rule name. ImpersonationRule 393 Amazon WorkMail Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [^\x00-\x1F\x7F\x3C\x3E\x5C]+ Required: No NotTargetUsers A list of user IDs that don't match the rule. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 10 items. Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [a-zA-Z0-9._%+@-]+ Required: No TargetUsers A list of user IDs that match the rule. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 10 items. Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [a-zA-Z0-9._%+@-]+ Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 ImpersonationRule 394 Amazon WorkMail • AWS SDK for Ruby V3 API Reference ImpersonationRule 395 Amazon WorkMail API Reference LambdaAvailabilityProvider Service: Amazon WorkMail Describes a Lambda based availability provider. Contents LambdaArn The Amazon Resource Name (ARN) of the Lambda that acts as the availability provider. Type: String Length Constraints: Minimum length of 49. Maximum length of 256. Pattern: arn:aws:lambda:[a-z]{2}-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9\-_ \.]+(:(\$LATEST|[a-zA-Z0-9\-_]+))? Required: Yes See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 LambdaAvailabilityProvider 396 Amazon WorkMail ListGroupsFilters Service: Amazon WorkMail API Reference Filtering options for ListGroups operation. This is only used as input to Operation. Contents NamePrefix Filters only groups with the provided name prefix. Type: String Length Constraints: Maximum length of 256. Required: No PrimaryEmailPrefix Filters only groups with the provided primary email prefix. Type: String Length Constraints: Maximum length of 256. Required: No State Filters only groups with the provided state. Type: String Valid Values: ENABLED | DISABLED | DELETED Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ ListGroupsFilters 397 Amazon WorkMail • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference ListGroupsFilters 398 Amazon WorkMail API Reference ListGroupsForEntityFilters Service: Amazon WorkMail Filtering options for ListGroupsForEntity operation. This is only used as input to Operation. Contents GroupNamePrefix Filters only group names that start with the provided name prefix. Type: String Length Constraints: Maximum length of 256. Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ListGroupsForEntityFilters 399 Amazon WorkMail ListResourcesFilters Service: Amazon WorkMail API Reference Filtering options for ListResources operation. This is only used as input to Operation. Contents NamePrefix Filters only resource that start with the entered name prefix . Type: String Length Constraints: Maximum length of 256. Required: No PrimaryEmailPrefix Filters only resource with the provided primary email prefix. Type: String Length Constraints: Maximum length of 256. Required: No State Filters only resource with the provided state. Type: String Valid Values: ENABLED | DISABLED | DELETED Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ ListResourcesFilters 400 Amazon WorkMail • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference ListResourcesFilters 401 Amazon WorkMail ListUsersFilters Service: Amazon WorkMail API Reference Filtering options for ListUsers operation. This is only used as input to Operation. Contents DisplayNamePrefix Filters only users with the provided display name prefix. Type: String Length Constraints: Maximum length of 256. Required: No IdentityProviderUserIdPrefix Filters only users with the ID from the IAM Identity Center. Type: String Length Constraints: Minimum length of 1. Maximum length |
workmail-api-066 | workmail-api.pdf | 66 | API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ ListResourcesFilters 400 Amazon WorkMail • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference ListResourcesFilters 401 Amazon WorkMail ListUsersFilters Service: Amazon WorkMail API Reference Filtering options for ListUsers operation. This is only used as input to Operation. Contents DisplayNamePrefix Filters only users with the provided display name prefix. Type: String Length Constraints: Maximum length of 256. Required: No IdentityProviderUserIdPrefix Filters only users with the ID from the IAM Identity Center. Type: String Length Constraints: Minimum length of 1. Maximum length of 47. Pattern: ^[A-Fa-f0-9-]+$ Required: No PrimaryEmailPrefix Filters only users with the provided email prefix. Type: String Length Constraints: Maximum length of 256. Required: No State Filters only users with the provided state. Type: String ListUsersFilters 402 Amazon WorkMail API Reference Valid Values: ENABLED | DISABLED | DELETED Required: No UsernamePrefix Filters only users with the provided username prefix. Type: String Length Constraints: Maximum length of 256. Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ListUsersFilters 403 Amazon WorkMail MailboxExportJob Service: Amazon WorkMail API Reference The details of a mailbox export job, including the user or resource ID associated with the mailbox and the S3 bucket that the mailbox contents are exported to. Contents Description The mailbox export job description. Type: String Length Constraints: Minimum length of 0. Maximum length of 1023. Pattern: [\S\s]* Required: No EndTime The mailbox export job end timestamp. Type: Timestamp Required: No EntityId The identifier of the user or resource associated with the mailbox. Type: String Length Constraints: Minimum length of 12. Maximum length of 256. Required: No EstimatedProgress The estimated progress of the mailbox export job, in percentage points. Type: Integer Valid Range: Minimum value of 0. Maximum value of 100. MailboxExportJob 404 Amazon WorkMail Required: No JobId The identifier of the mailbox export job. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. API Reference Pattern: [A-Za-z0-9-]+ Required: No S3BucketName The name of the S3 bucket. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: [A-Za-z0-9.-]+ Required: No S3Path The path to the S3 bucket and file that the mailbox export job exports to. Type: String Length Constraints: Minimum length of 1. Maximum length of 1023. Pattern: [A-Za-z0-9!_.*'()/-]+ Required: No StartTime The mailbox export job start timestamp. Type: Timestamp Required: No MailboxExportJob 405 Amazon WorkMail State The state of the mailbox export job. Type: String Valid Values: RUNNING | COMPLETED | FAILED | CANCELLED API Reference Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 MailboxExportJob 406 API Reference Amazon WorkMail MailDomainSummary Service: Amazon WorkMail The data for a given domain. Contents DefaultDomain Whether the domain is default or not. Type: Boolean Required: No DomainName The domain name. Type: String Length Constraints: Minimum length of 3. Maximum length of 255. Pattern: [a-zA-Z0-9.-]+ Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 MailDomainSummary 407 API Reference Amazon WorkMail Member Service: Amazon WorkMail The representation of a user or group. Contents DisabledDate The date indicating when the member was disabled from WorkMail use. Type: Timestamp Required: No EnabledDate The date indicating when the member was enabled for WorkMail use. Type: Timestamp Required: No Id The identifier of the member. Type: String Length Constraints: Maximum length of 256. Required: No Name The name of the member. Type: String Length Constraints: Maximum length of 256. Required: No State The state of the member, which can be ENABLED, DISABLED, or DELETED. Member 408 Amazon WorkMail Type: String Valid Values: ENABLED | DISABLED | DELETED API Reference Required: No Type A member can be a user or group. Type: String Valid Values: GROUP | USER Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Member 409 Amazon WorkMail API Reference MobileDeviceAccessMatchedRule Service: Amazon WorkMail The rule that a simulated user matches. Contents MobileDeviceAccessRuleId Identifier of the rule that a simulated user matches. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [a-zA-Z0-9_-]+ Required: No Name Name of a rule that a simulated user matches. Type: String Length Constraints: Minimum length of |
workmail-api-067 | workmail-api.pdf | 67 | USER Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Member 409 Amazon WorkMail API Reference MobileDeviceAccessMatchedRule Service: Amazon WorkMail The rule that a simulated user matches. Contents MobileDeviceAccessRuleId Identifier of the rule that a simulated user matches. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [a-zA-Z0-9_-]+ Required: No Name Name of a rule that a simulated user matches. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [\S\s]+ Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 MobileDeviceAccessMatchedRule 410 Amazon WorkMail API Reference MobileDeviceAccessOverride Service: Amazon WorkMail The override object. Contents DateCreated The date the override was first created. Type: Timestamp Required: No DateModified The date the override was last modified. Type: Timestamp Required: No Description A description of the override. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [\S\s]+ Required: No DeviceId The device to which the override applies. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. Pattern: [A-Za-z0-9]+ MobileDeviceAccessOverride 411 API Reference Amazon WorkMail Required: No Effect The effect of the override, ALLOW or DENY. Type: String Valid Values: ALLOW | DENY Required: No UserId The WorkMail user to which the access override applies. Type: String Length Constraints: Minimum length of 12. Maximum length of 256. Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 MobileDeviceAccessOverride 412 Amazon WorkMail API Reference MobileDeviceAccessRule Service: Amazon WorkMail A rule that controls access to mobile devices for an WorkMail group. Contents DateCreated The date and time at which an access rule was created. Type: Timestamp Required: No DateModified The date and time at which an access rule was modified. Type: Timestamp Required: No Description The description of a mobile access rule. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [\S\s]+ Required: No DeviceModels Device models that a rule will match. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 10 items. Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [\u0020-\u00FF]+ MobileDeviceAccessRule 413 API Reference Amazon WorkMail Required: No DeviceOperatingSystems Device operating systems that a rule will match. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 10 items. Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [\u0020-\u00FF]+ Required: No DeviceTypes Device types that a rule will match. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 10 items. Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [\u0020-\u00FF]+ Required: No DeviceUserAgents Device user agents that a rule will match. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 10 items. Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [\u0020-\u00FF]+ Required: No Effect The effect of the rule when it matches. Allowed values are ALLOW or DENY. MobileDeviceAccessRule 414 API Reference Amazon WorkMail Type: String Valid Values: ALLOW | DENY Required: No MobileDeviceAccessRuleId The ID assigned to a mobile access rule. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [a-zA-Z0-9_-]+ Required: No Name The name of a mobile access rule. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [\S\s]+ Required: No NotDeviceModels Device models that a rule will not match. All other device models will match. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 10 items. Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [\u0020-\u00FF]+ Required: No NotDeviceOperatingSystems Device operating systems that a rule will not match. All other device types will match. MobileDeviceAccessRule 415 Amazon WorkMail Type: Array of strings API Reference Array Members: Minimum number of 1 item. Maximum number of 10 items. Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [\u0020-\u00FF]+ Required: No NotDeviceTypes Device types that a rule will not match. All other device types will match. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 10 items. Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [\u0020-\u00FF]+ Required: No NotDeviceUserAgents Device user agents that a rule will not match. All other device user agents will match. Type: Array of strings Array Members: Minimum number of 1 |
workmail-api-068 | workmail-api.pdf | 68 | API Reference Array Members: Minimum number of 1 item. Maximum number of 10 items. Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [\u0020-\u00FF]+ Required: No NotDeviceTypes Device types that a rule will not match. All other device types will match. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 10 items. Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [\u0020-\u00FF]+ Required: No NotDeviceUserAgents Device user agents that a rule will not match. All other device user agents will match. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 10 items. Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [\u0020-\u00FF]+ Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ MobileDeviceAccessRule 416 Amazon WorkMail • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference MobileDeviceAccessRule 417 API Reference Amazon WorkMail OrganizationSummary Service: Amazon WorkMail The representation of an organization. Contents Alias The alias associated with the organization. Type: String Length Constraints: Minimum length of 1. Maximum length of 62. Pattern: ^(?!d-)([\da-zA-Z]+)([-][\da-zA-Z]+)* Required: No DefaultMailDomain The default email domain associated with the organization. Type: String Length Constraints: Minimum length of 3. Maximum length of 255. Pattern: [a-zA-Z0-9.-]+ Required: No ErrorMessage The error message associated with the organization. It is only present if unexpected behavior has occurred with regards to the organization. It provides insight or solutions regarding unexpected behavior. Type: String Length Constraints: Maximum length of 256. Required: No OrganizationId The identifier associated with the organization. OrganizationSummary 418 API Reference Amazon WorkMail Type: String Length Constraints: Fixed length of 34. Pattern: ^m-[0-9a-f]{32}$ Required: No State The state associated with the organization. Type: String Length Constraints: Maximum length of 256. Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 OrganizationSummary 419 Amazon WorkMail Permission Service: Amazon WorkMail API Reference Permission granted to a user, group, or resource to access a certain aspect of another user, group, or resource mailbox. Contents GranteeId The identifier of the user, group, or resource to which the permissions are granted. Type: String Length Constraints: Minimum length of 12. Maximum length of 256. Required: Yes GranteeType The type of user, group, or resource referred to in GranteeId. Type: String Valid Values: GROUP | USER Required: Yes PermissionValues The permissions granted to the grantee. SEND_AS allows the grantee to send email as the owner of the mailbox (the grantee is not mentioned on these emails). SEND_ON_BEHALF allows the grantee to send email on behalf of the owner of the mailbox (the grantee is not mentioned as the physical sender of these emails). FULL_ACCESS allows the grantee full access to the mailbox, irrespective of other folder-level permissions set on the mailbox. Type: Array of strings Valid Values: FULL_ACCESS | SEND_AS | SEND_ON_BEHALF Required: Yes Permission 420 Amazon WorkMail See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Permission 421 Amazon WorkMail API Reference PersonalAccessTokenConfiguration Service: Amazon WorkMail Displays the Personal Access Token status. Contents Status The status of the Personal Access Token allowed for the organization. • Active - Mailbox users can login to the web application and choose Settings to see the new Personal Access Tokens page to create and delete the Personal Access Tokens. Mailbox users can use the Personal Access Tokens to set up mailbox connection from desktop or mobile email clients. • Inactive - Personal Access Tokens are disabled for your organization. Mailbox users can’t create, list, or delete Personal Access Tokens and can’t use them to connect to their mailboxes from desktop or mobile email clients. Type: String Valid Values: ACTIVE | INACTIVE Required: Yes LifetimeInDays The validity of the Personal Access Token status in days. Type: Integer Valid Range: Minimum value of 1. Maximum value of 3653. Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 PersonalAccessTokenConfiguration 422 Amazon WorkMail • AWS SDK for Ruby V3 API Reference PersonalAccessTokenConfiguration 423 Amazon WorkMail API Reference PersonalAccessTokenSummary Service: Amazon WorkMail The summary of the Personal Access Token. Contents DateCreated The date when the Personal Access Token was created. Type: Timestamp Required: No DateLastUsed The date when the Personal Access Token was last used. Type: Timestamp Required: No ExpiresTime The date when the Personal Access Token will expire. |
workmail-api-069 | workmail-api.pdf | 69 | No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 PersonalAccessTokenConfiguration 422 Amazon WorkMail • AWS SDK for Ruby V3 API Reference PersonalAccessTokenConfiguration 423 Amazon WorkMail API Reference PersonalAccessTokenSummary Service: Amazon WorkMail The summary of the Personal Access Token. Contents DateCreated The date when the Personal Access Token was created. Type: Timestamp Required: No DateLastUsed The date when the Personal Access Token was last used. Type: Timestamp Required: No ExpiresTime The date when the Personal Access Token will expire. Type: Timestamp Required: No Name The name of the Personal Access Token. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [^\x00-\x1F\x7F\x3C\x3E\x5C]+ Required: No PersonalAccessTokenId The ID of the Personal Access Token. PersonalAccessTokenSummary 424 Amazon WorkMail Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [a-zA-Z0-9_-]+ Required: No Scopes Lists all the Personal Access Token permissions for a mailbox. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 10 items. Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [^\x00-\x1F\x7F\x3C\x3E\x5C]+ Required: No UserId The user ID of the WorkMail user associated with the Personal Access Token. Type: String Length Constraints: Minimum length of 12. Maximum length of 256. Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 PersonalAccessTokenSummary 425 Amazon WorkMail API Reference RedactedEwsAvailabilityProvider Service: Amazon WorkMail Describes an EWS based availability provider when returned from the service. It does not contain the password of the endpoint. Contents EwsEndpoint The endpoint of the remote EWS server. Type: String Length Constraints: Maximum length of 256. Pattern: https?://[A-Za-z0-9.-]+(:[0-9]+)?/.* Required: No EwsUsername The username used to authenticate the remote EWS server. Type: String Length Constraints: Maximum length of 256. Pattern: [\u0020-\u00FF]+ Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RedactedEwsAvailabilityProvider 426 API Reference Amazon WorkMail Resource Service: Amazon WorkMail The representation of a resource. Contents Description Resource description. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: No DisabledDate The date indicating when the resource was disabled from WorkMail use. Type: Timestamp Required: No Email The email of the resource. Type: String Length Constraints: Minimum length of 1. Maximum length of 254. Pattern: [a-zA-Z0-9._%+-]{1,64}@[a-zA-Z0-9.-]+\.[a-zA-Z-]{2,} Required: No EnabledDate The date indicating when the resource was enabled for WorkMail use. Type: Timestamp Required: No Resource 427 Amazon WorkMail Id The identifier of the resource. Type: String Length Constraints: Minimum length of 12. Maximum length of 256. API Reference Required: No Name The name of the resource. Type: String Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: [\w\-.]+(@[a-zA-Z0-9.\-]+\.[a-zA-Z0-9-]{2,})? Required: No State The state of the resource, which can be ENABLED, DISABLED, or DELETED. Type: String Valid Values: ENABLED | DISABLED | DELETED Required: No Type The type of the resource: equipment or room. Type: String Valid Values: ROOM | EQUIPMENT Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: Resource 428 Amazon WorkMail • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference Resource 429 API Reference Amazon WorkMail Tag Service: Amazon WorkMail Describes a tag applied to a resource. Contents Key The key of the tag. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Required: Yes Value The value of the tag. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Required: Yes See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Tag 430 API Reference Amazon WorkMail User Service: Amazon WorkMail The representation of an WorkMail user. Contents DisabledDate The date indicating when the user was disabled from WorkMail use. Type: Timestamp Required: No DisplayName The display name of the user. Type: String Length Constraints: Maximum length of 256. Required: No Email The email of the user. Type: String Length Constraints: Minimum length of 1. Maximum length of 254. Pattern: [a-zA-Z0-9._%+-]{1,64}@[a-zA-Z0-9.-]+\.[a-zA-Z-]{2,} Required: No EnabledDate The date indicating when the user was enabled for WorkMail use. Type: Timestamp Required: No User 431 Amazon WorkMail Id The identifier of the user. Type: String API Reference Length Constraints: Minimum length of 12. Maximum length of 256. Required: No IdentityProviderIdentityStoreId |
workmail-api-070 | workmail-api.pdf | 70 | user. Contents DisabledDate The date indicating when the user was disabled from WorkMail use. Type: Timestamp Required: No DisplayName The display name of the user. Type: String Length Constraints: Maximum length of 256. Required: No Email The email of the user. Type: String Length Constraints: Minimum length of 1. Maximum length of 254. Pattern: [a-zA-Z0-9._%+-]{1,64}@[a-zA-Z0-9.-]+\.[a-zA-Z-]{2,} Required: No EnabledDate The date indicating when the user was enabled for WorkMail use. Type: Timestamp Required: No User 431 Amazon WorkMail Id The identifier of the user. Type: String API Reference Length Constraints: Minimum length of 12. Maximum length of 256. Required: No IdentityProviderIdentityStoreId Identity store 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 36. Pattern: ^d-[0-9a-f]{10}$|^[0-9a-f]{8}\\b-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f] {4}-\\b[0-9a-f]{12}$ Required: No IdentityProviderUserId 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 47. Pattern: ^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A- Fa-f0-9]{4}-[A-Fa-f0-9]{12}$ Required: No Name The name of the user. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. User 432 Amazon WorkMail API Reference Pattern: [\w\-.]+(@[a-zA-Z0-9.\-]+\.[a-zA-Z0-9-]{2,})? Required: No State The state of the user, which can be ENABLED, DISABLED, or DELETED. Type: String Valid Values: ENABLED | DISABLED | DELETED Required: No UserRole The role of the user. Type: String Valid Values: USER | RESOURCE | SYSTEM_USER | REMOTE_USER Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Amazon WorkMail Message Flow The following data types are supported by Amazon WorkMail Message Flow: • RawMessageContent • S3Reference Amazon WorkMail Message Flow 433 Amazon WorkMail API Reference RawMessageContent Service: Amazon WorkMail Message Flow Provides the MIME content of the updated email message as an S3 object. All MIME content must meet the following criteria: • Each part of a multipart MIME message must be formatted properly. • Attachments must be of a content type that Amazon SES supports. For more information, see Unsupported Attachment Types. • If any of the MIME parts in a message contain content that is outside of the 7-bit ASCII character range, we recommend encoding that content. • Per RFC 5321, the maximum length of each line of text, including the <CRLF>, must not exceed 1,000 characters. • The message must contain all the required header fields. Check the returned error message for more information. • The value of immutable headers must remain unchanged. Check the returned error message for more information. • Certain unique headers can only appear once. Check the returned error message for more information. Contents s3Reference The S3 reference of an email message. Type: S3Reference object Required: Yes See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 RawMessageContent 434 Amazon WorkMail • AWS SDK for Ruby V3 API Reference RawMessageContent 435 Amazon WorkMail API Reference S3Reference Service: Amazon WorkMail Message Flow Amazon S3 object representing the updated message content, in MIME format. Note The region for the S3 bucket containing the S3 object must match the region used for WorkMail operations. Also, for WorkMail to process an S3 object, it must have permission to access that object. For more information, see Updating message content with AWS Lambda. Contents bucket The S3 bucket name. Type: String Length Constraints: Minimum length of 3. Maximum length of 63. Pattern: ^[a-z0-9][a-z0-9\-]* Required: Yes key The S3 key object name. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: [a-zA-Z0-9\-/]* Required: Yes objectVersion If you enable versioning for the bucket, you can specify the object version. S3Reference 436 Amazon WorkMail Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: .+ Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 S3Reference 437 Amazon WorkMail API Reference Common Parameters The following list contains the parameters that all actions use for signing Signature Version 4 requests with a query string. Any action-specific parameters are listed in the topic for that action. For more information about Signature Version 4, see Signing AWS API requests in the IAM User Guide. Action The action to be performed. Type: string Required: Yes Version The API version |
workmail-api-071 | workmail-api.pdf | 71 | using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 S3Reference 437 Amazon WorkMail API Reference Common Parameters The following list contains the parameters that all actions use for signing Signature Version 4 requests with a query string. Any action-specific parameters are listed in the topic for that action. For more information about Signature Version 4, see Signing AWS API requests in the IAM User Guide. Action The action to be performed. Type: string Required: Yes Version The API version that the request is written for, expressed in the format YYYY-MM-DD. Type: string Required: Yes X-Amz-Algorithm The hash algorithm that you used to create the request signature. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Valid Values: AWS4-HMAC-SHA256 Required: Conditional X-Amz-Credential The credential scope value, which is a string that includes your access key, the date, the region you are targeting, the service you are requesting, and a termination string ("aws4_request"). The value is expressed in the following format: access_key/YYYYMMDD/region/service/ aws4_request. 438 Amazon WorkMail API Reference For more information, see Create a signed AWS API request in the IAM User Guide. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Required: Conditional X-Amz-Date The date that is used to create the signature. The format must be ISO 8601 basic format (YYYYMMDD'T'HHMMSS'Z'). For example, the following date time is a valid X-Amz-Date value: 20120325T120000Z. Condition: X-Amz-Date is optional for all requests; it can be used to override the date used for signing requests. If the Date header is specified in the ISO 8601 basic format, X-Amz-Date is not required. When X-Amz-Date is used, it always overrides the value of the Date header. For more information, see Elements of an AWS API request signature in the IAM User Guide. Type: string Required: Conditional X-Amz-Security-Token The temporary security token that was obtained through a call to AWS Security Token Service (AWS STS). For a list of services that support temporary security credentials from AWS STS, see AWS services that work with IAM in the IAM User Guide. Condition: If you're using temporary security credentials from AWS STS, you must include the security token. Type: string Required: Conditional X-Amz-Signature Specifies the hex-encoded signature that was calculated from the string to sign and the derived signing key. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. 439 Amazon WorkMail Type: string Required: Conditional X-Amz-SignedHeaders API Reference Specifies all the HTTP headers that were included as part of the canonical request. For more information about specifying signed headers, see Create a signed AWS API request in the IAM User Guide. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Required: Conditional 440 Amazon WorkMail API Reference Common Errors This section lists the errors common to the API actions of all AWS services. For errors specific to an API action for this service, see the topic for that API action. AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 400 IncompleteSignature The request signature does not conform to AWS standards. HTTP Status Code: 400 InternalFailure The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 InvalidAction The action or operation requested is invalid. Verify that the action is typed correctly. HTTP Status Code: 400 InvalidClientTokenId The X.509 certificate or AWS access key ID provided does not exist in our records. HTTP Status Code: 403 NotAuthorized You do not have permission to perform this action. HTTP Status Code: 400 OptInRequired The AWS access key ID needs a subscription for the service. HTTP Status Code: 403 441 Amazon WorkMail RequestExpired API Reference The request reached the service more than 15 minutes after the date stamp on the request or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request is more than 15 minutes in the future. HTTP Status Code: 400 ServiceUnavailable The request has failed due to a temporary failure of the server. HTTP Status Code: 503 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 ValidationError The input fails to satisfy the constraints specified by an AWS service. HTTP Status Code: 400 442 |
workmail-ug-001 | workmail-ug.pdf | 1 | User Guide Amazon WorkMail Version 1.0 Copyright © 2025 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. Amazon WorkMail User Guide Amazon WorkMail: User Guide Copyright © 2025 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored by Amazon. Amazon WorkMail Table of Contents User Guide What is Amazon WorkMail? ............................................................................................................ 1 Amazon WorkMail system requirements ................................................................................................. 1 Amazon WorkMail quotas ........................................................................................................................... 2 Amazon WorkMail languages ..................................................................................................................... 2 Setting up email clients .................................................................................................................. 3 Password best practices for security ........................................................................................................ 4 Signing in to the Amazon WorkMail web client .................................................................................... 4 Changing web client settings ............................................................................................................... 5 Changing the personal access token settings ................................................................................... 6 General settings ....................................................................................................................................... 6 Email settings ........................................................................................................................................... 7 Email rules settings ................................................................................................................................ 8 Automatic response settings ................................................................................................................ 9 Calendar settings ..................................................................................................................................... 9 Setting up Microsoft Outlook clients .................................................................................................... 11 Connecting Microsoft Outlook clients to your Amazon WorkMail account using AutoDiscover .......................................................................................................................................... 11 Connecting Microsoft Outlook clients to your Amazon WorkMail account manually ............. 13 Setting up mobile device clients ............................................................................................................ 17 Connect your Android device ............................................................................................................. 17 Connect your iOS device ..................................................................................................................... 18 Manually connect your mobile device .............................................................................................. 19 Setting up Microsoft Outlook for Android and iOS ...................................................................... 20 Setting up the Windows 10 Mail app .................................................................................................... 20 Setting up the Windows 11 Mail app .................................................................................................... 22 Setting up macOS apps ............................................................................................................................ 24 Setting up IMAP ......................................................................................................................................... 25 Working with email ....................................................................................................................... 28 Working with email messages ................................................................................................................. 28 Sending email messages ..................................................................................................................... 28 Sending email from an alias .............................................................................................................. 30 Sending email to a subaddress .......................................................................................................... 31 Copying or moving email messages ................................................................................................. 31 Printing email messages ..................................................................................................................... 32 Version 1.0 iii Amazon WorkMail User Guide Deleting email messages ..................................................................................................................... 32 Working with email rules ......................................................................................................................... 33 Working with shared and full access inboxes ...................................................................................... 36 Opening shared inboxes ...................................................................................................................... 36 Opening full access inboxes ............................................................................................................... 37 Sending encrypted or signed email ....................................................................................................... 37 Working with folders .................................................................................................................... 41 Managing folders ....................................................................................................................................... 41 Creating folders ..................................................................................................................................... 41 Copying, moving, or renaming folders ............................................................................................. 42 Deleting folders ..................................................................................................................................... 42 Emptying the Deleted Items folder .................................................................................................. 42 Marking items as read or unread ...................................................................................................... 43 Viewing folder size ............................................................................................................................... 43 Sharing folders and folder permissions ................................................................................................ 44 Sharing email folders ........................................................................................................................... 44 Sharing non-standard folders ............................................................................................................ 45 Opening shared email folders ............................................................................................................ 45 Viewing folder permissions ................................................................................................................ 46 Changing folder permissions .............................................................................................................. 47 Stop sharing folders ............................................................................................................................. 47 Working with calendars ................................................................................................................ 48 Managing calendars ................................................................................................................................... 48 Creating appointments ........................................................................................................................ 49 Creating meeting requests .................................................................................................................. 49 Editing meetings and appointments ................................................................................................ 50 Moving meetings and appointments ................................................................................................ 50 Canceling or declining meeting requests ........................................................................................ 51 Printing calendar items ....................................................................................................................... 51 Deleting meetings and appointments .............................................................................................. 52 Working with calendar settings .............................................................................................................. 52 Changing your calendar view ............................................................................................................. 52 Changing calendar settings ................................................................................................................ 52 Viewing multiple calendars ................................................................................................................ 53 Sharing calendars ....................................................................................................................................... 53 Sharing calendars with other users .................................................................................................. 54 Version 1.0 iv Amazon WorkMail User Guide Opening shared calendars .................................................................................................................. 54 Working with contacts .................................................................................................................. 56 Managing contacts ..................................................................................................................................... 56 Creating contacts .................................................................................................................................. 56 Editing contacts ..................................................................................................................................... 57 Copying or moving contacts .............................................................................................................. 57 Printing contacts ................................................................................................................................... 57 Deleting contacts .................................................................................................................................. 57 Creating distribution lists ......................................................................................................................... 58 Sharing contacts ......................................................................................................................................... 58 Sharing contacts with other users .................................................................................................... 59 Opening shared contacts .................................................................................................................... 59 Working with delegates ................................................................................................................ 61 Sending email on behalf of someone else ........................................................................................... 61 Sending email as someone else .............................................................................................................. 62 Scheduling meetings on behalf of someone else ............................................................................... 62 Sharing your inbox with another user ................................................................................................... 64 Working with accessibility features ............................................................................................. 65 Supported screen readers ........................................................................................................................ 65 Using shortcut keys with Amazon WorkMail ........................................................................................ 66 Working with general and email settings ............................................................................................. 67 General settings .................................................................................................................................... 67 Email settings ........................................................................................................................................ 68 Using the global address book ............................................................................................................... 69 Working with email ................................................................................................................................... 70 Working with folders ................................................................................................................................. 73 Troubleshooting ............................................................................................................................. 75 Document history .......................................................................................................................... 76 AWS Glossary ................................................................................................................................. 79 Version 1.0 v Amazon WorkMail User Guide What is Amazon WorkMail? Amazon WorkMail is a managed email and calendaring service with strong security controls and support for existing desktop and mobile email clients. You can access your email, contacts, and calendars wherever you use Microsoft Outlook, your browser, or your iOS and Android mobile devices. Administrators can integrate Amazon WorkMail with existing corporate directories, controlling both the keys that encrypt their data and the location where the data is stored. Amazon WorkMail system requirements When your Amazon WorkMail administrator invites you to |
workmail-ug-002 | workmail-ug.pdf | 2 | Document history .......................................................................................................................... 76 AWS Glossary ................................................................................................................................. 79 Version 1.0 v Amazon WorkMail User Guide What is Amazon WorkMail? Amazon WorkMail is a managed email and calendaring service with strong security controls and support for existing desktop and mobile email clients. You can access your email, contacts, and calendars wherever you use Microsoft Outlook, your browser, or your iOS and Android mobile devices. Administrators can integrate Amazon WorkMail with existing corporate directories, controlling both the keys that encrypt their data and the location where the data is stored. Amazon WorkMail system requirements When your Amazon WorkMail administrator invites you to sign in to your Amazon WorkMail account, you can sign in using the Amazon WorkMail web client. For more information, see Signing in to the Amazon WorkMail web client. Amazon WorkMail also works with all major mobile devices and operating systems that support the Exchange ActiveSync protocol. These devices include the iPad, iPhone, Android, and Windows Phone. Users of macOS can add their Amazon WorkMail account to their Mail, Calendar, and Contacts apps. Amazon WorkMail supports the following operating system versions: • Windows – Windows 7 SP1 or later • MacOS – MacOS 10.12 (Sierra) or later • Android – Andriod 5.0 or later • iPhone – iOS 5 or later • Windows phone – Windows 8.1 or later • Blackberry – Blackberry OS 10.3.3.3216 If you have a valid Microsoft Outlook license, you can access Amazon WorkMail using the following versions of Microsoft Outlook: • Outlook 2013 or later • Outlook 2013 Click-to-Run or later • Outlook for Mac 2016 or later Amazon WorkMail system requirements Version 1.0 1 Amazon WorkMail User Guide You can access the Amazon WorkMail web client using the following browser versions: • Google Chrome – Version 22 or later • Mozilla Firefox – Version 27 or later • Safari – Version 7 or later • Internet Explorer – Version 11 • Microsoft Edge You can also use Amazon WorkMail with your preferred IMAP client. For more information, see Setting up email clients for Amazon WorkMail. Amazon WorkMail quotas For a list of Amazon WorkMail quotas, see Amazon WorkMail Quotas in the Amazon WorkMail Administrator Guide. Amazon WorkMail languages Amazon WorkMail is available in the following languages: • English • Russian • French Amazon WorkMail quotas Version 1.0 2 Amazon WorkMail User Guide Setting up email clients for Amazon WorkMail Amazon WorkMail integrates with most popular email apps and devices. You can synchronize your email, calendar, and contacts between Amazon WorkMail and your client. When your Amazon WorkMail administrator invites you to sign in to your Amazon WorkMail account, you can sign in using the Amazon WorkMail web client. You can also set up other email clients for use with your Amazon WorkMail account, such as Microsoft Outlook, the stock Android or iOS clients, the Windows Mail client, macOS clients, or IMAP clients. Currently, POP3 clients are not supported. Note Amazon WorkMail discontinued support for Transport Layer Security (TLS) 1.0 and 1.1. If you are using TLS 1.0 or 1.1, you must upgrade the TLS version to 1.2. For more information, see TLS 1.2 to become the minimum TLS protocol level for all AWS API endpoints. Warning To help protect your computer from malicious email attachments, we recommend that you install antivirus software. Topics • Password best practices for security • Signing in to the Amazon WorkMail web client • Setting up Microsoft Outlook clients for Amazon WorkMail • Setting up mobile device clients for Amazon WorkMail • Setting up the Windows 10 Mail app for Amazon WorkMail • Setting up the Windows 11 Mail app for Amazon WorkMail • Setting up macOS apps for Amazon WorkMail • Setting up IMAP for Amazon WorkMail Version 1.0 3 Amazon WorkMail User Guide Password best practices for security When you use the Amazon WorkMail web or a third-party client to access your mailbox, you must use a password to sign in. As an Amazon WorkMail web client user, under Settings, you can change or update your password. For information on changing the password on the Amazon WorkMail web client, see General settings. You can also ask your system administrator to reset the password using the AWS console. As part of security best practices, here are some password guidelines recommended by Amazon WorkMail. • Set a password that contains a minimum of 8 characters. The password should include uppercase and lowercase characters, numerical digits (0 through 9), and special characters (for example, ~ or !). • Use unique passwords across all online accounts. Avoid re-using the same password for multiple accounts. • Avoid using common words or phrases related to your username, domain, organization, Amazon WorkMail service, AWS or the account type for which the password applies. • Use a password manager to securely store your password. Signing |
workmail-ug-003 | workmail-ug.pdf | 3 | As part of security best practices, here are some password guidelines recommended by Amazon WorkMail. • Set a password that contains a minimum of 8 characters. The password should include uppercase and lowercase characters, numerical digits (0 through 9), and special characters (for example, ~ or !). • Use unique passwords across all online accounts. Avoid re-using the same password for multiple accounts. • Avoid using common words or phrases related to your username, domain, organization, Amazon WorkMail service, AWS or the account type for which the password applies. • Use a password manager to securely store your password. Signing in to the Amazon WorkMail web client Amazon WorkMail has a web-based client that you use to access your Amazon WorkMail account from a web browser. The Amazon WorkMail web client includes integrated applications, such as Mail, Calendar, and Contacts. To get started with the Amazon WorkMail web client, you need a broadband internet connection and the latest version of one of the following web browsers: • Google Chrome – Version 22 or later • Mozilla Firefox – Version 27 or later • Safari – Version 7 or later • Internet Explorer – Version 11 • Microsoft Edge Password best practices for security Version 1.0 4 Amazon WorkMail User Guide Your Amazon WorkMail system administrator provides you with your initial sign-in credentials, which consist of a user name and a password. To recover a lost or forgotten password, contact your administrator. Your administrator also provides you with a unique Amazon WorkMail web client URL. This URL contains a unique alias set up by your Amazon WorkMail site administrator. The web client URL looks like this: https://alias.awsapps.com/mail. Replace alias with the alias you received from your site administrator. To sign in to the Amazon WorkMail web client 1. In your web browser, enter the web client URL provided by your Amazon WorkMail administrator. For example, https://alias.awsapps.com/mail. 2. For Username, enter the user name provided by your Amazon WorkMail administrator. Note Don't enter your full email address. User names are case-sensitive. 3. For Password, enter your password. 4. Choose Sign In. Changing Amazon WorkMail web client settings You can change many of the default settings for the Amazon WorkMail web client. To change the Amazon WorkMail web client settings 1. 2. In the Amazon WorkMail web client, on the menu bar, choose Settings (the gear icon). In the navigation pane, select the General tab, Email tab, Email Rules tab, Automatic response tab, or Calendar tab to update setting in each category. 3. Press the F5 key to refresh and activate the new settings. For more information about changing specific settings, see the following topics. Changing web client settings Version 1.0 5 Amazon WorkMail User Guide Personal access token settings When your administrator enables multi-factor authentication (MFA), you can use personal access tokens in Amazon WorkMail to authenticate and access your mailbox using various email clients. Personal access tokens provide direct access to your Amazon WorkMail and should be handled securely to avoid unauthorized access to your email. You can create multiple personal access tokens with different names and expiration dates. This allows you to manage access to your mailbox more granularly, such as creating a token for a specific device or email client, and setting an expiration date for the token. To manage your personal access tokens in Amazon WorkMail, follow this procedure: 1. In the Amazon WorkMail web client, on the menu bar, choose Settings (the gear icon). 2. Choose Personal access token. 3. Choose Create token. The Create personal access token page appears. 4. Under Name, enter a name for the personal access token. 5. Choose Create token. Note Copy the generated token immediately and paste the token value in your email client for authentication. Once you leave this page, you will not be able to view the token for security reasons. 6. Choose Return to list page. The Personal access token page appeared. You can view all the existing personal access tokens created. General settings View mailbox usage and set your password, preferred language, and default address book from the General tab using the following settings. Changing the personal access token settings Version 1.0 6 Amazon WorkMail Change password User Guide To change your password, choose Change password, and then follow the instructions on the screen. Note If Amazon WorkMail is integrated with your corporate directory, you might have to change your password using Microsoft Windows or corporate password management tools. Contact your Amazon WorkMail administrator for details if you are unsure. Language To change the language in which Amazon WorkMail is displayed, select a language from the list. To change your date format and time format, select a format from the list. Mailbox Usage Shows the current amount of storage space used. To reduce your mailbox size you |
workmail-ug-004 | workmail-ug.pdf | 4 | User Guide To change your password, choose Change password, and then follow the instructions on the screen. Note If Amazon WorkMail is integrated with your corporate directory, you might have to change your password using Microsoft Windows or corporate password management tools. Contact your Amazon WorkMail administrator for details if you are unsure. Language To change the language in which Amazon WorkMail is displayed, select a language from the list. To change your date format and time format, select a format from the list. Mailbox Usage Shows the current amount of storage space used. To reduce your mailbox size you can empty the Deleted Items folder, delete older messages, or delete messages with large attachments from your folders. Address Book To select a default address book, in Select Default Folder, select the address book to use. The default address book is loaded when choosing Address book from the main menu bar, or when selecting the To, Cc, or Bcc field when composing a new email. Email settings Change email preview, formatting, font, and other options from the Email tab using the following settings. Display preview pane You can choose to view a preview of items to either the right of the content pane or below the content pane. You can also choose to turn off the preview pane. Email settings Version 1.0 7 Amazon WorkMail Note User Guide Changing the view from the mail application using the View menu also updates this Display preview pane setting. Close email when responding When selected, the original email closes when you reply to it. Deselect this setting to compose replies in a separate tab from the original message. Format You can compose new mail messages as Plain text or HTML. Default font Specifies the default font used in all new email messages. Default font size Specifies the size of the default font. Always request a read receipt Select this check box to automatically request read receipts for every email message you send. Respond to read receipt Select whether Amazon WorkMail should always send a read receipt, never send a read receipt, or whether you should be prompted before sending a read receipt. Signatures You can create several signatures for different purposes. For example, you can create a signature for business and one for private use, or create a long signature for new email messages and a short signature for replies and forwards. (Optional) After you create one or more signatures, you can also specify which one to use for new email messages and which one to use for replies and forwards. Email rules settings Email rules can help you focus on important email messages and keep your inbox organized. Rules are stored on the server so that they can filter the mail before it arrives in your inbox. Email rules settings Version 1.0 8 Amazon WorkMail User Guide You can create as many rules as you want. With each rule, you can set different conditions to activate the rule. You can also set various follow-up actions to perform after the rule has been activated. You can construct complex rules to deal with large email volumes or complex workflows. To create a new email rule 1. 2. From the Email Rules tab, choose New. In the New email rule dialog box, define the rule. You can set a variety of conditions and actions that Amazon WorkMail performs on every email message that meets your defined criteria. Automatic response settings Mark yourself in or out of the office from the Automatic Response tab. You can also specify the message that is sent automatically in reply to all incoming messages while you are away. To prevent someone who is sending you several email messages per day from getting a reply on each message, automatic responses are only sent once to any specific email address. This also prevents a mail flood in case the person who sends you the email message also has automatic responses turned on. When Automatic response is enabled, and you sign on to the Amazon WorkMail web client, a warning message is shown to remind you that the Automatic response is set. The warning message also prompts you to turn automatic responses off. Calendar settings Set your calendar format, default reminder time, and other options using the following settings. First day of the week If your week starts on a different day instead of Monday, you can change it to that day using this setting. First week of the year Specify whether the calendar should count weeks from the first full week, or first partial week, of a new year. Automatic response settings Version 1.0 9 Amazon WorkMail User Guide Start of workday, End of workday Specify the part of the day that is marked as your workday. The calendar shows this time |
workmail-ug-005 | workmail-ug.pdf | 5 | Calendar settings Set your calendar format, default reminder time, and other options using the following settings. First day of the week If your week starts on a different day instead of Monday, you can change it to that day using this setting. First week of the year Specify whether the calendar should count weeks from the first full week, or first partial week, of a new year. Automatic response settings Version 1.0 9 Amazon WorkMail User Guide Start of workday, End of workday Specify the part of the day that is marked as your workday. The calendar shows this time period in a different color so that you can see when an appointment or meeting is scheduled outside office hours. The default values for office hours are 8:30 - 17:30 (8:30 AM - 5:30 PM). Calendar resolution If your appointments frequently start at times other than each half or whole hour, or have a duration other than multiples of 30 minutes, then change this value to better fit your needs. Note Setting the value to less than 30 minutes makes the Amazon WorkMail web application zoom in on the calendar. This may cause you to scroll more when accessing your calendar on a smaller screen. View multiple calendars Specify how multiple calendars should be displayed by default in the Calendar. Side-by-side displays all calendars next to each other. Overlay displays all calendars transparently on top of each other, where each calendar has its own color. Note This setting has no effect when you are only displaying one calendar. Default reminder time Specify how long before the start of the appointment the default reminder should occur. This setting can be overruled for any appointment by editing it manually in the calendar. The default is 15 minutes. Default all-day appointment reminder time Specify the reminder time that is automatically set when you create a new all-day appointment. The default is 18 hours. This setting can be overruled for any appointment by editing it manually in the calendar. Calendar settings Version 1.0 10 Amazon WorkMail User Guide Setting up Microsoft Outlook clients for Amazon WorkMail To get started with Microsoft Outlook, connect Microsoft Outlook to your Amazon WorkMail account. Topics • Connecting Microsoft Outlook clients to your Amazon WorkMail account using AutoDiscover • Connecting Microsoft Outlook clients to your Amazon WorkMail account manually Connecting Microsoft Outlook clients to your Amazon WorkMail account using AutoDiscover Amazon WorkMail uses AutoDiscover to configure your Outlook client. Make sure AutoDiscover is configured before you setup your Outlook client. For information, see Enabling AutoDiscover in the Amazon WorkMail Administrator Guide. To set up your Outlook client, you need your Amazon WorkMail email address and password. Amazon WorkMail integrates with the following versions of Outlook: • Windows clients — Office Outlook 2013 or later • Mac clients — Outlook for Mac 2016 or later Note You must use legacy mode for Mac Outlook to sync email and fully utilize Amazon WorkMail. The new Outlook mode currently lacks support for Amazon WorkMail profile configuration and features. Switching to legacy mode allows you to set up a complete Amazon WorkMail profile with syncing, sending, and receiving capabilities. If automatic configuration fails, you can manually configure most Outlook clients, except for Outlook 2016 and Outlook 2019 for Windows. For more information, see Connecting Microsoft Outlook clients to your Amazon WorkMail account manually. Topics • Connecting Microsoft Outlook on Windows clients • Connecting Microsoft Outlook on Mac clients Setting up Microsoft Outlook clients Version 1.0 11 Amazon WorkMail User Guide Connecting Microsoft Outlook on Windows clients To connect Microsoft Outlook to your Amazon WorkMail account. 1. 2. 3. 4. In Windows, open Control Panel, and choose Mail (32-bit). In the Mail Setup - Outlook dialog box, choose Show Profiles. Then, in the Mail dialog box, choose Add. In the New Profile dialog box, enter WorkMail in the Profile Name field, and choose OK. In the Add Account dialog box, in the E-mail Address field, enter your Amazon WorkMail email address and choose Next. If you're prompted to enter your user name and password, make sure that you enter your full email address as your user name. If you're prompted to configure server settings in the Allow this website to configure dialog box, select the Don't ask me about this website again check box, and choose Allow. 5. Outlook will prompt you when it finishes setting up your account. Choose Finish. Connecting Microsoft Outlook on Mac clients To connect Microsoft Outlook 2016 or 2019 to your Amazon WorkMail account. 1. In Outlook 2016 for Mac or Outlook 2019 for Mac, do one of the following: • If this is the first account you're creating in Outlook 2016 or later for Mac: a. On the Welcome screen, choose Add Email Account. b. Enter your email |
workmail-ug-006 | workmail-ug.pdf | 6 | in the Allow this website to configure dialog box, select the Don't ask me about this website again check box, and choose Allow. 5. Outlook will prompt you when it finishes setting up your account. Choose Finish. Connecting Microsoft Outlook on Mac clients To connect Microsoft Outlook 2016 or 2019 to your Amazon WorkMail account. 1. In Outlook 2016 for Mac or Outlook 2019 for Mac, do one of the following: • If this is the first account you're creating in Outlook 2016 or later for Mac: a. On the Welcome screen, choose Add Email Account. b. Enter your email address, and then choose Continue. c. Under Choose the provider, choose Exchange. • If you already have an email account for a different email address: a. b. c. In the Tools menu, choose Accounts. In the Accounts dialog box, choose + (plus sign) and New Account. Enter your Email Address and choose Continue. d. Under Choose the provider, choose Exchange. 2. In the Enter your Exchange account information dialog box, for Method, choose User Name and Password and enter your email address. Connecting Microsoft Outlook clients to your Amazon WorkMail account using AutoDiscover Version 1.0 12 Amazon WorkMail User Guide 3. For Domain\Username or Email, enter your email address, and for Password, enter your password. 4. Choose Add Account to complete setup. Microsoft Outlook will attempt to detect your email server settings. If Outlook prompts you to allow the server to configure your settings, select the Always use my response for this server check box, and then choose Allow. After your account is successfully set up, Outlook displays the account in the Accounts dialog box. For more information about adding accounts in Outlook 2016 or later for Mac, see Add an email account to Outlook Connecting Microsoft Outlook clients to your Amazon WorkMail account manually If automatic configuration fails, you can manually configure the following versions of Outlook: • Windows clients — Outlook 2013 • Mac clients — Outlook 2016 or later for Mac Outlook 2016 and Outlook 2019 for Windows can only be configured by using AutoDiscover. For more information see Connecting Microsoft Outlook clients to your Amazon WorkMail account manually. Topics • Connecting Microsoft Outlook on Windows clients manually • Connecting Outlook for Windows on Windows clients manually • Connecting Microsoft Outlook on Mac clients manually Connecting Microsoft Outlook on Windows clients manually To manually configure Outlook on Windows. Follow these steps to manually configure Office Outlook 2013. Connecting Microsoft Outlook clients to your Amazon WorkMail account manually Version 1.0 13 Amazon WorkMail User Guide 1. In Windows, open Control Panel, and choose User Accounts and Mail (32-bit). Note If you don't see User Accounts and Mail (32-bit), open the View by list and choose either Large icons or Small icons. 2. 3. 4. 5. In the Mail Setup - Outlook dialog box, choose Show Profiles. Then, in the Mail dialog box, choose Add. In the New Profile dialog box, enter a name for the profile in the Profile name field and choose OK. Select Manual setup or additional server types, and then choose Next. If it isn't already, select Outlook.com or Exchange ActiveSync compatible service, and then choose Next. 6. Complete the following fields in the Server Settings dialog box: • For Your name, enter the name that you want others to see. • For E-mail Address, enter your Amazon WorkMail address. • For Mail server, enter the outlook.mail.aws-region.awsapps.com server that corresponds to your mailbox's AWS Region • US West (Oregon) outlook.mail.us-west-2.awsapps.com • US East (N. Virginia) outlook.mail.us-east-1.awsapps.com • Europe (Ireland) outlook.mail.eu-west-1.awsapps.com Note If you don’t know your mailbox's AWS Region, contact your system administrator. • For User Name, enter your Amazon WorkMail user name. • For Password, enter your Amazon WorkMail password. Connecting Microsoft Outlook clients to your Amazon WorkMail account manually Version 1.0 14 Amazon WorkMail User Guide 7. (Optional) Choose Remember password. 8. Choose Next. Outlook tests the connection and displays a message saying that your account is ready for use. 9. Choose Finish. Connecting Outlook for Windows on Windows clients manually To manually configure Outlook for Windows on Windows. Follow these steps to manually configure Outlook for Windows, also known as Outlook (new) or the new Outlook. 1. In Windows, open Outlook for Windows. 2. Choose Add account. 3. In the Enter an email address to sign in text box, enter your email address. 4. Choose Continue. 5. On the Select your email provider page, scroll down to select IMAP and enter the password. 6. Slide the Show more button. 7. Under IMAP incoming server, replace the URL with imap.mail.{AWS- region}.awsapps.com and retain the Port to 993. 8. Set the Secure connection type as SSL/TLS. 9. Under SMTP username and password, retain the SMTP username and password. 10. Under SMTP Outgoing server, enter |
workmail-ug-007 | workmail-ug.pdf | 7 | or the new Outlook. 1. In Windows, open Outlook for Windows. 2. Choose Add account. 3. In the Enter an email address to sign in text box, enter your email address. 4. Choose Continue. 5. On the Select your email provider page, scroll down to select IMAP and enter the password. 6. Slide the Show more button. 7. Under IMAP incoming server, replace the URL with imap.mail.{AWS- region}.awsapps.com and retain the Port to 993. 8. Set the Secure connection type as SSL/TLS. 9. Under SMTP username and password, retain the SMTP username and password. 10. Under SMTP Outgoing server, enter the URL smtp.mail.{AWS-region}.awsapps.com and set the Port to 465. 11. Set the Secure connection type as SSL/TLS. 12. Choose Continue to add the account. 13. On the Sync your IMAP account page, choose Continue. 14. Choose Done. Connecting Microsoft Outlook on Mac clients manually To manually configure Outlook 2019 or later for Mac. Connecting Microsoft Outlook clients to your Amazon WorkMail account manually Version 1.0 15 Amazon WorkMail User Guide Follow these steps to manually configure Outlook for Outlook 2019 or later for Mac. 1. In the Tools menu, choose Accounts. In the Accounts dialog box, choose + and New Account, type your Email Address, choose Continue, and under Choose the provider, choose Exchange. • If you’re using Outlook for Mac 2011, uncheck Configure automatically in the Enter your Exchange account information dialog box. For Authentication, choose User Name and Password. 2. Type your Email address, Password, and User name where indicated. Make sure to type your full password. 3. For Server, type the endpoint matching the AWS Region where your mailbox is located. • US West (Oregon) https://ews.mail.us-west-2.awsapps.com/EWS/Exchange.asmx • US East (N. Virginia) https://ews.mail.us-east-1.awsapps.com/EWS/Exchange.asmx • Europe (Ireland) https://ews.mail.eu-west-1.awsapps.com/EWS/Exchange.asmx Note If you don’t know the AWS Region where your mailbox is located, contact your system administrator. 4. Choose Add Account to complete setup. 5. After your account is successfully set up, it displays in the Accounts dialog box. For more information about adding accounts in Outlook for Mac, see the following: • Add an email account to Outlook for Mac 2011 • Add an email account to Outlook (Outlook 2019 or later for Mac) Connecting Microsoft Outlook clients to your Amazon WorkMail account manually Version 1.0 16 Amazon WorkMail User Guide Setting up mobile device clients for Amazon WorkMail Note Make sure AutoDiscover is configured before you setup your mobile device client. Amazon WorkMail uses AutoDiscover to configure your mobile device client. For information, see Enabling AutoDiscover in the Amazon WorkMail Administrator Guide. Use Exchange ActiveSync to connect your Android or iOS mobile device to Amazon WorkMail. Note Amazon WorkMail does not support draft synchronization with Android or iOS mobile devices. Topics • Connect your Android device • Connect your iOS device • Manually connect your mobile device • Setting up Microsoft Outlook for Android and iOS Connect your Android device Amazon WorkMail supports Exchange ActiveSync for integration with Android devices. To connect your Android device to your Amazon WorkMail email account, you need your Amazon WorkMail email address and password. To connect your Amazon WorkMail account to your Android device 1. On your Android device, open the Settings page. 2. Choose Accounts, and then choose Add accounts. 3. Choose Exchange, then enter your email address and choose Next. Setting up mobile device clients Version 1.0 17 Amazon WorkMail User Guide 4. Enter your password. After your device connects with the mail server, choose Save. Connect your iOS device Amazon WorkMail supports Microsoft Exchange ActiveSync for integration with iOS devices. To connect your iOS device to your Amazon WorkMail email account, you need your Amazon WorkMail email address and password. Note If your organization has enabled mobile device management, you may be required to set a password when you connect your device. To connect your Amazon WorkMail account to your iOS device 1. On your iOS device, choose Settings. 2. Scroll down to Mail. 3. Choose Accounts, Add Account, and then choose Microsoft Exchange. 4. Do one of the following: • In iOS 11 and later, enter your Amazon WorkMail email address and a description for the account. Choose Next, Sign in, and then enter the password associated with your email address. • In versions of iOS earlier than iOS 11, enter your Amazon WorkMail email address, password, a description for the account, and then choose Next. Note In iOS 11 and later, automatic configuration works if you use your organization's alias.awsapps.com complementary domain, or if you use a custom domain with AutoDiscover Phase 2 that is configured for the domain. For more information, see Use AutoDiscover to configure endpoints. 5. Do one of the following: Connect your iOS device Version 1.0 18 Amazon WorkMail User Guide • In the Exchange confirmation dialog box, select the items to synchronize with |
workmail-ug-008 | workmail-ug.pdf | 8 | email address. • In versions of iOS earlier than iOS 11, enter your Amazon WorkMail email address, password, a description for the account, and then choose Next. Note In iOS 11 and later, automatic configuration works if you use your organization's alias.awsapps.com complementary domain, or if you use a custom domain with AutoDiscover Phase 2 that is configured for the domain. For more information, see Use AutoDiscover to configure endpoints. 5. Do one of the following: Connect your iOS device Version 1.0 18 Amazon WorkMail User Guide • In the Exchange confirmation dialog box, select the items to synchronize with your device, and then choose Save. • If your account can't be found, you are prompted to provide the name of your Exchange server, the server's domain, your user name, and your password. For more information, see Manually connect your mobile device. Manually connect your mobile device If your mobile device doesn't support AutoDiscover, or if automatic configuration failed, you can manually configure the client by providing the following information. Required Information Description Type of account Protocol Domain Exchange ActiveSync Empty User name or Domain/User name Email address associated with your Amazon WorkMail account Password Server Your password The endpoint matching the AWS Region where your mailbox is located: • US West (Oregon) mobile.mail.us-west-2.awsapps.com • US East (N. Virginia) mobile.mail.us-east-1.awsapps.com • Europe (Ireland) mobile.mail.eu-west-1.awsapps.com Manually connect your mobile device Version 1.0 19 Amazon WorkMail User Guide Required Information Description Note If you don't know the AWS Region where your mailbox is located, contact your system administrator. Setting up Microsoft Outlook for Android and iOS You can use your Amazon WorkMail account to setup and use Microsoft Outlook on your Android or iOS devices. To use your Amazon WorkMail to configure Microsoft Outlook 1. Open the Microsoft Outlook app on your device. 2. Choose Accounts. Enter your Amazon WorkMail address and choose Add Account. Note If you are asked to select a service or protocol, choose Exchange. 3. On the configuration screen, do the following: • Password –Enter your Amazon WorkMailaccount password. • Server – Enter the Exchange ActiveSync URL for your AWS Region. For a list of available Exchange ActiveSync URLs, see Amazon WorkMail endpoints and quotas. • Domain – Enter your Amazon WorkMail address' domain. • Username – Enter your Amazon WorkMail address 4. Choose Sign-in. Setting up the Windows 10 Mail app for Amazon WorkMail If you have the Mail app for Microsoft Windows 10, you can add your Amazon WorkMail account. Setting up Microsoft Outlook for Android and iOS Version 1.0 20 Amazon WorkMail User Guide To connect your Amazon WorkMail account to your Mail app 1. In Windows 10, open the Mail app, and then choose Accounts. 2. Choose Add Account, and then choose Advanced Setup. 3. Choose Exchange ActiveSync, and then provide the following information. Required Information Description Email address Password User name Domain Server Email address associated with your Amazon WorkMail account Your password Email address associated with your Amazon WorkMail account Leave this field empty The endpoint matching the AWS Region in which your mailbox is located: • US West (Oregon) mobile.mail.us-west-2.awsapps.com • US East (N. Virginia) mobile.mail.us-east-1.awsapps.com • Europe (Ireland) mobile.mail.eu-west-1.awsapps.com Note If you don't know the AWS Region where your mailbox is located, contact your system administrator. Setting up the Windows 10 Mail app Version 1.0 21 Amazon WorkMail User Guide Required Information Description Server requires encrypted (SSL) connection Select Enabled Account name Your account name 4. Choose Sign in. Setting up the Windows 11 Mail app for Amazon WorkMail If you have the Mail app for Microsoft Windows 11, you can add your Amazon WorkMail account. Note If you are using the Mail app for Microsoft Windows 11, you may receive incompatibility reports that require a fix when connecting your Amazon WorkMail account to the app. Until a fix is released by Microsoft, you will not be able to connect the Mail app to WorkMail. To ensure that you can resolve the issue as soon as a fix is released, make sure that you install Windows 11 updates as they become available. To connect your Amazon WorkMail account to your Mail app 1. In Windows 11, open the Mail app, and then choose Accounts. 2. Choose Add Account, and then choose Advanced Setup. 3. Choose Internet email, and then provide the following information: Required Information Description Email address Password User name Email address associated with your Amazon WorkMail account Your password Email address associated with your Amazon WorkMail account Setting up the Windows 11 Mail app Version 1.0 22 Amazon WorkMail User Guide Required Information Description Account name Your account name Send your message using this name Your account name Incoming email server The endpoint matching the AWS Region in which your mailbox is located: • US West (Oregon) imap.mail.us-west-2.awsapps.com |
workmail-ug-009 | workmail-ug.pdf | 9 | and then choose Accounts. 2. Choose Add Account, and then choose Advanced Setup. 3. Choose Internet email, and then provide the following information: Required Information Description Email address Password User name Email address associated with your Amazon WorkMail account Your password Email address associated with your Amazon WorkMail account Setting up the Windows 11 Mail app Version 1.0 22 Amazon WorkMail User Guide Required Information Description Account name Your account name Send your message using this name Your account name Incoming email server The endpoint matching the AWS Region in which your mailbox is located: • US West (Oregon) imap.mail.us-west-2.awsapps.com • US East (N. Virginia) imap.mail.us-east-1.awsapps.com • Europe (Ireland) imap.mail.eu-west-1.awsapps.com Note If you don't know the AWS Region where your mailbox is located, contact your system administrator. Account type IMAP4 Setting up the Windows 11 Mail app Version 1.0 23 Amazon WorkMail User Guide Required Information Description Outgoing (SMTP) email server The endpoint matching the AWS Region where your mailbox is located: • US West (Oregon) smtp.mail.us-west-2.awsapps.com • US East (N. Virginia) smtp.mail.us-east-1.awsapps.com • Europe (Ireland) smtp.mail.eu-west-1.awsapps.com Note If you don't know the AWS Region where your mailbox is located, contact your system administrator. 4. Choose Sign in. Setting up macOS apps for Amazon WorkMail Note Make sure AutoDiscover is configured before you setup the macOS apps. Amazon WorkMail uses AutoDiscover to configure the macOS apps. For information, see Enabling AutoDiscover in the Amazon WorkMail Administrator Guide. If you use macOS, you can add your Amazon WorkMail account to use with macOS apps such as Mail, Calendar, Contacts, Reminders, and Notes. Setting up macOS apps Version 1.0 24 Amazon WorkMail User Guide To connect your Amazon WorkMail account to your macOS app 1. Open System Preferences. 2. Choose Internet Accounts. 3. Choose Microsoft Exchange. 4. Do one of the following: • If using macOS Mojave or later – Enter your full name and email address, choose Sign In, and then choose Configure Manually or Sign In. Enter your password and choose Sign In. • If using macOS High Sierra or earlier – Enter your full name, email address, and password, and then choose Continue. Note If you need to provide an endpoint, see Amazon WorkMail endpoints and quotas for a current list. The information you provide in step 4 is used to set up your email account automatically. After that, you can select which macOS apps to use with Amazon WorkMail. Setting up IMAP for Amazon WorkMail You can connect any IMAP-compatible software to Amazon WorkMail by providing the following information. Note If you are using the web application, Microsoft Outlook, an Android or iOS mobile device, or a mail app for Windows 10 or macOS, see Setting up email clients for Amazon WorkMail for specific guidelines that apply to those applications. The following information is intended for use with all other IMAP-compatible clients. Setting up IMAP Version 1.0 25 Amazon WorkMail User Guide Required Information Description Type of account Protocol Port IMAP IMAPS 993 Secure connection Select Required and SSL Type of authentication PLAIN Incoming username Email address associated with your Amazon WorkMail account Incoming password Your password Incoming server The endpoint matching the AWS Region where your mailbox is located: • US West (Oregon) imap.mail.us-west-2.awsapps.com • US East (N. Virginia) imap.mail.us-east-1.awsapps.com • Europe (Ireland) imap.mail.eu-west-1.awsapps.com Note If you don't know the AWS Region where your mailbox is located, contact your system administrator. To send email, you also need to configure an outgoing SMTP server in your IMAP-compatible software. Setting up IMAP Version 1.0 26 Amazon WorkMail User Guide Required Information Description Protocol Port SMTPS (SMTP, encrypted with TLS) 465 Secure connection Select Required and SSL Note STARTTLS is not currently supported by Amazon WorkMail Outgoing username Email address associated with your Amazon WorkMail account Outgoing password Your password Outgoing server The endpoint matching the AWS Region where your mailbox is located: • US West (Oregon) smtp.mail.us-west-2.awsapps.com • US East (N. Virginia) smtp.mail.us-east-1.awsapps.com • Europe (Ireland) smtp.mail.eu-west-1.awsapps.com Note If you don't know the AWS Region where your mailbox is located, contact your system administrator. Setting up IMAP Version 1.0 27 Amazon WorkMail User Guide Working with email You can send and receive email, add or remove attachments, share inboxes, and send signed or encrypted email with the Amazon WorkMail web application. Topics • Working with email messages • Working with email rules • Working with shared and full access inboxes • Sending encrypted or signed email Working with email messages Send, copy, move, print, and delete email messages from Amazon WorkMail. If your administrator has created an alias for you, you can also send email using that alias. If you are notified that you have reached 90 percent of your mailbox quota, you can delete email to free up space. Topics • Sending email messages • Sending email from |
workmail-ug-010 | workmail-ug.pdf | 10 | and send signed or encrypted email with the Amazon WorkMail web application. Topics • Working with email messages • Working with email rules • Working with shared and full access inboxes • Sending encrypted or signed email Working with email messages Send, copy, move, print, and delete email messages from Amazon WorkMail. If your administrator has created an alias for you, you can also send email using that alias. If you are notified that you have reached 90 percent of your mailbox quota, you can delete email to free up space. Topics • Sending email messages • Sending email from an alias • Sending email to a subaddress • Copying or moving email messages • Printing email messages • Deleting email messages Sending email messages You can create and send a message to one or more recipients, include attachments, set the priority, or add a flag to indicate that the message is important. To send a message 1. In the Amazon WorkMail web application, choose the mail icon on the shortcut bar. Working with email messages Version 1.0 28 Amazon WorkMail User Guide 2. On the menu bar, choose + New item and New email. Tip You can also choose the plus sign (+) on the tab bar. 3. To add recipients, for To, type one or more names. Amazon WorkMail suggests previously used email addresses. You can remove suggestions from this list by selecting a name and choosing Delete. To add users from the address book or to add them to the CC or BCC fields, choose To, and select one or more users from the address book as appropriate. 4. (Optional) Do one of the following: • To add an attachment, choose Attach. Note The total size of the attached files can’t exceed 25 MB. • To mark the message as important or high priority, low priority, or for follow-up, choose the exclamation mark (!), down arrow, or flag icon. • To mark the message for follow-up or as a completed task, choose the flag or the checkmark icon. • To save the message as a draft in the Drafts folder, choose Save. 5. Enter your text in the lower half of the contents pane, and choose Send. Sending email messages Version 1.0 29 Amazon WorkMail User Guide Sending email from an alias Note To view the From field on the WebMail client, select the From button above the subject. You can send and receive email using an alias that your administrator configures for you. Recipients outside of your organization then see the sender as your alias address instead of your primary address. For information about configuring aliases, see Edit User Email Addresses. Note Sending email from an alias is not supported for EWS clients, IMAP/SMTP clients, or ActiveSync mobile devices. If you send an email from an alias to someone in your organization, the message is still received from your primary address. For information about sending email as a delegate, see Working with delegates. To send an email from an alias 1. In the Amazon WorkMail web application, choose the mail icon on the shortcut bar and choose + New item, New email. 2. For From, type the alias from which to send email. Tip To include a display name, use the SMTP standard format Your Name <[email protected]>. 3. When you're ready to send the email, choose Send. Sending email from an alias Version 1.0 30 Amazon WorkMail User Guide Sending email to a subaddress Note The email address (anything before the @) cannot exceed 64 characters. You can add a + tag to your Amazon WorkMail email address to help filter your incoming email messages. This is also known as subaddressing. To send emails to a subaddress, add the + sign followed by a text string of your choice to the first part of your Amazon WorkMail email address. The following example shows how to add a +sales tag to a standard email address ([email protected]), converting it to a subaddress. [email protected] In the preceding example, the recipient can use the +sales tag to filter the email messages sent to the subaddress. Amazon WorkMail recognizes text after the first + sign as a subaddress. If a sender adds a + tag that matches an existing email address in your organization, that email message is sent to the existing email address. Amazon WorkMail allows + signs in email addresses as well as subaddresses. You can't send email messages from a subaddress. Instead, contact your administrator to create an alias for you. For more information, see Sending email from an alias. Copying or moving email messages You can copy or move a message from one folder to another. To copy or move a message 1. In the Amazon WorkMail web application, choose the mail icon on the shortcut bar. |
workmail-ug-011 | workmail-ug.pdf | 11 | adds a + tag that matches an existing email address in your organization, that email message is sent to the existing email address. Amazon WorkMail allows + signs in email addresses as well as subaddresses. You can't send email messages from a subaddress. Instead, contact your administrator to create an alias for you. For more information, see Sending email from an alias. Copying or moving email messages You can copy or move a message from one folder to another. To copy or move a message 1. In the Amazon WorkMail web application, choose the mail icon on the shortcut bar. 2. Do one of the following: • To copy an item, select the message in the contents pane and choose Copy/Move. • To copy more than one message, press the Ctrl key while you select each message in the contents pane, and then choose Copy/Move. • To move a single message, drag the item to its new location. Sending email to a subaddress Version 1.0 31 Amazon WorkMail Tip User Guide The folder names directly under the dragged message are highlighted and show the target location when you release the message. • To move multiple consecutive messages, press the Shift key while you select all the messages to move, and then drag them to the desired folder. • To move messages that are not consecutive, press the Ctrl key while you select each message to move, release the Ctrl key, and then drag them into the designated folder. 3. In the Copy/move messages dialog box, select the destination folder and choose either Copy or Move. Printing email messages If you have a printer attached to your computer and your computer is set up to print documents, you can print your messages. To print a message 1. 2. 3. In the Amazon WorkMail web application, on the shortcut bar, choose the mail icon. In the navigation pane, select the folder that contains the message to print. In the contents pane, select the message to print and choose Print on the menu bar. Deleting email messages When you no longer need an email message, you can delete it. Deleting unwanted email also helps you to free up space in your inbox. To delete a message 1. In the Amazon WorkMail web application, choose the mail icon on the shortcut bar. 2. Do one of the following: • In the contents pane, select a message and press the Delete key. • In the contents pane, open the message and choose Delete. • In the Message tab, choose Delete. Printing email messages Version 1.0 32 Amazon WorkMail User Guide If you mistakenly delete a message, calendar item, or contact, you can restore it. All deleted email, calendar items, and contacts are stored in the Deleted Items folder in the application. Note You can only restore items that are still in the Deleted Items folder. If you've emptied the Deleted Items folder, those items are unrecoverable. To restore a deleted item 1. 2. In the Amazon WorkMail web application, choose the mail icon on the shortcut bar. In the Deleted Items folder, select the message to restore and choose Copy/Move. Tip You can also choose the plus sign (+) on the tab bar. 3. In the Copy/move messages dialog box, select the destination folder and choose Move. Working with email rules You use inbox rules to route emails from your mailbox in Amazon WorkMail. You can forward or redirect emails to external email addresses and to Amazon WorkMail users, resources, or groups, but not to personal distribution lists in your Contacts folder. Note Email rules don't work for recipients in Bcc. To create an email rule 1. In the Amazon WorkMail web application, choose the gear icon in the upper-right corner of the screen. 2. Choose Email rules, then New. 3. In the Rule name box, enter a name and ensure that the Active rule check box is selected. Working with email rules Version 1.0 33 Amazon WorkMail User Guide 4. Under Conditions, open the When the message list and choose a condition, such as is sent only to me. To add conditions, choose Add and select another condition from the second list. Note To match a string with special HTML characters for the condition Includes these rules in the body, remove any left angle brackets from the string. This allows matching against email body text that contains HTML markup. 5. Under Actions, open the Then list and choose an action, such as Move message to folder. To add an action, choose Add and select an action from the second list. 6. Choose OK, Save changes. Note To use the is sent to email rule, the To: or CC: fields of the email message must list the recipients. To create an email forwarding rule 1. |
workmail-ug-012 | workmail-ug.pdf | 12 | match a string with special HTML characters for the condition Includes these rules in the body, remove any left angle brackets from the string. This allows matching against email body text that contains HTML markup. 5. Under Actions, open the Then list and choose an action, such as Move message to folder. To add an action, choose Add and select an action from the second list. 6. Choose OK, Save changes. Note To use the is sent to email rule, the To: or CC: fields of the email message must list the recipients. To create an email forwarding rule 1. In the Amazon WorkMail web application, choose the gear icon in the upper-right corner of the screen. 2. Choose Email rules, then New. The New email rule dialog box appears. 3. In the Rule name box, enter a name for the rule and ensure that the Active rule check box is selected. 4. Under Conditions, open the When the message list and choose is received from. The Select sender(s) link appears. 5. Choose Select sender(s), choose the sender whose messages you want to forward, choose To, ensure that the sender's email address appears in that box, then choose Ok. Working with email rules Version 1.0 34 Amazon WorkMail Note User Guide To select multiple senders, press Shift and choose the additional senders. If you need more conditions, choose Add and select another condition from the list that appears. When done, you return to the New email rule dialog box, and the sender or senders' email addresses appear in place of Select sender(s). 6. Under Actions, open the Then list and choose Forward the message to, then choose the Select recipient(s) link. Choose the recipient that you want to forward to, choose To, then Ok. That returns you to the to the New email rule dialog box, and the sender or senders' email addresses appear in place of Select recipient(s). Note To add an action, choose Add and select a condition from the second list. 7. Choose Ok to accept the new rule. The rule then appears on your email rules page. The recipients see that you forwarded the messages, and the system copies forwarded messages to your mailbox. Finally, Amazon WorkMail doesn't forward bounced messages, messages rejected by a recipient's email server. To create an email redirect rule 1. Repeat steps 1 through 3 in the previous procedure. 2. Under Conditions, open the When the message list and choose is received from. Choose Select sender(s) and follow the steps in the previous procedure to select one or more senders. You can also add conditions as needed. 3. Under Actions, choose Redirect the message to, then Select recipient(s) and follow the steps in the previous procedure to add one or more recipients. You can also add actions as needed. 4. Follow the remaining steps in the previous procedure to save the rule. The recipient of the redirected email sees it as coming from the original sender. Also, Amazon WorkMail does not redirect bounced emails—messages rejected by a recipient's email server— Working with email rules Version 1.0 35 Amazon WorkMail User Guide unless they pass certain checks. For more information about those checks, contact your system administrator. Working with shared and full access inboxes You can open inboxes that other users share with you or that your administrator grants you permission to access. For information about sharing your inbox with another user, see Sharing your inbox with another user. Topics • Opening shared inboxes • Opening full access inboxes Opening shared inboxes You can open an inbox that another user has shared with you. To open a shared inbox 1. In the Amazon WorkMail web application, on the shortcut bar, choose the mail icon. 2. At the bottom of the navigation pane, choose Open other inbox. 3. 4. 5. In the Open other folders dialog box, choose Name. For Address Book, select the owner of the inbox to open, and choose OK. In the Open other folders dialog box, for Folder type, choose Inbox. 6. Choose Show subfolders, OK. The shared mail folders are now visible in the navigation pane. Note The shared folders are stored in your Amazon WorkMail web application profile. The next time you log in to the Amazon WorkMail web application, the opened folders are still displayed. If you receive a message saying You have insufficient privileges to open this folder, contact the owner of the folder and ask them to grant you access. Working with shared and full access inboxes Version 1.0 36 Amazon WorkMail User Guide To change folder permissions, in the navigation pane, right-click the folder, choose Properties, Permissions. 7. To close a shared folder, open the context (right-click) menu for the shared folder, and choose Close store. Opening full access inboxes You can open |
workmail-ug-013 | workmail-ug.pdf | 13 | profile. The next time you log in to the Amazon WorkMail web application, the opened folders are still displayed. If you receive a message saying You have insufficient privileges to open this folder, contact the owner of the folder and ask them to grant you access. Working with shared and full access inboxes Version 1.0 36 Amazon WorkMail User Guide To change folder permissions, in the navigation pane, right-click the folder, choose Properties, Permissions. 7. To close a shared folder, open the context (right-click) menu for the shared folder, and choose Close store. Opening full access inboxes You can open all the folders in an inbox for which your administrator has given you full access. To open a full access inbox 1. In the Amazon WorkMail web application, on the shortcut bar, choose the mail icon. 2. At the bottom of the navigation pane, choose Open other inbox. 3. 4. 5. In the Open other folders dialog box, choose Name. For Address Book, select the owner of the inbox to open, and choose OK. In the Open other folders dialog box, for Folder type, choose All. The shared inbox is now visible in the navigation pane. Note The shared inboxes are stored in your Amazon WorkMail web application profile. The next time you log in to the Amazon WorkMail web application, the opened inboxes are still displayed. If you receive a message saying You have insufficient privileges to open this folder, contact your administrator and ask them to grant you access. To close a shared inbox, open the context (right-click) menu for the shared inbox, and then choose Close store. Sending encrypted or signed email With S/MIME, you can send signed or encrypted emails inside and outside of your organization. After you configure S/MIME in the email client settings, all emails that you send are automatically Opening full access inboxes Version 1.0 37 Amazon WorkMail User Guide signed. Encryption options depend on different email clients and respective platforms. The Amazon WorkMail web app client is not supported. Note AWS Certificate Manager does not currently provide certificates to sign and encrypt email. Get the certificate (*.p12) file from your administrator or a third-party certificate authority. To configure S/MIME in Windows Outlook 1. Get the certificate (*.p12) file from your administrator or third-party certificate authority and save it to a folder. 2. Right-click the file and choose Install PFX. 3. Choose Current User, Next, select the *.p12 file, and then choose Next. 4. Enter the password and choose Next. 5. Make sure that Automatically select the certificate store is selected and choose Next. 6. Choose Finish. 7. Perform the following steps in Windows Outlook: 1. Choose File, Options, Trust Center, Trust Center Settings, Email Security, and Settings. 2. In the Change Email Security dialog box, choose Choose and select the installed certificate. 3. Choose OK, select one or all applicable options, and choose OK. 8. If all email recipients have certificates in the Global Address List (GAL) or Contacts, then all emails sent are automatically encrypted. Otherwise, you receive a warning message and can decide to send an unencrypted message or cancel. To configure S/MIME in iOS Mail 1. Get the certificate (*.p12) file from your administrator or third-party certificate authority in an email. 2. Open the email attachment and choose Install. 3. Enter the PIN and follow the instructions. Sending encrypted or signed email Version 1.0 38 Amazon WorkMail User Guide 4. Choose Settings, Mail, Accounts, select your account, and then choose Account, Advanced Settings. 5. Enable S/MIME and choose one or both of the options to sign or encrypt emails. If you chose Encrypt by Default, then all emails sent are automatically encrypted. 6. When you type an email address in the To field, iOS loads the user certificate from the Global Address List (GAL) or from Contacts. If the certificate is not found, then the red unlocked icon means that the email can’t be encrypted. To configure S/MIME in Android Nine and the Samsung Mobile devices native mail app 1. Get the certificate (*.pfx or *.p12) file from your administrator or third-party certificate authority in an email. 2. Download the attached certificates. 3. Open the Android Nine app and choose Email Settings, Accounts, select your account, and then choose Security options. 4. To enable encryption, choose Encrypt ongoing emails. Under Email encryption cert, choose Install, select your certificate used for encrypting your email message, and then choose Allow. Note If you allow Email encryption cert, when you send an email, the app loads and validates the user certificate from the Global Address List (GAL) or from a contact. If the certificate is found for the recipient, the email is sent as encrypted. Otherwise, an error is displayed and the email is not sent. You must disable the Email encryption |
workmail-ug-014 | workmail-ug.pdf | 14 | choose Email Settings, Accounts, select your account, and then choose Security options. 4. To enable encryption, choose Encrypt ongoing emails. Under Email encryption cert, choose Install, select your certificate used for encrypting your email message, and then choose Allow. Note If you allow Email encryption cert, when you send an email, the app loads and validates the user certificate from the Global Address List (GAL) or from a contact. If the certificate is found for the recipient, the email is sent as encrypted. Otherwise, an error is displayed and the email is not sent. You must disable the Email encryption cert setting. 5. To enable signing, choose Sign all outgoing emails. Under Email signing cert, choose Install, select your certificate used for signing your email message, and then choose Allow. To configure S/MIME in Outlook 2016 for Mac 1. Install the certificate on macOS: a. Get the certificate (*.p12) file from your administrator or third-party certificate authority, and save the file to a folder. Sending encrypted or signed email Version 1.0 39 Amazon WorkMail User Guide b. Double-click the certificate file to open Keychain Access and approve to add the certificate to your keychain. c. In the list of certificates in your keychain, view the newly installed certificate. 2. 3. In Outlook for Mac, choose Tools, Accounts, select your account, and then choose Advanced, Security. In Digital signing and Encryption, choose the newly installed certificate from the list and choose from the following options: • To sign all outgoing messages by default, choose Sign outgoing messages. • To encrypt all outgoing messages by default, choose Encrypt outgoing messages. • To make sure that your signed message can be viewed by all recipients and mail applications, choose Send digitally signed messages as clear text. • To enable recipients to send encrypted messages to you, choose Include my certificates in signed messages. 4. Choose OK. Note To send an encrypted email to the group, manually expand the group. Sending encrypted or signed email Version 1.0 40 Amazon WorkMail User Guide Working with folders The Amazon WorkMail web application uses folders to store email, calendars, and contacts. Email is stored in mail folders, calendar items are stored in calendar folders, and contacts are stored in contact folders, and so on. You can also share folders with other users. Topics • Managing folders • Sharing folders and folder permissions Managing folders You can organize and manage your folders by creating new folders or copying, moving, renaming, or deleting existing ones. You can also mark all the items in a folder as read or unread, empty your Deleted Items folder, and view the size of a folder to see how much storage space it takes up. Topics • Creating folders • Copying, moving, or renaming folders • Deleting folders • Emptying the Deleted Items folder • Marking items as read or unread • Viewing folder size Creating folders Create folders to organize your email, contacts, and calendar items. To create a folder 1. In the Amazon WorkMail web application, on the shortcut bar, choose the mail icon. 2. On the task bar, choose + New item, New folder. 3. In the Create New Folder dialog box, for Name, enter the name of the new folder. Managing folders Version 1.0 41 Amazon WorkMail User Guide 4. 5. For Folder contains, select the type of contents for the folder to contain. For Select where to place the folder, select the target location and choose OK. Copying, moving, or renaming folders You can copy, move, and rename folders. To copy or move a folder 1. 2. In the Amazon WorkMail web application, on the shortcut bar, choose the mail icon. In the navigation pane, right-click the folder, choose Copy/move, select the target folder, and then choose Copy or Move. To rename a folder 1. 2. 3. In the Amazon WorkMail web application, on the shortcut bar, choose the mail icon. In the navigation pane, open the context (right-click) menu for the folder, and choose Rename. Enter a new name for the folder. Deleting folders You can delete a folder that you no longer need. Deleting a folder also deletes any items in the folder. To delete a folder 1. 2. In the Amazon WorkMail web application, on the shortcut bar, choose the mail icon. In the navigation pane, open the context (right-click) menu for the folder, and choose Delete. Emptying the Deleted Items folder If your inbox is full and you're out of space, you can empty the Deleted Items folder to free up space. When you empty the Deleted Items folder, you cannot recover or undelete those items. To empty the Deleted Items folder 1. In the Amazon WorkMail web application, on the shortcut bar, choose the mail icon. Copying, moving, or renaming folders Version 1.0 42 |
workmail-ug-015 | workmail-ug.pdf | 15 | 1. 2. In the Amazon WorkMail web application, on the shortcut bar, choose the mail icon. In the navigation pane, open the context (right-click) menu for the folder, and choose Delete. Emptying the Deleted Items folder If your inbox is full and you're out of space, you can empty the Deleted Items folder to free up space. When you empty the Deleted Items folder, you cannot recover or undelete those items. To empty the Deleted Items folder 1. In the Amazon WorkMail web application, on the shortcut bar, choose the mail icon. Copying, moving, or renaming folders Version 1.0 42 Amazon WorkMail User Guide 2. In the navigation pane, open the context (right-click) menu for the Deleted Items folder, and choose Empty folder. Marking items as read or unread You can mark all items in a folder as read or unread. To mark all items in a folder as read 1. 2. In the Amazon WorkMail web application, on the shortcut bar, choose the mail icon. In the navigation pane, open the context (right-click) menu for the folder, and choose Mark all read. To mark all items in a folder as unread 1. 2. 3. In the Amazon WorkMail web application, on the shortcut bar, choose the mail icon. In the navigation pane, select the folder. In the contents pane, select all items in the folder, open the context (right-click), and then choose Mark Unread. Viewing folder size You can view a folder's size to see how much storage space it takes up. To view the size of a folder 1. 2. In the Amazon WorkMail web application, on the shortcut bar, choose the mail icon. In the navigation pane, open the context (right-click) menu for a mail folder, and choose Properties. Tip To see more details about the storage size, including the storage sizes of any subfolders, choose Details. Marking items as read or unread Version 1.0 43 Amazon WorkMail User Guide Sharing folders and folder permissions You can share email folders with other Amazon WorkMail users and open folders that have been shared with you. You can also view, change, or remove folder permissions for a shared folder. Note If you share a folder with a user that has Read permissions, that user can view everything in the folder, potentially including items marked Private. Topics • Sharing email folders • Sharing non-standard folders • Opening shared email folders • Viewing folder permissions • Changing folder permissions • Stop sharing folders Sharing email folders You can give another user permission to view an email folder. By default, Amazon WorkMail allows you to share the folders that you use the most, such as your Inbox, Calendar, and Contacts folders. If you need to share a non-standard folder, such as Sent Items, see Sharing non-standard folders. To share email folders 1. On the Amazon WorkMail shortcut bar, choose the mail icon. 2. In the navigation pane, open the context (right-click) menu for the folder to share, and choose Properties. The Permissions dialog box appears. 3. Choose the Permissions tab. 4. Under People with permissions, choose Add. The Address Book appears. Sharing folders and folder permissions Version 1.0 44 Amazon WorkMail User Guide 5. Select the users with whom you want to share the folder, and then choose OK. The Permissions dialog box appears. 6. Under Default, select a user. You can only set permissions for one user at a time. 7. Under Permission details, open the Profile list and choose a profile. —or— Under, Read, Write, Deleted items, and Other, choose the types and levels of access that you want to grant that user, and then choose OK. If you choose options that match an existing profile, the profile name appears in the Profile list. For example, Author. Otherwise, Custom appears in the list. Sharing non-standard folders To share non-standard folders, you change a permission setting in your parent email folder. To share non-standard folders 1. If you run windows, in the Amazon WorkMail navigation pane, above your Inbox folder, right- click My Mail, and then choose Properties. —or— If you run macOS, right-click the parent email address, also located above your Inbox, and then choose Properties. The Properties dialog box appears. 2. Choose the Permissions tab. 3. Select the checkbox next to Folder visible. 4. Choose OK. 5. Follow the steps in the previous section to share the desired folder. Opening shared email folders You can open an email folder that has been shared with you. Sharing non-standard folders Version 1.0 45 Amazon WorkMail To open a shared email folder User Guide 1. 2. 3. 4. 5. In the Amazon WorkMail web application, on the shortcut bar, choose the mail icon. In the navigation pane, choose Open other inbox. In the Open other folders dialog box, choose Name. For Address |
workmail-ug-016 | workmail-ug.pdf | 16 | appears. 2. Choose the Permissions tab. 3. Select the checkbox next to Folder visible. 4. Choose OK. 5. Follow the steps in the previous section to share the desired folder. Opening shared email folders You can open an email folder that has been shared with you. Sharing non-standard folders Version 1.0 45 Amazon WorkMail To open a shared email folder User Guide 1. 2. 3. 4. 5. In the Amazon WorkMail web application, on the shortcut bar, choose the mail icon. In the navigation pane, choose Open other inbox. In the Open other folders dialog box, choose Name. For Address Book, select the owner of the inbox to open and choose OK. In the Open other folders dialog box, for Folder type, select the inbox, and choose OK. The shared mail folders are now visible in the navigation pane. Note Your Amazon WorkMail profile stores the shared folders. When you log in to Amazon WorkMail, any opened folders will appear. If you receive a message saying You have insufficient privileges to open this folder, contact the folder's owner and ask for access. To change folder permissions, in the navigation pane, right-click the folder, choose Properties, and then choose Permissions. 6. To close a shared folder, open the context (right-click) menu for the shared folder, and choose Close store. Viewing folder permissions By default, you have full permissions on all of the folders and items that you own. You can share your folders with other users and groups in your organization by changing the permissions for a folder. The folder permissions provide others with different access privileges to the folder and its contents. To view folder permissions 1. 2. 3. 4. In the Amazon WorkMail web application, on the shortcut bar, choose the mail icon. In the navigation pane, open the context (right-click) menu for the folder, and choose Properties. In the Properties dialog box, choose the Permissions tab. For Profile, select a predefined set of permissions, or customize the permissions as needed. Viewing folder permissions Version 1.0 46 Amazon WorkMail User Guide Changing folder permissions You can set the permissions on a shared folder to specify the actions another user can perform on items in folder you shared with them. To change a folder's permissions 1. 2. 3. 4. 5. 6. In the Amazon WorkMail web application, on the shortcut bar, choose the mail icon. In the navigation pane, open the context (right-click) menu for the folder, and choose Properties. In the Properties dialog box, choose Permissions, Add. For Address Book, select the users or groups in your organization with which to share the folder, and choose OK. Select the user or group to which to apply the permissions. For Profile, select a predefined set of permissions, or customize the permissions as needed. 7. Repeat steps 5 and 6 for each of the users or groups in the list. 8. Choose OK. Stop sharing folders If you've shared a folder with another user, you can stop sharing it at any time. To stop sharing a folder 1. 2. In the Amazon WorkMail web application, on the shortcut bar, choose the mail icon. In the navigation pane, open the context (right-click) menu for the folder, and choose Properties. 3. On the User details page, under Permissions, choose Add or remove. 4. For Permissions, select the user or group to remove, and choose < <. 5. Repeat as necessary, then choose Save. Changing folder permissions Version 1.0 47 Amazon WorkMail User Guide Working with calendars You can create both appointments and meetings in the Amazon WorkMail web application. An appointment is an item in your calendar that is only applicable to you. No other participants are invited. A meeting is an item in your calendar that has more than one participant. As soon as you invite a coworker or schedule a resource with any appointment, it automatically becomes a meeting. When you create or edit a meeting in the Amazon WorkMail web application, there are extra controls and buttons for meeting invitations. You can share your calendar with other users, and open calendars that have been shared with you. Topics • Managing calendars • Working with calendar settings • Sharing calendars Managing calendars Create, update, and print appointments and meetings from your calendar. You can also cancel, decline, and delete calendar events. If another user has made you their delegate, you can schedule meetings on their behalf. For more information, see Scheduling meetings on behalf of someone else. Topics • Creating appointments • Creating meeting requests • Editing meetings and appointments • Moving meetings and appointments • Canceling or declining meeting requests • Printing calendar items • Deleting meetings and appointments Managing calendars Version 1.0 48 Amazon WorkMail Creating appointments User Guide You can create an appointment and set a reminder that |
workmail-ug-017 | workmail-ug.pdf | 17 | calendars Create, update, and print appointments and meetings from your calendar. You can also cancel, decline, and delete calendar events. If another user has made you their delegate, you can schedule meetings on their behalf. For more information, see Scheduling meetings on behalf of someone else. Topics • Creating appointments • Creating meeting requests • Editing meetings and appointments • Moving meetings and appointments • Canceling or declining meeting requests • Printing calendar items • Deleting meetings and appointments Managing calendars Version 1.0 48 Amazon WorkMail Creating appointments User Guide You can create an appointment and set a reminder that automatically reminds you before the appointment's start date and time. To create an appointment 1. In the Amazon WorkMail web application, on the shortcut bar, choose the calendar icon. 2. On the menu bar, choose New appointment. 3. Enter the following: • For Subject, enter a subject for the appointment. • For Start and End, specify the start and end times for the appointment. • (Optional) For Location, specify a location. • (Optional) For Reminder, set a reminder. 4. Choose Save and close. Tip You can also create an appointment by double-clicking in the calendar. Creating meeting requests You can create a meeting request that includes attendees and resources, and set a reminder to remind you before the meeting starts. To create a meeting request 1. In the Amazon WorkMail web application, on the shortcut bar, choose the calendar icon. 2. On the menu bar, choose New meeting request. 3. To add one or more attendees, type their names in the To field. Amazon WorkMail suggests names from the address book. You can remove suggestions from this list by selecting a name and then pressing Delete. To add users from the address book or to add them to the Required, Optional, or Resource fields, choose To, and select one or more users from the address book and add them to the appropriate fields. 4. Enter the following: Creating appointments Version 1.0 49 Amazon WorkMail User Guide • For Subject, enter a subject for the meeting. • For Start and End, specify the start and end times for the meeting. • For Location, specify a location. • (Optional) For Reminder, set a reminder. 5. In the lower portion of the meeting invitation, you can add information about the meeting, such as an agenda. To add an attachment to the meeting invitation, choose Attach. 6. Choose Send invitation. Editing meetings and appointments You can edit a meeting or an appointment to make changes. To edit a meeting or appointment 1. In the Amazon WorkMail web application, on the shortcut bar, select the calendar icon. 2. On the calendar, open the meeting or appointment and edit the meeting as appropriate. 3. If you are the organizer of a meeting, do one of the following: • To save your changes and send an update to the other participants, choose Send invitation. • To save your changes to the meeting without sending an update to the other participants, choose Save. Moving meetings and appointments You can move a meeting or appointment by clicking it and dragging it to a different day or time. You can also edit the meeting or appointment to move it. To move a meeting or appointment 1. In the Amazon WorkMail web application, on the shortcut bar, select the calendar icon. 2. On the calendar, do one of the following: • Drag the meeting or appointment to a different day and time. • Open the meeting or appointment and change the date and time. 3. For a meeting, if prompted to send an update to attendees, choose Yes. Editing meetings and appointments Version 1.0 50 Amazon WorkMail User Guide Canceling or declining meeting requests You can cancel or decline a scheduled meeting. To cancel or decline a scheduled meeting 1. 2. In the Amazon WorkMail web application, on the shortcut bar, choose the calendar icon. In the calendar, double-click the meeting, and then do one of the following: • If you are the meeting organizer, choose Cancel invitation. • If you are not the organizer, choose Decline. 3. In the Send meeting request cancellation dialog box, do one of the following: • To send a message along with your response, choose Edit the cancellation before sending, OK. • To send your response without comments, choose Send the cancellation now, OK. Printing calendar items You can print a single appointment or meeting, or overviews of a certain time period, such as five or seven days. To print calendar items 1. 2. In the Amazon WorkMail web application, on the shortcut bar, choose the calendar icon. In the calendar, open the appointment, and then choose Print. To print a calendar overview 1. 2. In the Amazon WorkMail web application, on the shortcut bar, |
workmail-ug-018 | workmail-ug.pdf | 18 | • To send a message along with your response, choose Edit the cancellation before sending, OK. • To send your response without comments, choose Send the cancellation now, OK. Printing calendar items You can print a single appointment or meeting, or overviews of a certain time period, such as five or seven days. To print calendar items 1. 2. In the Amazon WorkMail web application, on the shortcut bar, choose the calendar icon. In the calendar, open the appointment, and then choose Print. To print a calendar overview 1. 2. In the Amazon WorkMail web application, on the shortcut bar, choose the calendar icon. In the calendar, open the appointment. 3. Choose Print, Print overview. Note You can print overviews from your work week (5 days) and the entire week (7 days). Canceling or declining meeting requests Version 1.0 51 Amazon WorkMail User Guide Deleting meetings and appointments You can delete a meeting or appointment that you no longer plan to hold or attend. To delete a meeting or appointment 1. In the Amazon WorkMail web application, on the shortcut bar, select the calendar icon. 2. On the calendar, open the context (right-click) menu for the meeting or appointment, and choose Delete. Working with calendar settings View your calendar by day, work week, week, or month. You can also view multiple calendars and update other calendar settings. Topics • Changing your calendar view • Changing calendar settings • Viewing multiple calendars Changing your calendar view You can switch the calendar layout to view appointments by day, work week, week, or month. To change the calendar view 1. 2. In the Amazon WorkMail web application, on the shortcut bar, choose the calendar icon. In the navigation pane, choose Day, Workweek, Week, or Month. Changing calendar settings You can change the default settings for the calendar. To change calendar settings 1. On the menu bar, choose Settings (the gear icon). Deleting meetings and appointments Version 1.0 52 Amazon WorkMail User Guide 2. 3. In the navigation pane, choose Calendar. In the contents pane, update the settings as appropriate. Viewing multiple calendars You can open multiple calendars in a single overview. You can open the calendars side by side or in an overlay to see the calendars transparently stacked on top of each other. By default, the calendars are opened side by side. To work with multiple calendars 1. In the Amazon WorkMail web application, on the shortcut bar, choose the calendar icon. 2. At the bottom of navigation pane, choose Open other calendars. 3. 4. 5. 6. In the Open other folders dialog box, choose Name. In the address book, select the owner of calendar to open and choose OK. For Folder type, choose Calendar. To show the subfolders of the shared calendar, choose Show subfolders. 7. Choose OK. 8. Repeat steps 1–5 for each calendar to open. 9. To place calendars in the stacked overlay, use the arrow buttons on top of the calendars. Sharing calendars You can share your calendar with other users, and view calendars that have been shared with you. Note If you share a calendar with a user that has Read permissions, that user can view everything in the calendar, potentially including items marked Private. Topics • Sharing calendars with other users • Opening shared calendars Viewing multiple calendars Version 1.0 53 Amazon WorkMail User Guide Sharing calendars with other users You can give another user permission to view your calendar within the WorkMail organization. You cannot share calendars externally. Note You will need to grant full details read permissions to open a shared calendar. Free or busy read permissions will only show the availability. To share your calendar with another user 1. 2. Sign in to the Amazon WorkMail web application. In the navigation pane, choose the calendar icon. 3. Under My calendars, open the context (right-click) menu for a calendar. 4. Choose Properties. 5. Choose Permissions. 6. 7. For People with permissions, choose Add. Search for and select the users to share your calendar with. 8. Choose Ok, and then choose Ok again. Opening shared calendars You can set permissions on your calendar and share it with other users. To open a shared calendar 1. In the Amazon WorkMail web application, on the shortcut bar, choose the calendar icon. 2. At the bottom of the navigation pane, choose Open other calendars. 3. 4. 5. 6. In the Open other folders dialog box, choose Name. In the address book, select the owner of the calendar to open and choose OK. For Folder type, choose Calendar. To show the subfolders of the shared calendar, choose Show subfolders. 7. Choose OK. Sharing calendars with other users Version 1.0 54 Amazon WorkMail User Guide The shared calendar is now visible in the folder navigation pane. Note Your opened folders |
workmail-ug-019 | workmail-ug.pdf | 19 | In the Amazon WorkMail web application, on the shortcut bar, choose the calendar icon. 2. At the bottom of the navigation pane, choose Open other calendars. 3. 4. 5. 6. In the Open other folders dialog box, choose Name. In the address book, select the owner of the calendar to open and choose OK. For Folder type, choose Calendar. To show the subfolders of the shared calendar, choose Show subfolders. 7. Choose OK. Sharing calendars with other users Version 1.0 54 Amazon WorkMail User Guide The shared calendar is now visible in the folder navigation pane. Note Your opened folders are stored in your Amazon WorkMail web application profile. The next time you log in to the Amazon WorkMail web application, the opened folders are still displayed. If you receive a message saying You have insufficient privileges to open this folder, contact the owner of the folder and ask them to grant you access. To change folder permissions, in the navigation pane, open the context (right-click) menu for the folder and choose Properties, Permissions. Opening shared calendars Version 1.0 55 Amazon WorkMail User Guide Working with contacts You can add, edit, delete, copy, and print contacts, as well as share contacts with other users. Topics • Managing contacts • Creating distribution lists • Sharing contacts Managing contacts You can create, edit, copy, move, print, or delete contacts from Amazon WorkMail. Topics • Creating contacts • Editing contacts • Copying or moving contacts • Printing contacts • Deleting contacts Creating contacts You can create a contact in the Amazon WorkMail web application. Microsoft Outlook users can import contacts from a .csv file. To create a contact 1. In the Amazon WorkMail web application, on the shortcut bar, choose the contacts icon. 2. Do one of the following: • In the row of tabs in the contents pane, choose the + (plus sign). • On the menu bar, choose + New item, New contact. 3. In the contents pane, enter the contact's information in the appropriate fields. 4. When you're finished editing, choose Save. Managing contacts Version 1.0 56 Amazon WorkMail Editing contacts You can edit your contacts to update their information. To edit a contact User Guide 1. 2. 3. In the Amazon WorkMail web application, on the shortcut bar, choose the contacts icon. In the navigation pane, under My Contacts, choose Contacts. In the contents pane, open the contact to edit. 4. Update the contact information as appropriate, and choose Save. Copying or moving contacts You can copy or move a contact to another folder. To copy or move a contact 1. 2. 3. In the Amazon WorkMail web application, on the shortcut bar, choose the contacts icon. In the navigation pane, under My Contacts, choose Contacts. Select the contact, choose Copy/Move, select the destination folder, and then choose either Copy or Move. Printing contacts If you have a printer configured to print documents from your computer, you can print your contacts. To print a contact 1. 2. In the Amazon WorkMail web application, on the shortcut bar, select the contacts icon. In the navigation pane, under My Contacts, select the Contacts folder that contains the contact to print. 3. In the contents pane, double-click the contact to print. On the menu bar, choose Print. Deleting contacts When you no longer need contacts, you can delete them. Editing contacts Version 1.0 57 Amazon WorkMail To delete a contact User Guide 1. 2. 3. In the Amazon WorkMail web application, on the shortcut bar, choose the contacts icon. In the navigation pane, under My Contacts, choose Contacts. In the contents pane, open the context (right-click) menu for the contact and choose Delete. Note To restore a contact that you deleted by mistake, drag the contact from the Deleted Items folder back to the Contacts folder. Creating distribution lists You can create a distribution list that includes all of the people in a group (for example, Sales). To create a distribution list 1. 2. In the Amazon WorkMail web application, on the shortcut bar, choose the contacts icon. In the navigation pane, under My Contacts, select the Contacts folder in which to add the new distribution list. 3. On the menu bar, choose + New item, New distribution list. 4. In the contents pane, for Distribution list name, enter a name for the distribution list. For example, Sales. 5. Under Members, choose Add from address book to add new members from the address book to the distribution list. Or you can choose Add new member to add a new contact to the distribution list. 6. Choose Save and close. The distribution list is saved to your Contacts. To send an email message to the list, choose the To field when you compose your email message. Then choose View, Contacts and select the |
workmail-ug-020 | workmail-ug.pdf | 20 | choose + New item, New distribution list. 4. In the contents pane, for Distribution list name, enter a name for the distribution list. For example, Sales. 5. Under Members, choose Add from address book to add new members from the address book to the distribution list. Or you can choose Add new member to add a new contact to the distribution list. 6. Choose Save and close. The distribution list is saved to your Contacts. To send an email message to the list, choose the To field when you compose your email message. Then choose View, Contacts and select the distribution list. Sharing contacts You can share your contacts with other users, and view contacts that have been shared with you. Creating distribution lists Version 1.0 58 Amazon WorkMail Note User Guide If you share your contacts with a user that has Read permissions, that user can view all of your contacts, potentially including contacts marked Private. Topics • Sharing contacts with other users • Opening shared contacts Sharing contacts with other users You can give another user permission to view your contacts. To share your contacts with another user 1. 2. In the Amazon WorkMail web application, on the shortcut bar, select the contacts icon. In the navigation pane, open the context (right-click) menu for the Contacts folder, and choose Properties. 3. On the User details page, under Permissions, choose Add or remove. 4. Select the user to share your contacts with and choose >> to add them to the Permissions list. Choose Save. 5. On the Permissions tab, select the level of permissions to grant, and choose Save. Opening shared contacts You can open contacts that other users have shared with you. To open shared contacts 1. In the Amazon WorkMail web application, on the shortcut bar, choose the contacts icon. 2. At the bottom of the navigation pane, choose Open other contacts. 3. 4. 5. In the Open other folders dialog box, choose Name to open the address book. Select the owner of contacts to open, and choose OK. For Folder type, choose Contacts. Sharing contacts with other users Version 1.0 59 Amazon WorkMail User Guide 6. To view the subfolders of the shared contacts, choose Show subfolders. 7. Choose OK. The shared contacts are now visible in the folder navigation pane. Note Your opened folders are stored in your Amazon WorkMail web application profile. The next time you sign in to the Amazon WorkMail web application, the opened folders are still displayed. If you receive a message saying that You have insufficient privileges to open this folder, contact the owner of the folder and ask them to grant you access. To change folder permissions, in the navigation pane, open the context (right-click) menu for the folder, and choose Properties, Permissions. Opening shared contacts Version 1.0 60 Amazon WorkMail User Guide Working with delegates You can specify another user as a delegate who can send email on your behalf. For example, if your coworker grants the appropriate permissions to you, you can send emails and schedule meetings on their behalf. In this case, an email or meeting request is sent with the following in the From field: you on behalf of coworker. You can specify delegates in Microsoft Outlook. To do this, connect to your Outlook account, and then choose File, Account Settings, and Delegate Access. Topics • Sending email on behalf of someone else • Sending email as someone else • Scheduling meetings on behalf of someone else • Sharing your inbox with another user Sending email on behalf of someone else You can send email on another user's behalf if they've made you their delegate. To send email on behalf of someone else 1. In the Amazon WorkMail web application, on the shortcut bar, choose the mail icon. 2. On the menu bar, choose + New item, New email. Tip You can also choose the plus sign (+) on the tab bar. 3. Under the To field, choose From. 4. 5. For From, enter the name of the person for whom you are sending email. In the contents pane, type your message and choose Send. The mailbox owner appears in the From: header, and you appear in the Sender: header. Sending email on behalf of someone else Version 1.0 61 Amazon WorkMail Note User Guide If you have not been granted delegation permissions for the person you specified in the From field, you receive an email message in your own inbox indicating that you don't have the required permissions. Sending email as someone else You can send email as another user or group if your administrator has granted you the Send As permission. To send email as someone else 1. In the Amazon WorkMail web application, on the shortcut bar, choose the mail icon. 2. |
workmail-ug-021 | workmail-ug.pdf | 21 | appear in the Sender: header. Sending email on behalf of someone else Version 1.0 61 Amazon WorkMail Note User Guide If you have not been granted delegation permissions for the person you specified in the From field, you receive an email message in your own inbox indicating that you don't have the required permissions. Sending email as someone else You can send email as another user or group if your administrator has granted you the Send As permission. To send email as someone else 1. In the Amazon WorkMail web application, on the shortcut bar, choose the mail icon. 2. On the menu bar, choose + New item, New email. Tip You can also choose the plus sign (+) on the tab bar. 3. Under the To field, choose From. 4. 5. For From, enter the name of the person or group for whom you are sending the email. In the contents pane, type your message and choose Send. The mailbox owner appears in both the From: and Sender: headers. Note If you have not been granted Send As permissions for the person or group you specified in the From field, you receive an email message in your own inbox indicating that you don't have the required permissions. Scheduling meetings on behalf of someone else If another user has made you their delegate, you can schedule meetings on their behalf. Sending email as someone else Version 1.0 62 Amazon WorkMail User Guide To schedule a meeting on behalf of someone else 1. In the Amazon WorkMail web application, on the shortcut bar, choose the calendar icon. 2. At the bottom of the navigation pane, choose Open other calendars, Name. 3. 4. In the address book, select the owner of the calendar to open and choose OK. For Folder type, choose Calendar. To show the subfolders of the shared calendar, choose Show subfolders.Choose OK. The shared calendar is now visible in the folder navigation pane. Note Your opened folders are stored in your Amazon WorkMail web application profile. The next time that you log in to the Amazon WorkMail web application, the opened folders are still displayed. If you receive a message saying that You have insufficient privileges to open this folder, contact the owner of the folder and ask them to grant you access. To change folder permissions, in the navigation pane, open the context (right-click) menu for the folder and choose Properties, Permissions. 5. To create a meeting request, open the day and time on the calendar when the meeting should occur. 6. To add one or more attendees, type their names into the To field. Amazon WorkMail suggests names from the address book. You can remove suggestions from this list by selecting a name and then pressing Delete. To add users from the address book or to add them to the Required, Optional, or Resource fields, choose To, and select one or more users from the address book and add them to the Required, Optional, or Resource fields as appropriate. 7. Enter values for the following: • For Subject, enter a subject for the meeting. • For Start and End, specify the start and end times for the meeting. • For Location, specify a location. • (Optional) For Reminder, set a reminder. 8. In the lower portion of the meeting invitation, you can add information about the meeting, such as an agenda. To add an attachment to the meeting invitation, choose Attach. Scheduling meetings on behalf of someone else Version 1.0 63 Amazon WorkMail User Guide 9. When you're ready to send the meeting invitation, choose Send invitation. Sharing your inbox with another user You can give another user permissions to view your inbox. To share your inbox with another user 1. 2. In the Amazon WorkMail web application, on the shortcut bar, choose the mail icon. In the navigation pane, open the context (right-click) menu for Inbox, and choose Properties. 3. On the User details page, under Permissions, choose Add or remove. 4. Under Users and groups, select the user to share your inbox and choose >> to add them to the Permissions list. Choose Save. 5. On the Permissions tab, select the level of permissions to grant, and choose Save. Sharing your inbox with another user Version 1.0 64 Amazon WorkMail User Guide Working with accessibility features You can use screen readers and keyboard shortcuts with Amazon WorkMail for easier accessibility. Topics • Supported screen readers • Using shortcut keys with Amazon WorkMail • Working with general and email settings • Using the global address book • Working with email • Working with folders Supported screen readers You can use the following browser-based screen readers with Amazon WorkMail: • Firefox - NVDA • Safari - VoiceOver Note For NVDA, some actions work best when you enter |
workmail-ug-022 | workmail-ug.pdf | 22 | grant, and choose Save. Sharing your inbox with another user Version 1.0 64 Amazon WorkMail User Guide Working with accessibility features You can use screen readers and keyboard shortcuts with Amazon WorkMail for easier accessibility. Topics • Supported screen readers • Using shortcut keys with Amazon WorkMail • Working with general and email settings • Using the global address book • Working with email • Working with folders Supported screen readers You can use the following browser-based screen readers with Amazon WorkMail: • Firefox - NVDA • Safari - VoiceOver Note For NVDA, some actions work best when you enter or exit Forms mode. Most of the commands provided can be used across all screen readers. Some screen readers, such as VoiceOver, offer keyboard-based combinations for voiceover controls. For example, in VoiceOver use VO+Right arrow in place of the right-arrow key on your keyboard. Note The following exceptions apply only to VoiceOver: • VO+Spacebar replaces Enter. • VO+Left/Right arrows replace Tab and Shift+Tab. Supported screen readers Version 1.0 65 Amazon WorkMail User Guide • Fn+Delete replaces Delete. For best accessibility, use plain text as the email format and disable the Preview pane. For information, see the Email settings section in Working with general and email settings. Using shortcut keys with Amazon WorkMail Shortcut keys are globally applicable and not specific to screen reader software. Keyboard shortcuts are disabled by default. To enable keyboard shortcuts, see Working with general and email settings. Note For Mac, use Cmd instead of Ctrl. Keyboard shortcuts for creating new items • Ctrl+Shift+A - New appointment • Ctrl+Shift+B - New meeting request • Ctrl+Shift+X - New item • Ctrl+Shift+C - New contact • Ctrl+Shift+D - New distribution list • Ctrl+Shift+F - New folder • Ctrl+Shift+M - New message (email) Keyboard shortcuts for basic navigation • Ctrl+0-9 - Switch between context such as inbox, calendar, etc. • Ctrl+Shift+1-9 - Switch between different views • Ctrl+Shift+Arrow keys - Switch between tabs • Ctrl+Shift+L - Close tab • Alt+S - Open shared folder or store Using shortcut keys with Amazon WorkMail Version 1.0 66 Amazon WorkMail User Guide Keyboard shortcuts applicable to all views • F5 - Refresh • Enter - Open selected items • Delete - Delete selected items • Ctrl+A - Select all items • Ctrl+P - Print selected items • Ctrl+M - Open copy and move dialog • Ctrl+Shift+G - Print list Items • Ctrl+P - Print item • Ctrl+S - Save an item, such as a message, contact, etc. • Ctrl+Enter - Send an item, such as a message, meeting request, etc. Email • Ctrl+R - Reply • Ctrl+F - Forward • Ctrl+Shift+U - Toggle between read and unread • Ctrl+Shift+H - Toggle red flag and complete • Ctrl+Shift+Y - Reply all Working with general and email settings You can modify the default and email settings in the Amazon WorkMail web application. General settings The general settings have the following defaults, which can be modified. • Date format - English (US) • Address Book - Global Address List Working with general and email settings Version 1.0 67 Amazon WorkMail • Keyboard shortcuts - Off User Guide To change the default account settings 1. In the Amazon WorkMail web application, press Tab. 2. At the Username prompt, enter your username and press Tab. 3. At the Password prompt, enter your password and press Tab. 4. At the Sign in prompt, press Enter. The default starting point for the cursor is the Inbox. 5. Hold down Shift+Tab until the screen reader reads Settings button. Press Enter. 6. In the Settings screen, the default landing point is the General tab. 7. Press Tab until the screen reader reads Date format English (US) combo-box read only. Hold down Alt+Down to open the field and use the Up/Down arrows to select the date format. 8. Press Enter to confirm the selection. 9. Press Tab to move to the next section, which is Mailbox Usage. This section is read-only. Press Tab again to reach Address Book. 10. Use Alt+Down to open the Select Default Folder menu, and the Up/Down arrows to change the default view. Press Enter to accept the change. 11. Press Tab to move to the Keyboard shortcuts menu. The default setting for this is off. Press Tab to select the field. You can select and clear the box using the Spacebar. 12. Hold down Shift+Tab until the screen reader reads Save changes button. Press Enter to save the changes. Note Restart Amazon WorkMail to have the date format and keyboard shortcut changes take effect. Email settings Email settings have the following defaults, which can be modified. • Display preview pane - Right • Close email when responding - On • Format - HTML Email settings Version 1.0 68 Amazon WorkMail User Guide • Default font - Narrow Sans |
workmail-ug-023 | workmail-ug.pdf | 23 | The default setting for this is off. Press Tab to select the field. You can select and clear the box using the Spacebar. 12. Hold down Shift+Tab until the screen reader reads Save changes button. Press Enter to save the changes. Note Restart Amazon WorkMail to have the date format and keyboard shortcut changes take effect. Email settings Email settings have the following defaults, which can be modified. • Display preview pane - Right • Close email when responding - On • Format - HTML Email settings Version 1.0 68 Amazon WorkMail User Guide • Default font - Narrow Sans Serif • Always request a read receipt - Off • Incoming mail - Ask me before sending a response To change email settings 1. 2. In the Amazon WorkMail web application, hold down Shift+Tab until the screen reader reads Settings button. Press Enter. In the Settings screen, the default landing is the General tab. Press the Down arrow to select the Email tab. 3. Press Tab to access the Display preview pane field. Hold down Alt and use the Up/Down arrows to choose a display setting. 4. Press Enter to confirm the selection. 5. Press Tab to choose whether to Close email when responding, using the Spacebar to select or clear the field. 6. Press Tab to move to Compose email. • For Format, use Alt+Down and the Up/Down arrows to toggle between HTML and Plain Text. Press Enter to confirm the selection. • For Default font, use Alt+Down and the Up/Down arrows to scroll through the list of available fonts. Press Enter to confirm the selection. 7. Press Tab to move to the Always request a read receipt checkbox. Press Spacebar to select or clear the box. 8. Press Tab to move to Incoming mail for the Respond to read receipt setting. The default setting is Ask me before sending a response. 9. Press Tab to move to Signatures. Press Enter to open the New signature composer. Compose your signature. When you're finished, hold down Shift+Tab until the screen reader reads Save changes button. Press Enter to save the changes. Using the global address book You can use the Global Address Book to search for a user, change the default view, and send email to specific contacts. Using the global address book Version 1.0 69 Amazon WorkMail Using the Global Address Book User Guide 1. 2. 3. In the Amazon WorkMail web application, hold down Shift+Tab until the screen reader reads Address Book pop-up button. Press Enter. In the Address Book window, the default landing is the search bar. Start typing in the search bar and press Enter to search for matching entries. You can also press Tab until the screen reader reads Submit search button. Press Enter to select it. To clear the search, press Tab until the screen reader reads Clear search button. Press Enter. 4. You can send a message to a contact with the Address Book using the Up/Down arrows to navigate the list and select a row. Hold down Shift+F10 to open the context menu, and choose Send email. Working with email You can send, read, reply to, and delete email in Amazon WorkMail. To send email You can create and send email to one or more recipients, include attachments, set the priority, and add flags to indicate importance. 1. 2. In the Amazon WorkMail web application, press Tab until the screen reader reads Create new item, button list item. Press Enter. The message opens with the cursor in the To field. Add a contact using one of the following methods: • Add a contact from the Address Book. Hold down Shift+Tab to highlight the To field, then press Enter. Start typing a contact's name into the field. A list of suggested matching names is provided. Use the Up/Down arrows to navigate through the list. Press Enter to select a contact. To add multiple contacts, continue selecting names; the separator is added automatically. • Search for the contact. You can search for a contact using the Using the global address book. Working with email Version 1.0 70 Amazon WorkMail Note User Guide If a recipient's name is ambiguous or has multiple matches, the screen reader reads Check ambiguous names, dialog. Select the correct recipient from the list provided. 3. Press Tab to navigate to and set the Cc, Bcc, From, Subject, High Priority, Low Priority, Set Flag, and Options fields for the message. 4. Press Tab to get to the message composition field and type your message. 5. To send the message, use Shift+Tab until the screen reader reads Send button. Press Enter to send. Note If there are any unresolved recipients, the screen reader reads Not all recipients could be resolved. OK button. Review the recipients and correct them as needed. To read |
workmail-ug-024 | workmail-ug.pdf | 24 | reader reads Check ambiguous names, dialog. Select the correct recipient from the list provided. 3. Press Tab to navigate to and set the Cc, Bcc, From, Subject, High Priority, Low Priority, Set Flag, and Options fields for the message. 4. Press Tab to get to the message composition field and type your message. 5. To send the message, use Shift+Tab until the screen reader reads Send button. Press Enter to send. Note If there are any unresolved recipients, the screen reader reads Not all recipients could be resolved. OK button. Review the recipients and correct them as needed. To read email Reading the email in your inbox. 1. In the Amazon WorkMail web application, press Tab and, depending on your screen reader, use the Up/Down arrow keys or table navigation to navigate through the messages. 2. Select the row of the message to read. Press Enter to open the message in a new tab. 3. Press Tab to navigate through the Response toolbar. Use the Up/Down arrows to navigate through the page and read the body of the message line by line. To reply to email 1. In the Amazon WorkMail web application, press Tab to navigate to the message. Use the Up/ Down arrows to navigate scroll through the messages in the table. 2. Select the row of the message to read. Press Enter to open the message in a new tab. 3. Use Tab to read the Response toolbar. You can select Reply, Reply All, Forward, or Delete. You can navigate using the screen reader or the following keyboard shortcuts: Working with email Version 1.0 71 Amazon WorkMail User Guide Action Reply Reply all Forward Windows Ctrl+R Mac Cmd+R Ctrl+Shift+Y Cmd+Shift+Y Ctrl+F Cmd+F 4. Type your reply in the message form. To send the message, use Shift+Tab until the screen reader reads Send button. Press Enter to send. To delete email When you no longer need a message, you can delete it. This also helps free up space in your inbox. 1. 2. 3. In the Amazon WorkMail web application, press Tab to navigate to the message. Use the Up/ Down arrows to scroll through the messages in the table. Select the row of the message to read. Press Enter to open the message in a new tab. To delete the message, press Delete on your keyboard. You can also navigate to the Delete button using Shift+Tab. To copy and move email You can copy email or move it from one folder to another. 1. In the Amazon WorkMail web application, press Tab to navigate to the message. Use the Up/ Down arrows to scroll through the messages in the table. 2. Press Shift+Tab until the screen reader reads Copy/Move button. 3. In the Copy/move message dialog, choose the destination folder. Then use Tab to select either Copy or Move. 4. Press Enter to complete the action. To search for email You can search all the folders to find a specific message. Working with email Version 1.0 72 Amazon WorkMail User Guide 1. 2. 3. In the Amazon WorkMail web application, press Tab to navigate until the screen reader reads Mail action toolbar, toolbar, search text, edit text. Type the keyword into the search bar, and press Enter. To clear the search term, press Tab until the screen reader reads Clear search button and the focus moves to the X button, then press Enter. To search again, repeat the process. Working with folders You can create folders to organize your email, contacts, and calendar items. To create a new folder 1. 2. 3. In the Amazon WorkMail web application, press Shift+Tab until the screen reader reads New item pop-up button. Press Enter to select it. Use the Up/Down arrows to select New folder. The cursor focus is in the Name field. Enter the name of your new folder. Navigate through the items using Tab. Select the destination folder of the new folder. Navigate through the items using the Up/ Down arrows. 4. Press Enter to select a destination folder, press Tab to navigate to Ok, and then press Enter to save. To delete a folder You can delete folders you're no longer using. Deleting folders also deletes the email in the folders. 1. In the Amazon WorkMail web application, press Shift+Tab until the screen reader reads Inbox. Press Enter to select it. Use the Up/Down arrow keys to select the folder to delete. 2. On the confirmation screen, the screen reader reads Are you sure you want to move the folder [subfolder] and all of its contents into the Deleted items folder?. 3. The cursor focus is on the Yes option. Press Enter to delete the folder. To copy or move folders You can copy and move folders within Amazon WorkMail. Working with folders Version 1.0 73 Amazon |
workmail-ug-025 | workmail-ug.pdf | 25 | email in the folders. 1. In the Amazon WorkMail web application, press Shift+Tab until the screen reader reads Inbox. Press Enter to select it. Use the Up/Down arrow keys to select the folder to delete. 2. On the confirmation screen, the screen reader reads Are you sure you want to move the folder [subfolder] and all of its contents into the Deleted items folder?. 3. The cursor focus is on the Yes option. Press Enter to delete the folder. To copy or move folders You can copy and move folders within Amazon WorkMail. Working with folders Version 1.0 73 Amazon WorkMail User Guide 1. In the Amazon WorkMail web application, press Shift+Tab until the screen reader reads Inbox. Use the Up/Down arrow keys to select the folder to be copied or moved. 2. Press Shift+F10 to open the context menu, and select Copy. 3. In the dialog box press Shift+Tab to move to the destination folder, then use the Up/Down arrows to choose the destination folder. 4. Press Tab and Enter to copy or move the folder. Working with folders Version 1.0 74 Amazon WorkMail User Guide Troubleshooting the Amazon WorkMail web application Solutions to the most commonly encountered Amazon WorkMail web application errors are listed below. Connection loss If you lose connection to the server due to a network error, Amazon WorkMail displays a warning message at the top of the screen. You cannot retrieve data from the server, but you can continue working with items that are currently open. In the warning message, the timeout is shown for the next time the Amazon WorkMail web application will try to connect to the server. To skip this timeout, and immediately retry, you can click the warning message. If the connection has been reestablished, the warning message is removed, and you can continue working. Secure connection failed If this message appears when signing in to the Amazon WorkMail web client, update your web browser to the latest version and try again. For more information about compatible web browsers, see Signing in to the Amazon WorkMail web client. Session expired If your session has expired on the server and you are no longer logged in to the server, Amazon WorkMail displays a warning message. You can return to the login screen, or you can keep the Amazon WorkMail web application open (without being allowed to open or save any data). Mail cannot be saved If your email gets stuck in your outbox and doesn't get sent, Amazon WorkMail displays this error message. This may be due to a network issue. Try saving the email again to resolve this error. If your Amazon WorkMail administrator asks for email headers to help troubleshoot an email issue, you can copy and paste the email headers from your email to send to them. For more information, see Viewing email headers in the Amazon WorkMail Administrator Guide. Version 1.0 75 Amazon WorkMail User Guide Document history The following table describes important changes in each release of the Amazon WorkMail User Guide. For notification about updates to this documentation, you can subscribe to an RSS feed. Change Description Date Transport Layer Security (TLS) support Amazon WorkMail discontin ued support for Transport November 2, 2023 Layer Security (TLS) 1.0 and 1.1. If you are using TLS 1.0 or 1.1, you must upgrade the TLS version to 1.2. Support for Windows 11 Mail app You can now setup Windows 11 Mail app with Amazon October 4, 2022 Support for subaddresses Support for Outlook 2019 WorkMail. For more informati on, see Setting up the Windows 11 Mail app in the Amazon WorkMail User Guide. Amazon WorkMail supports sending emails to subaddres ses. For more information, see Sending email to a subaddres s in the Amazon WorkMail User Guide. Amazon WorkMail supports Outlook 2019 for Windows and macOS. For more information, see Amazon WorkMail System Requireme nts in the Amazon WorkMail User Guide. August 17, 2020 October 1, 2018 Version 1.0 76 Amazon WorkMail macOS Mojave support User Guide September 24, 2018 Amazon WorkMail supports macOS Mojave. For more information, see Getting Started with the macOS Mail App in the Amazon WorkMail User Guide. Various updates Various updates to topic layout and organization. July 12, 2018 Manual Outlook configuration May 29, 2018 You can manually configure Microsoft Outlook connectio ns to Amazon WorkMail. For more information, see Manually Connect Microsoft Outlook to Amazon WorkMail in the Amazon WorkMail User Guide. Mailbox permissions Various updates related to the Permissions UI. April 9, 2018 Push notifications February 7, 2018 With the Amazon WorkMail EWS API, you can receive push notifications about changes in your mailbox, including new email and calendar updates. For more information, see Working with Notifications in the Amazon WorkMail User Guide. Version 1.0 77 Amazon WorkMail Support for SMTP User |
workmail-ug-026 | workmail-ug.pdf | 26 | and organization. July 12, 2018 Manual Outlook configuration May 29, 2018 You can manually configure Microsoft Outlook connectio ns to Amazon WorkMail. For more information, see Manually Connect Microsoft Outlook to Amazon WorkMail in the Amazon WorkMail User Guide. Mailbox permissions Various updates related to the Permissions UI. April 9, 2018 Push notifications February 7, 2018 With the Amazon WorkMail EWS API, you can receive push notifications about changes in your mailbox, including new email and calendar updates. For more information, see Working with Notifications in the Amazon WorkMail User Guide. Version 1.0 77 Amazon WorkMail Support for SMTP User Guide May 10, 2017 You can configure your IMAP email client to send email through Amazon WorkMail. For more information, see Connect to Your IMAP Client Application in the Amazon WorkMail User Guide. Support for a wider range of email clients You can now use Amazon WorkMail with Microsoft January 9, 2017 Outlook 2016 for Mac and IMAP email clients. For more information, see Connect Microsoft Outlook to Your Amazon WorkMail Account and Connect to Your IMAP Client Application in the Amazon WorkMail User Guide. Support for Amazon WorkDocs email attachments You can attach a file from Amazon WorkDocs and save October 19, 2015 an email attachment to Amazon WorkDocs. For more information, see Download Attachments in the Amazon WorkMail User Guide. Updated guidance for using Microsoft Outlook 2011 for Mac with Amazon WorkMail. August 18, 2015 Support for Microsoft Outlook 2011 for Mac Preview release The preview release of Amazon WorkMail. January 28, 2015 Version 1.0 78 Amazon WorkMail User Guide AWS Glossary For the latest AWS terminology, see the AWS glossary in the AWS Glossary Reference. Version 1.0 79 |
workspaces-ag-001 | workspaces-ag.pdf | 1 | Administration Guide Amazon WorkSpaces Copyright © 2025 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. Amazon WorkSpaces Administration Guide Amazon WorkSpaces: Administration Guide Copyright © 2025 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored by Amazon. Amazon WorkSpaces Table of Contents Administration Guide What is WorkSpaces? ...................................................................................................................... 1 Connect using a client application ................................................................................................. 3 Bring Your Own Windows desktop licenses .................................................................................. 4 Using Amazon EC2 Image Builder (Windows 11 only) ......................................................................... 4 Step 1: Prerequisites for using Microsoft BYOL ..................................................................................... 4 Windows versions supported for BYOL ................................................................................................... 8 Step 2: Determine your account's BYOL eligibility ................................................................................ 8 Step 3: Enable BYOL for your eligible WorkSpaces account ............................................................. 10 (Optional) Use Amazon EC2 Image Builder (Windows 11 only) ....................................................... 11 Step 4: Confirm that your VM meets BYOL requirements ................................................................. 11 Common error messages and their solutions ................................................................................. 14 List of SysPrep error messages and error fixes .............................................................................. 19 Step 5: Export a VM from your virtualization environment .............................................................. 20 Step 6: Import a VM as an image into Amazon EC2 .......................................................................... 21 Step 7: Add Microsoft Office to your BYOL image ............................................................................. 22 Migrate between versions of Microsoft Office ............................................................................... 27 Step 8: Create a BYOL image using the WorkSpaces console ........................................................... 29 Step 9: Create a custom bundle from the BYOL image in WorkSpaces .......................................... 31 Step 10: Create a dedicated directory to use BYOL images .............................................................. 31 Step 11: Launch your BYOL WorkSpaces .............................................................................................. 31 Videos on uploading and creating BYOL images ................................................................................ 33 Link BYOL accounts in WorkSpaces ....................................................................................................... 34 Use and manage WorkSpaces Personal ....................................................................................... 35 WorkSpaces Personal options .................................................................................................................. 36 Get started with WorkSpaces Personal ................................................................................................. 36 Create a WorkSpace ................................................................................................................................... 45 Connect to the WorkSpace ................................................................................................................. 48 Next steps ............................................................................................................................................... 49 Networking protocols and access ........................................................................................................... 50 Protocols for Amazon WorkSpaces ................................................................................................... 50 VPC requirements ................................................................................................................................. 52 AWS Global Accelerator (AGA) ........................................................................................................... 58 Availability Zones for WorkSpaces .................................................................................................... 60 IP address and port requirements ..................................................................................................... 62 iii Amazon WorkSpaces Administration Guide Network requirements ....................................................................................................................... 156 Trusted devices .................................................................................................................................... 158 SAML 2.0 integration ......................................................................................................................... 161 Microsoft Entra ID access .................................................................................................................. 186 Smart card authentication ................................................................................................................ 189 Internet access .................................................................................................................................... 200 Security groups ................................................................................................................................... 201 IP access control groups ................................................................................................................... 203 PCoIP zero client ................................................................................................................................ 205 Set up Android for Chromebook ..................................................................................................... 207 Configure web access ........................................................................................................................ 207 Configure Amazon WorkSpaces Thin Client ................................................................................. 212 Configure FIPS endpoint encryption .............................................................................................. 215 Enable SSH connections for Linux WorkSpaces ........................................................................... 217 Required configuration and service components ........................................................................ 224 Manage directories for WorkSpaces .................................................................................................... 230 Register an existing AWS Directory Service directory ................................................................. 232 Select an organizational unit ........................................................................................................... 234 Configure automatic public IP addresses ...................................................................................... 235 Control device access ......................................................................................................................... 236 Manage local administrator permissions ....................................................................................... 236 Update the AD Connector account (AD Connector) .................................................................... 237 Multi-factor authentication (AD Connector) ................................................................................. 237 Create a directory ............................................................................................................................... 238 Update DNS servers for WorkSpaces ............................................................................................. 263 Delete a directory ............................................................................................................................... 271 Set up Directory Administration ..................................................................................................... 274 Administer users ....................................................................................................................................... 277 Manage users ....................................................................................................................................... 277 Create multiple WorkSpaces for a user ......................................................................................... 279 Customize how users log in to their WorkSpaces ....................................................................... 280 Enable self-service WorkSpaces management capabilities ........................................................ 283 Enable Amazon Connect audio optimization ............................................................................... 286 Enable diagnostic log uploads ......................................................................................................... 288 Administer WorkSpaces Personal ......................................................................................................... 290 Manage Windows WorkSpaces ........................................................................................................ 291 iv Amazon WorkSpaces Administration Guide Manage your Amazon Linux 2 WorkSpaces .................................................................................. 336 Manage your Ubuntu WorkSpaces .................................................................................................. 346 Manage your Rocky Linux WorkSpaces .......................................................................................... 353 Manage your Red Hat Enterprise Linux WorkSpaces .................................................................. 359 Optimize for real-time communication ......................................................................................... 366 Manage the running mode ............................................................................................................... 377 Manage applications .......................................................................................................................... 380 Modify a WorkSpace .......................................................................................................................... 387 Customize branding ........................................................................................................................... 393 Tag resources ....................................................................................................................................... 402 Maintenance ......................................................................................................................................... 404 Encrypted WorkSpaces ...................................................................................................................... 406 Reboot a WorkSpace .......................................................................................................................... 416 Rebuild a WorkSpace ......................................................................................................................... 416 Restore a WorkSpace ......................................................................................................................... 419 Microsoft 365 BYOL ........................................................................................................................... 421 Upgrade Windows BYOL WorkSpaces ............................................................................................ 423 Migrate a WorkSpace ......................................................................................................................... 433 Delete a WorkSpace ........................................................................................................................... 441 Bundles and images ................................................................................................................................ 442 Bundle options .................................................................................................................................... 445 Create a custom image and bundle ............................................................................................... 450 Update a custom bundle .................................................................................................................. 471 Copy a custom image ........................................................................................................................ 472 Share or unshare a custom image .................................................................................................. 475 Delete a custom bundle or image .................................................................................................. 478 Monitor WorkSpaces Personal .............................................................................................................. 479 Monitor with CloudWatch automatic dashboard ......................................................................... 480 Monitor using CloudWatch metrics ................................................................................................ 483 Monitor using Amazon EventBridge ............................................................................................... 497 Understanding AWS sign-in events for smart card users ........................................................... 501 |
workspaces-ag-002 | workspaces-ag.pdf | 2 | Microsoft 365 BYOL ........................................................................................................................... 421 Upgrade Windows BYOL WorkSpaces ............................................................................................ 423 Migrate a WorkSpace ......................................................................................................................... 433 Delete a WorkSpace ........................................................................................................................... 441 Bundles and images ................................................................................................................................ 442 Bundle options .................................................................................................................................... 445 Create a custom image and bundle ............................................................................................... 450 Update a custom bundle .................................................................................................................. 471 Copy a custom image ........................................................................................................................ 472 Share or unshare a custom image .................................................................................................. 475 Delete a custom bundle or image .................................................................................................. 478 Monitor WorkSpaces Personal .............................................................................................................. 479 Monitor with CloudWatch automatic dashboard ......................................................................... 480 Monitor using CloudWatch metrics ................................................................................................ 483 Monitor using Amazon EventBridge ............................................................................................... 497 Understanding AWS sign-in events for smart card users ........................................................... 501 Create custom CloudWatch dashboards ........................................................................................ 507 Business continuity .................................................................................................................................. 513 Cross-Region redirection ................................................................................................................... 514 Multi-Region Resilience ..................................................................................................................... 531 Troubleshooting ....................................................................................................................................... 540 v Amazon WorkSpaces Administration Guide Enabling advanced logging .............................................................................................................. 540 Troubleshoot specific issues ............................................................................................................. 545 Release notes ............................................................................................................................................ 575 Use and manage WorkSpaces Pools ........................................................................................... 583 Supported Regions and Availability Zones ......................................................................................... 583 Manage directories .................................................................................................................................. 586 Configure SAML 2.0 and create a pool directory ........................................................................ 587 Update directory details ................................................................................................................... 606 Deregister a WorkSpaces Pools directory ...................................................................................... 609 Networking and Access ........................................................................................................................... 610 Internet Access .................................................................................................................................... 610 VPC Requirements .............................................................................................................................. 612 Configure FIPS endpoint encryption .............................................................................................. 624 Amazon S3 VPC Endpoints ............................................................................................................... 625 Connections to Your VPC .................................................................................................................. 627 User connections ................................................................................................................................ 630 Create a WorkSpaces Pool ..................................................................................................................... 632 Administer WorkSpaces Pools ............................................................................................................... 635 Running mode ..................................................................................................................................... 636 Bundles ................................................................................................................................................. 637 Modify a pool ...................................................................................................................................... 637 Delete a pool ....................................................................................................................................... 638 Auto Scaling for WorkSpaces Pools ................................................................................................ 638 Using Active Directory ............................................................................................................................ 650 Active Directory Domains ................................................................................................................. 651 Before You Begin ................................................................................................................................ 652 Certificate-Based Authentication .................................................................................................... 654 Administration ..................................................................................................................................... 661 More Info .............................................................................................................................................. 667 Bundles and images ................................................................................................................................ 667 Bundles options .................................................................................................................................. 669 Create a custom image and bundle ............................................................................................... 672 Manage custom images and bundles ............................................................................................. 688 Use session scripts to manage experience .................................................................................... 689 Monitoring WorkSpaces Pools .............................................................................................................. 699 WorkSpaces Pools metrics and dimensions .................................................................................. 700 vi Amazon WorkSpaces Administration Guide Administer Persistent Storage .............................................................................................................. 702 Administer Home Folders ................................................................................................................. 702 Enable application settings persistence for your users .................................................................... 709 How application settings persistence works ................................................................................. 710 Enabling application settings persistence ..................................................................................... 712 Administer the VHDs for your users' application settings ......................................................... 713 Troubleshooting notification codes ..................................................................................................... 720 Security ........................................................................................................................................ 724 Data protection ........................................................................................................................................ 724 Encryption at rest ............................................................................................................................... 725 Encryption in transit .......................................................................................................................... 726 Identity and access management ......................................................................................................... 726 Example policies ................................................................................................................................. 728 Specify WorkSpaces resources in an IAM policy .......................................................................... 735 Create the workspaces_DefaultRole Role ...................................................................................... 740 Create the AmazonWorkSpacesPCAAccess service role .............................................................. 742 AWS managed policies for WorkSpaces ........................................................................................ 743 Access to WorkSpaces and scripts on streaming instances ........................................................ 751 Compliance validation ............................................................................................................................ 755 Resilience ................................................................................................................................................... 756 Infrastructure security ............................................................................................................................. 756 Network isolation ............................................................................................................................... 757 Isolation on physical hosts ............................................................................................................... 757 Authorization of corporate users .................................................................................................... 757 Make Amazon WorkSpaces API requests through a VPC interface endpoint ......................... 758 Create a VPC endpoint policy for Amazon WorkSpaces ............................................................. 759 Connect your private network to your VPC .................................................................................. 761 Update management .............................................................................................................................. 761 Quotas .......................................................................................................................................... 762 WorkSpaces client end of life ..................................................................................................... 769 Unsupported client versions .................................................................................................................. 774 EOL FAQs ................................................................................................................................................... 776 I’m using a version of a WorkSpaces client that has reached its EOL. What should I do to upgrade to a supported version? .................................................................................................... 776 Can I use a version of the WorkSpaces client that has reached its EOL with a supported WorkSpace? .......................................................................................................................................... 776 vii Amazon WorkSpaces Administration Guide I’m using a version of a WorkSpaces client that has reached its EOL. Can I still report issues for it? ......................................................................................................................................... 776 I'm using a supported WorkSpaces client version on an operating system that has reached its EOL. Can I still report issues for it? .......................................................................................... 776 Extension SDK Developer Guide ................................................................................................. 777 Document history ........................................................................................................................ 778 Earlier Updates ......................................................................................................................................... 785 viii Amazon WorkSpaces Administration Guide What is Amazon WorkSpaces? Amazon WorkSpaces enables you to provision virtual, cloud-based desktops known as WorkSpaces for your users. These desktops can run Microsoft Windows, Amazon Linux 2, Ubuntu Linux, Rocky Linux, or Red Hat Enterprise Linux. WorkSpaces eliminates the need to procure and deploy hardware or install complex software. You can quickly add or remove users as your needs change. Users can access their virtual desktops from multiple devices or web browsers. Amazon WorkSpaces allows you to choose between WorkSpaces Personal and WorkSpaces Pools depending on your organization and user needs. • WorkSpaces Personal - Choose WorkSpaces Personal if you need persistent virtual desktops that are tailored for users who need a highly-personalized desktop provisioned for their exclusive use. This is similar to a physical desktop computer that's assigned to an individual. For more information, see Create a WorkSpace in WorkSpaces Personal. • WorkSpaces Pool - Choose WorkSpaces Pool for non-persistent virtual desktops that are tailored for users who need access to highly-curated desktop |
workspaces-ag-003 | workspaces-ag.pdf | 3 | virtual desktops from multiple devices or web browsers. Amazon WorkSpaces allows you to choose between WorkSpaces Personal and WorkSpaces Pools depending on your organization and user needs. • WorkSpaces Personal - Choose WorkSpaces Personal if you need persistent virtual desktops that are tailored for users who need a highly-personalized desktop provisioned for their exclusive use. This is similar to a physical desktop computer that's assigned to an individual. For more information, see Create a WorkSpace in WorkSpaces Personal. • WorkSpaces Pool - Choose WorkSpaces Pool for non-persistent virtual desktops that are tailored for users who need access to highly-curated desktop environments hosted on ephemeral infrastructure. For more information, see Administer WorkSpaces Pools. You can set up WorkSpaces desktops in a variety of ways: • Choose from a range of hardware configurations, software configurations, and AWS Regions. For more information, see Amazon WorkSpaces Bundles and the section called “Create a custom image and bundle”. • If your WorkSpaces is running Windows, you can bring your own licenses and applications or purchase them from the AWS Marketplace for Desktop Apps. • If your WorkSpaces is running Windows 10 or 11, you can join your WorkSpaces to Microsoft Entra ID so that your users can use their existing Entra ID credentials to obtain seamless access to Microsoft 365 Apps for enterprise. You can also enroll your WorkSpaces into Intune to manage your virtual desktops using Intune. For more information, see Create a dedicated Microsoft Entra ID directory with WorkSpaces Personal. To learn more about Microsoft Entra ID, see What is Microsoft Entra ID?. To learn more about Microsoft Intune, please see Microsoft Intune securely manages identities, manages apps, and manages devices. • Choose a PCoIP or DCV protocol. For more information, see Protocols for WorkSpaces Personal. • Create a standalone managed Microsoft Active Directory for your users, or connect your WorkSpaces to your on-premises Active Directory so that your users can use their existing 1 Amazon WorkSpaces Administration Guide credentials to obtain seamless access to corporate resources. For more information, see the section called “Manage directories for WorkSpaces”. • Use the same tools to manage WorkSpaces that you use to manage on-premises desktops. • Use multi-factor authentication (MFA) for additional security. • Use AWS Key Management Service (AWS KMS) to encrypt data at rest, disk I/O, and volume snapshots. • Choose which IP addresses your users are allowed to use to access their WorkSpaces. • Choose monthly or hourly billing for WorkSpaces. For more information, see WorkSpaces Pricing. For more information about working with WorkSpaces, see: • Amazon WorkSpaces resources — includes whitepapers, blog posts, webinars, and re:Invent sessions • Provision Desktops in the Cloud • Best Practices for Deploying Amazon WorkSpaces • Amazon WorkSpaces FAQs • For WorkSpaces pricing details and examples, see WorkSpaces Pricing. 2 Amazon WorkSpaces Administration Guide Connect to WorkSpaces using a client application You can connect to your WorkSpaces by using the client application for a supported device through a supported web browser on a supported operating system. Note You can't use a web browser to connect to Amazon Linux WorkSpaces. There are client applications for the following devices: • Windows computers • macOS computers • Ubuntu Linux 18.04 computers • Chromebooks • iPads • Android devices • Fire tablets • Zero client devices (Teradici zero client devices are supported only with PCoIP.) On Windows, macOS, and Linux PCs, you can use the following web browsers to connect to Windows and Ubuntu Linux WorkSpaces: • Chrome 53 and later (Windows and macOS only) • Firefox 49 and later For more information, see WorkSpaces Clients in the Amazon WorkSpaces User Guide. 3 Amazon WorkSpaces Administration Guide Bring Your Own Windows desktop licenses in WorkSpaces If your licensing agreement with Microsoft allows it, you can bring and deploy your Windows 10 or 11 desktop on your WorkSpaces. To do this, you must enable Bring Your Own License (BYOL) and provide a Windows 10 or 11 license that meets the requirements below. For more information about using Microsoft software on AWS, see Amazon Web Services and Microsoft. To stay compliant with Microsoft licensing terms, AWS runs your BYOL WorkSpaces on hardware that is dedicated to you in the AWS Cloud. By bringing your own license, you can provide a consistent experience for your users. For more information, see WorkSpaces Pricing. Important Image creation is not supported on Windows 10 or 11 systems that have been upgraded from one version of Windows 10 or 11 to a newer version of Windows 10 or 11 (a Windows feature/version upgrade). However, Windows cumulative or security updates are supported by the WorkSpaces image-creation process. Using Amazon EC2 Image Builder (Windows 11 only) If you are using Windows 11, you can choose to use Amazon EC2 Image Builder to import and create your BYOL image for |
workspaces-ag-004 | workspaces-ag.pdf | 4 | bringing your own license, you can provide a consistent experience for your users. For more information, see WorkSpaces Pricing. Important Image creation is not supported on Windows 10 or 11 systems that have been upgraded from one version of Windows 10 or 11 to a newer version of Windows 10 or 11 (a Windows feature/version upgrade). However, Windows cumulative or security updates are supported by the WorkSpaces image-creation process. Using Amazon EC2 Image Builder (Windows 11 only) If you are using Windows 11, you can choose to use Amazon EC2 Image Builder to import and create your BYOL image for WorkSpaces. To do this, you use Amazon EC2 Image Builder in place of: • the section called “Step 4: Confirm that your VM meets BYOL requirements” • the section called “Step 5: Export a VM from your virtualization environment” For more information, see Amazon EC2 Image Builder User Guide. Step 1: Prerequisites for using Microsoft BYOL with Amazon WorkSpaces Before you begin, verify the following: Using Amazon EC2 Image Builder (Windows 11 only) 4 Amazon WorkSpaces Administration Guide • Your Microsoft licensing agreement allows Windows to run in a virtual hosted environment. • If you will be using non-GPU-enabled bundles (bundles other than Graphics.g4dn, GraphicsPro.g4dn, Graphics, and GraphicsPro), verify that you will use a minimum of 100 WorkSpaces per Region. These 100 WorkSpaces can be any mix of AlwaysOn and AutoStop WorkSpaces. Using a minimum of 100 WorkSpaces per Region is a requirement for running your WorkSpaces on dedicated hardware. Running your WorkSpaces on dedicated hardware is necessary to comply with Microsoft licensing requirements. The dedicated hardware is provisioned on the AWS side, so your VPC can stay on default tenancy. If you plan to use GPU-enabled (Graphics.g4dn, GraphicsPro.g4dn, Graphics, and GraphicsPro) bundles, verify that you will run a minimum of 4 AlwaysOn or 20 AutoStop GPU-enabled WorkSpaces in a Region per month on dedicated hardware. Note • As part of the image import process, AWS automatically retrieves system logs to resolve image import errors, provide troubleshooting help, and provide accurate error messages to users. • GraphicsPro bundle reaches end-of-life on October 31, 2025. We recommend migrating your GraphicsPro WorkSpaces to supported bundles before October 31, 2025. For more information, see Migrate a WorkSpace in WorkSpaces Personal. • Graphics bundle is no longer supported after November 30, 2023. We recommend migrating your WorkSpaces to Graphics.g4dn bundle. For more information, see Migrate a WorkSpace in WorkSpaces Personal. • Graphics and GraphicsPro bundles aren't available in the Asia Pacific (Mumbai) Region. • Graphics.g4dn, GraphicsPro.g4dn, Graphics, and GraphicsPro bundles are not available in the Africa (Cape Town) Region and the Israel (Tel Aviv) Region. • To run your WorkSpaces in the Africa (Cape Town) Region, you are required to run a minimum of 400 WorkSpaces in the Africa (Cape Town) Region. • Windows 11 bundles can be created for DCV for WorkSpaces. Windows 11 bundles are also supported for partner protocols with WorkSpaces Core. • Graphics and GraphicsPro bundles are not supported for Windows 11. • Value bundles are not available for Windows 11 and WorkSpaces Pools. For more information about migrating your existing value bundle WorkSpaces see Migrate a WorkSpace in WorkSpaces Personal. Step 1: Prerequisites for using Microsoft BYOL 5 Amazon WorkSpaces Administration Guide • For the best video conferencing experience we recommend using Power (4 vCPU, 16 GB memory or higher) bundles. • Windows 11 requires the Unified Extensible Firmware Interface (UEFI) boot mode to function. Make sure you specify the optional --boot-mode parameter as UEFI to successfully import of your VM. • WorkSpaces can use a management interface in the /16 IP address range. The management interface is connected to a secure WorkSpaces management network used for interactive streaming. This allows WorkSpaces to manage your WorkSpaces. For more information, see Network interfaces. You must reserve a /16 netmask from at least one of the following IP address ranges for this purpose: • 10.0.0.0/8 • 100.64.0.0/10 • 172.16.0.0/12 • 192.168.0.0/16 • 198.18.0.0/15 Note • As you adopt the WorkSpaces service, the available management interface IP address ranges frequently change. To determine which ranges are currently available, run the list-available-management-cidr-ranges AWS Command Line Interface (AWS CLI) command. • In addition to the /16 CIDR block that you select, the 54.239.224.0/20 IP address range is used for management interface traffic in all AWS Regions. • Make sure you have opened the necessary management interface ports for Microsoft Windows and Microsoft Office KMS activation for BYOL WorkSpaces. For more information, see Management interface ports. • You have a virtual machine (VM) that runs a supported 64-bit version of Windows. For a list of supported versions, see the next section in this topic, Windows versions supported for BYOL. The VM must also meet these requirements: • The Windows operating system must be activated against |
workspaces-ag-005 | workspaces-ag.pdf | 5 | the /16 CIDR block that you select, the 54.239.224.0/20 IP address range is used for management interface traffic in all AWS Regions. • Make sure you have opened the necessary management interface ports for Microsoft Windows and Microsoft Office KMS activation for BYOL WorkSpaces. For more information, see Management interface ports. • You have a virtual machine (VM) that runs a supported 64-bit version of Windows. For a list of supported versions, see the next section in this topic, Windows versions supported for BYOL. The VM must also meet these requirements: • The Windows operating system must be activated against your key management servers. • The Windows operating system must have English (United States) as the primary language. Step 1: Prerequisites for using Microsoft BYOL 6 Amazon WorkSpaces Administration Guide • No software beyond what is included with Windows can be installed on the VM. You can add additional software, such as an antivirus solution, when you later create a custom image. • Do not customize the default user profile (C:\Users\Default) or make other customizations before creating an image. All customizations should be made after image creation. We recommend making any customizations to the user profile through Group Policy Objects (GPOs) and applying them after image creation. This is because customizations done through GPOs can be easily modified or rolled back and are less prone to error than customizations made to the default user profile. • You must create a WorkSpaces_BYOL account with local administrator access before you share the image. The password for this account might be required later, so make note of it. • The VM must be on a single volume with a maximum size of 70 GB and at least 10 GB of free space. If you're also planning to subscribe to Microsoft Office for your BYOL image, the VM must be on a single volume with a maximum size of 70 GB and at least 20 GB of free space. The DISK that the root volume is on cannot exceed 70GB. • Your VM must run Windows PowerShell version 4 or later. • Make sure that you have installed the latest Microsoft Windows patches before you run the BYOL checker script in Step 4: Confirm that the Windows VM in Amazon WorkSpaces meets the requirements for Microsoft BYOL. • The Windows default system unattend files in the %WINDIR%\panther and %WINDIR% \panther\unattend paths should not be modified. Note • For BYOL AutoStop WorkSpaces, a large number of concurrent logins could result in significantly increased time for WorkSpaces to be available. If you expect many users to log into your BYOL AutoStop WorkSpaces at the same time, please consult your account manager for advice. • Encrypted AMIs are not supported in the importing process. Ensure you disable the instance used to create the EC2 AMI has EBS encryption. Encryption can be enabled after the final WorkSpaces is provisioned. Step 1: Prerequisites for using Microsoft BYOL 7 Amazon WorkSpaces Administration Guide Windows versions supported for BYOL Your VM must run one of the following Windows versions: • Windows 10 Version 22H2 (November 2022 Update) • Windows 10 Enterprise LTSC 2019 (1809) • Windows 10 Enterprise LTSC 2021 (21H2) • Windows 11 Enterprise 23H2 (October 2023 release) • Windows 11 Enterprise 22H2 (October 2022 release) All supported OS versions support all of the compute types available in the AWS Region where you're using WorkSpaces. Versions of Windows that are no longer supported by Microsoft are not guaranteed to work and are not supported by AWS Support. Note Windows 10 N and Windows 11 N versions are not supported for BYOL at this time. Step 2: Determine whether your WorkSpaces account is eligible for use with Microsoft BYOL Before you can enable your account for BYOL, you must go through a verification process to confirm your eligibility for BYOL. Until you go through this process, the Enable BYOL option will not be available in your Amazon WorkSpaces console. Note The verification process takes at least one business day. If you want to apply the CIDR range and BYOL configurations of an existing AWS account to a different one, you can link them together to use the same underlying hardware. To link your AWS accounts, you don't need to submit a support ticket. You can use APIs, such as CreateAccountLinkInvitations and AcceptAccountLinkInvitation to connect your AWS accounts. For more information, see Link BYOL accounts in WorkSpaces. Windows versions supported for BYOL 8 Amazon WorkSpaces Administration Guide To check the eligibility of your account for BYOL by using the Amazon WorkSpaces console 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. In the navigation pane, choose Account Settings, and then under Bring your own license (BYOL), choose View WorkSpaces BYOL settings. If your account is not currently eligible for BYOL, a message provides |
workspaces-ag-006 | workspaces-ag.pdf | 6 | link your AWS accounts, you don't need to submit a support ticket. You can use APIs, such as CreateAccountLinkInvitations and AcceptAccountLinkInvitation to connect your AWS accounts. For more information, see Link BYOL accounts in WorkSpaces. Windows versions supported for BYOL 8 Amazon WorkSpaces Administration Guide To check the eligibility of your account for BYOL by using the Amazon WorkSpaces console 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. In the navigation pane, choose Account Settings, and then under Bring your own license (BYOL), choose View WorkSpaces BYOL settings. If your account is not currently eligible for BYOL, a message provides guidance for next steps. To get started, contact your AWS account manager or sales representative, or contact the AWS Support Center. Your contact will verify your eligibility for BYOL. To determine your eligibility for BYOL, your contact will need certain information from you. For example, you might be asked to answer the following questions. • Have you reviewed and accepted the BYOL requirements listed earlier? • In which AWS Regions do you need your account enabled for BYOL? • How many BYOL WorkSpaces do you plan to deploy per AWS Region? • What is your ramp-up plan? • Are you purchasing WorkSpaces from a reseller? • What bundle types do you need for BYOL? • Does your organization have any other AWS accounts enabled for BYOL in the same Region? If yes, do you want to link these accounts so that they use the same underlying hardware? If the accounts are linked, the total number of WorkSpaces deployed in these accounts is aggregated together for the purposes of determining your eligibility for BYOL. If the answer to both of these questions is yes, you can link your accounts together. You can use APIs, such as CreateAccountLinkInvitations and AcceptAccountLinkInvitation to connect your AWS accounts. If you want to link other BYOL-enabled accounts, but want to use a different BYOL setup (CIDR range and image), contact to AWS Support to enable your new account for BYOL. 3. After your eligibility is confirmed for BYOL, you can proceed to the next step, where you enable BYOL for your account in the Amazon WorkSpaces console. Step 2: Determine your account's BYOL eligibility 9 Amazon WorkSpaces Administration Guide Step 3: Enable BYOL for your eligible WorkSpaces account using the Amazon WorkSpaces console After you determine that your WorkSpaces account is eligible to use Microsoft Bring Your Own License (BYOL) by following the instructions in Step 2: Determine whether your WorkSpaces account is eligible for use with Microsoft BYOL, you must specify a management network interface to enable BYOL for your account. This interface is connected to a secure Amazon WorkSpaces management network. It is used for interactive streaming of the WorkSpace desktop to Amazon WorkSpaces clients, and to allow Amazon WorkSpaces to manage the WorkSpace. Note You only need to perform the steps in this procedure once per Region to enable BYOL for your account. To enable BYOL for your account by using the Amazon WorkSpaces console 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. In the navigation pane, choose Account Settings, and then under Bring your own license (BYOL), choose View WorkSpaces BYOL settings. 3. On the Account Settings page, under Bring Your Own License (BYOL), choose Enable BYOL. If you don't see the Enable BYOL option, this means that your account is not currently eligible for BYOL. For more information, see Step 2: Determine whether your WorkSpaces account is eligible for use with Microsoft BYOL. 4. Under Bring Your Own License (BYOL), in the Management network interface IP address range area, choose an IP address range, and then choose Display available CIDR blocks. Amazon WorkSpaces searches for and displays available IP address ranges as IPv4 Classless Inter-Domain Routing (CIDR) blocks, within the range that you specify. If you require a specific IP address range, you can edit the search range. Important After you specify an IP address range, you cannot modify it. Make sure to specify an IP address range that doesn't conflict with the ranges used by your internal Step 3: Enable BYOL for your eligible WorkSpaces account 10 Amazon WorkSpaces Administration Guide network. If you have any questions about which range to specify, contact your AWS account manager or sales representative, or contact the AWS Support Center before proceeding. 5. Choose the CIDR block that you want from the list of results, and then choose Enable BYOL. This process may take several hours. While WorkSpaces is enabling your account for BYOL, proceed to the next step. (Optional) Use Amazon EC2 Image Builder (Windows 11 only) The Amazon EC2 Image Builder is capable of creating an Amazon Machine Image (AMI) from a raw ISO file. This feature is only available for Windows 11 systems. If you are using Amazon EC2 Image Builder |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.