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

ListTenants

List all tenants associated with your account in the current AWS Region.

This operation returns basic information about each tenant, such as tenant name, ID, ARN, and creation timestamp.

Request Syntax


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

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

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 ListTenants to indicate the position in the list of tenants.

Type: String

Required: No

PageSize

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

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "Tenants": [ 
      { 
         "CreatedTimestamp": number,
         "TenantArn": "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 ListTenants, and pass this token in the NextToken parameter.

Type: String

Tenants

An array that contains basic information about each tenant.

Type: Array of TenantInfo objects

Errors

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

BadRequestException

The input you provided is invalid.

HTTP Status Code: 400

TooManyRequestsException

Too many requests have been made to the operation.

HTTP Status Code: 429