[ aws . connectcases ]

update-related-item

Description

Updates the content of a related item associated with a case. The following related item types are supported:

• Comment - Update the text content of an existing comment
• Custom - Update the fields of a custom related item. You can add, modify, and remove fields from a custom related item. There’s a quota for the number of fields allowed in a Custom type related item. See Amazon Connect Cases quotas .

Important things to know

• When updating a Custom related item, all existing and new fields, and their associated values should be included in the request. Fields not included as part of this request will be removed.
• If you provide a value for performedBy.userArn you must also have DescribeUser permission on the ARN of the user that you provide.
• System case fields cannot be used in a custom related item.

Endpoints : See Amazon Connect endpoints and quotas .

See also: AWS API Documentation

Synopsis

  update-related-item
--domain-id <value>
--case-id <value>
--related-item-id <value>
--content <value>
[--performed-by <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options

--domain-id (string) [required]

The unique identifier of the Cases domain.

Constraints:

• min: 1
• max: 500

--case-id (string) [required]

A unique identifier of the case.

Constraints:

• min: 1
• max: 500

--related-item-id (string) [required]

Unique identifier of a related item.

Constraints:

• min: 1
• max: 500

--content (tagged union structure) [required]

The content of a related item to be updated.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: comment, custom.

comment -> (structure)

Represents the updated content of a Comment related item.

body -> (string) [required]

Updated text in the body of a Comment on a case.

Constraints:

• min: 1
• max: 15000

contentType -> (string) [required]

Type of the text in the box of a Comment on a case.

Possible values:

• Text/Plain

custom -> (structure)

Represents the updated content of a Custom related item.

fields -> (list) [required]

List of updated field values for the Custom related item. All existing and new fields, and their associated values should be included. Fields not included as part of this request will be removed.

Constraints:

• min: 1
• max: 50

(structure)

Object for case field values.

id -> (string) [required]

Unique identifier of a field.

Constraints:

• min: 1
• max: 500

value -> (tagged union structure) [required]

Union of potential field value types.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: stringValue, doubleValue, booleanValue, emptyValue, userArnValue.

stringValue -> (string)

String value type.

Constraints:

• min: 0
• max: 4100

doubleValue -> (double)

Can be either null, or have a Double number value type. Only one value can be provided.

booleanValue -> (boolean)

Can be either null, or have a Boolean value type. Only one value can be provided.

emptyValue -> (structure)

An empty value.

userArnValue -> (string)

Represents the user that performed the audit.

JSON Syntax:

{
  "comment": {
    "body": "string",
    "contentType": "Text/Plain"
  },
  "custom": {
    "fields": [
      {
        "id": "string",
        "value": {
          "stringValue": "string",
          "doubleValue": double,
          "booleanValue": true|false,
          "emptyValue": {

          },
          "userArnValue": "string"
        }
      }
      ...
    ]
  }
}

--performed-by (tagged union structure)

Represents the user who performed the update of the related item.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: userArn, customEntity.

userArn -> (string)

Represents the Amazon Connect ARN of the user.

Constraints:

• min: 1
• max: 500

customEntity -> (string)

Any provided entity.

Constraints:

• min: 1
• max: 500
• pattern: [a-zA-Z0-9_\-\.@:/ ]*[a-zA-Z0-9_\-\.@:/]

Shorthand Syntax:

userArn=string,customEntity=string

JSON Syntax:

{
  "userArn": "string",
  "customEntity": "string"
}

--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table
• yaml
• yaml-stream
• off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

• legacy
• json
• yaml
• text
• table
• enhanced

Output

relatedItemId -> (string)

The unique identifier of the updated related item.

Constraints:

• min: 1
• max: 500

relatedItemArn -> (string)

The Amazon Resource Name (ARN) of the updated related item.

Constraints:

• min: 1
• max: 500

type -> (string)

Type of the updated related item.

Possible values:

• Contact
• Comment
• File
• Sla
• ConnectCase
• Custom

content -> (tagged union structure)

Represents the content of the updated related item.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: contact, comment, file, sla, connectCase, custom.

contact -> (structure)

Represents the content of a contact to be returned to agents.

contactArn -> (string) [required]

A unique identifier of a contact in Amazon Connect.

Constraints:

• min: 1
• max: 500

channel -> (string) [required]

A list of channels to filter on for related items of type Contact .

Constraints:

• min: 1
• max: 100

connectedToSystemTime -> (timestamp) [required]

The difference between the InitiationTimestamp and the DisconnectTimestamp of the contact.

comment -> (structure)

Represents the content of a comment to be returned to agents.

body -> (string) [required]

Text in the body of a Comment on a case.

Constraints:

• min: 1
• max: 15000

contentType -> (string) [required]

Type of the text in the box of a Comment on a case.

Possible values:

• Text/Plain

file -> (structure)

Represents the content of a File to be returned to agents.

fileArn -> (string) [required]

The Amazon Resource Name (ARN) of a File in Amazon Connect.

Constraints:

• min: 1
• max: 500

sla -> (structure)

Represents the content of an SLA to be returned to agents.

slaConfiguration -> (structure) [required]

Represents an SLA configuration.

name -> (string) [required]

Name of an SLA.

Constraints:

• min: 1
• max: 500
• pattern: .*[\S]

type -> (string) [required]

Type of SLA.

Possible values:

• CaseField

status -> (string) [required]

Status of an SLA.

Possible values:

• Active
• Overdue
• Met
• NotMet

fieldId -> (string)

Unique identifier of a field.

Constraints:

• min: 1
• max: 500

targetFieldValues -> (list)

Represents a list of target field values for the fieldId specified in SlaConfiguration.

Constraints:

• min: 1
• max: 1

(tagged union structure)

Object to store union of Field values.

Note

The Summary system field accepts up to 3000 characters, while all other fields accept up to 4100 characters. If you use multi-byte characters, the effective character limit may be lower.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: stringValue, doubleValue, booleanValue, emptyValue, userArnValue.

stringValue -> (string)

String value type.

Constraints:

• min: 0
• max: 4100

doubleValue -> (double)

Can be either null, or have a Double number value type. Only one value can be provided.

booleanValue -> (boolean)

Can be either null, or have a Boolean value type. Only one value can be provided.

emptyValue -> (structure)

An empty value.

userArnValue -> (string)

Represents the user that performed the audit.

targetTime -> (timestamp) [required]

Target time by which an SLA should be completed.

completionTime -> (timestamp)

Time at which an SLA was completed.

connectCase -> (structure)

Represents the Amazon Connect case to be created as a related item.

caseId -> (string) [required]

A unique identifier of the case.

Constraints:

• min: 1
• max: 500

custom -> (structure)

Represents the content of a Custom type related item.

fields -> (list) [required]

List of field values for the Custom related item.

(structure)

Object for case field values.

id -> (string) [required]

Unique identifier of a field.

Constraints:

• min: 1
• max: 500

value -> (tagged union structure) [required]

Union of potential field value types.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: stringValue, doubleValue, booleanValue, emptyValue, userArnValue.

stringValue -> (string)

String value type.

Constraints:

• min: 0
• max: 4100

doubleValue -> (double)

Can be either null, or have a Double number value type. Only one value can be provided.

booleanValue -> (boolean)

Can be either null, or have a Boolean value type. Only one value can be provided.

emptyValue -> (structure)

An empty value.

userArnValue -> (string)

Represents the user that performed the audit.

associationTime -> (timestamp)

Time at which the related item was associated with the case.

tags -> (map)

A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.

key -> (string)

value -> (string)

lastUpdatedUser -> (tagged union structure)

Represents the last user that updated the related item.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: userArn, customEntity.

userArn -> (string)

Represents the Amazon Connect ARN of the user.

Constraints:

• min: 1
• max: 500

customEntity -> (string)

Any provided entity.

Constraints:

• min: 1
• max: 500
• pattern: [a-zA-Z0-9_\-\.@:/ ]*[a-zA-Z0-9_\-\.@:/]

createdBy -> (tagged union structure)

Represents the creator of the related item.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: userArn, customEntity.

userArn -> (string)

Represents the Amazon Connect ARN of the user.

Constraints:

• min: 1
• max: 500

customEntity -> (string)

Any provided entity.

Constraints:

• min: 1
• max: 500
• pattern: [a-zA-Z0-9_\-\.@:/ ]*[a-zA-Z0-9_\-\.@:/]