GetContactList - Amazon SES API v2

GetContactList

Returns contact list metadata. It does not return any information about the contacts present in the list.

Request Syntax

GET /v2/email/contact-lists/ContactListName HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

ContactListName

The name of the contact list.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "ContactListName": "string", "CreatedTimestamp": number, "Description": "string", "LastUpdatedTimestamp": number, "Tags": [ { "Key": "string", "Value": "string" } ], "Topics": [ { "DefaultSubscriptionStatus": "string", "Description": "string", "DisplayName": "string", "TopicName": "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.

ContactListName

The name of the contact list.

Type: String

CreatedTimestamp

A timestamp noting when the contact list was created.

Type: Timestamp

Description

A description of what the contact list is about.

Type: String

LastUpdatedTimestamp

A timestamp noting the last time the contact list was updated.

Type: Timestamp

Tags

The tags associated with a contact list.

Type: Array of Tag objects

Topics

An interest group, theme, or label within a list. A contact list can have multiple topics.

Type: Array of Topic objects

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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: