Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetTenant

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

Request Syntax


POST /v2/email/tenants/get HTTP/1.1
Content-type: application/json

{
   "TenantName": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

TenantName

The name of the tenant to retrieve information about.

Type: String

Length Constraints: Minimum length of 1.

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Tenant": { 
      "CreatedTimestamp": number,
      "SendingStatus": "string",
      "Tags": [ 
         { 
            "Key": "string",
            "Value": "string"
         }
      ],
      "TenantArn": "string",
      "TenantId": "string",
      "TenantName": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Tenant

A structure that contains details about the tenant.

Type: Tenant object

Errors

For information about the errors that are common to all actions, see Common Errors.

BadRequestException

The input you provided is invalid.

HTTP Status Code: 400

NotFoundException

The resource you attempted to access doesn't exist.

HTTP Status Code: 404

TooManyRequestsException

Too many requests have been made to the operation.

HTTP Status Code: 429