AWS CLI Command Reference

[ aws . qbusiness ]

chat-sync

Description

Starts or continues a non-streaming Amazon Q conversation.

See also: AWS API Documentation

chat-sync uses document type values. Document types follow the JSON data model where valid values are: strings, numbers, booleans, null, arrays, and objects. For command input, options and nested parameters that are labeled with the type document must be provided as JSON. Shorthand syntax does not support document types.

Synopsis

  chat-sync
[--action-execution <value>]
--application-id <value>
[--attachments <value>]
[--attribute-filter <value>]
[--client-token <value>]
[--conversation-id <value>]
[--parent-message-id <value>]
[--user-groups <value>]
--user-id <value>
[--user-message <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]

Options

--action-execution (structure)

A request from an end user to perform an Amazon Q plugin action.

payload -> (map)

A mapping of field names to the field values in input that an end user provides to Amazon Q requests to perform their plugin action.

key -> (string)

value -> (structure)

A user input field in an plugin action execution payload.

value -> (document)

The content of a user input field in an plugin action execution payload.

payloadFieldNameSeparator -> (string)

A string used to retain information about the hierarchical contexts within an action execution event payload.

pluginId -> (string)

The identifier of the plugin the action is attached to.

Shorthand Syntax:

payload={KeyName1={},KeyName2={}},payloadFieldNameSeparator=string,pluginId=string

JSON Syntax:

{
  "payload": {"string": {
        "value": {...}
      }
    ...},
  "payloadFieldNameSeparator": "string",
  "pluginId": "string"
}

--application-id (string)

The identifier of the Amazon Q application linked to the Amazon Q conversation.

--attachments (list)

A list of files uploaded directly during chat. You can upload a maximum of 5 files of upto 10 MB each.

(structure)

A file directly uploaded into a web experience chat.

data -> (blob)

The data contained within the uploaded file.

name -> (string)

The name of the file.

Shorthand Syntax:

data=blob,name=string ...

JSON Syntax:

[
  {
    "data": blob,
    "name": "string"
  }
  ...
]

--attribute-filter (structure)

Enables filtering of Amazon Q web experience responses based on document attributes or metadata fields.

andAllFilters -> (list)

Performs a logical AND operation on all supplied filters.

(structure)

Enables filtering of Amazon Q web experience responses based on document attributes or metadata fields.

andAllFilters -> (list)

Performs a logical AND operation on all supplied filters.

( … recursive … )

containsAll -> (structure)

Returns true when a document contains all the specified document attributes or metadata fields.

name -> (string)

The identifier for the attribute.

value -> (tagged union structure)

The value of the attribute.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: dateValue, longValue, stringListValue, stringValue.

dateValue -> (timestamp)

A date expressed as an ISO 8601 string.

It’s important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

longValue -> (long)

A long integer value.

stringListValue -> (list)

A list of strings.

(string)

stringValue -> (string)

A string.

containsAny -> (structure)

Returns true when a document contains any of the specified document attributes or metadata fields.

name -> (string)

The identifier for the attribute.

value -> (tagged union structure)

The value of the attribute.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: dateValue, longValue, stringListValue, stringValue.

dateValue -> (timestamp)

A date expressed as an ISO 8601 string.

It’s important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

longValue -> (long)

A long integer value.

stringListValue -> (list)

A list of strings.

(string)

stringValue -> (string)

A string.

equalsTo -> (structure)

Performs an equals operation on two document attributes or metadata fields.

name -> (string)

The identifier for the attribute.

value -> (tagged union structure)

The value of the attribute.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: dateValue, longValue, stringListValue, stringValue.

dateValue -> (timestamp)

A date expressed as an ISO 8601 string.

It’s important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

longValue -> (long)

A long integer value.

stringListValue -> (list)

A list of strings.

(string)

stringValue -> (string)

A string.

greaterThan -> (structure)

Performs a greater than operation on two document attributes or metadata fields. Use with a document attribute of type Date or Long .

name -> (string)

The identifier for the attribute.

value -> (tagged union structure)

The value of the attribute.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: dateValue, longValue, stringListValue, stringValue.

dateValue -> (timestamp)

A date expressed as an ISO 8601 string.

It’s important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

longValue -> (long)

A long integer value.

stringListValue -> (list)

A list of strings.

(string)

stringValue -> (string)

A string.

greaterThanOrEquals -> (structure)

Performs a greater or equals than operation on two document attributes or metadata fields. Use with a document attribute of type Date or Long .

