Skip to content

Update Email Address Metadata

connect_update_email_address_metadata R Documentation

Updates an email address metadata

Description

Updates an email address metadata. For more information about email addresses, see Create email addresses in the Amazon Connect Administrator Guide.

Usage

connect_update_email_address_metadata(InstanceId, EmailAddressId,
  Description, DisplayName, ClientToken)

Arguments

InstanceId

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

EmailAddressId

[required] The identifier of the email address.

Description

The description of the email address.

DisplayName

The display name of email address.

ClientToken

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.

Value

A list with the following syntax:

list(
  EmailAddressId = "string",
  EmailAddressArn = "string"
)

Request syntax

svc$update_email_address_metadata(
  InstanceId = "string",
  EmailAddressId = "string",
  Description = "string",
  DisplayName = "string",
  ClientToken = "string"
)