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

CreateTenant

Create a tenant.

Tenants are logical containers that group related SES resources together. Each tenant can have its own set of resources like email identities, configuration sets, and templates, along with reputation metrics and sending status. This helps isolate and manage email sending for different customers or business units within your Amazon SES API v2 account.

Request Syntax


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

{
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "TenantName": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

Tags

An array of objects that define the tags (keys and values) to associate with the tenant

Type: Array of Tag objects

Required: No

TenantName

The name of the tenant to create. The name can contain up to 64 alphanumeric characters, including letters, numbers, hyphens (-) and underscores (_) only.

Type: String

Length Constraints: Minimum length of 1.

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "CreatedTimestamp": number,
   "SendingStatus": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "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.

CreatedTimestamp

The date and time when the tenant was created.

Type: Timestamp

SendingStatus

The status of email sending capability for the tenant.

Type: String

Valid Values: ENABLED | REINSTATED | DISABLED

Tags

An array of objects that define the tags (keys and values) associated with the tenant.

Type: Array of Tag objects

TenantArn

The Amazon Resource Name (ARN) of the tenant.

Type: String

Length Constraints: Minimum length of 1.

TenantId

A unique identifier for the tenant.

Type: String

TenantName

The name of the tenant.

Type: String

Length Constraints: Minimum length of 1.

Errors

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

AlreadyExistsException

The resource specified in your request already exists.

HTTP Status Code: 400

BadRequestException

The input you provided is invalid.

HTTP Status Code: 400

LimitExceededException

There are too many instances of the specified resource type.

HTTP Status Code: 400

TooManyRequestsException

Too many requests have been made to the operation.

HTTP Status Code: 429