# UpdateEmailAddressMetadata
<a name="API_UpdateEmailAddressMetadata"></a>

Updates an email address metadata. For more information about email addresses, see [Create email addresses](https://docs.aws.amazon.com/connect/latest/adminguide/create-email-address1.html) in the Amazon Connect Administrator Guide.

## Request Syntax
<a name="API_UpdateEmailAddressMetadata_RequestSyntax"></a>

```
POST /email-addresses/InstanceId/EmailAddressId HTTP/1.1
Content-type: application/json

{
   "ClientToken": "string",
   "Description": "string",
   "DisplayName": "string"
}
```

## URI Request Parameters
<a name="API_UpdateEmailAddressMetadata_RequestParameters"></a>

The request uses the following URI parameters.

 ** [EmailAddressId](#API_UpdateEmailAddressMetadata_RequestSyntax) **   <a name="connect-UpdateEmailAddressMetadata-request-uri-EmailAddressId"></a>
The identifier of the email address.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [InstanceId](#API_UpdateEmailAddressMetadata_RequestSyntax) **   <a name="connect-UpdateEmailAddressMetadata-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_UpdateEmailAddressMetadata_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ClientToken](#API_UpdateEmailAddressMetadata_RequestSyntax) **   <a name="connect-UpdateEmailAddressMetadata-request-ClientToken"></a>
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](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Maximum length of 500.  
Required: No

 ** [Description](#API_UpdateEmailAddressMetadata_RequestSyntax) **   <a name="connect-UpdateEmailAddressMetadata-request-Description"></a>
The description of the email address.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 4096.  
Required: No

 ** [DisplayName](#API_UpdateEmailAddressMetadata_RequestSyntax) **   <a name="connect-UpdateEmailAddressMetadata-request-DisplayName"></a>
The display name of email address.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Required: No

## Response Syntax
<a name="API_UpdateEmailAddressMetadata_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "EmailAddressArn": "string",
   "EmailAddressId": "string"
}
```

## Response Elements
<a name="API_UpdateEmailAddressMetadata_ResponseElements"></a>

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](#API_UpdateEmailAddressMetadata_ResponseSyntax) **   <a name="connect-UpdateEmailAddressMetadata-response-EmailAddressArn"></a>
The Amazon Resource Name (ARN) of the email address.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.

 ** [EmailAddressId](#API_UpdateEmailAddressMetadata_ResponseSyntax) **   <a name="connect-UpdateEmailAddressMetadata-response-EmailAddressId"></a>
The identifier of the email address.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.

## Errors
<a name="API_UpdateEmailAddressMetadata_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** 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.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_UpdateEmailAddressMetadata_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/UpdateEmailAddressMetadata) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/UpdateEmailAddressMetadata) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UpdateEmailAddressMetadata) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/UpdateEmailAddressMetadata) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/UpdateEmailAddressMetadata) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/UpdateEmailAddressMetadata) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/UpdateEmailAddressMetadata) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/UpdateEmailAddressMetadata) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/UpdateEmailAddressMetadata) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UpdateEmailAddressMetadata)