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

DescribeEmailAddress

Describe email address form the specified Amazon Connect instance.

Request Syntax


GET /email-addresses/InstanceId/EmailAddressId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

EmailAddressId

The identifier of the email address.

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

Required: Yes

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 does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "CreateTimestamp": "string",
   "Description": "string",
   "DisplayName": "string",
   "EmailAddress": "string",
   "EmailAddressArn": "string",
   "EmailAddressId": "string",
   "ModifiedTimestamp": "string",
   "Tags": { 
      "string" : "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.

CreateTimestamp

The email address creation timestamp in ISO 8601 Datetime.

Type: String

Description

The description of the email address.

Type: String

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

DisplayName

The display name of email address

Type: String

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

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@]+

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.

ModifiedTimestamp

The email address last modification timestamp in ISO 8601 Datetime.

Type: String

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.

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

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

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 404

ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 429