资讯详情

资讯详情

使用 aws-cli 的 codeguru-reviewer list-recommendation-feedback 查询代码评审推荐反馈

使用 aws-cli 的 codeguru-reviewer list-recommendation-feedback 查询代码评审推荐反馈【免费下载链接】aws-cliUniversal Command Line Interface for Amazon Web Services项目地址: https://gitcode.com/GitHub_Trending/aw/aws-cliaws codeguru-reviewer list-recommendation-feedback是 aws-cli 中用于批量查询 Amazon CodeGuru Reviewer 代码评审Code Review推荐反馈的核心命令。本指南以仓库中的官方示例 list-recommendation-feedback.rst 为主体结合服务模型 service-2.json 的底层定义带你掌握该命令的参数语义、输出结构、筛选与分页能力并与put-recommendation-feedback、describe-recommendation-feedback串联成完整的提建议—收反馈—查反馈闭环。命令概览与适用场景Amazon CodeGuru Reviewer 通过程序分析与机器学习对 Java、Python 代码中的潜在缺陷和最佳实践给出推荐Recommendation。为了让开发者对每一条推荐表达意见服务提供了反馈Feedback机制——你可以对某条推荐点ThumbsUp或ThumbsDown。list-recommendation-feedback对应 CodeGuru Reviewer API 中的ListRecommendationFeedback操作其作用是返回包含所有 CodeGuru Reviewer 用户针对某次代码评审的推荐反馈的RecommendationFeedbackSummary对象列表。典型场景包括评审完成后汇总团队对每条推荐的赞成/反对意见判断推荐质量结合--user-ids查看特定用户的反馈偏好用于培训或审计结合--recommendation-ids单独核验某几条关键推荐尤其是安全类推荐是否被采纳。从服务模型看该操作对应的 HTTP 请求为GET /feedback/{CodeReviewArn}/RecommendationFeedback见 service-2.jsonCodeReviewArn直接拼入 URL 路径其余参数以 query string 传递。前置条件先拿到 CodeReviewArnCodeReviewArn是该命令唯一必填参数它标识一次具体的代码评审。实际使用中评审 ARN 通常通过以下方式获取调用aws codeguru-reviewer list-code-reviews列出 90 天内创建的评审调用aws codeguru-reviewer describe-code-review查看指定评审详情在评审完成后从创建命令create-code-review的返回值中取得。从模型中的Arn形状service-2.json可以推断其结构arn:aws:codeguru-reviewer:region:12位账号ID:资源类型:资源ID长度限制为 1–1600 字符。官方示例中的 ARN 是一个典型的基于仓库分析的评审arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111:code-review:RepositoryAnalysis-my-repository-name-branch-abcdefgh12345678其中association:后是仓库关联 IDUUID 格式code-review:后是评审名称形如RepositoryAnalysis-仓库名-分支名-哈希。基本用法列出评审的全部推荐反馈官方示例list-recommendation-feedback.rst给出了最直接的调用方式只传--code-review-arn列出该评审下所有推荐上的客户反馈aws codeguru-reviewer list-recommendation-feedback \ --code-review-arn arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111:code-review:RepositoryAnalysis-my-repository-name-branch-abcdefgh12345678示例输出该评审下有一条反馈来自某位客户的一条ThumbsUp{ RecommendationFeedbackSummaries: [ { RecommendationId: 3be1b2e5d7ef6e298a06499379ee290c9c596cf688fdcadb08285ddb0dd390eb, Reactions: [ ThumbsUp ], UserId: aws-user-id } ] }输出字段逐项解读根据RecommendationFeedbackSummary形状定义service-2.json返回数组中的每个对象包含三个字段字段类型说明RecommendationIdstring推荐 ID用于追踪推荐并收集反馈长度 1–64 字符Reactionslist反馈表情列表当前枚举值为ThumbsUp/ThumbsDown列表容量最多 1 个max:1UserIdstring给出反馈的用户标识是 IAM 主体可为 AWS 账号 ID 或 IAM 角色的 ARN长度 1–256 字符需要注意两点细节一条反馈只对应一种表情Reactions形状service-2.json的约束是max:1, min:0即单条反馈要么有一个表情要么为空列表表示已清除反馈。UserId是 IAM 主体模型文档明确说明它可以是指定的 IAM principalAWS 账号 ID 或 ARN。示例中的aws-user-id只是示意值真实输出中会是你配置的凭证对应的账号标识。响应中的分页字段除了RecommendationFeedbackSummariesListRecommendationFeedbackResponseservice-2.json还包含NextToken如果响应中返回了nextToken说明还有更多结果nextToken是每页唯一的透明分页令牌仅用于取下一页不应被解析或用于其他目的把返回的 token 原样传给下一次调用的--next-token其余参数保持不变。进阶用法筛选与分页控制list-recommendation-feedback除必填的--code-review-arn外还支持三个可选参数见 service-2.json 的请求定义。--user-ids只看某个用户的反馈aws codeguru-reviewer list-recommendation-feedback \ --code-review-arn arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111:code-review:RepositoryAnalysis-my-repository-name-branch-abcdefgh12345678 \ --user-ids 111122223333UserIds列表最多可传 100 个值每个值为 AWS 账号 ID 或 IAM 主体 ARN。适用于查询某位开发者对本次评审的反馈。--recommendation-ids只看特定推荐的反馈aws codeguru-reviewer list-recommendation-feedback \ --code-review-arn arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111:code-review:RepositoryAnalysis-my-repository-name-branch-abcdefgh12345678 \ --recommendation-ids 3be1b2e5d7ef6e298a06499379ee290c9c596cf688fdcadb08285ddb0dd390ebRecommendationIds列表同样最多 100 个每个推荐 ID 长度 1–64 字符。推荐 ID 的来源是先调用aws codeguru-reviewer list-recommendations获取——该命令的示例输出见 list-recommendations.rst中每条RecommendationSummary都带有RecommendationId、StartLine、EndLine、FilePath和Description你可以据此定位某条具体推荐。--max-results 与 --next-token控制分页aws codeguru-reviewer list-recommendation-feedback \ --code-review-arn arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111:code-review:RepositoryAnalysis-my-repository-name-branch-abcdefgh12345678 \ --max-results 50 \ --next-token 上次返回的token参数语义依据模型文档--max-results单次调用最多返回的结果数取值 1–100默认值为 100MaxResults形状见 service-2.json--next-token上一页返回的NextToken长度 1–2048用于翻页无更多结果时响应中不带该字段。反馈闭环put / describe / list 三个命令配合使用list-recommendation-feedback只是读的一环完整的工作流通常由以下命令协同完成命令对应操作作用put-recommendation-feedbackPutRecommendationFeedbackPUT /feedback写入反馈同一推荐再次调用会覆盖之前的反馈describe-recommendation-feedbackDescribeRecommendationFeedback查看单条推荐的反馈详情含创建/更新时间戳list-recommendation-feedbackListRecommendationFeedback批量汇总所有用户对所有推荐的反馈1. 写入反馈put-recommendation-feedback官方示例 put-recommendation-feedback.rst 展示了给某条推荐点赞aws codeguru-reviewer put-recommendation-feedback \ --code-review-arn arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111:code-review:RepositoryAnalysis-my-repository-name-branch-abcdefgh12345678 \ --recommendation-id 3be1b2e5d7ef6e298a06499379ee290c9c596cf688fdcadb08285ddb0dd390eb \ --reactions ThumbsUp该命令不产生输出。其请求定义service-2.json要求CodeReviewArn、RecommendationId、Reactions三个参数均为必填且服务端文档明确指出当该 API 以不同的 reactions 再次调用时之前的反馈会被覆盖。 如果想清除反馈可以发送空列表--reactions []。2. 查看单条详情describe-recommendation-feedbackaws codeguru-reviewer describe-recommendation-feedback \ --code-review-arn arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111:code-review:RepositoryAnalysis-my-repository-name-branch-abcdefgh12345678 \ --recommendation-id 3be1b2e5d7ef6e298a06499379ee290c9c596cf688fdcadb08285ddb0dd390eb示例输出describe-recommendation-feedback.rst比list更详细额外包含CodeReviewArn、CreatedTimeStamp、LastUpdatedTimeStamp{ RecommendationFeedback: { CodeReviewArn: arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111:code-review:RepositoryAnalysis-my-repository-name-branch-abcdefgh12345678, RecommendationId: 3be1b2e5d7ef6e298a06499379ee290c9c596cf688fdcadb08285ddb0dd390eb, Reactions: [ ThumbsUp ], UserId: aws-user-id, CreatedTimeStamp: 1618877070.313, LastUpdatedTimeStamp: 1618877948.881 } }对应到模型中的RecommendationFeedback形状service-2.jsonCreatedTimeStamp与LastUpdatedTimeStamp分别表示反馈创建和最后更新时间。如果你需要追踪某条反馈是什么时候提交/修改的用describe而不是list。3. 组合工作流示例一个典型的反馈审查流程是# 第一步获取某条推荐的 ID aws codeguru-reviewer list-recommendations \ --code-review-arn code-review-arn # 第二步针对推荐写反馈 或 aws codeguru-reviewer put-recommendation-feedback \ --code-review-arn code-review-arn \ --recommendation-id recommendation-id \ --reactions ThumbsDown # 第三步汇总查看所有反馈 aws codeguru-reviewer list-recommendation-feedback \ --code-review-arn code-review-arn # 第四步可选核查单条反馈的提交时间 aws codeguru-reviewer describe-recommendation-feedback \ --code-review-arn code-review-arn \ --recommendation-id recommendation-id异常与排错ListRecommendationFeedback可能抛出的异常类型定义在 service-2.json可据此推断常见报错原因异常含义排查建议ResourceNotFoundException指定的CodeReviewArn不存在用list-code-reviews确认评审 ARN 是否真实存在、是否属于当前账号ValidationException输入不满足约束检查 ARN 格式含 12 位账号 ID、--max-results是否在 1–100、--recommendation-ids数量是否超过 100AccessDeniedException权限不足确认 IAM 凭证具备codeguru-reviewer:ListRecommendationFeedback权限ThrottlingException请求被限流适当退避重试InternalServerException服务端内部错误稍后重试若持续失败可联系 AWS 支持一个值得注意的坑示例 ARN 中的账号123456789012、关联 IDa1b2c3d4-...和推荐 ID 均为文档占位符。直接把示例命令原样执行会得到ResourceNotFoundException或ValidationException务必替换为你账号下真实存在的评审 ARN。源码依据本文涉及的命令定义与参数约束均可从以下仓库文件直接验证官方 CLI 示例list-recommendation-feedback.rst配套写反馈示例put-recommendation-feedback.rst配套详情示例describe-recommendation-feedback.rst推荐 ID 来源示例list-recommendations.rstCodeGuru Reviewer 服务模型API 定义、参数约束、异常、返回形状awscli/botocore/data/codeguru-reviewer/2019-09-19/service-2.jsonaws-cli 会依据该 JSON 服务模型自动生成list-recommendation-feedback子命令的参数校验与序列化逻辑因此模型中的min/max约束、枚举值与查询参数位置querystring、uri即是你实际执行命令时的行为边界。【免费下载链接】aws-cliUniversal Command Line Interface for Amazon Web Services项目地址: https://gitcode.com/GitHub_Trending/aw/aws-cli创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考
觉得有用,分享给同行:

为您的企业打造数字门面

稳重轻奢商务风格,端正雅致视觉,长效耐看不易过时。

立即咨询 →