[ aws . wisdom ]

search-quick-responses

Description

Searches existing Wisdom quick responses in a Wisdom knowledge base.

See also: AWS API Documentation

search-quick-responses 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: results

Synopsis

  search-quick-responses
[--attributes <value>]
--knowledge-base-id <value>
--search-expression <value>
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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

--attributes (map)

The user-defined Amazon Connect contact attributes to be resolved when search results are returned.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--knowledge-base-id (string)

The identifier of the knowledge base. This should be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

--search-expression (structure)

The search expression for querying the quick response.

filters -> (list)

The configuration of filtering rules applied to quick response query results.

(structure)

The quick response fields to filter the quick response query results by.

The following is the list of supported field names.

• name
• description
• shortcutKey
• isActive
• channels
• language
• contentType
• createdTime
• lastModifiedTime
• lastModifiedBy
• groupingConfiguration.criteria
• groupingConfiguration.values

includeNoExistence -> (boolean)

Whether to treat null value as a match for the attribute field.

name -> (string)

The name of the attribute field to filter the quick responses by.

operator -> (string)

The operator to use for filtering.

values -> (list)

The values of attribute field to filter the quick response by.

(string)

orderOnField -> (structure)

The quick response attribute fields on which the query results are ordered.

name -> (string)

The name of the attribute to order the quick response query results by.

order -> (string)

The order at which the quick responses are sorted by.

queries -> (list)

The quick response query expressions.

(structure)

The quick response fields to query quick responses by.

The following is the list of supported field names.

• content
• name
• description
• shortcutKey

allowFuzziness -> (boolean)

Whether the query expects only exact matches on the attribute field values. The results of the query will only include exact matches if this parameter is set to false.

name -> (string)

The name of the attribute to query the quick responses by.

operator -> (string)

The operator to use for matching attribute field values in the query.

priority -> (string)

The importance of the attribute field when calculating query result relevancy scores. The value set for this parameter affects the ordering of search results.

values -> (list)

The values of the attribute to query the quick responses by.

(string)

JSON Syntax:

{
  "filters": [
    {
      "includeNoExistence": true|false,
      "name": "string",
      "operator": "EQUALS"|"PREFIX",
      "values": ["string", ...]
    }
    ...
  ],
  "orderOnField": {
    "name": "string",
    "order": "ASC"|"DESC"
  },
  "queries": [
    {
      "allowFuzziness": true|false,
      "name": "string",
      "operator": "CONTAINS"|"CONTAINS_AND_PREFIX",
      "priority": "HIGH"|"MEDIUM"|"LOW",
      "values": ["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.

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

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

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

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

nextToken -> (string)

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

results -> (list)

The results of the quick response search.

(structure)

The result of quick response search.

attributesInterpolated -> (list)

The user defined contact attributes that are resolved when the search result is returned.

(string)

attributesNotInterpolated -> (list)

The user defined contact attributes that are not resolved when the search result is returned.

(string)

channels -> (list)

The Amazon Connect contact channels this quick response applies to. The supported contact channel types include Chat .

(string)

contentType -> (string)

The media type of the quick response content.

• Use application/x.quickresponse;format=plain for quick response written in plain text.
• Use application/x.quickresponse;format=markdown for quick response written in richtext.

contents -> (structure)

The contents of the quick response.

markdown -> (tagged union structure)

The container quick response content.

Note

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

content -> (string)

The content of the quick response.

plainText -> (tagged union structure)

The container quick response content.

Note

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

content -> (string)

The content of the quick response.

createdTime -> (timestamp)

The timestamp when the quick response was created.

description -> (string)

The description of the quick response.

groupingConfiguration -> (structure)

The configuration information of the user groups that the quick response is accessible to.

criteria -> (string)

The criteria used for grouping Wisdom users.

The following is the list of supported criteria values.

• RoutingProfileArn : Grouping the users by their Amazon Connect routing profile ARN . User should have SearchRoutingProfile and DescribeRoutingProfile permissions when setting criteria to this value.

values -> (list)

The list of values that define different groups of Wisdom users.

• When setting criteria to RoutingProfileArn , you need to provide a list of ARNs of Amazon Connect routing profiles as values of this parameter.

(string)

isActive -> (boolean)

Whether the quick response is active.

knowledgeBaseArn -> (string)

The Amazon Resource Name (ARN) of the knowledge base.

knowledgeBaseId -> (string)

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you’re storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

language -> (string)

The language code value for the language in which the quick response is written.

lastModifiedBy -> (string)

The Amazon Resource Name (ARN) of the user who last updated the quick response search result data.

lastModifiedTime -> (timestamp)

The timestamp when the quick response search result data was last modified.

name -> (string)

The name of the quick response.

quickResponseArn -> (string)

The Amazon Resource Name (ARN) of the quick response.

quickResponseId -> (string)

The identifier of the quick response.

shortcutKey -> (string)

The shortcut key of the quick response. The value should be unique across the knowledge base.

status -> (string)

The resource status of the quick response.

tags -> (map)

The tags used to organize, track, or control access for this resource.

key -> (string)

value -> (string)