Amazon WorkMail
API Reference (API Version 2017-10-01)


Updates data for the resource. It must be preceded by a describe call in order to have the latest information. The dataset in the request should be the one expected when performing another describe call.

Request Syntax

{ "BookingOptions": { "AutoAcceptRequests": boolean, "AutoDeclineConflictingRequests": boolean, "AutoDeclineRecurringRequests": boolean }, "Name": "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.


The resource's booking options to be updated.

Type: BookingOptions object

Required: No


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


The identifier associated with the organization for which the resource is updated.

Type: String

Pattern: ^m-[0-9a-f]{32}$

Required: Yes


The identifier of the resource to be updated.

Type: String

Pattern: ^r-[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.


For information about the errors that are common to all actions, see Common Errors.


The directory that you are trying to perform operations on isn't available.

HTTP Status Code: 400


The email address that you're trying to assign is already created for a different user, group, or resource.

HTTP Status Code: 400


The identifier supplied for the entity is valid, but it does not exist in your organization.

HTTP Status Code: 400


You are performing an operation on an entity that isn't in the expected state, such as trying to update a deleted user.

HTTP Status Code: 400


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 it on its behalf.

HTTP Status Code: 400


For an email or alias to be created in Amazon WorkMail, the included domain must be defined in the organization.

HTTP Status Code: 400


After a domain has been added to the organization, it must be verified. The domain is not yet verified.

HTTP Status Code: 400


The entity (user, group, or user) name isn't unique in Amazon WorkMail.

HTTP Status Code: 400


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

HTTP Status Code: 400


The organization must have a valid state (Active or Synchronizing) to perform certain operations on the organization or its entities.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: