SESV2 / Client / create_tenant

create_tenant¶

SESV2.Client.create_tenant(**kwargs)¶

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.

You can optionally specify SuppressionAttributes to configure tenant-level suppression at creation time. When tenant-level suppression is enabled, Amazon SES maintains a separate suppression list for the tenant instead of using the account-level suppression list.

Request Syntax

response = client.create_tenant(
    TenantName='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    SuppressionAttributes={
        'SuppressedReasons': [
            'BOUNCE'|'COMPLAINT',
        ],
        'SuppressionScope': 'ACCOUNT'|'TENANT'
    }
)

Parameters:

TenantName (string) –
[REQUIRED]

The name of the tenant to create. The name can contain up to 64 alphanumeric characters, including letters, numbers, hyphens (-) and underscores (_) only.
Tags (list) –
An array of objects that define the tags (keys and values) to associate with the tenant
- (dict) –
  
  An object that defines the tags that are associated with a resource. A tag is a label that you optionally define and associate with a resource. Tags can help you categorize and manage resources in different ways, such as by purpose, owner, environment, or other criteria. A resource can have as many as 50 tags.
  
  Each tag consists of a required tag key and an associated tag value, both of which you define. A tag key is a general label that acts as a category for a more specific tag value. A tag value acts as a descriptor within a tag key. A tag key can contain as many as 128 characters. A tag value can contain as many as 256 characters. The characters can be Unicode letters, digits, white space, or one of the following symbols: _ . : / = + -. The following additional restrictions apply to tags:
  - Tag keys and values are case sensitive.
  - For each associated resource, each tag key must be unique and it can have only one value.
  - The aws: prefix is reserved for use by Amazon Web Services; you can’t use it in any tag keys or values that you define. In addition, you can’t edit or remove tag keys or values that use this prefix. Tags that use this prefix don’t count against the limit of 50 tags per resource.
  - You can associate tags with public or shared resources, but the tags are available only for your Amazon Web Services account, not any other accounts that share the resource. In addition, the tags are available only for resources that are located in the specified Amazon Web Services Region for your Amazon Web Services account.
  - Key (string) – [REQUIRED]
    
    One part of a key-value pair that defines a tag. The maximum length of a tag key is 128 characters. The minimum length is 1 character.
  - Value (string) – [REQUIRED]
    
    The optional part of a key-value pair that defines a tag. The maximum length of a tag value is 256 characters. The minimum length is 0 characters. If you don’t want a resource to have a specific tag value, don’t specify a value for this parameter. If you don’t specify a value, Amazon SES sets the value to an empty string.
SuppressionAttributes (dict) –
An object that contains information about the suppression list preferences for the tenant. Use this to configure tenant-level suppression at creation time.
- SuppressedReasons (list) –
  
  A list that contains the reasons that email addresses are automatically added to the suppression list for the tenant. This list can contain any or all of the following:
  - COMPLAINT – Amazon SES adds an email address to the suppression list when a message sent to that address results in a complaint.
  - BOUNCE – Amazon SES adds an email address to the suppression list when a message sent to that address results in a hard bounce.
  - (string) –
    
    The reason that the address was added to the suppression list for your account or for a specific tenant. The value can be one of the following:
    - COMPLAINT – Amazon SES added an email address to the suppression list for your account or for a specific tenant because a message sent to that address results in a complaint.
    - BOUNCE – Amazon SES added an email address to the suppression list for your account or for a specific tenant because a message sent to that address results in a hard bounce.
- SuppressionScope (string) –
  
  The suppression scope for the tenant. Can be one of the following:
  - TENANT – The tenant uses its own suppression list.
  - ACCOUNT – The tenant uses the account-level suppression list.
  Note
  If you don’t specify a suppression scope, the tenant defaults to ACCOUNT scope and uses the account-level suppression list.

Return type:

dict

Returns:

Response Syntax

