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

ListTenantResources

List all resources associated with a specific tenant.

This operation returns a list of resources (email identities, configuration sets, or email templates) that are associated with the specified tenant. You can optionally filter the results by resource type.

Request Syntax


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

{
   "Filter": { 
      "string" : "string" 
   },
   "NextToken": "string",
   "PageSize": number,
   "TenantName": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

Filter

A map of filter keys and values for filtering the list of tenant resources. Currently, the only supported filter key is RESOURCE_TYPE.

Type: String to string map

Valid Keys: RESOURCE_TYPE

Value Length Constraints: Minimum length of 1. Maximum length of 512.

Required: No

NextToken

A token returned from a previous call to ListTenantResources to indicate the position in the list of tenant resources.

Type: String

Required: No

PageSize

The number of results to show in a single call to ListTenantResources. 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

TenantName

The name of the tenant to list resources for.

Type: String

Length Constraints: Minimum length of 1.

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "TenantResources": [ 
      { 
         "ResourceArn": "string",
         "ResourceType": "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 resources to list. To view additional resources, issue another request to ListTenantResources, and pass this token in the NextToken parameter.

Type: String

TenantResources

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

Type: Array of TenantResource 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