Request Syntax Request Parameters Response Elements Errors See Also

UpdateResource

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 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

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: resource@domain.tld
Resource name: resource

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

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

Important

The directory is unavailable. It might be located in another Region or deleted.

HTTP Status Code: 400

EmailAddressInUseException

Important

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

HTTP Status Code: 400

EntityNotFoundException

Important

The identifier supplied for the user, group, or resource does not exist in your organization.

HTTP Status Code: 400

EntityStateException

Important

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

Important

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

Important

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

HTTP Status Code: 400

MailDomainNotFoundException

Important

The domain specified is not found in your organization.

HTTP Status Code: 400

MailDomainStateException

Important

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

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

UnsupportedOperationException

Important

You can't perform a write operation against a read-only directory.

HTTP Status Code: 400