[ aws . connectcases ]

search-all-related-items

Description

Searches for related items across all cases within a domain. This is a global search operation that returns related items from multiple cases, unlike the case-specific SearchRelatedItems API.

Use cases

Following are common uses cases for this API:

• Find cases with similar issues across the domain. For example, search for all cases containing comments about “product defect” to identify patterns and existing solutions.
• Locate all cases associated with specific contacts or orders. For example, find all cases linked to a contactArn to understand the complete customer journey.
• Monitor SLA compliance across cases. For example, search for all cases with “Active” SLA status to prioritize remediation efforts.

Important things to know

• This API returns case identifiers, not complete case objects. To retrieve full case details, you must make additional calls to the GetCase API for each returned case ID.
• This API searches across related items content, not case fields. Use the SearchCases API to search within case field values.

Endpoints : See Amazon Connect endpoints and quotas .

See also: AWS API Documentation

search-all-related-items is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: relatedItems

Synopsis

  search-all-related-items
--domain-id <value>
[--filters <value>]
[--sorts <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <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

--filters (list)

The list of types of related items and their parameters to use for filtering. The filters work as an OR condition: caller gets back related items that match any of the specified filter types.

Constraints:

• min: 0
• max: 10

(tagged union structure)

The list of types of related items and their parameters to use for filtering.

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)

A filter for related items of type Contact .

channel -> (list)

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

Constraints:

• min: 0
• max: 3

(string)

Constraints:

• min: 1
• max: 100

contactArn -> (string)

A unique identifier of a contact in Amazon Connect.

Constraints:

• min: 1
• max: 500

comment -> (structure)

A filter for related items of type Comment .

file -> (structure)

A filter for related items of this type of File .

fileArn -> (string)

The Amazon Resource Name (ARN) of the file.

Constraints:

• min: 1
• max: 500

sla -> (structure)

Filter for related items of type SLA .

name -> (string)

Name of an SLA.

Constraints:

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

status -> (string)

Status of an SLA.

Possible values:

• Active
• Overdue
• Met
• NotMet

connectCase -> (structure)

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

caseId -> (string)

A unique identifier of the case.

Constraints:

• min: 1
• max: 500

custom -> (structure)

Represents the content of a Custom type related item.

fields -> (tagged union structure)

Filter conditions for custom fields.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: field, not, andAll, orAll.

field -> (tagged union structure)

A filter for fields. Only one value can be provided.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: equalTo, contains, greaterThan, greaterThanOrEqualTo, lessThan, lessThanOrEqualTo.

equalTo -> (structure)

Object containing field identifier and value information.

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.

contains -> (structure)

Object containing field identifier and value information.

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.

greaterThan -> (structure)

Object containing field identifier and value information.

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.

greaterThanOrEqualTo -> (structure)

Object containing field identifier and value information.

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.

lessThan -> (structure)

Object containing field identifier and value information.

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.

lessThanOrEqualTo -> (structure)

Object containing field identifier and value information.

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.

not -> (tagged union structure)

Excludes items matching the filter.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: field, not, andAll, orAll.

field -> (tagged union structure)

A filter for fields. Only one value can be provided.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: equalTo, contains, greaterThan, greaterThanOrEqualTo, lessThan, lessThanOrEqualTo.

equalTo -> (structure)

Object containing field identifier and value information.

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.

contains -> (structure)

Object containing field identifier and value information.

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.

greaterThan -> (structure)

Object containing field identifier and value information.

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.

greaterThanOrEqualTo -> (structure)

Object containing field identifier and value information.

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.

lessThan -> (structure)

Object containing field identifier and value information.

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.

lessThanOrEqualTo -> (structure)

Object containing field identifier and value information.

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.

( … recursive … )andAll -> (list)

Provides “and all” filtering.

Constraints:

• min: 0
• max: 10

( … recursive … )

orAll -> (list)

Provides “or all” filtering.

Constraints:

• min: 0
• max: 10

( … recursive … )

andAll -> (list)

Provides “and all” filtering.

Constraints:

• min: 0
• max: 10

(tagged union structure)

A filter for fields in Custom type related items. Only one value can be provided.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: field, not, andAll, orAll.

field -> (tagged union structure)

A filter for fields. Only one value can be provided.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: equalTo, contains, greaterThan, greaterThanOrEqualTo, lessThan, lessThanOrEqualTo.

equalTo -> (structure)

Object containing field identifier and value information.

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.

contains -> (structure)

Object containing field identifier and value information.

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.

greaterThan -> (structure)

Object containing field identifier and value information.

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.

greaterThanOrEqualTo -> (structure)

Object containing field identifier and value information.

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.

lessThan -> (structure)

Object containing field identifier and value information.

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.

lessThanOrEqualTo -> (structure)

Object containing field identifier and value information.

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.

( … recursive … )andAll -> (list)

Provides “and all” filtering.

Constraints:

• min: 0
• max: 10

( … recursive … )

