Skip to content

List all tenants associated with your account in the current Amazon Web Services Region

Description

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.

Usage

sesv2_list_tenants(Filter, NextToken, PageSize)

Arguments

  • Filter

An object that contains filters to apply when listing tenants. You can filter by tenant name or sending status.

  • NextToken

A token returned from a previous call to list_tenants to indicate the position in the list of tenants.

  • PageSize

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

Value

A list with the following syntax:

list(
  Tenants = list(
    list(
      TenantName = "string",
      TenantId = "string",
      TenantArn = "string",
      CreatedTimestamp = as.POSIXct(
        "2015-01-01"
      ),
      SendingStatus = "ENABLED"|"REINSTATED"|"DISABLED"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_tenants(
  Filter = list(
    "string"
  ),
  NextToken = "string",
  PageSize = 123
)