Post x amz targetawskendrarerankingfrontendservice.describerescoreexecutionplan

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1495840.6 KB

Gets information about a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the <code>Rescore</code> API.

post/#X-Amz-Target=AWSKendraRerankingFrontendService.DescribeRescoreExecutionPlan

Headers

X-Amz-Target'AWSKendraRerankingFrontendService.DescribeRescoreExecutionPlan' required

Request body

Idstring required

The identifier of the rescore execution plan that you want to get information on.

Response

Success

Idstring

The identifier of the rescore execution plan.

Arnstring

The Amazon Resource Name (ARN) of the rescore execution plan.

Namestring

The name for the rescore execution plan.

Descriptionstring

The description for the rescore execution plan.

CreatedAtstring date-time

The Unix timestamp of when the rescore execution plan was created.

UpdatedAtstring date-time

The Unix timestamp of when the rescore execution plan was last updated.

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

The current status of the rescore execution plan. When the value is <code>ACTIVE</code>, the rescore execution plan is ready for use. If the <code>Status</code> field value is <code>FAILED</code>, the <code>ErrorMessage</code> field contains a message that explains why.

ErrorMessagestring

When the <code>Status</code> field value is <code>FAILED</code>, the <code>ErrorMessage</code> field contains a message that explains why.