DescribeExperience - Amazon Kendra

DescribeExperience

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.

Request Syntax

{ "Id": "string", "IndexId": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Id

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 36.

Pattern: [a-zA-Z0-9][a-zA-Z0-9_-]*

Required: Yes

IndexId

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

Type: String

Length Constraints: Fixed length of 36.

Pattern: [a-zA-Z0-9][a-zA-Z0-9-]*

Required: Yes

Response Syntax

{ "Configuration": { "ContentSourceConfiguration": { "DataSourceIds": [ "string" ], "DirectPutContent": boolean, "FaqIds": [ "string" ] }, "UserIdentityConfiguration": { "IdentityAttributeName": "string" } }, "CreatedAt": number, "Description": "string", "Endpoints": [ { "Endpoint": "string", "EndpointType": "string" } ], "ErrorMessage": "string", "Id": "string", "IndexId": "string", "Name": "string", "RoleArn": "string", "Status": "string", "UpdatedAt": number }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Configuration

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.

Type: ExperienceConfiguration object

CreatedAt

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

Type: Timestamp

Description

Shows the description for your Amazon Kendra experience.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1000.

Pattern: ^\P{C}*$

Endpoints

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

Type: Array of ExperienceEndpoint objects

Array Members: Minimum number of 1 item. Maximum number of 2 items.

ErrorMessage

The reason your Amazon Kendra experience could not properly process.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: ^\P{C}*$

Id

Shows the identifier of your Amazon Kendra experience.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 36.

Pattern: [a-zA-Z0-9][a-zA-Z0-9_-]*

IndexId

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

Type: String

Length Constraints: Fixed length of 36.

Pattern: [a-zA-Z0-9][a-zA-Z0-9-]*

Name

Shows the name of your Amazon Kendra experience.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1000.

Pattern: [a-zA-Z0-9][a-zA-Z0-9_-]*

RoleArn

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

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1284.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

Status

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.

Type: String

Valid Values: CREATING | ACTIVE | DELETING | FAILED

UpdatedAt

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

Type: Timestamp

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

HTTP Status Code: 400

InternalServerException

HTTP Status Code: 500

ResourceNotFoundException

HTTP Status Code: 400

ThrottlingException

HTTP Status Code: 400

ValidationException

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: