Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1465766489.0 KB

Retrieves detailed information about a recommendation, including its configuration, status, and results.

get/recommendations/{recommendationId}

Path parameters

recommendationIdstring required

The unique identifier of the recommendation to retrieve.

Response

Success

recommendationIdstring required

The unique identifier of the recommendation.

recommendationArnstring required

The Amazon Resource Name (ARN) of the recommendation.

namestring required

The name of the recommendation.

descriptionstring

The description of the recommendation.

type'SYSTEM_PROMPT_RECOMMENDATION' | 'TOOL_DESCRIPTION_RECOMMENDATION' required

The type of recommendation.

status'PENDING' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED' | 'DELETING' required

The current status of the recommendation.

createdAtstring date-time required

The timestamp when the recommendation was created.

updatedAtstring date-time required

The timestamp when the recommendation was last updated.

kmsKeyArnstring

The ARN of the KMS key used to encrypt recommendation data.