Request Syntax Request Parameters Response Elements Errors See Also

CreateAvailabilityConfiguration

Important

End of support notice: On March 31, 2027, AWS will end support for Amazon WorkMail. After March 31, 2027, you will no longer be able to access the WorkMail console or WorkMail resources. For more information, see Amazon WorkMail end of support.

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.

Type: String

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 Error Types.

InvalidParameterException

Important

One or more of the input parameters don't match the service's restrictions.

HTTP Status Code: 400

LimitExceededException

Important

The request exceeds the limit of the resource.

HTTP Status Code: 400

NameAvailabilityException

Important

The user, group, or resource name isn't unique in WorkMail.

HTTP Status Code: 400

OrganizationNotFoundException

Important

An operation received a valid organization identifier that either doesn't belong or exist in the system.

HTTP Status Code: 400

OrganizationStateException

Important

The organization must have a valid state to perform certain operations on the organization or its members.

HTTP Status Code: 400