{
    'TenantName': 'string',
    'TenantId': 'string',
    'TenantArn': 'string',
    'CreatedTimestamp': datetime(2015, 1, 1),
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    'SendingStatus': 'ENABLED'|'REINSTATED'|'DISABLED',
    'SuppressionAttributes': {
        'SuppressedReasons': [
            'BOUNCE'|'COMPLAINT',
        ],
        'SuppressionScope': 'ACCOUNT'|'TENANT'
    }
}

Response Structure

(dict) –

Information about a newly created tenant.
- TenantName (string) –
  
  The name of the tenant.
- TenantId (string) –
  
  A unique identifier for the tenant.
- TenantArn (string) –
  
  The Amazon Resource Name (ARN) of the tenant.
- CreatedTimestamp (datetime) –
  
  The date and time when the tenant was created.
- Tags (list) –
  
  An array of objects that define the tags (keys and values) associated with the tenant.
  - (dict) –
    
    An object that defines the tags that are associated with a resource. A tag is a label that you optionally define and associate with a resource. Tags can help you categorize and manage resources in different ways, such as by purpose, owner, environment, or other criteria. A resource can have as many as 50 tags.
    
    Each tag consists of a required tag key and an associated tag value, both of which you define. A tag key is a general label that acts as a category for a more specific tag value. A tag value acts as a descriptor within a tag key. A tag key can contain as many as 128 characters. A tag value can contain as many as 256 characters. The characters can be Unicode letters, digits, white space, or one of the following symbols: _ . : / = + -. The following additional restrictions apply to tags:
    - Tag keys and values are case sensitive.
    - For each associated resource, each tag key must be unique and it can have only one value.
    - The aws: prefix is reserved for use by Amazon Web Services; you can’t use it in any tag keys or values that you define. In addition, you can’t edit or remove tag keys or values that use this prefix. Tags that use this prefix don’t count against the limit of 50 tags per resource.
    - You can associate tags with public or shared resources, but the tags are available only for your Amazon Web Services account, not any other accounts that share the resource. In addition, the tags are available only for resources that are located in the specified Amazon Web Services Region for your Amazon Web Services account.
    - Key (string) –
      
      One part of a key-value pair that defines a tag. The maximum length of a tag key is 128 characters. The minimum length is 1 character.
    - Value (string) –
      
      The optional part of a key-value pair that defines a tag. The maximum length of a tag value is 256 characters. The minimum length is 0 characters. If you don’t want a resource to have a specific tag value, don’t specify a value for this parameter. If you don’t specify a value, Amazon SES sets the value to an empty string.
- SendingStatus (string) –
  
  The status of email sending capability for the tenant.
- SuppressionAttributes (dict) –
  
  An object that contains the suppression list preferences for a tenant.
  - SuppressedReasons (list) –
    
    A list that contains the reasons that email addresses are automatically added to the suppression list for the tenant. This list can contain any or all of the following:
    - COMPLAINT – Amazon SES adds an email address to the suppression list when a message sent to that address results in a complaint.
    - BOUNCE – Amazon SES adds an email address to the suppression list when a message sent to that address results in a hard bounce.
    - (string) –
      
      The reason that the address was added to the suppression list for your account or for a specific tenant. The value can be one of the following:
      - COMPLAINT – Amazon SES added an email address to the suppression list for your account or for a specific tenant because a message sent to that address results in a complaint.
      - BOUNCE – Amazon SES added an email address to the suppression list for your account or for a specific tenant because a message sent to that address results in a hard bounce.
  - SuppressionScope (string) –
    
    The suppression scope for the tenant. Can be one of the following:
    - TENANT – The tenant uses its own suppression list.
    - ACCOUNT – The tenant uses the account-level suppression list.
    Note
    If you don’t specify a suppression scope, the tenant defaults to ACCOUNT scope and uses the account-level suppression list.

Exceptions

SESV2.Client.exceptions.AlreadyExistsException
SESV2.Client.exceptions.LimitExceededException
SESV2.Client.exceptions.TooManyRequestsException
SESV2.Client.exceptions.BadRequestException