UserNotificationsContacts / Client / get_email_contact

get_email_contact#

UserNotificationsContacts.Client.get_email_contact(**kwargs)#

Returns an email contact.

See also: AWS API Documentation

Request Syntax

response = client.get_email_contact(
    arn='string'
)
Parameters:

arn (string) –

[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • emailContact (dict) –

      The email contact for the provided email address.

      • 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.ResourceNotFoundException

  • UserNotificationsContacts.Client.exceptions.AccessDeniedException

  • UserNotificationsContacts.Client.exceptions.ThrottlingException

  • UserNotificationsContacts.Client.exceptions.ValidationException