[ aws . kendra ]

list-featured-results-sets

Description

Lists all your sets of featured results for a given index. Features results are placed above all other results for certain queries. If there’s an exact match of a query, then one or more specific documents are featured in the search results.

See also: AWS API Documentation

Synopsis

  list-featured-results-sets
--index-id <value>
[--next-token <value>]
[--max-results <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

--index-id (string) [required]

The identifier of the index used for featuring results.

Constraints:

• min: 36
• max: 36
• pattern: [a-zA-Z0-9][a-zA-Z0-9-]*

--next-token (string)

If the response is truncated, Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of featured results sets.

Constraints:

• min: 1
• max: 800

--max-results (integer)

The maximum number of featured results sets to return.

Constraints:

• min: 1
• max: 100

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

FeaturedResultsSetSummaryItems -> (list)

An array of summary information for one or more featured results sets.

(structure)

Summary information for a set of featured results. Featured results are placed above all other results for certain queries. If there’s an exact match of a query, then one or more specific documents are featured in the search results.

FeaturedResultsSetId -> (string)

The identifier of the set of featured results.

Constraints:

• min: 36
• max: 36
• pattern: ^[a-zA-Z-0-9]*

FeaturedResultsSetName -> (string)

The name for the set of featured results.

Constraints:

• min: 1
• max: 1000
• pattern: [a-zA-Z0-9][ a-zA-Z0-9_-]*

Status -> (string)

The current status of the set of featured results. When the value is ACTIVE , featured results are ready for use. You can still configure your settings before setting the status to ACTIVE . You can set the status to ACTIVE or INACTIVE using the UpdateFeaturedResultsSet API. The queries you specify for featured results must be unique per featured results set for each index, whether the status is ACTIVE or INACTIVE .

Possible values:

• ACTIVE
• INACTIVE

LastUpdatedTimestamp -> (long)

The Unix timestamp when the set of featured results was last updated.

CreationTimestamp -> (long)

The Unix timestamp when the set of featured results was created.

NextToken -> (string)

If the response is truncated, Amazon Kendra returns a pagination token in the response.

Constraints:

• min: 1
• max: 800