- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
UpdateEmailAddressMetadataCommand
Updates an email address metadata. For more information about email addresses, see Create email addresses in the Amazon Connect Administrator Guide.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { ConnectClient, UpdateEmailAddressMetadataCommand } from "@aws-sdk/client-connect"; // ES Modules import
// const { ConnectClient, UpdateEmailAddressMetadataCommand } = require("@aws-sdk/client-connect"); // CommonJS import
const client = new ConnectClient(config);
const input = { // UpdateEmailAddressMetadataRequest
InstanceId: "STRING_VALUE", // required
EmailAddressId: "STRING_VALUE", // required
Description: "STRING_VALUE",
DisplayName: "STRING_VALUE",
ClientToken: "STRING_VALUE",
};
const command = new UpdateEmailAddressMetadataCommand(input);
const response = await client.send(command);
// { // UpdateEmailAddressMetadataResponse
// EmailAddressId: "STRING_VALUE",
// EmailAddressArn: "STRING_VALUE",
// };
UpdateEmailAddressMetadataCommand Input
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
EmailAddressIdRequired | string | undefined | The identifier of the email address. |
InstanceIdRequired | string | undefined | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. |
ClientToken | string | undefined | 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 . |
Description | string | undefined | The description of the email address. |
DisplayName | string | undefined | The display name of email address. |
UpdateEmailAddressMetadataCommand Output
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
EmailAddressArn | string | undefined | The Amazon Resource Name (ARN) of the email address. |
EmailAddressId | string | undefined | The identifier of the email address. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| AccessDeniedException | client | You do not have sufficient permissions to perform this action. |
| IdempotencyException | client | An entity with the same name already exists. |
| InternalServiceException | server | Request processing failed because of an error or failure with the service. |
| InvalidParameterException | client | One or more of the specified parameters are not valid. |
| InvalidRequestException | client | The request is not valid. |
| ResourceNotFoundException | client | The specified resource was not found. |
| ThrottlingException | client | The throttling limit has been exceeded. |
| ConnectServiceException | Base exception class for all service exceptions from Connect service. |