orAll -> (list)

Provides “or all” filtering.

Constraints:

• min: 0
• max: 10

( … recursive … )

orAll -> (list)

Provides “or all” filtering.

Constraints:

• min: 0
• max: 10

(tagged union structure)

A filter for fields in Custom type related items. Only one value can be provided.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: field, not, andAll, orAll.

field -> (tagged union structure)

A filter for fields. Only one value can be provided.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: equalTo, contains, greaterThan, greaterThanOrEqualTo, lessThan, lessThanOrEqualTo.

equalTo -> (structure)

Object containing field identifier and value information.

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.

contains -> (structure)

Object containing field identifier and value information.

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.

greaterThan -> (structure)

Object containing field identifier and value information.

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.

greaterThanOrEqualTo -> (structure)

Object containing field identifier and value information.

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.

lessThan -> (structure)

Object containing field identifier and value information.

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.

lessThanOrEqualTo -> (structure)

Object containing field identifier and value information.

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.

( … recursive … )andAll -> (list)

Provides “and all” filtering.

Constraints:

• min: 0
• max: 10

( … recursive … )

orAll -> (list)

Provides “or all” filtering.

Constraints:

• min: 0
• max: 10

( … recursive … )

JSON Syntax:

[
  {
    "contact": {
      "channel": ["string", ...],
      "contactArn": "string"
    },
    "comment": {

    },
    "file": {
      "fileArn": "string"
    },
    "sla": {
      "name": "string",
      "status": "Active"|"Overdue"|"Met"|"NotMet"
    },
    "connectCase": {
      "caseId": "string"
    },
    "custom": {
      "fields": {
        "field": {
          "equalTo": {
            "id": "string",
            "value": {
              "stringValue": "string",
              "doubleValue": double,
              "booleanValue": true|false,
              "emptyValue": {

              },
              "userArnValue": "string"
            }
          },
          "contains": {
            "id": "string",
            "value": {
              "stringValue": "string",
              "doubleValue": double,
              "booleanValue": true|false,
              "emptyValue": {

              },
              "userArnValue": "string"
            }
          },
          "greaterThan": {
            "id": "string",
            "value": {
              "stringValue": "string",
              "doubleValue": double,
              "booleanValue": true|false,
              "emptyValue": {

              },
              "userArnValue": "string"
            }
          },
          "greaterThanOrEqualTo": {
            "id": "string",
            "value": {
              "stringValue": "string",
              "doubleValue": double,
              "booleanValue": true|false,
              "emptyValue": {

              },
              "userArnValue": "string"
            }
          },
          "lessThan": {
            "id": "string",
            "value": {
              "stringValue": "string",
              "doubleValue": double,
              "booleanValue": true|false,
              "emptyValue": {

              },
              "userArnValue": "string"
            }
          },
          "lessThanOrEqualTo": {
            "id": "string",
            "value": {
              "stringValue": "string",
              "doubleValue": double,
              "booleanValue": true|false,
              "emptyValue": {

              },
              "userArnValue": "string"
            }
          }
        },
        "not": {
          "field": {
            "equalTo": {
              "id": "string",
              "value": {
                "stringValue": "string",
                "doubleValue": double,
                "booleanValue": true|false,
                "emptyValue": {

                },
                "userArnValue": "string"
              }
            },
            "contains": {
              "id": "string",
              "value": {
                "stringValue": "string",
                "doubleValue": double,
                "booleanValue": true|false,
                "emptyValue": {

                },
                "userArnValue": "string"
              }
            },
            "greaterThan": {
              "id": "string",
              "value": {
                "stringValue": "string",
                "doubleValue": double,
                "booleanValue": true|false,
                "emptyValue": {

                },
                "userArnValue": "string"
              }
            },
            "greaterThanOrEqualTo": {
              "id": "string",
              "value": {
                "stringValue": "string",
                "doubleValue": double,
                "booleanValue": true|false,
                "emptyValue": {

                },
                "userArnValue": "string"
              }
            },
            "lessThan": {
              "id": "string",
              "value": {
                "stringValue": "string",
                "doubleValue": double,
                "booleanValue": true|false,
                "emptyValue": {

                },
                "userArnValue": "string"
              }
            },
            "lessThanOrEqualTo": {
              "id": "string",
              "value": {
                "stringValue": "string",
                "doubleValue": double,
                "booleanValue": true|false,
                "emptyValue": {

                },
                "userArnValue": "string"
              }
            }
          },
          "not": { ... recursive ... },
          "andAll": [
            { ... recursive ... }
            ...
          ],
          "orAll": [
            { ... recursive ... }
            ...
          ]
        },
        "andAll": [
          {
            "field": {
              "equalTo": {
                "id": "string",
                "value": {
                  "stringValue": "string",
                  "doubleValue": double,
                  "booleanValue": true|false,
                  "emptyValue": {

                  },
                  "userArnValue": "string"
                }
              },
              "contains": {
                "id": "string",
                "value": {
                  "stringValue": "string",
                  "doubleValue": double,
                  "booleanValue": true|false,
                  "emptyValue": {

                  },
                  "userArnValue": "string"
                }
              },
              "greaterThan": {
                "id": "string",
                "value": {
                  "stringValue": "string",
                  "doubleValue": double,
                  "booleanValue": true|false,
                  "emptyValue": {

                  },
                  "userArnValue": "string"
                }
              },
              "greaterThanOrEqualTo": {
                "id": "string",
                "value": {
                  "stringValue": "string",
                  "doubleValue": double,
                  "booleanValue": true|false,
                  "emptyValue": {

                  },
                  "userArnValue": "string"
                }
              },
              "lessThan": {
                "id": "string",
                "value": {
                  "stringValue": "string",
                  "doubleValue": double,
                  "booleanValue": true|false,
                  "emptyValue": {

                  },
                  "userArnValue": "string"
                }
              },
              "lessThanOrEqualTo": {
                "id": "string",
                "value": {
                  "stringValue": "string",
                  "doubleValue": double,
                  "booleanValue": true|false,
                  "emptyValue": {

                  },
                  "userArnValue": "string"
                }
              }
            },
            "not": { ... recursive ... },
            "andAll": [
              { ... recursive ... }
              ...
            ],
            "orAll": [
              { ... recursive ... }
              ...
            ]
          }
          ...
        ],
        "orAll": [
          {
            "field": {
              "equalTo": {
                "id": "string",
                "value": {
                  "stringValue": "string",
                  "doubleValue": double,
                  "booleanValue": true|false,
                  "emptyValue": {

                  },
                  "userArnValue": "string"
                }
              },
              "contains": {
                "id": "string",
                "value": {
                  "stringValue": "string",
                  "doubleValue": double,
                  "booleanValue": true|false,
                  "emptyValue": {

                  },
                  "userArnValue": "string"
                }
              },
              "greaterThan": {
                "id": "string",
                "value": {
                  "stringValue": "string",
                  "doubleValue": double,
                  "booleanValue": true|false,
                  "emptyValue": {

                  },
                  "userArnValue": "string"
                }
              },
              "greaterThanOrEqualTo": {
                "id": "string",
                "value": {
                  "stringValue": "string",
                  "doubleValue": double,
                  "booleanValue": true|false,
                  "emptyValue": {

                  },
                  "userArnValue": "string"
                }
              },
              "lessThan": {
                "id": "string",
                "value": {
                  "stringValue": "string",
                  "doubleValue": double,
                  "booleanValue": true|false,
                  "emptyValue": {

                  },
                  "userArnValue": "string"
                }
              },
              "lessThanOrEqualTo": {
                "id": "string",
                "value": {
                  "stringValue": "string",
                  "doubleValue": double,
                  "booleanValue": true|false,
                  "emptyValue": {

                  },
                  "userArnValue": "string"
                }
              }
            },
            "not": { ... recursive ... },
            "andAll": [
              { ... recursive ... }
              ...
            ],
            "orAll": [
              { ... recursive ... }
              ...
            ]
          }
          ...
        ]
      }
    }
  }
  ...
]

