Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . kendra ]

submit-feedback

Description

Enables you to provide feedback to Amazon Kendra to improve the performance of your index.

SubmitFeedback is currently not supported in the Amazon Web Services GovCloud (US-West) region.

See also: AWS API Documentation

Synopsis

  submit-feedback
--index-id <value>
--query-id <value>
[--click-feedback-items <value>]
[--relevance-feedback-items <value>]
[--cli-input-json <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>]

Options

--index-id (string)

The identifier of the index that was queried.

--query-id (string)

The identifier of the specific query for which you are submitting feedback. The query ID is returned in the response to the Query API.

--click-feedback-items (list)

Tells Amazon Kendra that a particular search result link was chosen by the user.

(structure)

Gathers information about when a particular result was clicked by a user. Your application uses the SubmitFeedback API to provide click information.

ResultId -> (string)

The identifier of the search result that was clicked.

ClickTime -> (timestamp)

The Unix timestamp when the result was clicked.

Shorthand Syntax:

ResultId=string,ClickTime=timestamp ...

JSON Syntax:

[
  {
    "ResultId": "string",
    "ClickTime": timestamp
  }
  ...
]

--relevance-feedback-items (list)

Provides Amazon Kendra with relevant or not relevant feedback for whether a particular item was relevant to the search.

(structure)

Provides feedback on how relevant a document is to a search. Your application uses the SubmitFeedback API to provide relevance information.

ResultId -> (string)

The identifier of the search result that the user provided relevance feedback for.

RelevanceValue -> (string)

Whether the document was relevant or not relevant to the search.

Shorthand Syntax:

ResultId=string,RelevanceValue=string ...

JSON Syntax:

[
  {
    "ResultId": "string",
    "RelevanceValue": "RELEVANT"|"NOT_RELEVANT"
  }
  ...
]

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

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

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

Output

None