Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1465566486.4 KB

Gets information about your Amazon Kendra experience such as a search application. For more information on creating a search application experience, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html">Building a search experience with no code</a>.

post/#X-Amz-Target=AWSKendraFrontendService.DescribeExperience

Headers

X-Amz-Target'AWSKendraFrontendService.DescribeExperience' required

Request body

Idstring required

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

IndexIdstring required

The identifier of the index for your Amazon Kendra experience.

Response

Success

Idstring

Shows the identifier of your Amazon Kendra experience.

IndexIdstring

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

Namestring

Shows the name of your Amazon Kendra experience.

CreatedAtstring date-time

The Unix timestamp when your Amazon Kendra experience was created.

UpdatedAtstring date-time

The Unix timestamp when your Amazon Kendra experience was last updated.

Descriptionstring

Shows the description for your Amazon Kendra experience.

Status'CREATING' | 'ACTIVE' | 'DELETING' | 'FAILED'

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

RoleArnstring

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

ErrorMessagestring

The reason your Amazon Kendra experience could not properly process.