--sorts (list)

A structured set of sort terms to specify the order in which related items should be returned. Supports sorting by association time or case ID. The sorts work in the order specified: first sort term takes precedence over subsequent terms.

Constraints:

• min: 0
• max: 2

(structure)

The order in which all returned related items should be sorted.

sortProperty -> (string) [required]

Whether related items should be sorted in ascending or descending order.

Possible values:

• AssociationTime
• CaseId

sortOrder -> (string) [required]

Whether related items should be sorted by association time or case ID.

Possible values:

• Asc
• Desc

Shorthand Syntax:

sortProperty=string,sortOrder=string ...

JSON Syntax:

[
  {
    "sortProperty": "AssociationTime"|"CaseId",
    "sortOrder": "Asc"|"Desc"
  }
  ...
]

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

Constraints:

• min: 1
• max: 25

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--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

nextToken -> (string)

The token for the next set of results. This is null if there are no more results to return.

Constraints:

• min: 0
• max: 9000

relatedItems -> (list)

A list of items related to a case.

Constraints:

• min: 0
• max: 25

(structure)

A list of items that represent RelatedItems. This data type is similar to SearchRelatedItemsResponseItem except Search**All** RelatedItemsResponseItem has a caseId field.

relatedItemId -> (string) [required]

Unique identifier of a related item.

Constraints:

• min: 1
• max: 500

caseId -> (string) [required]

A unique identifier of the case.

Constraints:

• min: 1
• max: 500

type -> (string) [required]

Type of a related item.

Possible values:

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

associationTime -> (timestamp) [required]

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

content -> (tagged union structure) [required]

Represents the content of a particular type of 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.

performedBy -> (tagged union structure)

Represents the entity that performed the action.

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_\-\.@:/]

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)