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

ListResourceDelegates

Lists the delegates associated with a resource. Users and groups can be resource delegates and answer requests on behalf of the resource.

Request Syntax

{ "MaxResults": number, "NextToken": "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.

MaxResults

The number of maximum results in a page.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NextToken

The token used to paginate through the delegates associated with a resource.

Type: String

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

Required: No

OrganizationId

The identifier for the organization that contains the resource for which delegates are listed.

Type: String

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

Required: Yes

ResourceId

The identifier for the resource whose delegates are listed.

Type: String

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

Required: Yes

Response Syntax

{ "Delegates": [ { "Id": "string", "Type": "string" } ], "NextToken": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Delegates

One page of the resource's delegates.

Type: Array of Delegate objects

NextToken

The token used to paginate through the delegates associated with a resource. While results are still available, it has an associated value. When the last page is reached, the token is empty.

Type: String

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

Errors

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

EntityNotFoundException

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

HTTP Status Code: 400

EntityStateException

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

HTTP Status Code: 400

InvalidParameterException

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

HTTP Status Code: 400

OrganizationNotFoundException

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

HTTP Status Code: 400

OrganizationStateException

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

HTTP Status Code: 400

See Also

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