name -> (string)

The identifier for the attribute.

value -> (tagged union structure)

The value of the attribute.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: dateValue, longValue, stringListValue, stringValue.

dateValue -> (timestamp)

A date expressed as an ISO 8601 string.

It’s important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

longValue -> (long)

A long integer value.

stringListValue -> (list)

A list of strings.

(string)

stringValue -> (string)

A string.

lessThan -> (structure)

Performs a less than operation on two document attributes or metadata fields. Use with a document attribute of type Date or Long .

name -> (string)

The identifier for the attribute.

value -> (tagged union structure)

The value of the attribute.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: dateValue, longValue, stringListValue, stringValue.

dateValue -> (timestamp)

A date expressed as an ISO 8601 string.

It’s important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

longValue -> (long)

A long integer value.

stringListValue -> (list)

A list of strings.

(string)

stringValue -> (string)

A string.

lessThanOrEquals -> (structure)

Performs a less than or equals operation on two document attributes or metadata fields. Use with a document attribute of type Date or Long .

name -> (string)

The identifier for the attribute.

value -> (tagged union structure)

The value of the attribute.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: dateValue, longValue, stringListValue, stringValue.

dateValue -> (timestamp)

A date expressed as an ISO 8601 string.

It’s important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

longValue -> (long)

A long integer value.

stringListValue -> (list)

A list of strings.

(string)

stringValue -> (string)

A string.

( … recursive … )orAllFilters -> (list)

Performs a logical OR operation on all supplied filters.

( … recursive … )

containsAll -> (structure)

Returns true when a document contains all the specified document attributes or metadata fields.

name -> (string)

The identifier for the attribute.

value -> (tagged union structure)

The value of the attribute.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: dateValue, longValue, stringListValue, stringValue.

dateValue -> (timestamp)

A date expressed as an ISO 8601 string.

It’s important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

longValue -> (long)

A long integer value.

stringListValue -> (list)

A list of strings.

(string)

stringValue -> (string)

A string.

containsAny -> (structure)

Returns true when a document contains any of the specified document attributes or metadata fields.

name -> (string)

The identifier for the attribute.

value -> (tagged union structure)

The value of the attribute.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: dateValue, longValue, stringListValue, stringValue.

dateValue -> (timestamp)

A date expressed as an ISO 8601 string.

It’s important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

longValue -> (long)

A long integer value.

stringListValue -> (list)

A list of strings.

(string)

stringValue -> (string)

A string.

equalsTo -> (structure)

Performs an equals operation on two document attributes or metadata fields.

name -> (string)

The identifier for the attribute.

value -> (tagged union structure)

The value of the attribute.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: dateValue, longValue, stringListValue, stringValue.

dateValue -> (timestamp)

A date expressed as an ISO 8601 string.

It’s important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

longValue -> (long)

A long integer value.

stringListValue -> (list)

A list of strings.

(string)

stringValue -> (string)

A string.

greaterThan -> (structure)

Performs a greater than operation on two document attributes or metadata fields. Use with a document attribute of type Date or Long .

name -> (string)

The identifier for the attribute.

value -> (tagged union structure)

The value of the attribute.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: dateValue, longValue, stringListValue, stringValue.

dateValue -> (timestamp)

A date expressed as an ISO 8601 string.

It’s important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

longValue -> (long)

A long integer value.

stringListValue -> (list)

A list of strings.

(string)

stringValue -> (string)

A string.

greaterThanOrEquals -> (structure)

Performs a greater or equals than operation on two document attributes or metadata fields. Use with a document attribute of type Date or Long .

name -> (string)

The identifier for the attribute.

value -> (tagged union structure)

The value of the attribute.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: dateValue, longValue, stringListValue, stringValue.

dateValue -> (timestamp)

A date expressed as an ISO 8601 string.

It’s important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

longValue -> (long)

A long integer value.

stringListValue -> (list)

A list of strings.

(string)

stringValue -> (string)

A string.

lessThan -> (structure)

Performs a less than operation on two document attributes or metadata fields. Use with a document attribute of type Date or Long .

name -> (string)

The identifier for the attribute.

value -> (tagged union structure)

The value of the attribute.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: dateValue, longValue, stringListValue, stringValue.

dateValue -> (timestamp)

A date expressed as an ISO 8601 string.

It’s important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

longValue -> (long)

A long integer value.

stringListValue -> (list)

A list of strings.

