UserNotificationsContacts / Client / list_email_contacts

list_email_contacts#

UserNotificationsContacts.Client.list_email_contacts(**kwargs)#

Lists all email contacts created under the Account.

See also: AWS API Documentation

Request Syntax

response = client.list_email_contacts(
    maxResults=123,
    nextToken='string'
)
Parameters:

  • maxResults (integer) – The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

  • nextToken (string) – An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'emailContacts': [
        {
            'arn': 'string',
            'name': 'string',
            'address': 'string',
            'status': 'inactive'|'active',
            'creationTime': datetime(2015, 1, 1),
            'updateTime': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

  • (dict) –

    • nextToken (string) –

      An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

    • emailContacts (list) –

      A list of email contacts.

      • (dict) –

        An email contact.

        • arn (string) –

          The Amazon Resource Name (ARN) of the email contact.

        • name (string) –

          The name of the email contact.

        • address (string) –

          The email address this email contact points to. The activation email and any subscribed emails are sent here.

        • status (string) –

          The status of the email contact. Only activated email contacts receive emails.

        • creationTime (datetime) –

          The creation time of the resource.

        • updateTime (datetime) –

          The time the resource was last updated.

Exceptions

  • UserNotificationsContacts.Client.exceptions.InternalServerException

  • UserNotificationsContacts.Client.exceptions.AccessDeniedException

  • UserNotificationsContacts.Client.exceptions.ThrottlingException

  • UserNotificationsContacts.Client.exceptions.ValidationException