Request Syntax Request Parameters Response Elements Errors See Also

UpdateAvailabilityConfiguration

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.

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.

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

Important

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

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

ResourceNotFoundException

Important

The resource cannot be found.

HTTP Status Code: 400