aws-sdk-codecommit

这是 CodeCommit API 参考。本参考提供了 CodeCommit API 的操作和数据类型描述，以及使用示例。

您可以使用 CodeCommit API 来操作以下对象

通过以下方式调用

• BatchGetRepositories，它返回有关与您的 Amazon Web Services 账户关联的一个或多个存储库的信息。
• CreateRepository，它创建一个 CodeCommit 存储库。
• DeleteRepository，它删除一个 CodeCommit 存储库。
• GetRepository，它返回有关指定存储库的信息。
• ListRepositories，它列出与您的 Amazon Web Services 账户关联的所有 CodeCommit 存储库。
• UpdateRepositoryDescription，它设置或更新存储库的描述。
• UpdateRepositoryEncryptionKey，它更新用于加密和解密存储库的密钥管理服务加密密钥。
• UpdateRepositoryName，它更改存储库的名称。如果您更改存储库的名称，则无法访问该存储库的其他用户，直到您发送给他们新的 HTTPS 或 SSH URL。

通过以下方式调用

• CreateBranch，它在指定的存储库中创建一个分支。
• DeleteBranch，它删除存储库中的指定分支（除非它是默认分支）。
• GetBranch，它返回有关指定分支的信息。
• ListBranches，它列出指定存储库的所有分支。
• UpdateDefaultBranch，它更改存储库的默认分支。

通过以下方式调用

• DeleteFile，它从指定的分支中删除指定文件的内容。
• GetBlob，它返回存储库中单个 Git blob 对象的 base-64 编码内容。
• GetFile，它返回指定文件的 base-64 编码内容。
• GetFolder，它返回指定文件夹或目录的内容。
• ListFileCommitHistory，它检索有关指定文件的提交和更改的列表。
• PutFile，该操作向指定的仓库和分支中添加或修改单个文件。

提交，通过调用以下方法：

• BatchGetCommits，该方法返回关于一个或多个仓库提交的信息。
• CreateCommit，该方法为仓库的更改创建提交。
• GetCommit，该方法返回关于提交的信息，包括提交消息、作者和提交者信息。
• GetDifferences，该方法返回关于有效提交指定符（例如分支、标签、HEAD、提交ID或其他完全限定引用）中差异的信息。

合并，通过调用以下方法：

• BatchDescribeMergeConflicts，该方法返回关于仓库中提交之间的合并冲突的信息。
• CreateUnreferencedMergeCommit，该方法在两个分支或提交之间创建一个未引用的提交，用于比较它们并识别任何潜在冲突。
• DescribeMergeConflicts，该方法返回关于潜在合并中文件的基础、源和目标版本的合并冲突的信息。
• GetMergeCommit，该方法返回关于源提交和目标提交之间的合并信息。
• GetMergeConflicts，该方法返回关于拉取请求中源分支和目标分支之间的合并冲突的信息。
• GetMergeOptions，该方法返回关于两个分支或提交指定符之间的可用合并选项的信息。
• MergeBranchesByFastForward，该方法使用快进合并选项合并两个分支。
• MergeBranchesBySquash，该方法使用合并提交选项合并两个分支。
• MergeBranchesByThreeWay，该方法使用三路合并选项合并两个分支。

拉取请求，通过调用以下方法：

• CreatePullRequest，该方法在指定的仓库中创建拉取请求。
• CreatePullRequestApprovalRule，该方法为指定的拉取请求创建一个批准规则。
• DeletePullRequestApprovalRule，该方法删除指定的拉取请求的批准规则。
• DescribePullRequestEvents，该方法返回有关一个或多个拉取请求事件的信息。
• EvaluatePullRequestApprovalRules，该方法评估拉取请求是否满足其相关批准规则中指定的所有条件。
• GetCommentsForPullRequest，该方法返回有关指定拉取请求的评论信息。
• GetPullRequest，该方法返回有关指定拉取请求的信息。
• GetPullRequestApprovalStates，该方法返回有关指定拉取请求的批准状态的信息。
• GetPullRequestOverrideState，该方法返回有关是否为拉取请求忽略了（覆盖）批准规则，如果是，则返回覆盖规则的用户或身份的Amazon资源名称（ARN）及其对拉取请求的要求。
• ListPullRequests，该方法列出仓库中所有的拉取请求。
• MergePullRequestByFastForward，该方法使用快进合并选项将拉取请求的源目标分支合并到指定的目标分支。
• MergePullRequestBySquash，该方法使用合并提交选项将拉取请求的源目标分支合并到指定的目标分支。
• MergePullRequestByThreeWay，该方法使用三路合并选项将拉取请求的源目标分支合并到指定的目标分支。
• OverridePullRequestApprovalRules，该方法忽略拉取请求的所有批准规则要求。
• PostCommentForPullRequest，该方法在指定的行、文件或请求中发布评论。
• UpdatePullRequestApprovalRuleContent，该方法更新拉取请求的批准规则结构。
• UpdatePullRequestApprovalState，该方法更新拉取请求上的批准状态。
• UpdatePullRequestDescription，该方法更新拉取请求的描述。
• UpdatePullRequestStatus，该方法更新拉取请求的状态。
• UpdatePullRequestTitle，该方法更新拉取请求的标题。

