Amazonka.Connect.UpdateContact

This API is in preview release for Amazon Connect and is subject to change.

Adds or updates user-defined contact information associated with the specified contact. At least one field to be updated must be present in the request.

You can add or update user-defined contact information for both ongoing and completed contacts.

Creating a Request

data UpdateContact

See: newUpdateContact smart constructor.

Constructors

UpdateContact'

Fields

• description :: Maybe Text

  The description of the contact.

• name :: Maybe Text

  The name of the contact.

• references :: Maybe (HashMap Text Reference)

  Well-formed data on contact, shown to agents on Contact Control Panel (CCP).

• instanceId :: Text

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

• contactId :: Text

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

Instances

ToJSON UpdateContact

Defined in Amazonka.Connect.UpdateContact

Methods

toJSON :: UpdateContact -> Value

toEncoding :: UpdateContact -> Encoding

toJSONList :: [UpdateContact] -> Value

toEncodingList :: [UpdateContact] -> Encoding

ToHeaders UpdateContact

Defined in Amazonka.Connect.UpdateContact

Methods

toHeaders :: UpdateContact -> [Header]

ToPath UpdateContact

Defined in Amazonka.Connect.UpdateContact

Methods

toPath :: UpdateContact -> ByteString

ToQuery UpdateContact

Defined in Amazonka.Connect.UpdateContact

Methods

toQuery :: UpdateContact -> QueryString

AWSRequest UpdateContact

Defined in Amazonka.Connect.UpdateContact

Associated Types

type AWSResponse UpdateContact

Methods

request :: (Service -> Service) -> UpdateContact -> Request UpdateContact

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateContact -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateContact)))

Generic UpdateContact

Defined in Amazonka.Connect.UpdateContact

Associated Types

type Rep UpdateContact :: Type -> Type

Methods

from :: UpdateContact -> Rep UpdateContact x

to :: Rep UpdateContact x -> UpdateContact

Read UpdateContact

Defined in Amazonka.Connect.UpdateContact

Methods

readsPrec :: Int -> ReadS UpdateContact

readList :: ReadS [UpdateContact]

readPrec :: ReadPrec UpdateContact

readListPrec :: ReadPrec [UpdateContact]

Show UpdateContact

Defined in Amazonka.Connect.UpdateContact

Methods

showsPrec :: Int -> UpdateContact -> ShowS

show :: UpdateContact -> String

showList :: [UpdateContact] -> ShowS

NFData UpdateContact

Defined in Amazonka.Connect.UpdateContact

Methods

rnf :: UpdateContact -> ()

Eq UpdateContact

Defined in Amazonka.Connect.UpdateContact

Methods

(==) :: UpdateContact -> UpdateContact -> Bool

(/=) :: UpdateContact -> UpdateContact -> Bool

Hashable UpdateContact

Defined in Amazonka.Connect.UpdateContact

Methods

hashWithSalt :: Int -> UpdateContact -> Int

hash :: UpdateContact -> Int

type AWSResponse UpdateContact

Defined in Amazonka.Connect.UpdateContact

type AWSResponse UpdateContact = UpdateContactResponse

type Rep UpdateContact

Defined in Amazonka.Connect.UpdateContact

type Rep UpdateContact = D1 ('MetaData "UpdateContact" "Amazonka.Connect.UpdateContact" "amazonka-connect-2.0-IAACrecRcUS5AABe9BOFyN" 'False) (C1 ('MetaCons "UpdateContact'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "references") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Reference))) :*: (S1 ('MetaSel ('Just "instanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "contactId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newUpdateContact

Arguments

:: Text

UpdateContact

-> Text

UpdateContact

-> UpdateContact

Create a value of UpdateContact 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:

UpdateContact, updateContact_description - The description of the contact.

UpdateContact, updateContact_name - The name of the contact.

UpdateContact, updateContact_references - Well-formed data on contact, shown to agents on Contact Control Panel (CCP).

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

UpdateContact, updateContact_contactId - The identifier of the contact. This is the identifier of the contact associated with the first interaction with your contact center.

Request Lenses

updateContact_description :: Lens' UpdateContact (Maybe Text)

The description of the contact.

updateContact_name :: Lens' UpdateContact (Maybe Text)

The name of the contact.

updateContact_references :: Lens' UpdateContact (Maybe (HashMap Text Reference))

Well-formed data on contact, shown to agents on Contact Control Panel (CCP).

updateContact_instanceId :: Lens' UpdateContact Text

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

updateContact_contactId :: Lens' UpdateContact Text

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

Destructuring the Response

data UpdateContactResponse

See: newUpdateContactResponse smart constructor.

Constructors

UpdateContactResponse'

Fields

• httpStatus :: Int

  The response's http status code.

Instances

Generic UpdateContactResponse

Defined in Amazonka.Connect.UpdateContact

Associated Types

type Rep UpdateContactResponse :: Type -> Type

Methods

from :: UpdateContactResponse -> Rep UpdateContactResponse x

to :: Rep UpdateContactResponse x -> UpdateContactResponse

Read UpdateContactResponse

Defined in Amazonka.Connect.UpdateContact

Methods

readsPrec :: Int -> ReadS UpdateContactResponse

readList :: ReadS [UpdateContactResponse]

readPrec :: ReadPrec UpdateContactResponse

readListPrec :: ReadPrec [UpdateContactResponse]

Show UpdateContactResponse

Defined in Amazonka.Connect.UpdateContact

Methods

showsPrec :: Int -> UpdateContactResponse -> ShowS

show :: UpdateContactResponse -> String

showList :: [UpdateContactResponse] -> ShowS

NFData UpdateContactResponse

Defined in Amazonka.Connect.UpdateContact

Methods

rnf :: UpdateContactResponse -> ()

Eq UpdateContactResponse

Defined in Amazonka.Connect.UpdateContact

Methods

(==) :: UpdateContactResponse -> UpdateContactResponse -> Bool

(/=) :: UpdateContactResponse -> UpdateContactResponse -> Bool

type Rep UpdateContactResponse

Defined in Amazonka.Connect.UpdateContact

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

newUpdateContactResponse

Arguments

:: Int

$sel:httpStatus:UpdateContactResponse'

-> UpdateContactResponse

Create a value of UpdateContactResponse 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:UpdateContactResponse', updateContactResponse_httpStatus - The response's http status code.

Response Lenses

updateContactResponse_httpStatus :: Lens' UpdateContactResponse Int

The response's http status code.