Connect / Client / describe_email_address

describe_email_address#

Connect.Client.describe_email_address(**kwargs)#

Describe email address form the specified Amazon Connect instance.

Request Syntax

response = client.describe_email_address(
    InstanceId='string',
    EmailAddressId='string'
)

Parameters:

InstanceId (string) –
[REQUIRED]

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
EmailAddressId (string) –
[REQUIRED]

The identifier of the email address.

Return type:

dict

Returns:

Response Syntax

{
    'EmailAddressId': 'string',
    'EmailAddressArn': 'string',
    'EmailAddress': 'string',
    'DisplayName': 'string',
    'Description': 'string',
    'CreateTimestamp': 'string',
    'ModifiedTimestamp': 'string',
    'Tags': {
        'string': 'string'
    }
}

Response Structure

(dict) –
- EmailAddressId (string) –
  
  The identifier of the email address.
- EmailAddressArn (string) –
  
  The Amazon Resource Name (ARN) of the email address.
- EmailAddress (string) –
  
  The email address with the instance, in [^s@]+@[^s@]+.[^s@]+ format.
- DisplayName (string) –
  
  The display name of email address
- Description (string) –
  
  The description of the email address.
- CreateTimestamp (string) –
  
  The email address creation timestamp in ISO 8601 Datetime.
- ModifiedTimestamp (string) –
  
  The email address last modification timestamp in ISO 8601 Datetime.
- Tags (dict) –
  
  The tags used to organize, track, or control access for this resource. For example, { “Tags”: {“key1”:”value1”, “key2”:”value2”} }.
  - (string) –
    - (string) –

Exceptions

Connect.Client.exceptions.ResourceNotFoundException
Connect.Client.exceptions.AccessDeniedException
Connect.Client.exceptions.ThrottlingException
Connect.Client.exceptions.InvalidParameterException
Connect.Client.exceptions.InvalidRequestException
Connect.Client.exceptions.InternalServiceException