批准规则模板，通过调用以下方法

• AssociateApprovalRuleTemplateWithRepository，该方法将模板与指定的仓库关联。模板与仓库关联后，CodeCommit将为在指定仓库中创建的每个拉取请求创建符合模板条件的批准规则。
• BatchAssociateApprovalRuleTemplateWithRepositories，该方法将模板与一个或多个指定的仓库关联。模板与仓库关联后，CodeCommit将为在指定仓库中创建的每个拉取请求创建符合模板条件的批准规则。
• BatchDisassociateApprovalRuleTemplateFromRepositories，该方法删除模板与指定仓库之间的关联，以确保在那些仓库中创建拉取请求时不会自动创建基于模板的批准规则。
• CreateApprovalRuleTemplate，该方法创建一个批准规则模板，然后可以将其与您的Amazon Web Services账户中的一个或多个仓库关联。
• DeleteApprovalRuleTemplate，该方法删除指定的模板。它不会删除已使用模板创建的拉取请求上的批准规则。
• DisassociateApprovalRuleTemplateFromRepository，该方法删除模板与仓库之间的关联，以确保在指定仓库中创建拉取请求时不会自动创建基于模板的批准规则。
• GetApprovalRuleTemplate，该方法返回有关批准规则模板的信息。
• ListApprovalRuleTemplates，该方法列出您在Amazon Web Services账户中Amazon Web Services区域的所有批准规则模板。
• ListAssociatedApprovalRuleTemplatesForRepository，该方法列出与指定仓库关联的所有批准规则模板。
• ListRepositoriesForApprovalRuleTemplate，该方法列出与指定批准规则模板关联的所有仓库。
• UpdateApprovalRuleTemplateDescription，该方法更新批准规则模板的描述。
• UpdateApprovalRuleTemplateName，该方法更新批准规则模板的名称。
• UpdateApprovalRuleTemplateContent，该方法更新批准规则模板的内容。

通过以下方法在仓库中的评论，

• DeleteCommentContent，该方法删除仓库中提交上的评论内容。
• GetComment，该方法返回有关提交上评论的信息。
• GetCommentReactions，该方法返回有关对评论的emoji反应的信息。
• GetCommentsForComparedCommit，该方法返回有关仓库中两个提交指定者之间比较的评论信息。
• PostCommentForComparedCommit，该方法在仓库中两个提交指定者之间的比较上创建评论。
• PostCommentReply，该方法为评论创建回复。
• PutCommentReaction，该方法创建或更新对评论的emoji反应。
• UpdateComment，该方法更新仓库中提交上的评论内容。

用于在CodeCommit中标记资源的标签（不是Git标签），通过以下方法

• ListTagsForResource，该方法获取有关CodeCommit中指定Amazon Resource Name (ARN)的Amazon Web Servicestags的信息。
• TagResource，该方法向CodeCommit中的资源添加或更新标签。
• UntagResource，该方法从CodeCommit中的资源删除标签。

触发器，通过以下方法

• GetRepositoryTriggers，该方法返回有关为仓库配置的触发器的信息。
• PutRepositoryTriggers，该方法替换仓库的所有触发器，可用于创建或删除触发器。
• TestRepositoryTriggers，该方法通过向触发器目标发送数据来测试仓库触发器的功能。

有关如何使用CodeCommit的信息，请参阅CodeCommit用户指南。

入门指南

许多服务和操作都有示例，请查看GitHub上的示例文件夹。

该SDK为每个AWS服务提供一個crate。您必须在您的Rust项目中添加作为依赖项以执行异步代码。Tokio。要将aws-sdk-codecommit添加到您的项目中，请将以下内容添加到您的Cargo.toml文件中

[dependencies]
aws-config = { version = "1.1.7", features = ["behavior-version-latest"] }
aws-sdk-codecommit = "1.40.0"
tokio = { version = "1", features = ["full"] }

然后在代码中，可以使用以下方式创建客户端

use aws_sdk_codecommit as codecommit;

#[::tokio::main]
async fn main() -> Result<(), codecommit::Error> {
    let config = aws_config::load_from_env().await;
    let client = aws_sdk_codecommit::Client::new(&config);

    // ... make some calls with the client

    Ok(())
}

有关可以进行的调用以及每个调用输入和输出的信息，请参阅客户端文档。

使用SDK

在SDK发布之前，我们将向开发者指南中添加有关使用SDK的信息。请通过创建一个问题并描述您正在尝试做的事情来提出指南的额外章节建议。

获取帮助

• GitHub讨论 - 用于想法、RFC和一般问题
• GitHub问题 - 用于错误报告和功能请求
• 生成的文档（最新版本）
• 使用示例

许可证

本项目采用Apache-2.0许可证。