Request Syntax Request Parameters Response Elements Errors See Also

AssociateDelegateToResource

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.

Adds a member (user or group) to 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 member (user or group) to associate to the resource.

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: entity@domain.tld
Entity: entity

Type: String

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

Pattern: [a-zA-Z0-9._%+@-]+

Required: Yes

OrganizationId

The organization under which the resource exists.

Type: String

Length Constraints: Fixed length of 34.

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

Required: Yes

ResourceId

The resource for which members (users or groups) are associated.

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

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

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

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

UnsupportedOperationException

Important

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

HTTP Status Code: 400