[ aws . connect ]

update-contact

Description

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.

Warning

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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-contact
--instance-id <value>
--contact-id <value>
[--name <value>]
[--description <value>]
[--references <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--instance-id (string)

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

--contact-id (string)

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

--name (string)

The name of the contact.

--description (string)

The description of the contact.

--references (map)

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

key -> (string)

value -> (structure)

Well-formed data on a contact, used by agents to complete a contact request. You can have up to 4,096 UTF-8 bytes across all references for a contact.

Value -> (string)

A valid value for the reference. For example, for a URL reference, a formatted URL that is displayed to an agent in the Contact Control Panel (CCP).

Type -> (string)

The type of the reference.

Shorthand Syntax:

KeyName1=Value=string,Type=string,KeyName2=Value=string,Type=string

JSON Syntax:

{"string": {
      "Value": "string",
      "Type": "URL"|"ATTACHMENT"|"NUMBER"|"STRING"|"DATE"|"EMAIL"
    }
  ...}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

None