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

ListContactLists

Lists all of the contact lists available.

Request Syntax


GET /v2/email/contact-lists?NextToken=NextToken&PageSize=PageSize HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

NextToken: A string token indicating that there might be additional contact lists available to be listed. Use the token provided in the Response to use in the subsequent call to ListContactLists with the same parameters to retrieve the next page of contact lists.
PageSize: Maximum number of contact lists to return at once. Use this parameter to paginate results. If additional contact lists exist beyond the specified limit, the NextToken element is sent in the response. Use the NextToken value in subsequent requests to retrieve additional lists.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "ContactLists": [ 
      { 
         "ContactListName": "string",
         "LastUpdatedTimestamp": number
      }
   ],
   "NextToken": "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.

ContactLists

The available contact lists.

Type: Array of ContactList objects

NextToken

A string token indicating that there might be additional contact lists available to be listed. Copy this token to a subsequent call to ListContactLists with the same parameters to retrieve the next page of contact lists.

Type: String

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

TooManyRequestsException

Too many requests have been made to the operation.

HTTP Status Code: 429