(string)

stringValue -> (string)

A string.

lessThanOrEquals -> (structure)

Performs a less than or equals operation on two document attributes or metadata fields. Use with a document attribute of type Date or Long .

name -> (string)

The identifier for the attribute.

value -> (tagged union structure)

The value of the attribute.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: dateValue, longValue, stringListValue, stringValue.

dateValue -> (timestamp)

A date expressed as an ISO 8601 string.

It’s important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

longValue -> (long)

A long integer value.

stringListValue -> (list)

A list of strings.

(string)

stringValue -> (string)

A string.

notFilter -> (structure)

Performs a logical NOT operation on all supplied filters.

andAllFilters -> (list)

Performs a logical AND operation on all supplied filters.

( … recursive … )

containsAll -> (structure)

Returns true when a document contains all the specified document attributes or metadata fields.

name -> (string)

The identifier for the attribute.

value -> (tagged union structure)

The value of the attribute.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: dateValue, longValue, stringListValue, stringValue.

dateValue -> (timestamp)

A date expressed as an ISO 8601 string.

It’s important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

longValue -> (long)

A long integer value.

stringListValue -> (list)

A list of strings.

(string)

stringValue -> (string)

A string.

containsAny -> (structure)

Returns true when a document contains any of the specified document attributes or metadata fields.

name -> (string)

The identifier for the attribute.

value -> (tagged union structure)

The value of the attribute.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: dateValue, longValue, stringListValue, stringValue.

dateValue -> (timestamp)

A date expressed as an ISO 8601 string.

It’s important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

longValue -> (long)

A long integer value.

stringListValue -> (list)

A list of strings.

(string)

stringValue -> (string)

A string.

equalsTo -> (structure)

Performs an equals operation on two document attributes or metadata fields.

name -> (string)

The identifier for the attribute.

value -> (tagged union structure)

The value of the attribute.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: dateValue, longValue, stringListValue, stringValue.

dateValue -> (timestamp)

A date expressed as an ISO 8601 string.

It’s important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

longValue -> (long)

A long integer value.

stringListValue -> (list)

A list of strings.

(string)

stringValue -> (string)

A string.

greaterThan -> (structure)

Performs a greater than operation on two document attributes or metadata fields. Use with a document attribute of type Date or Long .

name -> (string)

The identifier for the attribute.

value -> (tagged union structure)

The value of the attribute.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: dateValue, longValue, stringListValue, stringValue.

dateValue -> (timestamp)

A date expressed as an ISO 8601 string.

It’s important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

longValue -> (long)

A long integer value.

stringListValue -> (list)

A list of strings.

(string)

stringValue -> (string)

A string.

greaterThanOrEquals -> (structure)

Performs a greater or equals than operation on two document attributes or metadata fields. Use with a document attribute of type Date or Long .

name -> (string)

The identifier for the attribute.

value -> (tagged union structure)

The value of the attribute.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: dateValue, longValue, stringListValue, stringValue.

dateValue -> (timestamp)

A date expressed as an ISO 8601 string.

It’s important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

longValue -> (long)

A long integer value.

stringListValue -> (list)

A list of strings.

(string)

stringValue -> (string)

A string.

lessThan -> (structure)

Performs a less than operation on two document attributes or metadata fields. Use with a document attribute of type Date or Long .

name -> (string)

The identifier for the attribute.

value -> (tagged union structure)

The value of the attribute.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: dateValue, longValue, stringListValue, stringValue.

dateValue -> (timestamp)

A date expressed as an ISO 8601 string.

It’s important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

longValue -> (long)

A long integer value.

stringListValue -> (list)

A list of strings.

(string)

stringValue -> (string)

A string.

lessThanOrEquals -> (structure)

Performs a less than or equals operation on two document attributes or metadata fields. Use with a document attribute of type Date or Long .

name -> (string)

The identifier for the attribute.

value -> (tagged union structure)

The value of the attribute.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: dateValue, longValue, stringListValue, stringValue.

dateValue -> (timestamp)

A date expressed as an ISO 8601 string.

It’s important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

longValue -> (long)

A long integer value.

stringListValue -> (list)

A list of strings.

(string)

stringValue -> (string)

A string.

( … recursive … )orAllFilters -> (list)

Performs a logical OR operation on all supplied filters.

( … recursive … )

orAllFilters -> (list)

Performs a logical OR operation on all supplied filters.

(structure)

