GetContact - Amazon SES API v2

GetContact

Returns a contact from a contact list.

Request Syntax

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

URI Request Parameters

The request uses the following URI parameters.

ContactListName

The name of the contact list to which the contact belongs.

Required: Yes

EmailAddress

The contact's email addres.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "AttributesData": "string", "ContactListName": "string", "CreatedTimestamp": number, "EmailAddress": "string", "LastUpdatedTimestamp": number, "TopicDefaultPreferences": [ { "SubscriptionStatus": "string", "TopicName": "string" } ], "TopicPreferences": [ { "SubscriptionStatus": "string", "TopicName": "string" } ], "UnsubscribeAll": boolean }

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.

AttributesData

The attribute data attached to a contact.

Type: String

ContactListName

The name of the contact list to which the contact belongs.

Type: String

CreatedTimestamp

A timestamp noting when the contact was created.

Type: Timestamp

EmailAddress

The contact's email addres.

Type: String

LastUpdatedTimestamp

A timestamp noting the last time the contact's information was updated.

Type: Timestamp

TopicDefaultPreferences

The default topic preferences applied to the contact.

Type: Array of TopicPreference objects

TopicPreferences

The contact's preference for being opted-in to or opted-out of a topic.>

Type: Array of TopicPreference objects

UnsubscribeAll

A boolean value status noting if the contact is unsubscribed from all contact list topics.

Type: Boolean

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: