Skip to content

Create a tenant

Description

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.

Usage

sesv2_create_tenant(TenantName, Tags, SuppressionAttributes)

Arguments

  • TenantName

[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

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

  • SuppressionAttributes

An object that contains information about the suppression list preferences for the tenant. Use this to configure tenant-level suppression at creation time.

Value

A list with the following syntax:

list(
  TenantName = "string",
  TenantId = "string",
  TenantArn = "string",
  CreatedTimestamp = as.POSIXct(
    "2015-01-01"
  ),
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  ),
  SendingStatus = "ENABLED"|"REINSTATED"|"DISABLED",
  SuppressionAttributes = list(
    SuppressedReasons = list(
      "BOUNCE"|"COMPLAINT"
    ),
    SuppressionScope = "ACCOUNT"|"TENANT"
  )
)

Request syntax

svc$create_tenant(
  TenantName = "string",
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  ),
  SuppressionAttributes = list(
    SuppressedReasons = list(
      "BOUNCE"|"COMPLAINT"
    ),
    SuppressionScope = "ACCOUNT"|"TENANT"
  )
)