Enables filtering of Amazon Q web experience responses based on document attributes or metadata fields.

andAllFilters -> (list)

Performs a logical AND operation on all supplied filters.

( … recursive … )

containsAll -> (structure)

Returns true when a document contains all the specified document attributes or metadata fields.

name -> (string)

The identifier for the attribute.

value -> (tagged union structure)

The value of the attribute.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: dateValue, longValue, stringListValue, stringValue.

dateValue -> (timestamp)

A date expressed as an ISO 8601 string.

It’s important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

longValue -> (long)

A long integer value.

stringListValue -> (list)

A list of strings.

(string)

stringValue -> (string)

A string.

containsAny -> (structure)

Returns true when a document contains any of the specified document attributes or metadata fields.

name -> (string)

The identifier for the attribute.

value -> (tagged union structure)

The value of the attribute.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: dateValue, longValue, stringListValue, stringValue.

dateValue -> (timestamp)

A date expressed as an ISO 8601 string.

It’s important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

longValue -> (long)

A long integer value.

stringListValue -> (list)

A list of strings.

(string)

stringValue -> (string)

A string.

equalsTo -> (structure)

Performs an equals operation on two document attributes or metadata fields.

name -> (string)

The identifier for the attribute.

value -> (tagged union structure)

The value of the attribute.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: dateValue, longValue, stringListValue, stringValue.

dateValue -> (timestamp)

A date expressed as an ISO 8601 string.

It’s important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

longValue -> (long)

A long integer value.

stringListValue -> (list)

A list of strings.

(string)

stringValue -> (string)

A string.

greaterThan -> (structure)

Performs a greater than operation on two document attributes or metadata fields. Use with a document attribute of type Date or Long .

name -> (string)

The identifier for the attribute.

value -> (tagged union structure)

The value of the attribute.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: dateValue, longValue, stringListValue, stringValue.

dateValue -> (timestamp)

A date expressed as an ISO 8601 string.

It’s important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

longValue -> (long)

A long integer value.

stringListValue -> (list)

A list of strings.

(string)

stringValue -> (string)

A string.

greaterThanOrEquals -> (structure)

Performs a greater or equals than operation on two document attributes or metadata fields. Use with a document attribute of type Date or Long .

name -> (string)

The identifier for the attribute.

value -> (tagged union structure)

The value of the attribute.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: dateValue, longValue, stringListValue, stringValue.

dateValue -> (timestamp)

A date expressed as an ISO 8601 string.

It’s important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

longValue -> (long)

A long integer value.

stringListValue -> (list)

A list of strings.

(string)

stringValue -> (string)

A string.

lessThan -> (structure)

Performs a less than operation on two document attributes or metadata fields. Use with a document attribute of type Date or Long .

name -> (string)

The identifier for the attribute.

value -> (tagged union structure)

The value of the attribute.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: dateValue, longValue, stringListValue, stringValue.

dateValue -> (timestamp)

A date expressed as an ISO 8601 string.

It’s important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

longValue -> (long)

A long integer value.

stringListValue -> (list)

A list of strings.

(string)

stringValue -> (string)

A string.

lessThanOrEquals -> (structure)

Performs a less than or equals operation on two document attributes or metadata fields. Use with a document attribute of type Date or Long .

name -> (string)

The identifier for the attribute.

value -> (tagged union structure)

The value of the attribute.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: dateValue, longValue, stringListValue, stringValue.

dateValue -> (timestamp)

A date expressed as an ISO 8601 string.

It’s important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

longValue -> (long)

A long integer value.

stringListValue -> (list)

A list of strings.

(string)

stringValue -> (string)

A string.

( … recursive … )orAllFilters -> (list)

Performs a logical OR operation on all supplied filters.

( … recursive … )

JSON Syntax:

