tenants

Creates, updates, deletes, gets or lists a tenants resource.

Overview

Name	tenants
Type	Resource
Id	aws.sesv2.tenants

Fields

The following fields are returned by SELECT queries:

get_tenant

Name	Datatype	Description
created_timestamp	string (date-time)	The date and time when the tenant was created.
sending_status	string	The status of sending capability for the tenant. (ENABLED, REINSTATED, DISABLED)
suppression_attributes	object	An object that contains the suppression list preferences for a tenant.
tags	array	An array of objects that define the tags (keys and values) associated with the tenant.
tenant_arn	string	The Amazon Resource Name (ARN) of the tenant.
tenant_id	string	A unique identifier for the tenant.
tenant_name	string	The name of a tenant. The name can contain up to 64 alphanumeric characters, including letters, numbers, hyphens (-) and underscores (_) only.

list_tenants

Name	Datatype	Description
created_timestamp	string (date-time)	The date and time when the tenant was created.
tenant_arn	string	The Amazon Resource Name (ARN) of the tenant.
tenant_id	string	A unique identifier for the tenant.
tenant_name	string	The name of a tenant. The name can contain up to 64 alphanumeric characters, including letters, numbers, hyphens (-) and underscores (_) only.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_tenant	select	region		Get information about a specific tenant, including the tenant's name, ID, ARN, creation timestamp, tags, sending status, and suppression attributes.
list_tenants	select	region		List all tenants associated with your account in the current Amazon Web Services Region. This operation returns basic information about each tenant, such as tenant name, ID, ARN, and creation timestamp.
create_tenant	insert	region, TenantName		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.
put_tenant_suppression_attributes	replace	region, TenantName		Configure the suppression list preferences for a tenant. Use this operation to enable or disable tenant-level suppression, or to change the suppressed reasons for a tenant. When you set the suppression scope to TENANT, Amazon SES maintains a separate suppression list for the tenant. When you set the scope to ACCOUNT, the tenant uses the account-level suppression list.
delete_tenant	delete	region		Delete an existing tenant. When you delete a tenant, its associations with resources are removed, but the resources themselves are not deleted.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_tenant

Get information about a specific tenant, including the tenant's name, ID, ARN, creation timestamp, tags, sending status, and suppression attributes.

SELECT
created_timestamp,
sending_status,
suppression_attributes,
tags,
tenant_arn,
tenant_id,
tenant_name
FROM aws.sesv2.tenants
WHERE region = '{{ region }}' -- required
;

list_tenants

List all tenants associated with your account in the current Amazon Web Services Region. This operation returns basic information about each tenant, such as tenant name, ID, ARN, and creation timestamp.

SELECT
created_timestamp,
tenant_arn,
tenant_id,
tenant_name
FROM aws.sesv2.tenants
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_tenant

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.

INSERT INTO aws.sesv2.tenants (
TenantName,
Tags,
SuppressionAttributes,
region
)
SELECT 
'{{ TenantName }}' /* required */,
'{{ Tags }}',
'{{ SuppressionAttributes }}',
'{{ region }}'
RETURNING
created_timestamp,
sending_status,
suppression_attributes,
tags,
tenant_arn,
tenant_id,
tenant_name
;

Manifest

# Description fields are for documentation purposes
- name: tenants
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the tenants resource.
  - name: TenantName
    value: "{{ TenantName }}"
    description: |
      The name of a tenant. The name can contain up to 64 alphanumeric characters, including letters, numbers, hyphens (-) and underscores (_) only.
  - name: Tags
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
  - name: SuppressionAttributes
    description: |
      An object that contains the suppression list preferences for a tenant.
    value:
      SuppressedReasons:
        - "{{ SuppressedReasons }}"
      SuppressionScope: "{{ SuppressionScope }}"

REPLACE examples

put_tenant_suppression_attributes

Configure the suppression list preferences for a tenant. Use this operation to enable or disable tenant-level suppression, or to change the suppressed reasons for a tenant. When you set the suppression scope to TENANT, Amazon SES maintains a separate suppression list for the tenant. When you set the scope to ACCOUNT, the tenant uses the account-level suppression list.

REPLACE aws.sesv2.tenants
SET 
TenantName = '{{ TenantName }}',
SuppressedReasons = '{{ SuppressedReasons }}',
SuppressionScope = '{{ SuppressionScope }}'
WHERE 
region = '{{ region }}' --required
AND TenantName = '{{ TenantName }}' --required;

DELETE examples

delete_tenant

Delete an existing tenant. When you delete a tenant, its associations with resources are removed, but the resources themselves are not deleted.

DELETE FROM aws.sesv2.tenants
WHERE region = '{{ region }}' --required
;