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 ]

describe-experience

Description

Gets information about your Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code .

See also: AWS API Documentation

Synopsis

  describe-experience
--id <value>
--index-id <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

--id (string)

The identifier of your Amazon Kendra experience you want to get information on.

--index-id (string)

The identifier of the index for your Amazon Kendra experience.

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

Id -> (string)

Shows the identifier of your Amazon Kendra experience.

IndexId -> (string)

Shows the identifier of the index for your Amazon Kendra experience.

Name -> (string)

Shows the name of your Amazon Kendra experience.

Endpoints -> (list)

Shows the endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully hosted by Amazon Web Services.

(structure)

Provides the configuration information for the endpoint for your Amazon Kendra experience.

EndpointType -> (string)

The type of endpoint for your Amazon Kendra experience. The type currently available is HOME , which is a unique and fully hosted URL to the home page of your Amazon Kendra experience.

Endpoint -> (string)

The endpoint of your Amazon Kendra experience.

Configuration -> (structure)

Shows the configuration information for your Amazon Kendra experience. This includes ContentSourceConfiguration , which specifies the data source IDs and/or FAQ IDs, and UserIdentityConfiguration , which specifies the user or group information to grant access to your Amazon Kendra experience.

ContentSourceConfiguration -> (structure)

The identifiers of your data sources and FAQs. Or, you can specify that you want to use documents indexed via the BatchPutDocument API. This is the content you want to use for your Amazon Kendra experience.

DataSourceIds -> (list)

The identifier of the data sources you want to use for your Amazon Kendra experience.

(string)

FaqIds -> (list)

The identifier of the FAQs that you want to use for your Amazon Kendra experience.

(string)

DirectPutContent -> (boolean)

TRUE to use documents you indexed directly using the BatchPutDocument API.

UserIdentityConfiguration -> (structure)

The IAM Identity Center field name that contains the identifiers of your users, such as their emails.

IdentityAttributeName -> (string)

The IAM Identity Center field name that contains the identifiers of your users, such as their emails. This is used for user context filtering and for granting access to your Amazon Kendra experience. You must set up IAM Identity Center with Amazon Kendra. You must include your users and groups in your Access Control List when you ingest documents into your index. For more information, see Getting started with an IAM Identity Center identity source .

CreatedAt -> (timestamp)

Shows the date-time your Amazon Kendra experience was created.

UpdatedAt -> (timestamp)

Shows the date-time your Amazon Kendra experience was last updated.

Description -> (string)

Shows the description for your Amazon Kendra experience.

Status -> (string)

The current processing status of your Amazon Kendra experience. When the status is ACTIVE , your Amazon Kendra experience is ready to use. When the status is FAILED , the ErrorMessage field contains the reason that this failed.

RoleArn -> (string)

Shows the Amazon Resource Name (ARN) of a role with permission to access Query API, QuerySuggestions API, SubmitFeedback API, and IAM Identity Center that stores your user and group information.

ErrorMessage -> (string)

The reason your Amazon Kendra experience could not properly process.