aws-sdk-codepipeline

概述

这是 CodePipeline API 参考文档。本指南提供了 CodePipeline 的操作和数据类型描述。您的一些管道功能只能通过 API 进行配置。有关更多信息，请参阅 CodePipeline 用户指南。

您可以使用 CodePipeline API 来处理管道、阶段、操作和转换。

管道 是自动化发布过程的模型。每个管道都有唯一的名称，并包含阶段、操作和转换。

您可以通过以下方式处理管道：

• 创建管道，创建一个具有唯一名称的管道。
• 删除管道，删除指定的管道。
• 获取管道，返回有关管道结构和管道元数据的信息，包括管道的 Amazon 资源名称 (ARN)。
• 获取管道执行，返回有关管道特定执行的信息。
• 获取管道状态，返回有关管道的阶段和操作当前状态的信息。
• 列出操作执行，返回过去执行的详细操作级别的信息。这些详细信息包括完整阶段和操作级别的详细情况，包括单个操作持续时间、状态、执行过程中发生的任何错误以及输入和输出工件的位置详细信息。
• 列出管道，获取与您的账户关联的所有管道的摘要。
• 列出管道执行，获取管道最近执行的摘要。
• 启动管道执行，运行通过管道的最新修订版本的工件。
• 停止管道执行，停止指定的管道执行，使其不再继续通过管道。
• 更新管道，使用对管道结构的编辑或更改更新管道。

管道包括阶段。每个阶段包含一个或多个必须在下一个阶段开始之前完成的操作。阶段的结果是成功或失败。如果阶段失败，则管道在该阶段停止，直到在源位置出现新版本的工件或用户采取行动重新运行最近通过管道的工件。您可以通过调用GetPipelineState来查看管道的状态，包括管道中阶段的状态，或者调用GetPipeline来获取管道的整个结构，包括该管道的阶段。有关阶段和操作的更多信息，请参阅CodePipeline 管道结构参考。

管道阶段包括在管道阶段中执行的动作，这些动作被归类到源或构建动作等类别。例如，您可以使用源动作将工件从源（如Amazon S3）导入到管道中。与阶段一样，在大多数情况下，您不直接与动作工作，但在使用创建管道和GetPipelineState等管道操作时，您定义和交互动作。有效的动作类别包括：

• 源
• 构建
• 测试
• 部署
• 审批
• 调用

管道还包括过渡，它允许在管道中一个阶段的动作完成后将工件从该阶段过渡到下一个阶段。

您可以通过以下方式处理过渡：

• DisableStageTransition，它阻止工件在管道中过渡到下一个阶段。
• EnableStageTransition，它启用管道中阶段间的工件过渡。

使用API与CodePipeline集成

对于希望创建自己的与CodePipeline集成的第三方集成商或开发者，预期的顺序与标准API用户不同。要集成CodePipeline，开发者需要处理以下项目：

作业，它是动作的实例。例如，源动作的作业可能从源导入工件的修订版本。

您可以通过以下方式处理作业：

• AcknowledgeJob，它确认作业工作者是否已收到指定的作业。
• GetJobDetails，它返回作业的详细信息。
• PollForJobs，它确定是否有任何作业要执行。
• PutJobFailureResult，它提供作业失败详情。
• PutJobSuccessResult，它提供作业成功详情。

第三方作业，它是合作伙伴动作创建的动作实例，并集成到CodePipeline中。合作伙伴动作是由Amazon Web Services合作伙伴网络成员创建的。

您可以通过以下方式处理第三方作业：

• AcknowledgeThirdPartyJob，它确认作业工作者是否已收到指定的作业。
• GetThirdPartyJobDetails，它请求合作伙伴动作作业的详细信息。
• PollForThirdPartyJobs，它确定是否有任何作业要执行。
• PutThirdPartyJobFailureResult，它提供作业失败详情。
• PutThirdPartyJobSuccessResult，它提供作业成功详情。

入门指南

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

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

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

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

use aws_sdk_codepipeline as codepipeline;

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

    // ... make some calls with the client

    Ok(())
}

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

使用SDK

在SDK发布之前，我们将向开发者指南中添加有关使用SDK的信息。您可以通过提交问题和描述您想要做什么来建议指南的附加章节。

获取帮助

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

许可证

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