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

CreateEmailAddress

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.

Request Syntax


PUT /email-addresses/InstanceId HTTP/1.1
Content-type: application/json

{
   "ClientToken": "string",
   "Description": "string",
   "DisplayName": "string",
   "EmailAddress": "string",
   "Tags": { 
      "string" : "string" 
   }
}

URI Request Parameters

The request uses the following URI parameters.

InstanceId

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: Yes

Request Body

The request accepts the following data in JSON format.

ClientToken

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

Type: String

Length Constraints: Maximum length of 500.

Required: No

Description

The description of the email address.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 4096.

Required: No

DisplayName

The display name of email address

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

EmailAddress

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [^\s@]+@[^\s@]+\.[^\s@]+

Required: Yes

Tags

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

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ^(?!aws:)[\p{L}\p{Z}\p{N}_.:/=+\-@]*$

Value Length Constraints: Maximum length of 256.

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "EmailAddressArn": "string",
   "EmailAddressId": "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.

EmailAddressArn

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 500.

EmailAddressId

The identifier of the email address.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 500.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient permissions to perform this action.

HTTP Status Code: 403

DuplicateResourceException

A resource with the specified name already exists.

HTTP Status Code: 409

IdempotencyException

An entity with the same name already exists.

HTTP Status Code: 409

InternalServiceException

Request processing failed because of an error or failure with the service.

HTTP Status Code: 500

InvalidParameterException

One or more of the specified parameters are not valid.

HTTP Status Code: 400

InvalidRequestException

The request is not valid.

HTTP Status Code: 400

ResourceConflictException

A resource already has that name.

HTTP Status Code: 409

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 404

ServiceQuotaExceededException

The service quota has been exceeded.

HTTP Status Code: 402

ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 429