Skip to content

Get Tenant

sesv2_get_tenant R Documentation

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

Description

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

Usage

sesv2_get_tenant(TenantName)

Arguments

TenantName

[required] The name of the tenant to retrieve information about.

Value

A list with the following syntax:

list(
  Tenant = list(
    TenantName = "string",
    TenantId = "string",
    TenantArn = "string",
    CreatedTimestamp = as.POSIXct(
      "2015-01-01"
    ),
    Tags = list(
      list(
        Key = "string",
        Value = "string"
      )
    ),
    SendingStatus = "ENABLED"|"REINSTATED"|"DISABLED"
  )
)

Request syntax

svc$get_tenant(
  TenantName = "string"
)