{
  "andAllFilters": [
    {
      "andAllFilters": [
        { ... recursive ... }
        ...
      ],
      "containsAll": {
        "name": "string",
        "value": {
          "dateValue": timestamp,
          "longValue": long,
          "stringListValue": ["string", ...],
          "stringValue": "string"
        }
      },
      "containsAny": {
        "name": "string",
        "value": {
          "dateValue": timestamp,
          "longValue": long,
          "stringListValue": ["string", ...],
          "stringValue": "string"
        }
      },
      "equalsTo": {
        "name": "string",
        "value": {
          "dateValue": timestamp,
          "longValue": long,
          "stringListValue": ["string", ...],
          "stringValue": "string"
        }
      },
      "greaterThan": {
        "name": "string",
        "value": {
          "dateValue": timestamp,
          "longValue": long,
          "stringListValue": ["string", ...],
          "stringValue": "string"
        }
      },
      "greaterThanOrEquals": {
        "name": "string",
        "value": {
          "dateValue": timestamp,
          "longValue": long,
          "stringListValue": ["string", ...],
          "stringValue": "string"
        }
      },
      "lessThan": {
        "name": "string",
        "value": {
          "dateValue": timestamp,
          "longValue": long,
          "stringListValue": ["string", ...],
          "stringValue": "string"
        }
      },
      "lessThanOrEquals": {
        "name": "string",
        "value": {
          "dateValue": timestamp,
          "longValue": long,
          "stringListValue": ["string", ...],
          "stringValue": "string"
        }
      },
      "notFilter": { ... recursive ... },
      "orAllFilters": [
        { ... recursive ... }
        ...
      ]
    }
    ...
  ],
  "containsAll": {
    "name": "string",
    "value": {
      "dateValue": timestamp,
      "longValue": long,
      "stringListValue": ["string", ...],
      "stringValue": "string"
    }
  },
  "containsAny": {
    "name": "string",
    "value": {
      "dateValue": timestamp,
      "longValue": long,
      "stringListValue": ["string", ...],
      "stringValue": "string"
    }
  },
  "equalsTo": {
    "name": "string",
    "value": {
      "dateValue": timestamp,
      "longValue": long,
      "stringListValue": ["string", ...],
      "stringValue": "string"
    }
  },
  "greaterThan": {
    "name": "string",
    "value": {
      "dateValue": timestamp,
      "longValue": long,
      "stringListValue": ["string", ...],
      "stringValue": "string"
    }
  },
  "greaterThanOrEquals": {
    "name": "string",
    "value": {
      "dateValue": timestamp,
      "longValue": long,
      "stringListValue": ["string", ...],
      "stringValue": "string"
    }
  },
  "lessThan": {
    "name": "string",
    "value": {
      "dateValue": timestamp,
      "longValue": long,
      "stringListValue": ["string", ...],
      "stringValue": "string"
    }
  },
  "lessThanOrEquals": {
    "name": "string",
    "value": {
      "dateValue": timestamp,
      "longValue": long,
      "stringListValue": ["string", ...],
      "stringValue": "string"
    }
  },
  "notFilter": {
    "andAllFilters": [
      { ... recursive ... }
      ...
    ],
    "containsAll": {
      "name": "string",
      "value": {
        "dateValue": timestamp,
        "longValue": long,
        "stringListValue": ["string", ...],
        "stringValue": "string"
      }
    },
    "containsAny": {
      "name": "string",
      "value": {
        "dateValue": timestamp,
        "longValue": long,
        "stringListValue": ["string", ...],
        "stringValue": "string"
      }
    },
    "equalsTo": {
      "name": "string",
      "value": {
        "dateValue": timestamp,
        "longValue": long,
        "stringListValue": ["string", ...],
        "stringValue": "string"
      }
    },
    "greaterThan": {
      "name": "string",
      "value": {
        "dateValue": timestamp,
        "longValue": long,
        "stringListValue": ["string", ...],
        "stringValue": "string"
      }
    },
    "greaterThanOrEquals": {
      "name": "string",
      "value": {
        "dateValue": timestamp,
        "longValue": long,
        "stringListValue": ["string", ...],
        "stringValue": "string"
      }
    },
    "lessThan": {
      "name": "string",
      "value": {
        "dateValue": timestamp,
        "longValue": long,
        "stringListValue": ["string", ...],
        "stringValue": "string"
      }
    },
    "lessThanOrEquals": {
      "name": "string",
      "value": {
        "dateValue": timestamp,
        "longValue": long,
        "stringListValue": ["string", ...],
        "stringValue": "string"
      }
    },
    "notFilter": { ... recursive ... },
    "orAllFilters": [
      { ... recursive ... }
      ...
    ]
  },
  "orAllFilters": [
    {
      "andAllFilters": [
        { ... recursive ... }
        ...
      ],
      "containsAll": {
        "name": "string",
        "value": {
          "dateValue": timestamp,
          "longValue": long,
          "stringListValue": ["string", ...],
          "stringValue": "string"
        }
      },
      "containsAny": {
        "name": "string",
        "value": {
          "dateValue": timestamp,
          "longValue": long,
          "stringListValue": ["string", ...],
          "stringValue": "string"
        }
      },
      "equalsTo": {
        "name": "string",
        "value": {
          "dateValue": timestamp,
          "longValue": long,
          "stringListValue": ["string", ...],
          "stringValue": "string"
        }
      },
      "greaterThan": {
        "name": "string",
        "value": {
          "dateValue": timestamp,
          "longValue": long,
          "stringListValue": ["string", ...],
          "stringValue": "string"
        }
      },
      "greaterThanOrEquals": {
        "name": "string",
        "value": {
          "dateValue": timestamp,
          "longValue": long,
          "stringListValue": ["string", ...],
          "stringValue": "string"
        }
      },
      "lessThan": {
        "name": "string",
        "value": {
          "dateValue": timestamp,
          "longValue": long,
          "stringListValue": ["string", ...],
          "stringValue": "string"
        }
      },
      "lessThanOrEquals": {
        "name": "string",
        "value": {
          "dateValue": timestamp,
          "longValue": long,
          "stringListValue": ["string", ...],
          "stringValue": "string"
        }
      },
      "notFilter": { ... recursive ... },
      "orAllFilters": [
        { ... recursive ... }
        ...
      ]
    }
    ...
  ]
}

