Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListResourceTenants

List all tenants associated with a specific resource.

This operation returns a list of tenants that are associated with the specified resource. This is useful for understanding which tenants are currently using a particular resource such as an email identity, configuration set, or email template.

Request Syntax


POST /v2/email/resources/tenants/list HTTP/1.1
Content-type: application/json

{
   "NextToken": "string",
   "PageSize": number,
   "ResourceArn": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

NextToken

A token returned from a previous call to ListResourceTenants to indicate the position in the list of resource tenants.

Type: String

Required: No

PageSize

The number of results to show in a single call to ListResourceTenants. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.

Type: Integer

Required: No

ResourceArn

The Amazon Resource Name (ARN) of the resource to list associated tenants for.

Type: String

Length Constraints: Minimum length of 1.

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "ResourceTenants": [ 
      { 
         "AssociatedTimestamp": number,
         "ResourceArn": "string",
         "TenantId": "string",
         "TenantName": "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.

NextToken

A token that indicates that there are additional tenants to list. To view additional tenants, issue another request to ListResourceTenants, and pass this token in the NextToken parameter.

Type: String

ResourceTenants

An array that contains information about each tenant associated with the resource.

Type: Array of ResourceTenantMetadata objects

Errors

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

BadRequestException

The input you provided is invalid.

HTTP Status Code: 400

NotFoundException

The resource you attempted to access doesn't exist.

HTTP Status Code: 404

TooManyRequestsException

Too many requests have been made to the operation.

HTTP Status Code: 429