文件 AWS 開發套件範例 GitHub 儲存庫中有更多可用的 [AWS SDK 範例](https://github.com/awsdocs/aws-doc-sdk-examples)。
本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。
# CodePipeline AWS SDKs的基本範例
下列程式碼範例示範如何 AWS CodePipeline 搭配 AWS SDKs 使用 的基本概念。
**Contents**
+ [動作](codepipeline_code_examples_actions.md)
+ [`AcknowledgeJob`](codepipeline_example_codepipeline_AcknowledgeJob_section.md)
+ [`CreateCustomActionType`](codepipeline_example_codepipeline_CreateCustomActionType_section.md)
+ [`CreatePipeline`](codepipeline_example_codepipeline_CreatePipeline_section.md)
+ [`DeleteCustomActionType`](codepipeline_example_codepipeline_DeleteCustomActionType_section.md)
+ [`DeletePipeline`](codepipeline_example_codepipeline_DeletePipeline_section.md)
+ [`DisableStageTransition`](codepipeline_example_codepipeline_DisableStageTransition_section.md)
+ [`EnableStageTransition`](codepipeline_example_codepipeline_EnableStageTransition_section.md)
+ [`GetJobDetails`](codepipeline_example_codepipeline_GetJobDetails_section.md)
+ [`GetPipeline`](codepipeline_example_codepipeline_GetPipeline_section.md)
+ [`GetPipelineState`](codepipeline_example_codepipeline_GetPipelineState_section.md)
+ [`ListActionTypes`](codepipeline_example_codepipeline_ListActionTypes_section.md)
+ [`ListPipelines`](codepipeline_example_codepipeline_ListPipelines_section.md)
+ [`PollForJobs`](codepipeline_example_codepipeline_PollForJobs_section.md)
+ [`StartPipelineExecution`](codepipeline_example_codepipeline_StartPipelineExecution_section.md)
+ [`UpdatePipeline`](codepipeline_example_codepipeline_UpdatePipeline_section.md)
# CodePipeline AWS SDKs的動作
下列程式碼範例示範如何使用 AWS SDKs 執行個別 CodePipeline 動作。每個範例均包含 GitHub 的連結，您可以在連結中找到設定和執行程式碼的相關說明。
下列範例僅包含最常使用的動作。如需完整清單，請參閱《[AWS CodePipeline API 參考](https://docs.aws.amazon.com/codepipeline/latest/APIReference/Welcome.html)》。
**Topics**
+ [`AcknowledgeJob`](codepipeline_example_codepipeline_AcknowledgeJob_section.md)
+ [`CreateCustomActionType`](codepipeline_example_codepipeline_CreateCustomActionType_section.md)
+ [`CreatePipeline`](codepipeline_example_codepipeline_CreatePipeline_section.md)
+ [`DeleteCustomActionType`](codepipeline_example_codepipeline_DeleteCustomActionType_section.md)
+ [`DeletePipeline`](codepipeline_example_codepipeline_DeletePipeline_section.md)
+ [`DisableStageTransition`](codepipeline_example_codepipeline_DisableStageTransition_section.md)
+ [`EnableStageTransition`](codepipeline_example_codepipeline_EnableStageTransition_section.md)
+ [`GetJobDetails`](codepipeline_example_codepipeline_GetJobDetails_section.md)
+ [`GetPipeline`](codepipeline_example_codepipeline_GetPipeline_section.md)
+ [`GetPipelineState`](codepipeline_example_codepipeline_GetPipelineState_section.md)
+ [`ListActionTypes`](codepipeline_example_codepipeline_ListActionTypes_section.md)
+ [`ListPipelines`](codepipeline_example_codepipeline_ListPipelines_section.md)
+ [`PollForJobs`](codepipeline_example_codepipeline_PollForJobs_section.md)
+ [`StartPipelineExecution`](codepipeline_example_codepipeline_StartPipelineExecution_section.md)
+ [`UpdatePipeline`](codepipeline_example_codepipeline_UpdatePipeline_section.md)
# 搭配使用 `AcknowledgeJob` 與 CLI
下列程式碼範例示範如何使用 `AcknowledgeJob`。
------
#### [ CLI ]
**AWS CLI**
**擷取指定任務的相關資訊**
此範例傳回指定任務的相關資訊，包括該任務存在時的狀態。這僅用於執行任務的工作者和自訂動作。若要判斷 nonce 的值和任務 ID，請使用 aws codepipeline poll-for-jobs。
命令：
```
aws codepipeline acknowledge-job --job-id f4f4ff82-2d11-EXAMPLE --nonce 3
```
輸出：
```
{
"status": "InProgress"
}
```
+ 如需 API 詳細資訊，請參閱《*AWS CLI 命令參考*》中的 [AcknowledgeJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/acknowledge-job.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例會取得任務的狀態。**
```
Confirm-CPJob -JobId f570dc12-5ef3-44bc-945a-6e133EXAMPLE -Nonce 3
```
**輸出：**
```
Value
-----
InProgress
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [AcknowledgeJob](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例會取得任務的狀態。**
```
Confirm-CPJob -JobId f570dc12-5ef3-44bc-945a-6e133EXAMPLE -Nonce 3
```
**輸出：**
```
Value
-----
InProgress
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [AcknowledgeJob](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `CreateCustomActionType` 與 CLI
下列程式碼範例示範如何使用 `CreateCustomActionType`。
------
#### [ CLI ]
**AWS CLI**
**建立自訂動作**
此範例使用已建立的 JSON 檔案 （此處名為 MyCustomAction.json) 為 AWS CodePipeline 建立自訂動作，其中包含自訂動作的結構。如需建立自訂動作需求的詳細資訊，包括 檔案的結構，請參閱 AWS CodePipeline 使用者指南。
```
aws codepipeline create-custom-action-type --cli-input-json file://MyCustomAction.json
```
JSON 檔案 `MyCustomAction.json` 的內容：
```
{
"category": "Build",
"provider": "MyJenkinsProviderName",
"version": "1",
"settings": {
"entityUrlTemplate": "https://192.0.2.4/job/{Config:ProjectName}/",
"executionUrlTemplate": "https://192.0.2.4/job/{Config:ProjectName}/lastSuccessfulBuild/{ExternalExecutionId}/"
},
"configurationProperties": [
{
"name": "MyJenkinsExampleBuildProject",
"required": true,
"key": true,
"secret": false,
"queryable": false,
"description": "The name of the build project must be provided when this action is added to the pipeline.",
"type": "String"
}
],
"inputArtifactDetails": {
"maximumCount": 1,
"minimumCount": 0
},
"outputArtifactDetails": {
"maximumCount": 1,
"minimumCount": 0
}
}
```
此命令傳回自訂動作的結構。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [CreateCustomActionType](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/create-custom-action-type.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例會使用指定的屬性建立新的自訂動作。**
```
New-CPCustomActionType -Category Build -ConfigurationProperty @{"Description" = "The name of the build project must be provided when this action is added to the pipeline."; "Key" = $True; "Name" = "ProjectName"; "Queryable" = $False; "Required" = $True; "Secret" = $False; "Type" = "String"} -Settings_EntityUrlTemplate "https://my-build-instance/job/{Config:ProjectName}/" -Settings_ExecutionUrlTemplate "https://my-build-instance/job/mybuildjob/lastSuccessfulBuild{ExternalExecutionId}/" -InputArtifactDetails_MaximumCount 1 -OutputArtifactDetails_MaximumCount 1 -InputArtifactDetails_MinimumCount 0 -OutputArtifactDetails_MinimumCount 0 -Provider "MyBuildProviderName" -Version 1
```
**輸出：**
```
ActionConfigurationProperties : {ProjectName}
Id : Amazon.CodePipeline.Model.ActionTypeId
InputArtifactDetails : Amazon.CodePipeline.Model.ArtifactDetails
OutputArtifactDetails : Amazon.CodePipeline.Model.ArtifactDetails
Settings : Amazon.CodePipeline.Model.ActionTypeSettings
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [CreateCustomActionType](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例會使用指定的屬性建立新的自訂動作。**
```
New-CPCustomActionType -Category Build -ConfigurationProperty @{"Description" = "The name of the build project must be provided when this action is added to the pipeline."; "Key" = $True; "Name" = "ProjectName"; "Queryable" = $False; "Required" = $True; "Secret" = $False; "Type" = "String"} -Settings_EntityUrlTemplate "https://my-build-instance/job/{Config:ProjectName}/" -Settings_ExecutionUrlTemplate "https://my-build-instance/job/mybuildjob/lastSuccessfulBuild{ExternalExecutionId}/" -InputArtifactDetails_MaximumCount 1 -OutputArtifactDetails_MaximumCount 1 -InputArtifactDetails_MinimumCount 0 -OutputArtifactDetails_MinimumCount 0 -Provider "MyBuildProviderName" -Version 1
```
**輸出：**
```
ActionConfigurationProperties : {ProjectName}
Id : Amazon.CodePipeline.Model.ActionTypeId
InputArtifactDetails : Amazon.CodePipeline.Model.ArtifactDetails
OutputArtifactDetails : Amazon.CodePipeline.Model.ArtifactDetails
Settings : Amazon.CodePipeline.Model.ActionTypeSettings
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [CreateCustomActionType](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `CreatePipeline` 與 CLI
下列程式碼範例示範如何使用 `CreatePipeline`。
------
#### [ CLI ]
**AWS CLI**
**建立管道**
此範例使用已建立的 JSON 檔案 （此處名為 MySecondPipeline.json) AWS CodePipeline 中建立管道，其中包含管道的結構。如需建立管道需求的詳細資訊，包括 檔案的結構，請參閱 AWS CodePipeline 使用者指南。
命令：
```
aws codepipeline create-pipeline --cli-input-json file://MySecondPipeline.json
```
JSON 檔案範例內容：
```
{
"pipeline": {
"roleArn": "arn:aws:iam::111111111111:role/AWS-CodePipeline-Service",
"stages": [
{
"name": "Source",
"actions": [
{
"inputArtifacts": [],
"name": "Source",
"actionTypeId": {
"category": "Source",
"owner": "AWS",
"version": "1",
"provider": "S3"
},
"outputArtifacts": [
{
"name": "MyApp"
}
],
"configuration": {
"S3Bucket": "awscodepipeline-demo-bucket",
"S3ObjectKey": "aws-codepipeline-s3-aws-codedeploy_linux.zip"
},
"runOrder": 1
}
]
},
{
"name": "Beta",
"actions": [
{
"inputArtifacts": [
{
"name": "MyApp"
}
],
"name": "CodePipelineDemoFleet",
"actionTypeId": {
"category": "Deploy",
"owner": "AWS",
"version": "1",
"provider": "CodeDeploy"
},
"outputArtifacts": [],
"configuration": {
"ApplicationName": "CodePipelineDemoApplication",
"DeploymentGroupName": "CodePipelineDemoFleet"
},
"runOrder": 1
}
]
}
],
"artifactStore": {
"type": "S3",
"location": "codepipeline-us-east-1-11EXAMPLE11"
},
"name": "MySecondPipeline",
"version": 1
}
}
```
輸出：
```
This command returns the structure of the pipeline.
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [CreatePipeline](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/create-pipeline.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例會使用指定的設定來建立新的管道。**
```
$pipeline = New-Object Amazon.CodePipeline.Model.PipelineDeclaration
$sourceStageAction = New-Object Amazon.CodePipeline.Model.ActionDeclaration
$deployStageAction = New-Object Amazon.CodePipeline.Model.ActionDeclaration
$sourceStageActionOutputArtifact = New-Object Amazon.CodePipeline.Model.OutputArtifact
$sourceStageActionOutputArtifact.Name = "MyApp"
$sourceStageAction.ActionTypeId = @{"Category" = "Source"; "Owner" = "AWS"; "Provider" = "S3"; "Version" = 1}
$sourceStageAction.Configuration.Add("S3Bucket", "amzn-s3-demo-bucket")
$sourceStageAction.Configuration.Add("S3ObjectKey", "my-object-key-name.zip")
$sourceStageAction.OutputArtifacts.Add($sourceStageActionOutputArtifact)
$sourceStageAction.Name = "Source"
$deployStageActionInputArtifact = New-Object Amazon.CodePipeline.Model.InputArtifact
$deployStageActionInputArtifact.Name = "MyApp"
$deployStageAction.ActionTypeId = @{"Category" = "Deploy"; "Owner" = "AWS"; "Provider" = "CodeDeploy"; "Version" = 1}
$deployStageAction.Configuration.Add("ApplicationName", "CodePipelineDemoApplication")
$deployStageAction.Configuration.Add("DeploymentGroupName", "CodePipelineDemoFleet")
$deployStageAction.InputArtifacts.Add($deployStageActionInputArtifact)
$deployStageAction.Name = "CodePipelineDemoFleet"
$sourceStage = New-Object Amazon.CodePipeline.Model.StageDeclaration
$deployStage = New-Object Amazon.CodePipeline.Model.StageDeclaration
$sourceStage.Name = "Source"
$deployStage.Name = "Beta"
$sourceStage.Actions.Add($sourceStageAction)
$deployStage.Actions.Add($deployStageAction)
$pipeline.ArtifactStore = @{"Location" = "amzn-s3-demo-bucket"; "Type" = "S3"}
$pipeline.Name = "CodePipelineDemo"
$pipeline.RoleArn = "arn:aws:iam::80398EXAMPLE:role/CodePipelineServiceRole"
$pipeline.Stages.Add($sourceStage)
$pipeline.Stages.Add($deployStage)
$pipeline.Version = 1
New-CPPipeline -Pipeline $pipeline
```
**輸出：**
```
ArtifactStore : Amazon.CodePipeline.Model.ArtifactStore
Name : CodePipelineDemo
RoleArn : arn:aws:iam::80398EXAMPLE:role/CodePipelineServiceRole
Stages : {Source, Beta}
Version : 1
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [CreatePipeline](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例會使用指定的設定來建立新的管道。**
```
$pipeline = New-Object Amazon.CodePipeline.Model.PipelineDeclaration
$sourceStageAction = New-Object Amazon.CodePipeline.Model.ActionDeclaration
$deployStageAction = New-Object Amazon.CodePipeline.Model.ActionDeclaration
$sourceStageActionOutputArtifact = New-Object Amazon.CodePipeline.Model.OutputArtifact
$sourceStageActionOutputArtifact.Name = "MyApp"
$sourceStageAction.ActionTypeId = @{"Category" = "Source"; "Owner" = "AWS"; "Provider" = "S3"; "Version" = 1}
$sourceStageAction.Configuration.Add("S3Bucket", "amzn-s3-demo-bucket")
$sourceStageAction.Configuration.Add("S3ObjectKey", "my-object-key-name.zip")
$sourceStageAction.OutputArtifacts.Add($sourceStageActionOutputArtifact)
$sourceStageAction.Name = "Source"
$deployStageActionInputArtifact = New-Object Amazon.CodePipeline.Model.InputArtifact
$deployStageActionInputArtifact.Name = "MyApp"
$deployStageAction.ActionTypeId = @{"Category" = "Deploy"; "Owner" = "AWS"; "Provider" = "CodeDeploy"; "Version" = 1}
$deployStageAction.Configuration.Add("ApplicationName", "CodePipelineDemoApplication")
$deployStageAction.Configuration.Add("DeploymentGroupName", "CodePipelineDemoFleet")
$deployStageAction.InputArtifacts.Add($deployStageActionInputArtifact)
$deployStageAction.Name = "CodePipelineDemoFleet"
$sourceStage = New-Object Amazon.CodePipeline.Model.StageDeclaration
$deployStage = New-Object Amazon.CodePipeline.Model.StageDeclaration
$sourceStage.Name = "Source"
$deployStage.Name = "Beta"
$sourceStage.Actions.Add($sourceStageAction)
$deployStage.Actions.Add($deployStageAction)
$pipeline.ArtifactStore = @{"Location" = "amzn-s3-demo-bucket"; "Type" = "S3"}
$pipeline.Name = "CodePipelineDemo"
$pipeline.RoleArn = "arn:aws:iam::80398EXAMPLE:role/CodePipelineServiceRole"
$pipeline.Stages.Add($sourceStage)
$pipeline.Stages.Add($deployStage)
$pipeline.Version = 1
New-CPPipeline -Pipeline $pipeline
```
**輸出：**
```
ArtifactStore : Amazon.CodePipeline.Model.ArtifactStore
Name : CodePipelineDemo
RoleArn : arn:aws:iam::80398EXAMPLE:role/CodePipelineServiceRole
Stages : {Source, Beta}
Version : 1
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [CreatePipeline](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `DeleteCustomActionType` 與 CLI
下列程式碼範例示範如何使用 `DeleteCustomActionType`。
------
#### [ CLI ]
**AWS CLI**
**建立自訂動作**
此範例使用已建立的 JSON 檔案 （此處名為 DeleteMyCustomAction.json) 刪除 AWS CodePipeline 中的自訂動作，其中包含要刪除的動作類型、提供者名稱和版本編號。使用 list-action-types 命令檢視類別、版本和提供者的正確值。
命令：
```
aws codepipeline delete-custom-action-type --cli-input-json file://DeleteMyCustomAction.json
```
JSON 檔案範例內容：
```
{
"category": "Build",
"version": "1",
"provider": "MyJenkinsProviderName"
}
```
輸出：
```
None.
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DeleteCustomActionType](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/delete-custom-action-type.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例會刪除指定的自訂動作。繼續之前，此命令會先提示確認。新增 -Force 切換變數可刪除自訂動作，無需提示。**
```
Remove-CPCustomActionType -Category Build -Provider MyBuildProviderName -Version 1
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [DeleteCustomActionType](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例會刪除指定的自訂動作。繼續之前，此命令會先提示確認。新增 -Force 切換變數可刪除自訂動作，無需提示。**
```
Remove-CPCustomActionType -Category Build -Provider MyBuildProviderName -Version 1
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DeleteCustomActionType](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `DeletePipeline` 與 CLI
下列程式碼範例示範如何使用 `DeletePipeline`。
------
#### [ CLI ]
**AWS CLI**
**刪除管道**
此範例會從CodePipeline 刪除名為 MySecondPipeline 的管道。 AWS CodePipeline 使用 list-pipelines 命令來檢視與 AWS 您的帳戶相關聯的管道清單。
命令：
```
aws codepipeline delete-pipeline --name MySecondPipeline
```
輸出：
```
None.
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DeletePipeline](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/delete-pipeline.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例會刪除指定的管道。繼續之前，此命令會先提示確認。新增 -Force 切換變數可刪除管道，無需提示。**
```
Remove-CPPipeline -Name CodePipelineDemo
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [DeletePipeline](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例會刪除指定的管道。繼續之前，此命令會先提示確認。新增 -Force 切換變數可刪除管道，無需提示。**
```
Remove-CPPipeline -Name CodePipelineDemo
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DeletePipeline](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `DisableStageTransition` 與 CLI
下列程式碼範例示範如何使用 `DisableStageTransition`。
------
#### [ CLI ]
**AWS CLI**
**停用到管道中階段的轉換**
此範例會停用轉換為CodePipeline 中 MyFirstPipeline AWS CodePipeline 管道的 Beta 階段。
命令：
```
aws codepipeline disable-stage-transition --pipeline-name MyFirstPipeline --stage-name Beta --transition-type Inbound
```
輸出：
```
None.
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DisableStageTransition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/disable-stage-transition.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例會停用指定管道中指定階段的傳入轉換。**
```
Disable-CPStageTransition -PipelineName CodePipelineDemo -Reason "Disabling temporarily." -StageName Beta -TransitionType Inbound
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [DisableStageTransition](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例會停用指定管道中指定階段的傳入轉換。**
```
Disable-CPStageTransition -PipelineName CodePipelineDemo -Reason "Disabling temporarily." -StageName Beta -TransitionType Inbound
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DisableStageTransition](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `EnableStageTransition` 與 CLI
下列程式碼範例示範如何使用 `EnableStageTransition`。
------
#### [ CLI ]
**AWS CLI**
**啟用到管道中階段的轉換**
此範例可讓 轉換至 CodePipeline 中 MyFirstPipeline AWS CodePipeline 管道的 Beta 階段。
命令：
```
aws codepipeline enable-stage-transition --pipeline-name MyFirstPipeline --stage-name Beta --transition-type Inbound
```
輸出：
```
None.
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [EnableStageTransition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/enable-stage-transition.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例會啟用指定管道中指定階段的傳入轉換。**
```
Enable-CPStageTransition -PipelineName CodePipelineDemo -StageName Beta -TransitionType Inbound
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [EnableStageTransition](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例會啟用指定管道中指定階段的傳入轉換。**
```
Enable-CPStageTransition -PipelineName CodePipelineDemo -StageName Beta -TransitionType Inbound
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [EnableStageTransition](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `GetJobDetails` 與 CLI
下列程式碼範例示範如何使用 `GetJobDetails`。
------
#### [ CLI ]
**AWS CLI**
**取得任務的詳細資訊**
此範例傳回其 ID 以 f4f4ff82-2d11-EXAMPLE 表示之任務的詳細資訊。此命令僅用於自訂動作。呼叫此命令時， AWS CodePipeline 會傳回用於存放管道成品之 Amazon S3 儲存貯體的臨時登入資料，如果自訂動作需要的話。如果定義了任何秘密值，此命令也會傳回為動作定義的任何秘密值。
命令：
```
aws codepipeline get-job-details --job-id f4f4ff82-2d11-EXAMPLE
```
輸出：
```
{
"jobDetails": {
"accountId": "111111111111",
"data": {
"actionConfiguration": {
"__type": "ActionConfiguration",
"configuration": {
"ProjectName": "MyJenkinsExampleTestProject"
}
},
"actionTypeId": {
"__type": "ActionTypeId",
"category": "Test",
"owner": "Custom",
"provider": "MyJenkinsProviderName",
"version": "1"
},
"artifactCredentials": {
"__type": "AWSSessionCredentials",
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"secretAccessKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
"sessionToken": "fICCQD6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb20wHhcNMTEwNDI1MjA0NTIxWhcNMTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMaK0dn+a4GmWIWJ21uUSfwfEvySWtC2XADZ4nB+BLYgVIk60CpiwsZ3G93vUEIO3IyNoH/f0wYK8m9TrDHudUZg3qX4waLG5M43q7Wgc/MbQITxOUSQv7c7ugFFDzQGBzZswY6786m86gpEIbb3OhjZnzcvQAaRHhdlQWIMm2nrAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAtCu4nUhVVxYUntneD9+h8Mg9q6q+auNKyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0FkbFFBjvSfpJIlJ00zbhNYS5f6GuoEDmFJl0ZxBHjJnyp378OD8uTs7fLvjx79LjSTbNYiytVbZPQUQ5Yaxu2jXnimvw3rrszlaEXAMPLE="
},
"inputArtifacts": [
{
"__type": "Artifact",
"location": {
"s3Location": {
"bucketName": "codepipeline-us-east-1-11EXAMPLE11",
"objectKey": "MySecondPipeline/MyAppBuild/EXAMPLE"
},
"type": "S3"
},
"name": "MyAppBuild"
}
],
"outputArtifacts": [],
"pipelineContext": {
"__type": "PipelineContext",
"action": {
"name": "MyJenkinsTest-Action"
},
"pipelineName": "MySecondPipeline",
"stage": {
"name": "Testing"
}
}
},
"id": "f4f4ff82-2d11-EXAMPLE"
}
}
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetJobDetails](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/get-job-details.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例會取得指定任務的一般資訊。**
```
Get-CPJobDetail -JobId f570dc12-5ef3-44bc-945a-6e133EXAMPLE
```
**輸出：**
```
AccountId Data Id
--------- ---- --
80398EXAMPLE Amazon.CodePipeline.Model.JobData f570dc12-5ef3-44bc-945a-6e133EXAMPLE
```
**範例 2：此範例會取得指定任務的詳細資訊。**
```
$jobDetails = Get-CPJobDetail -JobId f570dc12-5ef3-44bc-945a-6e133EXAMPLE
Write-Output ("For Job " + $jobDetails.Id + ":")
Write-Output (" AccountId = " + $jobDetails.AccountId)
$jobData = $jobDetails.Data
Write-Output (" Configuration:")
ForEach ($key in $jobData.ActionConfiguration.Keys) {
$value = $jobData.ActionConfiguration.$key
Write-Output (" " + $key + " = " + $value)
}
Write-Output (" ActionTypeId:")
Write-Output (" Category = " + $jobData.ActionTypeId.Category)
Write-Output (" Owner = " + $jobData.ActionTypeId.Owner)
Write-Output (" Provider = " + $jobData.ActionTypeId.Provider)
Write-Output (" Version = " + $jobData.ActionTypeId.Version)
Write-Output (" ArtifactCredentials:")
Write-Output (" AccessKeyId = " + $jobData.ArtifactCredentials.AccessKeyId)
Write-Output (" SecretAccessKey = " + $jobData.ArtifactCredentials.SecretAccessKey)
Write-Output (" SessionToken = " + $jobData.ArtifactCredentials.SessionToken)
Write-Output (" InputArtifacts:")
ForEach ($ia in $jobData.InputArtifacts) {
Write-Output (" " + $ia.Name)
}
Write-Output (" OutputArtifacts:")
ForEach ($oa in $jobData.OutputArtifacts) {
Write-Output (" " + $oa.Name)
}
Write-Output (" PipelineContext:")
$context = $jobData.PipelineContext
Write-Output (" Name = " + $context.Action.Name)
Write-Output (" PipelineName = " + $context.PipelineName)
Write-Output (" Stage = " + $context.Stage.Name)
```
**輸出：**
```
For Job f570dc12-5ef3-44bc-945a-6e133EXAMPLE:
AccountId = 80398EXAMPLE
Configuration:
ActionTypeId:
Category = Build
Owner = Custom
Provider = MyCustomProviderName
Version = 1
ArtifactCredentials:
AccessKeyId = ASIAIEI3...IXI6YREX
SecretAccessKey = cqAFDhEi...RdQyfa2u
SessionToken = AQoDYXdz...5u+lsAU=
InputArtifacts:
MyApp
OutputArtifacts:
MyAppBuild
PipelineContext:
Name = Build
PipelineName = CodePipelineDemo
Stage = Build
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [GetJobDetails](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例會取得指定任務的一般資訊。**
```
Get-CPJobDetail -JobId f570dc12-5ef3-44bc-945a-6e133EXAMPLE
```
**輸出：**
```
AccountId Data Id
--------- ---- --
80398EXAMPLE Amazon.CodePipeline.Model.JobData f570dc12-5ef3-44bc-945a-6e133EXAMPLE
```
**範例 2：此範例會取得指定任務的詳細資訊。**
```
$jobDetails = Get-CPJobDetail -JobId f570dc12-5ef3-44bc-945a-6e133EXAMPLE
Write-Output ("For Job " + $jobDetails.Id + ":")
Write-Output (" AccountId = " + $jobDetails.AccountId)
$jobData = $jobDetails.Data
Write-Output (" Configuration:")
ForEach ($key in $jobData.ActionConfiguration.Keys) {
$value = $jobData.ActionConfiguration.$key
Write-Output (" " + $key + " = " + $value)
}
Write-Output (" ActionTypeId:")
Write-Output (" Category = " + $jobData.ActionTypeId.Category)
Write-Output (" Owner = " + $jobData.ActionTypeId.Owner)
Write-Output (" Provider = " + $jobData.ActionTypeId.Provider)
Write-Output (" Version = " + $jobData.ActionTypeId.Version)
Write-Output (" ArtifactCredentials:")
Write-Output (" AccessKeyId = " + $jobData.ArtifactCredentials.AccessKeyId)
Write-Output (" SecretAccessKey = " + $jobData.ArtifactCredentials.SecretAccessKey)
Write-Output (" SessionToken = " + $jobData.ArtifactCredentials.SessionToken)
Write-Output (" InputArtifacts:")
ForEach ($ia in $jobData.InputArtifacts) {
Write-Output (" " + $ia.Name)
}
Write-Output (" OutputArtifacts:")
ForEach ($oa in $jobData.OutputArtifacts) {
Write-Output (" " + $oa.Name)
}
Write-Output (" PipelineContext:")
$context = $jobData.PipelineContext
Write-Output (" Name = " + $context.Action.Name)
Write-Output (" PipelineName = " + $context.PipelineName)
Write-Output (" Stage = " + $context.Stage.Name)
```
**輸出：**
```
For Job f570dc12-5ef3-44bc-945a-6e133EXAMPLE:
AccountId = 80398EXAMPLE
Configuration:
ActionTypeId:
Category = Build
Owner = Custom
Provider = MyCustomProviderName
Version = 1
ArtifactCredentials:
AccessKeyId = ASIAIEI3...IXI6YREX
SecretAccessKey = cqAFDhEi...RdQyfa2u
SessionToken = AQoDYXdz...5u+lsAU=
InputArtifacts:
MyApp
OutputArtifacts:
MyAppBuild
PipelineContext:
Name = Build
PipelineName = CodePipelineDemo
Stage = Build
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [GetJobDetails](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `GetPipeline` 與 CLI
下列程式碼範例示範如何使用 `GetPipeline`。
------
#### [ CLI ]
**AWS CLI**
**檢視管道的結構**
此範例會傳回名為 MyFirstPipeline 之管道的結構。
命令：
```
aws codepipeline get-pipeline --name MyFirstPipeline
```
輸出：
```
{
"pipeline": {
"roleArn": "arn:aws:iam::111111111111:role/AWS-CodePipeline-Service",
"stages": [
{
"name": "Source",
"actions": [
{
"inputArtifacts": [],
"name": "Source",
"actionTypeId": {
"category": "Source",
"owner": "AWS",
"version": "1",
"provider": "S3"
},
"outputArtifacts": [
{
"name": "MyApp"
}
],
"configuration": {
"S3Bucket": "awscodepipeline-demo-bucket",
"S3ObjectKey": "aws-codepipeline-s3-aws-codedeploy_linux.zip"
},
"runOrder": 1
}
]
},
{
"name": "Beta",
"actions": [
{
"inputArtifacts": [
{
"name": "MyApp"
}
],
"name": "CodePipelineDemoFleet",
"actionTypeId": {
"category": "Deploy",
"owner": "AWS",
"version": "1",
"provider": "CodeDeploy"
},
"outputArtifacts": [],
"configuration": {
"ApplicationName": "CodePipelineDemoApplication",
"DeploymentGroupName": "CodePipelineDemoFleet"
},
"runOrder": 1
}
]
}
],
"artifactStore": {
"type": "S3",
"location": "codepipeline-us-east-1-11EXAMPLE11"
},
"name": "MyFirstPipeline",
"version": 1
}
}
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetPipeline](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/get-pipeline.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例會取得指定管道的一般資訊。**
```
Get-CPPipeline -Name CodePipelineDemo -Version 1
```
**輸出：**
```
ArtifactStore : Amazon.CodePipeline.Model.ArtifactStore
Name : CodePipelineDemo
RoleArn : arn:aws:iam::80398EXAMPLE:role/CodePipelineServiceRole
Stages : {Source, Build, Beta, TestStage}
Version : 1
```
**範例 2：此範例會取得指定管道的詳細資訊。**
```
$pipeline = Get-CPPipeline -Name CodePipelineDemo
Write-Output ("Name = " + $pipeline.Name)
Write-Output ("RoleArn = " + $pipeline.RoleArn)
Write-Output ("Version = " + $pipeline.Version)
Write-Output ("ArtifactStore:")
Write-Output (" Location = " + $pipeline.ArtifactStore.Location)
Write-Output (" Type = " + $pipeline.ArtifactStore.Type.Value)
Write-Output ("Stages:")
ForEach ($stage in $pipeline.Stages) {
Write-Output (" Name = " + $stage.Name)
Write-Output (" Actions:")
ForEach ($action in $stage.Actions) {
Write-Output (" Name = " + $action.Name)
Write-Output (" Category = " + $action.ActionTypeId.Category)
Write-Output (" Owner = " + $action.ActionTypeId.Owner)
Write-Output (" Provider = " + $action.ActionTypeId.Provider)
Write-Output (" Version = " + $action.ActionTypeId.Version)
Write-Output (" Configuration:")
ForEach ($key in $action.Configuration.Keys) {
$value = $action.Configuration.$key
Write-Output (" " + $key + " = " + $value)
}
Write-Output (" InputArtifacts:")
ForEach ($ia in $action.InputArtifacts) {
Write-Output (" " + $ia.Name)
}
ForEach ($oa in $action.OutputArtifacts) {
Write-Output (" " + $oa.Name)
}
Write-Output (" RunOrder = " + $action.RunOrder)
}
}
```
**輸出：**
```
Name = CodePipelineDemo
RoleArn = arn:aws:iam::80398EXAMPLE:role/CodePipelineServiceRole
Version = 3
ArtifactStore:
Location = amzn-s3-demo-bucket
Type = S3
Stages:
Name = Source
Actions:
Name = Source
Category = Source
Owner = ThirdParty
Provider = GitHub
Version = 1
Configuration:
Branch = master
OAuthToken = ****
Owner = my-user-name
Repo = MyRepoName
InputArtifacts:
MyApp
RunOrder = 1
Name = Build
Actions:
Name = Build
Category = Build
Owner = Custom
Provider = MyCustomProviderName
Version = 1
Configuration:
ProjectName = MyProjectName
InputArtifacts:
MyApp
MyAppBuild
RunOrder = 1
Name = Beta
Actions:
Name = CodePipelineDemoFleet
Category = Deploy
Owner = AWS
Provider = CodeDeploy
Version = 1
Configuration:
ApplicationName = CodePipelineDemoApplication
DeploymentGroupName = CodePipelineDemoFleet
InputArtifacts:
MyAppBuild
RunOrder = 1
Name = TestStage
Actions:
Name = MyJenkinsTestAction
Category = Test
Owner = Custom
Provider = MyCustomTestProvider
Version = 1
Configuration:
ProjectName = MyJenkinsProjectName
InputArtifacts:
MyAppBuild
RunOrder = 1
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [GetPipeline](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例會取得指定管道的一般資訊。**
```
Get-CPPipeline -Name CodePipelineDemo -Version 1
```
**輸出：**
```
ArtifactStore : Amazon.CodePipeline.Model.ArtifactStore
Name : CodePipelineDemo
RoleArn : arn:aws:iam::80398EXAMPLE:role/CodePipelineServiceRole
Stages : {Source, Build, Beta, TestStage}
Version : 1
```
**範例 2：此範例會取得指定管道的詳細資訊。**
```
$pipeline = Get-CPPipeline -Name CodePipelineDemo
Write-Output ("Name = " + $pipeline.Name)
Write-Output ("RoleArn = " + $pipeline.RoleArn)
Write-Output ("Version = " + $pipeline.Version)
Write-Output ("ArtifactStore:")
Write-Output (" Location = " + $pipeline.ArtifactStore.Location)
Write-Output (" Type = " + $pipeline.ArtifactStore.Type.Value)
Write-Output ("Stages:")
ForEach ($stage in $pipeline.Stages) {
Write-Output (" Name = " + $stage.Name)
Write-Output (" Actions:")
ForEach ($action in $stage.Actions) {
Write-Output (" Name = " + $action.Name)
Write-Output (" Category = " + $action.ActionTypeId.Category)
Write-Output (" Owner = " + $action.ActionTypeId.Owner)
Write-Output (" Provider = " + $action.ActionTypeId.Provider)
Write-Output (" Version = " + $action.ActionTypeId.Version)
Write-Output (" Configuration:")
ForEach ($key in $action.Configuration.Keys) {
$value = $action.Configuration.$key
Write-Output (" " + $key + " = " + $value)
}
Write-Output (" InputArtifacts:")
ForEach ($ia in $action.InputArtifacts) {
Write-Output (" " + $ia.Name)
}
ForEach ($oa in $action.OutputArtifacts) {
Write-Output (" " + $oa.Name)
}
Write-Output (" RunOrder = " + $action.RunOrder)
}
}
```
**輸出：**
```
Name = CodePipelineDemo
RoleArn = arn:aws:iam::80398EXAMPLE:role/CodePipelineServiceRole
Version = 3
ArtifactStore:
Location = amzn-s3-demo-bucket
Type = S3
Stages:
Name = Source
Actions:
Name = Source
Category = Source
Owner = ThirdParty
Provider = GitHub
Version = 1
Configuration:
Branch = master
OAuthToken = ****
Owner = my-user-name
Repo = MyRepoName
InputArtifacts:
MyApp
RunOrder = 1
Name = Build
Actions:
Name = Build
Category = Build
Owner = Custom
Provider = MyCustomProviderName
Version = 1
Configuration:
ProjectName = MyProjectName
InputArtifacts:
MyApp
MyAppBuild
RunOrder = 1
Name = Beta
Actions:
Name = CodePipelineDemoFleet
Category = Deploy
Owner = AWS
Provider = CodeDeploy
Version = 1
Configuration:
ApplicationName = CodePipelineDemoApplication
DeploymentGroupName = CodePipelineDemoFleet
InputArtifacts:
MyAppBuild
RunOrder = 1
Name = TestStage
Actions:
Name = MyJenkinsTestAction
Category = Test
Owner = Custom
Provider = MyCustomTestProvider
Version = 1
Configuration:
ProjectName = MyJenkinsProjectName
InputArtifacts:
MyAppBuild
RunOrder = 1
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [GetPipeline](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `GetPipelineState` 與 CLI
下列程式碼範例示範如何使用 `GetPipelineState`。
------
#### [ CLI ]
**AWS CLI**
**取得管道狀態的相關資訊**
此範例會傳回名為 MyFirstPipeline 之管道的最新狀態。
命令：
```
aws codepipeline get-pipeline-state --name MyFirstPipeline
```
輸出：
```
{
"created": 1446137312.204,
"pipelineName": "MyFirstPipeline",
"pipelineVersion": 1,
"stageStates": [
{
"actionStates": [
{
"actionName": "Source",
"entityUrl": "https://console.aws.amazon.com/s3/home?#",
"latestExecution": {
"lastStatusChange": 1446137358.328,
"status": "Succeeded"
}
}
],
"stageName": "Source"
},
{
"actionStates": [
{
"actionName": "CodePipelineDemoFleet",
"entityUrl": "https://console.aws.amazon.com/codedeploy/home?#/applications/CodePipelineDemoApplication/deployment-groups/CodePipelineDemoFleet",
"latestExecution": {
"externalExecutionId": "d-EXAMPLE",
"externalExecutionUrl": "https://console.aws.amazon.com/codedeploy/home?#/deployments/d-EXAMPLE",
"lastStatusChange": 1446137493.131,
"status": "Succeeded",
"summary": "Deployment Succeeded"
}
}
],
"inboundTransitionState": {
"enabled": true
},
"stageName": "Beta"
}
],
"updated": 1446137312.204
}
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetPipelineState](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/get-pipeline-state.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例會取得指定之管道階段的一般資訊。**
```
Get-CPPipelineState -Name CodePipelineDemo
```
**輸出：**
```
Created : 8/13/2015 10:17:54 PM
PipelineName : CodePipelineDemo
PipelineVersion : 1
StageStates : {Source, Build, Beta, TestStage}
Updated : 8/13/2015 10:17:54 PM
```
**範例 2：此範例會取得指定之管道狀態的詳細資訊。**
```
ForEach ($stageState in (Get-CPPipelineState -Name $arg).StageStates) {
Write-Output ("For " + $stageState.StageName + ":")
Write-Output (" InboundTransitionState:")
Write-Output (" DisabledReason = " + $stageState.InboundTransitionState.DisabledReason)
Write-Output (" Enabled = " + $stageState.InboundTransitionState.Enabled)
Write-Output (" LastChangedAt = " + $stageState.InboundTransitionState.LastChangedAt)
Write-Output (" LastChangedBy = " + $stageState.InboundTransitionState.LastChangedBy)
Write-Output (" ActionStates:")
ForEach ($actionState in $stageState.ActionStates) {
Write-Output (" For " + $actionState.ActionName + ":")
Write-Output (" CurrentRevision:")
Write-Output (" Created = " + $actionState.CurrentRevision.Created)
Write-Output (" RevisionChangeId = " + $actionState.CurrentRevision.RevisionChangeId)
Write-Output (" RevisionId = " + $actionState.CurrentRevision.RevisionId)
Write-Output (" EntityUrl = " + $actionState.EntityUrl)
Write-Output (" LatestExecution:")
Write-Output (" ErrorDetails:")
Write-Output (" Code = " + $actionState.LatestExecution.ErrorDetails.Code)
Write-Output (" Message = " + $actionState.LatestExecution.ErrorDetails.Message)
Write-Output (" ExternalExecutionId = " + $actionState.LatestExecution.ExternalExecutionId)
Write-Output (" ExternalExecutionUrl = " + $actionState.LatestExecution.ExternalExecutionUrl)
Write-Output (" LastStatusChange = " + $actionState.LatestExecution.LastStatusChange)
Write-Output (" PercentComplete = " + $actionState.LatestExecution.PercentComplete)
Write-Output (" Status = " + $actionState.LatestExecution.Status)
Write-Output (" Summary = " + $actionState.LatestExecution.Summary)
Write-Output (" RevisionUrl = " + $actionState.RevisionUrl)
}
}
```
**輸出：**
```
For Source:
InboundTransitionState:
DisabledReason =
Enabled =
LastChangedAt =
LastChangedBy =
ActionStates:
For Source:
CurrentRevision:
Created =
RevisionChangeId =
RevisionId =
EntityUrl = https://github.com/my-user-name/MyRepoName/tree/master
LatestExecution:
ErrorDetails:
Code =
Message =
ExternalExecutionId =
ExternalExecutionUrl =
LastStatusChange = 07/20/2015 23:28:45
PercentComplete = 0
Status = Succeeded
Summary =
RevisionUrl =
For Build:
InboundTransitionState:
DisabledReason =
Enabled = True
LastChangedAt = 01/01/0001 00:00:00
LastChangedBy =
ActionStates:
For Build:
CurrentRevision:
Created =
RevisionChangeId =
RevisionId =
EntityUrl = http://54.174.131.1EX/job/MyJenkinsDemo
LatestExecution:
ErrorDetails:
Code = TimeoutError
Message = The action failed because a job worker exceeded its time limit. If this is a custom action, make sure that the job worker is configured correctly.
ExternalExecutionId =
ExternalExecutionUrl =
LastStatusChange = 07/21/2015 00:29:29
PercentComplete = 0
Status = Failed
Summary =
RevisionUrl =
For Beta:
InboundTransitionState:
DisabledReason =
Enabled = True
LastChangedAt = 01/01/0001 00:00:00
LastChangedBy =
ActionStates:
For CodePipelineDemoFleet:
CurrentRevision:
Created =
RevisionChangeId =
RevisionId =
EntityUrl = https://console.aws.amazon.com/codedeploy/home?#/applications/CodePipelineDemoApplication/deployment-groups/CodePipelineDemoFleet
LatestExecution:
ErrorDetails:
Code =
Message =
ExternalExecutionId = d-D5LTCZXEX
ExternalExecutionUrl = https://console.aws.amazon.com/codedeploy/home?#/deployments/d-D5LTCZXEX
LastStatusChange = 07/08/2015 22:07:42
PercentComplete = 0
Status = Succeeded
Summary = Deployment Succeeded
RevisionUrl =
For TestStage:
InboundTransitionState:
DisabledReason =
Enabled = True
LastChangedAt = 01/01/0001 00:00:00
LastChangedBy =
ActionStates:
For MyJenkinsTestAction25:
CurrentRevision:
Created =
RevisionChangeId =
RevisionId =
EntityUrl = http://54.174.131.1EX/job/MyJenkinsDemo
LatestExecution:
ErrorDetails:
Code =
Message =
ExternalExecutionId = 5
ExternalExecutionUrl = http://54.174.131.1EX/job/MyJenkinsDemo/5
LastStatusChange = 07/08/2015 22:09:03
PercentComplete = 0
Status = Succeeded
Summary = Finished
RevisionUrl =
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [GetPipelineState](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例會取得指定之管道階段的一般資訊。**
```
Get-CPPipelineState -Name CodePipelineDemo
```
**輸出：**
```
Created : 8/13/2015 10:17:54 PM
PipelineName : CodePipelineDemo
PipelineVersion : 1
StageStates : {Source, Build, Beta, TestStage}
Updated : 8/13/2015 10:17:54 PM
```
**範例 2：此範例會取得指定之管道狀態的詳細資訊。**
```
ForEach ($stageState in (Get-CPPipelineState -Name $arg).StageStates) {
Write-Output ("For " + $stageState.StageName + ":")
Write-Output (" InboundTransitionState:")
Write-Output (" DisabledReason = " + $stageState.InboundTransitionState.DisabledReason)
Write-Output (" Enabled = " + $stageState.InboundTransitionState.Enabled)
Write-Output (" LastChangedAt = " + $stageState.InboundTransitionState.LastChangedAt)
Write-Output (" LastChangedBy = " + $stageState.InboundTransitionState.LastChangedBy)
Write-Output (" ActionStates:")
ForEach ($actionState in $stageState.ActionStates) {
Write-Output (" For " + $actionState.ActionName + ":")
Write-Output (" CurrentRevision:")
Write-Output (" Created = " + $actionState.CurrentRevision.Created)
Write-Output (" RevisionChangeId = " + $actionState.CurrentRevision.RevisionChangeId)
Write-Output (" RevisionId = " + $actionState.CurrentRevision.RevisionId)
Write-Output (" EntityUrl = " + $actionState.EntityUrl)
Write-Output (" LatestExecution:")
Write-Output (" ErrorDetails:")
Write-Output (" Code = " + $actionState.LatestExecution.ErrorDetails.Code)
Write-Output (" Message = " + $actionState.LatestExecution.ErrorDetails.Message)
Write-Output (" ExternalExecutionId = " + $actionState.LatestExecution.ExternalExecutionId)
Write-Output (" ExternalExecutionUrl = " + $actionState.LatestExecution.ExternalExecutionUrl)
Write-Output (" LastStatusChange = " + $actionState.LatestExecution.LastStatusChange)
Write-Output (" PercentComplete = " + $actionState.LatestExecution.PercentComplete)
Write-Output (" Status = " + $actionState.LatestExecution.Status)
Write-Output (" Summary = " + $actionState.LatestExecution.Summary)
Write-Output (" RevisionUrl = " + $actionState.RevisionUrl)
}
}
```
**輸出：**
```
For Source:
InboundTransitionState:
DisabledReason =
Enabled =
LastChangedAt =
LastChangedBy =
ActionStates:
For Source:
CurrentRevision:
Created =
RevisionChangeId =
RevisionId =
EntityUrl = https://github.com/my-user-name/MyRepoName/tree/master
LatestExecution:
ErrorDetails:
Code =
Message =
ExternalExecutionId =
ExternalExecutionUrl =
LastStatusChange = 07/20/2015 23:28:45
PercentComplete = 0
Status = Succeeded
Summary =
RevisionUrl =
For Build:
InboundTransitionState:
DisabledReason =
Enabled = True
LastChangedAt = 01/01/0001 00:00:00
LastChangedBy =
ActionStates:
For Build:
CurrentRevision:
Created =
RevisionChangeId =
RevisionId =
EntityUrl = http://54.174.131.1EX/job/MyJenkinsDemo
LatestExecution:
ErrorDetails:
Code = TimeoutError
Message = The action failed because a job worker exceeded its time limit. If this is a custom action, make sure that the job worker is configured correctly.
ExternalExecutionId =
ExternalExecutionUrl =
LastStatusChange = 07/21/2015 00:29:29
PercentComplete = 0
Status = Failed
Summary =
RevisionUrl =
For Beta:
InboundTransitionState:
DisabledReason =
Enabled = True
LastChangedAt = 01/01/0001 00:00:00
LastChangedBy =
ActionStates:
For CodePipelineDemoFleet:
CurrentRevision:
Created =
RevisionChangeId =
RevisionId =
EntityUrl = https://console.aws.amazon.com/codedeploy/home?#/applications/CodePipelineDemoApplication/deployment-groups/CodePipelineDemoFleet
LatestExecution:
ErrorDetails:
Code =
Message =
ExternalExecutionId = d-D5LTCZXEX
ExternalExecutionUrl = https://console.aws.amazon.com/codedeploy/home?#/deployments/d-D5LTCZXEX
LastStatusChange = 07/08/2015 22:07:42
PercentComplete = 0
Status = Succeeded
Summary = Deployment Succeeded
RevisionUrl =
For TestStage:
InboundTransitionState:
DisabledReason =
Enabled = True
LastChangedAt = 01/01/0001 00:00:00
LastChangedBy =
ActionStates:
For MyJenkinsTestAction25:
CurrentRevision:
Created =
RevisionChangeId =
RevisionId =
EntityUrl = http://54.174.131.1EX/job/MyJenkinsDemo
LatestExecution:
ErrorDetails:
Code =
Message =
ExternalExecutionId = 5
ExternalExecutionUrl = http://54.174.131.1EX/job/MyJenkinsDemo/5
LastStatusChange = 07/08/2015 22:09:03
PercentComplete = 0
Status = Succeeded
Summary = Finished
RevisionUrl =
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [GetPipelineState](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `ListActionTypes` 與 CLI
下列程式碼範例示範如何使用 `ListActionTypes`。
------
#### [ CLI ]
**AWS CLI**
**檢視可用的動作類型**
list-action-types 命令會傳回您 AWS 帳戶可用的所有動作結構。此範例使用 --action-owner-filter 選項僅傳回自訂動作。
命令：
```
aws codepipeline list-action-types --action-owner-filter Custom
```
輸出：
```
{
"actionTypes": [
{
"inputArtifactDetails": {
"maximumCount": 5,
"minimumCount": 0
},
"actionConfigurationProperties": [
{
"secret": false,
"required": true,
"name": "MyJenkinsExampleBuildProject",
"key": true,
"queryable": true
}
],
"outputArtifactDetails": {
"maximumCount": 5,
"minimumCount": 0
},
"id": {
"category": "Build",
"owner": "Custom",
"version": "1",
"provider": "MyJenkinsProviderName"
},
"settings": {
"entityUrlTemplate": "http://192.0.2.4/job/{Config:ProjectName}",
"executionUrlTemplate": "http://192.0.2.4/job/{Config:ProjectName}/{ExternalExecutionId}"
}
},
{
"inputArtifactDetails": {
"maximumCount": 5,
"minimumCount": 0
},
"actionConfigurationProperties": [
{
"secret": false,
"required": true,
"name": "MyJenkinsExampleTestProject",
"key": true,
"queryable": true
}
],
"outputArtifactDetails": {
"maximumCount": 5,
"minimumCount": 0
},
"id": {
"category": "Test",
"owner": "Custom",
"version": "1",
"provider": "MyJenkinsProviderName"
},
"settings": {
"entityUrlTemplate": "http://192.0.2.4/job/{Config:ProjectName}",
"executionUrlTemplate": "http://192.0.2.4/job/{Config:ProjectName}/{ExternalExecutionId}"
}
}
]
}
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [ListActionTypes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/list-action-types.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例會取得指定之擁有者所有可用動作的相關資訊。**
```
ForEach ($actionType in (Get-CPActionType -ActionOwnerFilter AWS)) {
Write-Output ("For Category = " + $actionType.Id.Category + ", Owner = " + $actionType.Id.Owner + ", Provider = " + $actionType.Id.Provider + ", Version = " + $actionType.Id.Version + ":")
Write-Output (" ActionConfigurationProperties:")
ForEach ($acp in $actionType.ActionConfigurationProperties) {
Write-Output (" For " + $acp.Name + ":")
Write-Output (" Description = " + $acp.Description)
Write-Output (" Key = " + $acp.Key)
Write-Output (" Queryable = " + $acp.Queryable)
Write-Output (" Required = " + $acp.Required)
Write-Output (" Secret = " + $acp.Secret)
}
Write-Output (" InputArtifactDetails:")
Write-Output (" MaximumCount = " + $actionType.InputArtifactDetails.MaximumCount)
Write-Output (" MinimumCount = " + $actionType.InputArtifactDetails.MinimumCount)
Write-Output (" OutputArtifactDetails:")
Write-Output (" MaximumCount = " + $actionType.OutputArtifactDetails.MaximumCount)
Write-Output (" MinimumCount = " + $actionType.OutputArtifactDetails.MinimumCount)
Write-Output (" Settings:")
Write-Output (" EntityUrlTemplate = " + $actionType.Settings.EntityUrlTemplate)
Write-Output (" ExecutionUrlTemplate = " + $actionType.Settings.ExecutionUrlTemplate)
}
```
**輸出：**
```
For Category = Deploy, Owner = AWS, Provider = ElasticBeanstalk, Version = 1:
ActionConfigurationProperties:
For ApplicationName:
Description = The AWS Elastic Beanstalk Application name
Key = True
Queryable = False
Required = True
Secret = False
For EnvironmentName:
Description = The AWS Elastic Beanstalk Environment name
Key = True
Queryable = False
Required = True
Secret = False
InputArtifactDetails:
MaximumCount = 1
MinimumCount = 1
OutputArtifactDetails:
MaximumCount = 0
MinimumCount = 0
Settings:
EntityUrlTemplate = https://console.aws.amazon.com/elasticbeanstalk/r/application/{Config:ApplicationName}
ExecutionUrlTemplate = https://console.aws.amazon.com/elasticbeanstalk/r/application/{Config:ApplicationName}
For Category = Deploy, Owner = AWS, Provider = CodeDeploy, Version = 1:
ActionConfigurationProperties:
For ApplicationName:
Description = The AWS CodeDeploy Application name
Key = True
Queryable = False
Required = True
Secret = False
For DeploymentGroupName:
Description = The AWS CodeDeploy Deployment Group name
Key = True
Queryable = False
Required = True
Secret = False
InputArtifactDetails:
MaximumCount = 1
MinimumCount = 1
OutputArtifactDetails:
MaximumCount = 0
MinimumCount = 0
Settings:
EntityUrlTemplate = https://console.aws.amazon.com/codedeploy/home?#/applications/{Config:ApplicationName}/deployment-groups/{Config:DeploymentGroupName}
ExecutionUrlTemplate = https://console.aws.amazon.com/codedeploy/home?#/deployments/{ExternalExecutionId}
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [ListActionTypes](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例會取得指定之擁有者所有可用動作的相關資訊。**
```
ForEach ($actionType in (Get-CPActionType -ActionOwnerFilter AWS)) {
Write-Output ("For Category = " + $actionType.Id.Category + ", Owner = " + $actionType.Id.Owner + ", Provider = " + $actionType.Id.Provider + ", Version = " + $actionType.Id.Version + ":")
Write-Output (" ActionConfigurationProperties:")
ForEach ($acp in $actionType.ActionConfigurationProperties) {
Write-Output (" For " + $acp.Name + ":")
Write-Output (" Description = " + $acp.Description)
Write-Output (" Key = " + $acp.Key)
Write-Output (" Queryable = " + $acp.Queryable)
Write-Output (" Required = " + $acp.Required)
Write-Output (" Secret = " + $acp.Secret)
}
Write-Output (" InputArtifactDetails:")
Write-Output (" MaximumCount = " + $actionType.InputArtifactDetails.MaximumCount)
Write-Output (" MinimumCount = " + $actionType.InputArtifactDetails.MinimumCount)
Write-Output (" OutputArtifactDetails:")
Write-Output (" MaximumCount = " + $actionType.OutputArtifactDetails.MaximumCount)
Write-Output (" MinimumCount = " + $actionType.OutputArtifactDetails.MinimumCount)
Write-Output (" Settings:")
Write-Output (" EntityUrlTemplate = " + $actionType.Settings.EntityUrlTemplate)
Write-Output (" ExecutionUrlTemplate = " + $actionType.Settings.ExecutionUrlTemplate)
}
```
**輸出：**
```
For Category = Deploy, Owner = AWS, Provider = ElasticBeanstalk, Version = 1:
ActionConfigurationProperties:
For ApplicationName:
Description = The AWS Elastic Beanstalk Application name
Key = True
Queryable = False
Required = True
Secret = False
For EnvironmentName:
Description = The AWS Elastic Beanstalk Environment name
Key = True
Queryable = False
Required = True
Secret = False
InputArtifactDetails:
MaximumCount = 1
MinimumCount = 1
OutputArtifactDetails:
MaximumCount = 0
MinimumCount = 0
Settings:
EntityUrlTemplate = https://console.aws.amazon.com/elasticbeanstalk/r/application/{Config:ApplicationName}
ExecutionUrlTemplate = https://console.aws.amazon.com/elasticbeanstalk/r/application/{Config:ApplicationName}
For Category = Deploy, Owner = AWS, Provider = CodeDeploy, Version = 1:
ActionConfigurationProperties:
For ApplicationName:
Description = The AWS CodeDeploy Application name
Key = True
Queryable = False
Required = True
Secret = False
For DeploymentGroupName:
Description = The AWS CodeDeploy Deployment Group name
Key = True
Queryable = False
Required = True
Secret = False
InputArtifactDetails:
MaximumCount = 1
MinimumCount = 1
OutputArtifactDetails:
MaximumCount = 0
MinimumCount = 0
Settings:
EntityUrlTemplate = https://console.aws.amazon.com/codedeploy/home?#/applications/{Config:ApplicationName}/deployment-groups/{Config:DeploymentGroupName}
ExecutionUrlTemplate = https://console.aws.amazon.com/codedeploy/home?#/deployments/{ExternalExecutionId}
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [ListActionTypes](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `ListPipelines` 與 CLI
下列程式碼範例示範如何使用 `ListPipelines`。
------
#### [ CLI ]
**AWS CLI**
**檢視管道清單**
此範例列出與使用者帳戶相關聯的所有 AWS CodePipeline 管道 AWS 。
命令：
```
aws codepipeline list-pipelines
```
輸出：
```
{
"pipelines": [
{
"updated": 1439504274.641,
"version": 1,
"name": "MyFirstPipeline",
"created": 1439504274.641
},
{
"updated": 1436461837.992,
"version": 2,
"name": "MySecondPipeline",
"created": 1436460801.381
}
]
}
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [ListPipelines](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/list-pipelines.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例會取得可用管道的清單。**
```
Get-CPPipelineList
```
**輸出：**
```
Created Name Updated Version
------- ---- ------- -------
8/13/2015 10:17:54 PM CodePipelineDemo 8/13/2015 10:17:54 PM 3
7/8/2015 2:41:53 AM MyFirstPipeline 7/22/2015 9:06:37 PM 7
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [ListPipelines](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例會取得可用管道的清單。**
```
Get-CPPipelineList
```
**輸出：**
```
Created Name Updated Version
------- ---- ------- -------
8/13/2015 10:17:54 PM CodePipelineDemo 8/13/2015 10:17:54 PM 3
7/8/2015 2:41:53 AM MyFirstPipeline 7/22/2015 9:06:37 PM 7
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [ListPipelines](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `PollForJobs` 與 CLI
下列程式碼範例示範如何使用 `PollForJobs`。
------
#### [ CLI ]
**AWS CLI**
**檢視任何可用的任務**
此範例傳回有關任務工作者要執行的任何任務的資訊。此範例使用預先定義的 JSON 檔案 (MyActionTypeInfo.json)，提供任務工作者處理任務之動作類型的相關資訊。此命令僅用於自訂動作。呼叫此命令時， AWS CodePipeline 會傳回用於存放管道成品之 Amazon S3 儲存貯體的臨時登入資料。如果定義了任何秘密值，此命令也會傳回為動作定義的任何秘密值。
命令：
```
aws codepipeline poll-for-jobs --cli-input-json file://MyActionTypeInfo.json
```
JSON 檔案範例內容：
```
{
"actionTypeId": {
"category": "Test",
"owner": "Custom",
"provider": "MyJenkinsProviderName",
"version": "1"
},
"maxBatchSize": 5,
"queryParam": {
"ProjectName": "MyJenkinsTestProject"
}
}
```
輸出：
```
{
"jobs": [
{
"accountId": "111111111111",
"data": {
"actionConfiguration": {
"__type": "ActionConfiguration",
"configuration": {
"ProjectName": "MyJenkinsExampleTestProject"
}
},
"actionTypeId": {
"__type": "ActionTypeId",
"category": "Test",
"owner": "Custom",
"provider": "MyJenkinsProviderName",
"version": "1"
},
"artifactCredentials": {
"__type": "AWSSessionCredentials",
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"secretAccessKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
"sessionToken": "fICCQD6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb20wHhcNMTEwNDI1MjA0NTIxWhcNMTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMaK0dn+a4GmWIWJ21uUSfwfEvySWtC2XADZ4nB+BLYgVIk60CpiwsZ3G93vUEIO3IyNoH/f0wYK8m9TrDHudUZg3qX4waLG5M43q7Wgc/MbQITxOUSQv7c7ugFFDzQGBzZswY6786m86gpEIbb3OhjZnzcvQAaRHhdlQWIMm2nrAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAtCu4nUhVVxYUntneD9+h8Mg9q6q+auNKyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0FkbFFBjvSfpJIlJ00zbhNYS5f6GuoEDmFJl0ZxBHjJnyp378OD8uTs7fLvjx79LjSTbNYiytVbZPQUQ5Yaxu2jXnimvw3rrszlaEXAMPLE="
},
"inputArtifacts": [
{
"__type": "Artifact",
"location": {
"s3Location": {
"bucketName": "codepipeline-us-east-1-11EXAMPLE11",
"objectKey": "MySecondPipeline/MyAppBuild/EXAMPLE"
},
"type": "S3"
},
"name": "MyAppBuild"
}
],
"outputArtifacts": [],
"pipelineContext": {
"__type": "PipelineContext",
"action": {
"name": "MyJenkinsTest-Action"
},
"pipelineName": "MySecondPipeline",
"stage": {
"name": "Testing"
}
}
},
"id": "ef66c259-64f9-EXAMPLE",
"nonce": "3"
}
]
}
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [PollForJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/poll-for-jobs.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例會取得指定動作類別、擁有者、提供者、版本和查詢參數之所有可行任務的相關資訊。**
```
Get-CPActionableJobList -ActionTypeId_Category Build -ActionTypeId_Owner Custom -ActionTypeId_Provider MyCustomProviderName -ActionTypeId_Version 1 -QueryParam @{"ProjectName" = "MyProjectName"}
```
**輸出：**
```
AccountId Data Id Nonce
--------- ---- -- -----
80398EXAMPLE Amazon.CodePipeline.Model.JobData 0de392f5-712d-4f41-ace3-f57a0EXAMPLE 3
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [PollForJobs](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例會取得指定動作類別、擁有者、提供者、版本和查詢參數之所有可行任務的相關資訊。**
```
Get-CPActionableJobList -ActionTypeId_Category Build -ActionTypeId_Owner Custom -ActionTypeId_Provider MyCustomProviderName -ActionTypeId_Version 1 -QueryParam @{"ProjectName" = "MyProjectName"}
```
**輸出：**
```
AccountId Data Id Nonce
--------- ---- -- -----
80398EXAMPLE Amazon.CodePipeline.Model.JobData 0de392f5-712d-4f41-ace3-f57a0EXAMPLE 3
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [PollForJobs](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `StartPipelineExecution` 與 CLI
下列程式碼範例示範如何使用 `StartPipelineExecution`。
------
#### [ CLI ]
**AWS CLI**
**透過管道執行最新的修訂版**
此範例透過名為 "MyFirstPipeline" 的管道，執行管道來源階段中存在的最新修訂版。
命令：
```
aws codepipeline start-pipeline-execution --name MyFirstPipeline
```
輸出：
```
{
"pipelineExecutionId": "3137f7cb-7cf7-EXAMPLE"
}
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [StartPipelineExecution](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/start-pipeline-execution.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例會開始執行指定的管道。**
```
Start-CPPipelineExecution -Name CodePipelineDemo
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [StartPipelineExecution](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例會開始執行指定的管道。**
```
Start-CPPipelineExecution -Name CodePipelineDemo
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [StartPipelineExecution](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `UpdatePipeline` 與 CLI
下列程式碼範例示範如何使用 `UpdatePipeline`。
------
#### [ CLI ]
**AWS CLI**
**更新管道的結構**
此範例搭配使用 update-pipeline 命令和 --cli-input-json 引數。此範例使用預先定義的 JSON 檔案 (MyFirstPipeline.json) 來更新管道結構。 AWS CodePipeline 會辨識 JSON 檔案中包含的管道名稱，然後套用管道結構中修改欄位的任何變更來更新管道。
建立預先定義的 JSON 檔案時，使用下列準則：
如果您使用的是使用 get-pipeline 命令擷取的管道結構，您必須從 JSON 檔案的管道結構中移除中繼資料區段 ("metadata": \$1 \$1 行，和其中的 "created"、"pipelineARN" 和 "updated" 欄位)。管道名稱無法變更。
命令：
```
aws codepipeline update-pipeline --cli-input-json file://MyFirstPipeline.json
```
範例 JSON 檔案內容：
```
{
"pipeline": {
"roleArn": "arn:aws:iam::111111111111:role/AWS-CodePipeline-Service",
"stages": [
{
"name": "Source",
"actions": [
{
"inputArtifacts": [],
"name": "Source",
"actionTypeId": {
"category": "Source",
"owner": "AWS",
"version": "1",
"provider": "S3"
},
"outputArtifacts": [
{
"name": "MyApp"
}
],
"configuration": {
"S3Bucket": "awscodepipeline-demo-bucket2",
"S3ObjectKey": "aws-codepipeline-s3-aws-codedeploy_linux.zip"
},
"runOrder": 1
}
]
},
{
"name": "Beta",
"actions": [
{
"inputArtifacts": [
{
"name": "MyApp"
}
],
"name": "CodePipelineDemoFleet",
"actionTypeId": {
"category": "Deploy",
"owner": "AWS",
"version": "1",
"provider": "CodeDeploy"
},
"outputArtifacts": [],
"configuration": {
"ApplicationName": "CodePipelineDemoApplication",
"DeploymentGroupName": "CodePipelineDemoFleet"
},
"runOrder": 1
}
]
}
],
"artifactStore": {
"type": "S3",
"location": "codepipeline-us-east-1-11EXAMPLE11"
},
"name": "MyFirstPipeline",
"version": 1
}
}
```
輸出：
```
{
"pipeline": {
"artifactStore": {
"location": "codepipeline-us-east-1-11EXAMPLE11",
"type": "S3"
},
"name": "MyFirstPipeline",
"roleArn": "arn:aws:iam::111111111111:role/AWS-CodePipeline-Service",
"stages": [
{
"actions": [
{
"actionTypeId": {
"__type": "ActionTypeId",
"category": "Source",
"owner": "AWS",
"provider": "S3",
"version": "1"
},
"configuration": {
"S3Bucket": "awscodepipeline-demo-bucket2",
"S3ObjectKey": "aws-codepipeline-s3-aws-codedeploy_linux.zip"
},
"inputArtifacts": [],
"name": "Source",
"outputArtifacts": [
{
"name": "MyApp"
}
],
"runOrder": 1
}
],
"name": "Source"
},
{
"actions": [
{
"actionTypeId": {
"__type": "ActionTypeId",
"category": "Deploy",
"owner": "AWS",
"provider": "CodeDeploy",
"version": "1"
},
"configuration": {
"ApplicationName": "CodePipelineDemoApplication",
"DeploymentGroupName": "CodePipelineDemoFleet"
},
"inputArtifacts": [
{
"name": "MyApp"
}
],
"name": "CodePipelineDemoFleet",
"outputArtifacts": [],
"runOrder": 1
}
],
"name": "Beta"
}
],
"version": 3
}
}
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [UpdatePipeline](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/update-pipeline.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例會使用指定的設定來更新指定的現有管道。**
```
$pipeline = New-Object Amazon.CodePipeline.Model.PipelineDeclaration
$sourceStageAction = New-Object Amazon.CodePipeline.Model.ActionDeclaration
$deployStageAction = New-Object Amazon.CodePipeline.Model.ActionDeclaration
$sourceStageActionOutputArtifact = New-Object Amazon.CodePipeline.Model.OutputArtifact
$sourceStageActionOutputArtifact.Name = "MyApp"
$sourceStageAction.ActionTypeId = @{"Category" = "Source"; "Owner" = "AWS"; "Provider" = "S3"; "Version" = 1}
$sourceStageAction.Configuration.Add("S3Bucket", "amzn-s3-demo-bucket")
$sourceStageAction.Configuration.Add("S3ObjectKey", "my-object-key-name.zip")
$sourceStageAction.OutputArtifacts.Add($sourceStageActionOutputArtifact)
$sourceStageAction.Name = "Source"
$deployStageActionInputArtifact = New-Object Amazon.CodePipeline.Model.InputArtifact
$deployStageActionInputArtifact.Name = "MyApp"
$deployStageAction.ActionTypeId = @{"Category" = "Deploy"; "Owner" = "AWS"; "Provider" = "CodeDeploy"; "Version" = 1}
$deployStageAction.Configuration.Add("ApplicationName", "CodePipelineDemoApplication")
$deployStageAction.Configuration.Add("DeploymentGroupName", "CodePipelineDemoFleet")
$deployStageAction.InputArtifacts.Add($deployStageActionInputArtifact)
$deployStageAction.Name = "CodePipelineDemoFleet"
$sourceStage = New-Object Amazon.CodePipeline.Model.StageDeclaration
$deployStage = New-Object Amazon.CodePipeline.Model.StageDeclaration
$sourceStage.Name = "MyInputFiles"
$deployStage.Name = "MyTestDeployment"
$sourceStage.Actions.Add($sourceStageAction)
$deployStage.Actions.Add($deployStageAction)
$pipeline.ArtifactStore = @{"Location" = "amzn-s3-demo-bucket"; "Type" = "S3"}
$pipeline.Name = "CodePipelineDemo"
$pipeline.RoleArn = "arn:aws:iam::80398EXAMPLE:role/CodePipelineServiceRole"
$pipeline.Stages.Add($sourceStage)
$pipeline.Stages.Add($deployStage)
$pipeline.Version = 1
Update-CPPipeline -Pipeline $pipeline
```
**輸出：**
```
ArtifactStore : Amazon.CodePipeline.Model.ArtifactStore
Name : CodePipelineDemo
RoleArn : arn:aws:iam::80398EXAMPLE:role/CodePipelineServiceRole
Stages : {InputFiles, TestDeployment}
Version : 2
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [UpdatePipeline](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例會使用指定的設定來更新指定的現有管道。**
```
$pipeline = New-Object Amazon.CodePipeline.Model.PipelineDeclaration
$sourceStageAction = New-Object Amazon.CodePipeline.Model.ActionDeclaration
$deployStageAction = New-Object Amazon.CodePipeline.Model.ActionDeclaration
$sourceStageActionOutputArtifact = New-Object Amazon.CodePipeline.Model.OutputArtifact
$sourceStageActionOutputArtifact.Name = "MyApp"
$sourceStageAction.ActionTypeId = @{"Category" = "Source"; "Owner" = "AWS"; "Provider" = "S3"; "Version" = 1}
$sourceStageAction.Configuration.Add("S3Bucket", "amzn-s3-demo-bucket")
$sourceStageAction.Configuration.Add("S3ObjectKey", "my-object-key-name.zip")
$sourceStageAction.OutputArtifacts.Add($sourceStageActionOutputArtifact)
$sourceStageAction.Name = "Source"
$deployStageActionInputArtifact = New-Object Amazon.CodePipeline.Model.InputArtifact
$deployStageActionInputArtifact.Name = "MyApp"
$deployStageAction.ActionTypeId = @{"Category" = "Deploy"; "Owner" = "AWS"; "Provider" = "CodeDeploy"; "Version" = 1}
$deployStageAction.Configuration.Add("ApplicationName", "CodePipelineDemoApplication")
$deployStageAction.Configuration.Add("DeploymentGroupName", "CodePipelineDemoFleet")
$deployStageAction.InputArtifacts.Add($deployStageActionInputArtifact)
$deployStageAction.Name = "CodePipelineDemoFleet"
$sourceStage = New-Object Amazon.CodePipeline.Model.StageDeclaration
$deployStage = New-Object Amazon.CodePipeline.Model.StageDeclaration
$sourceStage.Name = "MyInputFiles"
$deployStage.Name = "MyTestDeployment"
$sourceStage.Actions.Add($sourceStageAction)
$deployStage.Actions.Add($deployStageAction)
$pipeline.ArtifactStore = @{"Location" = "amzn-s3-demo-bucket"; "Type" = "S3"}
$pipeline.Name = "CodePipelineDemo"
$pipeline.RoleArn = "arn:aws:iam::80398EXAMPLE:role/CodePipelineServiceRole"
$pipeline.Stages.Add($sourceStage)
$pipeline.Stages.Add($deployStage)
$pipeline.Version = 1
Update-CPPipeline -Pipeline $pipeline
```
**輸出：**
```
ArtifactStore : Amazon.CodePipeline.Model.ArtifactStore
Name : CodePipelineDemo
RoleArn : arn:aws:iam::80398EXAMPLE:role/CodePipelineServiceRole
Stages : {InputFiles, TestDeployment}
Version : 2
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [UpdatePipeline](https://docs.aws.amazon.com/powershell/v5/reference)。
------