--client-token (string)

A token that you provide to identify a chat request.

--conversation-id (string)

The identifier of the Amazon Q conversation.

--parent-message-id (string)

The identifier of the previous end user text input message in a conversation.

--user-groups (list)

The groups that a user associated with the chat input belongs to.

(string)

Syntax:

"string" "string" ...

--user-id (string)

The identifier of the user attached to the chat input.

--user-message (string)

A end user message in a conversation.

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

--output (string)

The formatting style for command output.

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

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

Output

actionReview -> (structure)

A request from Amazon Q to the end user for information Amazon Q needs to successfully complete a requested plugin action.

payload -> (map)

Field values that an end user needs to provide to Amazon Q for Amazon Q to perform the requested plugin action.

key -> (string)

value -> (structure)

A user input field in an plugin action review payload.

allowedValues -> (list)

Information about the field values that an end user can use to provide to Amazon Q for Amazon Q to perform the requested plugin action.

(structure)

Information about the field values that an end user can use to provide to Amazon Q for Amazon Q to perform the requested plugin action.

displayValue -> (document)

The name of the field.

value -> (document)

The field value.

displayName -> (string)

The name of the field.

displayOrder -> (integer)

The display order of fields in a payload.

required -> (boolean)

Information about whether the field is required.

type -> (string)

The type of field.

value -> (document)

The field value.

payloadFieldNameSeparator -> (string)

A string used to retain information about the hierarchical contexts within an action review payload.

pluginId -> (string)

The identifier of the plugin associated with the action review.

pluginType -> (string)

The type of plugin.

conversationId -> (string)

The identifier of the Amazon Q conversation.

failedAttachments -> (list)

A list of files which failed to upload during chat.

(structure)

The details of a file uploaded during chat.

error -> (structure)

An error associated with a file uploaded during chat.

errorCode -> (string)

The code associated with the data source sync error.

errorMessage -> (string)

The message explaining the data source sync error.

name -> (string)

The name of a file uploaded during chat.

status -> (string)

The status of a file uploaded during chat.

sourceAttributions -> (list)

The source documents used to generate the conversation response.

(structure)

The documents used to generate an Amazon Q web experience response.

citationNumber -> (integer)

The number attached to a citation in an Amazon Q generated response.

snippet -> (string)

The content extract from the document on which the generated response is based.

textMessageSegments -> (list)

A text extract from a source document that is used for source attribution.

(structure)

Provides information about a text extract in a chat response that can be attributed to a source document.

beginOffset -> (integer)

The zero-based location in the response string where the source attribution starts.

endOffset -> (integer)

The zero-based location in the response string where the source attribution ends.

title -> (string)

The title of the document which is the source for the Amazon Q generated response.

updatedAt -> (timestamp)

The Unix timestamp when the Amazon Q application was last updated.

url -> (string)

The URL of the document which is the source for the Amazon Q generated response.

systemMessage -> (string)

An AI-generated message in a conversation.

systemMessageId -> (string)

The identifier of an Amazon Q AI generated message within the conversation.

userMessageId -> (string)

The identifier of an Amazon Q end user text input message within the conversation.
© Copyright 2018, Amazon Web Services. Created using Sphinx.