View a markdown version of this page

列出建议 - Amazon Bedrock AgentCore
代码示例请求参数响应错误

列出建议

列出您账户中的所有推荐。结果是分页的，可以按状态进行筛选。

代码示例

例
AgentCore CLI

列出过去的推荐作业（正在运行的作业是从服务中刷新的）：

agentcore view recommendation

按 ID 查看单个推荐：

agentcore view recommendation <recommendation-id>

--json为机器可读输出添加：

agentcore view recommendation --json
AWS SDK (boto3)
import boto3

client = boto3.client("bedrock-agentcore", region_name="us-west-2")

# List all recommendations
response = client.list_recommendations()
for rec in response["recommendationSummaries"]:
    print(f"{rec['recommendationId']} | {rec['name']} | {rec['type']} | {rec['status']}")

按状态筛选：

response = client.list_recommendations(statusFilter="COMPLETED")

for rec in response["recommendationSummaries"]:
    print(f"{rec['recommendationId']}  {rec['name']}  {rec['status']}")

对所有结果进行分页：

paginator = client.get_paginator("list_recommendations")
for page in paginator.paginate(statusFilter="COMPLETED"):
    for rec in page["recommendationSummaries"]:
        print(rec["recommendationId"])

请求参数

参数 Type 必需 说明

maxResults

整数

否

每页的最大结果数。射程：1—100。

nextToken

字符串

否

来自先前响应的分页标记。

statusFilter

字符串

否

按状态筛选。其中一个:PENDING,IN_PROGRESS,COMPLETED,FAILED, DELETING。

响应

字段 Type 说明

recommendationSummaries

列表

推荐摘要清单。

nextToken

字符串

下一页的分页标记。没有更多结果时不存在。

推荐摘要字段

字段 Type 说明

recommendationId

字符串

唯一标识符。

recommendationArn

字符串

该建议的 ARN。

name

字符串

推荐名称。

description

字符串

可选描述（如果提供）。

type

字符串

SYSTEM_PROMPT_RECOMMENDATION 或 TOOL_DESCRIPTION_RECOMMENDATION。

status

字符串

当前状态：PENDING、IN_PROGRESS、COMPLETED、FAILED、DELETING。

createdAt

Timestamp

建议的创建时间。

updatedAt

Timestamp

上次更新建议的时间。

要检索推荐的完整详细信息和结果，请使用获取推荐recommendationId。

错误

错误 HTTP 状态 说明

ValidationException

400

分页参数或状态筛选器值无效。

AccessDeniedException

403

权限不足。

ThrottlingException

429

超出请求速率。

InternalServerException

500

Service-side 错误。