amazonka-connect-2.0: Amazon Connect Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Connect.UpdateContactAttributes

Description

Creates or updates user-defined contact attributes associated with the specified contact.

You can create or update user-defined attributes for both ongoing and completed contacts. For example, while the call is active, you can update the customer's name or the reason the customer called. You can add notes about steps that the agent took during the call that display to the next agent that takes the call. You can also update attributes for a contact using data from your CRM application and save the data with the contact in Amazon Connect. You could also flag calls for additional analysis, such as legal review or to identify abusive callers.

Contact attributes are available in Amazon Connect for 24 months, and are then deleted. For information about contact record retention and the maximum size of the contact record attributes section, see Feature specifications in the Amazon Connect Administrator Guide.

Synopsis

Creating a Request

data UpdateContactAttributes Source #

See: newUpdateContactAttributes smart constructor.

Constructors

UpdateContactAttributes' 

Fields

  • initialContactId :: Text

    The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.

  • instanceId :: Text

    The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

  • attributes :: HashMap Text Text

    The Amazon Connect attributes. These attributes can be accessed in flows just like any other contact attributes.

    You can have up to 32,768 UTF-8 bytes across all attributes for a contact. Attribute keys can include only alphanumeric, dash, and underscore characters.

Instances

Instances details
ToJSON UpdateContactAttributes Source # 
Instance details

Defined in Amazonka.Connect.UpdateContactAttributes

ToHeaders UpdateContactAttributes Source # 
Instance details

Defined in Amazonka.Connect.UpdateContactAttributes

ToPath UpdateContactAttributes Source # 
Instance details

Defined in Amazonka.Connect.UpdateContactAttributes

ToQuery UpdateContactAttributes Source # 
Instance details

Defined in Amazonka.Connect.UpdateContactAttributes

AWSRequest UpdateContactAttributes Source # 
Instance details

Defined in Amazonka.Connect.UpdateContactAttributes

Generic UpdateContactAttributes Source # 
Instance details

Defined in Amazonka.Connect.UpdateContactAttributes

Associated Types

type Rep UpdateContactAttributes :: Type -> Type #

Read UpdateContactAttributes Source # 
Instance details

Defined in Amazonka.Connect.UpdateContactAttributes

Show UpdateContactAttributes Source # 
Instance details

Defined in Amazonka.Connect.UpdateContactAttributes

NFData UpdateContactAttributes Source # 
Instance details

Defined in Amazonka.Connect.UpdateContactAttributes

Methods

rnf :: UpdateContactAttributes -> () #

Eq UpdateContactAttributes Source # 
Instance details

Defined in Amazonka.Connect.UpdateContactAttributes

Hashable UpdateContactAttributes Source # 
Instance details

Defined in Amazonka.Connect.UpdateContactAttributes

type AWSResponse UpdateContactAttributes Source # 
Instance details

Defined in Amazonka.Connect.UpdateContactAttributes

type Rep UpdateContactAttributes Source # 
Instance details

Defined in Amazonka.Connect.UpdateContactAttributes

type Rep UpdateContactAttributes = D1 ('MetaData "UpdateContactAttributes" "Amazonka.Connect.UpdateContactAttributes" "amazonka-connect-2.0-IAACrecRcUS5AABe9BOFyN" 'False) (C1 ('MetaCons "UpdateContactAttributes'" 'PrefixI 'True) (S1 ('MetaSel ('Just "initialContactId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "instanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "attributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashMap Text Text)))))

newUpdateContactAttributes Source #

Create a value of UpdateContactAttributes with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

UpdateContactAttributes, updateContactAttributes_initialContactId - The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.

UpdateContactAttributes, updateContactAttributes_instanceId - The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

$sel:attributes:UpdateContactAttributes', updateContactAttributes_attributes - The Amazon Connect attributes. These attributes can be accessed in flows just like any other contact attributes.

You can have up to 32,768 UTF-8 bytes across all attributes for a contact. Attribute keys can include only alphanumeric, dash, and underscore characters.

Request Lenses

updateContactAttributes_initialContactId :: Lens' UpdateContactAttributes Text Source #

The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.

updateContactAttributes_instanceId :: Lens' UpdateContactAttributes Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

updateContactAttributes_attributes :: Lens' UpdateContactAttributes (HashMap Text Text) Source #

The Amazon Connect attributes. These attributes can be accessed in flows just like any other contact attributes.

You can have up to 32,768 UTF-8 bytes across all attributes for a contact. Attribute keys can include only alphanumeric, dash, and underscore characters.

Destructuring the Response

data UpdateContactAttributesResponse Source #

See: newUpdateContactAttributesResponse smart constructor.

Constructors

UpdateContactAttributesResponse' 

Fields

Instances

Instances details
Generic UpdateContactAttributesResponse Source # 
Instance details

Defined in Amazonka.Connect.UpdateContactAttributes

Associated Types

type Rep UpdateContactAttributesResponse :: Type -> Type #

Read UpdateContactAttributesResponse Source # 
Instance details

Defined in Amazonka.Connect.UpdateContactAttributes

Show UpdateContactAttributesResponse Source # 
Instance details

Defined in Amazonka.Connect.UpdateContactAttributes

NFData UpdateContactAttributesResponse Source # 
Instance details

Defined in Amazonka.Connect.UpdateContactAttributes

Eq UpdateContactAttributesResponse Source # 
Instance details

Defined in Amazonka.Connect.UpdateContactAttributes

type Rep UpdateContactAttributesResponse Source # 
Instance details

Defined in Amazonka.Connect.UpdateContactAttributes

type Rep UpdateContactAttributesResponse = D1 ('MetaData "UpdateContactAttributesResponse" "Amazonka.Connect.UpdateContactAttributes" "amazonka-connect-2.0-IAACrecRcUS5AABe9BOFyN" 'False) (C1 ('MetaCons "UpdateContactAttributesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateContactAttributesResponse Source #

Create a value of UpdateContactAttributesResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:UpdateContactAttributesResponse', updateContactAttributesResponse_httpStatus - The response's http status code.

Response Lenses