Connect / Client / create_email_address

create_email_address#

Connect.Client.create_email_address(**kwargs)#

Create new email address in the specified Amazon Connect instance. For more information about email addresses, see Create email addresses in the Amazon Connect Administrator Guide.

See also: AWS API Documentation

Request Syntax

response = client.create_email_address(
    Description='string',
    InstanceId='string',
    EmailAddress='string',
    DisplayName='string',
    Tags={
        'string': 'string'
    },
    ClientToken='string'
)
Parameters:

  • Description (string) – The description of the email address.

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

  • EmailAddress (string) –

    [REQUIRED]

    The email address with the instance, in [^s@]+@[^s@]+.[^s@]+ format.

  • DisplayName (string) – The display name of email address

  • Tags (dict) –

    The tags used to organize, track, or control access for this resource. For example, { “Tags”: {“key1”:”value1”, “key2”:”value2”} }.

    • (string) –

      • (string) –

  • ClientToken (string) – A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

Return type:

dict

Returns:

Response Syntax

{
    'EmailAddressId': 'string',
    'EmailAddressArn': 'string'
}

Response Structure

  • (dict) –

    • EmailAddressId (string) –

      The identifier of the email address.

    • EmailAddressArn (string) –

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

Exceptions