There are more AWS SDK examples available in the [AWS Doc SDK Examples](https://github.com/awsdocs/aws-doc-sdk-examples) GitHub repo.
# Code examples for CodePipeline using AWS SDKs
The following code examples show you how to use AWS CodePipeline with an AWS software development kit (SDK).
*Actions* are code excerpts from larger programs and must be run in context. While actions show you how to call individual service functions, you can see actions in context in their related scenarios.
**More resources**
+ **[ CodePipeline User Guide](https://docs.aws.amazon.com/codepipeline/latest/userguide/welcome.html)** – More information about CodePipeline.
+ **[CodePipeline API Reference](https://docs.aws.amazon.com/codepipeline/latest/APIReference/Welcome.html)** – Details about all available CodePipeline actions.
+ **[AWS Developer Center](https://aws.amazon.com/developer/code-examples/?awsf.sdk-code-examples-product=product%23)** – Code examples that you can filter by category or full-text search.
+ **[AWS SDK Examples](https://github.com/awsdocs/aws-doc-sdk-examples)** – GitHub repo with complete code in preferred languages. Includes instructions for setting up and running the code.
**Contents**
+ [Basics](codepipeline_code_examples_basics.md)
+ [Actions](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)
# Basic examples for CodePipeline using AWS SDKs
The following code examples show how to use the basics of AWS CodePipeline with AWS SDKs.
**Contents**
+ [Actions](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)
# Actions for CodePipeline using AWS SDKs
The following code examples demonstrate how to perform individual CodePipeline actions with AWS SDKs. Each example includes a link to GitHub, where you can find instructions for setting up and running the code.
The following examples include only the most commonly used actions. For a complete list, see the [AWS CodePipeline API Reference](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)
# Use `AcknowledgeJob` with a CLI
The following code examples show how to use `AcknowledgeJob`.
------
#### [ CLI ]
**AWS CLI**
**To retrieve information about a specified job**
This example returns information about a specified job, including the status of that job if it exists. This is only used for job workers and custom actions. To determine the value of nonce and the job ID, use aws codepipeline poll-for-jobs.
Command:
```
aws codepipeline acknowledge-job --job-id f4f4ff82-2d11-EXAMPLE --nonce 3
```
Output:
```
{
"status": "InProgress"
}
```
+ For API details, see [AcknowledgeJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/acknowledge-job.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example gets the status of the specified job.**
```
Confirm-CPJob -JobId f570dc12-5ef3-44bc-945a-6e133EXAMPLE -Nonce 3
```
**Output:**
```
Value
-----
InProgress
```
+ For API details, see [AcknowledgeJob](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example gets the status of the specified job.**
```
Confirm-CPJob -JobId f570dc12-5ef3-44bc-945a-6e133EXAMPLE -Nonce 3
```
**Output:**
```
Value
-----
InProgress
```
+ For API details, see [AcknowledgeJob](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `CreateCustomActionType` with a CLI
The following code examples show how to use `CreateCustomActionType`.
------
#### [ CLI ]
**AWS CLI**
**To create a custom action**
This example creates a custom action for AWS CodePipeline using an already-created JSON file (here named MyCustomAction.json) that contains the structure of the custom action. For more information about the requirements for creating a custom action, including the structure of the file, see the AWS CodePipeline User Guide.
```
aws codepipeline create-custom-action-type --cli-input-json file://MyCustomAction.json
```
Contents of JSON file `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
}
}
```
This command returns the structure of the custom action.
+ For API details, see [CreateCustomActionType](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/create-custom-action-type.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example creates a new custom action with the specified properties.**
```
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
```
**Output:**
```
ActionConfigurationProperties : {ProjectName}
Id : Amazon.CodePipeline.Model.ActionTypeId
InputArtifactDetails : Amazon.CodePipeline.Model.ArtifactDetails
OutputArtifactDetails : Amazon.CodePipeline.Model.ArtifactDetails
Settings : Amazon.CodePipeline.Model.ActionTypeSettings
```
+ For API details, see [CreateCustomActionType](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example creates a new custom action with the specified properties.**
```
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
```
**Output:**
```
ActionConfigurationProperties : {ProjectName}
Id : Amazon.CodePipeline.Model.ActionTypeId
InputArtifactDetails : Amazon.CodePipeline.Model.ArtifactDetails
OutputArtifactDetails : Amazon.CodePipeline.Model.ArtifactDetails
Settings : Amazon.CodePipeline.Model.ActionTypeSettings
```
+ For API details, see [CreateCustomActionType](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `CreatePipeline` with a CLI
The following code examples show how to use `CreatePipeline`.
------
#### [ CLI ]
**AWS CLI**
**To create a pipeline**
This example creates a pipeline in AWS CodePipeline using an already-created JSON file (here named MySecondPipeline.json) that contains the structure of the pipeline. For more information about the requirements for creating a pipeline, including the structure of the file, see the AWS CodePipeline User Guide.
Command:
```
aws codepipeline create-pipeline --cli-input-json file://MySecondPipeline.json
```
JSON file sample contents:
```
{
"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
}
}
```
Output:
```
This command returns the structure of the pipeline.
```
+ For API details, see [CreatePipeline](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/create-pipeline.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This examples creates a new pipeline with the specified settings.**
```
$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
```
**Output:**
```
ArtifactStore : Amazon.CodePipeline.Model.ArtifactStore
Name : CodePipelineDemo
RoleArn : arn:aws:iam::80398EXAMPLE:role/CodePipelineServiceRole
Stages : {Source, Beta}
Version : 1
```
+ For API details, see [CreatePipeline](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This examples creates a new pipeline with the specified settings.**
```
$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
```
**Output:**
```
ArtifactStore : Amazon.CodePipeline.Model.ArtifactStore
Name : CodePipelineDemo
RoleArn : arn:aws:iam::80398EXAMPLE:role/CodePipelineServiceRole
Stages : {Source, Beta}
Version : 1
```
+ For API details, see [CreatePipeline](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `DeleteCustomActionType` with a CLI
The following code examples show how to use `DeleteCustomActionType`.
------
#### [ CLI ]
**AWS CLI**
**To delete a custom action**
This example deletes a custom action in AWS CodePipeline by using an already-created JSON file (here named DeleteMyCustomAction.json) that contains the action type, provider name, and version number of the action to be deleted. Use the list-action-types command to view the correct values for category, version, and provider.
Command:
```
aws codepipeline delete-custom-action-type --cli-input-json file://DeleteMyCustomAction.json
```
JSON file sample contents:
```
{
"category": "Build",
"version": "1",
"provider": "MyJenkinsProviderName"
}
```
Output:
```
None.
```
+ For API details, see [DeleteCustomActionType](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/delete-custom-action-type.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example deletes the specified custom action. The command will prompt for confirmation before proceeding. Add the -Force parameter to delete the custom action without a prompt.**
```
Remove-CPCustomActionType -Category Build -Provider MyBuildProviderName -Version 1
```
+ For API details, see [DeleteCustomActionType](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example deletes the specified custom action. The command will prompt for confirmation before proceeding. Add the -Force parameter to delete the custom action without a prompt.**
```
Remove-CPCustomActionType -Category Build -Provider MyBuildProviderName -Version 1
```
+ For API details, see [DeleteCustomActionType](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `DeletePipeline` with a CLI
The following code examples show how to use `DeletePipeline`.
------
#### [ CLI ]
**AWS CLI**
**To delete a pipeline**
This example deletes a pipeline named MySecondPipeline from AWS CodePipeline. Use the list-pipelines command to view a list of pipelines associated with your AWS account.
Command:
```
aws codepipeline delete-pipeline --name MySecondPipeline
```
Output:
```
None.
```
+ For API details, see [DeletePipeline](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/delete-pipeline.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example deletes the specified pipeline. The command will prompt for confirmation before proceeding. Add the -Force parameter to delete the pipeline without a prompt.**
```
Remove-CPPipeline -Name CodePipelineDemo
```
+ For API details, see [DeletePipeline](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example deletes the specified pipeline. The command will prompt for confirmation before proceeding. Add the -Force parameter to delete the pipeline without a prompt.**
```
Remove-CPPipeline -Name CodePipelineDemo
```
+ For API details, see [DeletePipeline](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `DisableStageTransition` with a CLI
The following code examples show how to use `DisableStageTransition`.
------
#### [ CLI ]
**AWS CLI**
**To disable a transition to a stage in a pipeline**
This example disables transitions into the Beta stage of the MyFirstPipeline pipeline in AWS CodePipeline.
Command:
```
aws codepipeline disable-stage-transition --pipeline-name MyFirstPipeline --stage-name Beta --transition-type Inbound
```
Output:
```
None.
```
+ For API details, see [DisableStageTransition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/disable-stage-transition.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example disables the inbound transition for the specified stage in the specified pipeline.**
```
Disable-CPStageTransition -PipelineName CodePipelineDemo -Reason "Disabling temporarily." -StageName Beta -TransitionType Inbound
```
+ For API details, see [DisableStageTransition](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example disables the inbound transition for the specified stage in the specified pipeline.**
```
Disable-CPStageTransition -PipelineName CodePipelineDemo -Reason "Disabling temporarily." -StageName Beta -TransitionType Inbound
```
+ For API details, see [DisableStageTransition](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `EnableStageTransition` with a CLI
The following code examples show how to use `EnableStageTransition`.
------
#### [ CLI ]
**AWS CLI**
**To enable a transition to a stage in a pipeline**
This example enables transitions into the Beta stage of the MyFirstPipeline pipeline in AWS CodePipeline.
Command:
```
aws codepipeline enable-stage-transition --pipeline-name MyFirstPipeline --stage-name Beta --transition-type Inbound
```
Output:
```
None.
```
+ For API details, see [EnableStageTransition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/enable-stage-transition.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example enables the inbound transition for the specified stage in the specified pipeline.**
```
Enable-CPStageTransition -PipelineName CodePipelineDemo -StageName Beta -TransitionType Inbound
```
+ For API details, see [EnableStageTransition](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example enables the inbound transition for the specified stage in the specified pipeline.**
```
Enable-CPStageTransition -PipelineName CodePipelineDemo -StageName Beta -TransitionType Inbound
```
+ For API details, see [EnableStageTransition](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `GetJobDetails` with a CLI
The following code examples show how to use `GetJobDetails`.
------
#### [ CLI ]
**AWS CLI**
**To get details of a job**
This example returns details about a job whose ID is represented by f4f4ff82-2d11-EXAMPLE. This command is only used for custom actions. When this command is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if required for the custom action. This command will also return any secret values defined for the action, if any are defined.
Command:
```
aws codepipeline get-job-details --job-id f4f4ff82-2d11-EXAMPLE
```
Output:
```
{
"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"
}
}
```
+ For API details, see [GetJobDetails](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/get-job-details.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example gets general information about the specified job.**
```
Get-CPJobDetail -JobId f570dc12-5ef3-44bc-945a-6e133EXAMPLE
```
**Output:**
```
AccountId Data Id
--------- ---- --
80398EXAMPLE Amazon.CodePipeline.Model.JobData f570dc12-5ef3-44bc-945a-6e133EXAMPLE
```
**Example 2: This example gets detailed information about the specified job.**
```
$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)
```
**Output:**
```
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
```
+ For API details, see [GetJobDetails](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example gets general information about the specified job.**
```
Get-CPJobDetail -JobId f570dc12-5ef3-44bc-945a-6e133EXAMPLE
```
**Output:**
```
AccountId Data Id
--------- ---- --
80398EXAMPLE Amazon.CodePipeline.Model.JobData f570dc12-5ef3-44bc-945a-6e133EXAMPLE
```
**Example 2: This example gets detailed information about the specified job.**
```
$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)
```
**Output:**
```
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
```
+ For API details, see [GetJobDetails](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `GetPipeline` with a CLI
The following code examples show how to use `GetPipeline`.
------
#### [ CLI ]
**AWS CLI**
**To view the structure of a pipeline**
This example returns the structure of a pipeline named MyFirstPipeline.
Command:
```
aws codepipeline get-pipeline --name MyFirstPipeline
```
Output:
```
{
"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
}
}
```
+ For API details, see [GetPipeline](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/get-pipeline.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example gets general information about the specified pipeline.**
```
Get-CPPipeline -Name CodePipelineDemo -Version 1
```
**Output:**
```
ArtifactStore : Amazon.CodePipeline.Model.ArtifactStore
Name : CodePipelineDemo
RoleArn : arn:aws:iam::80398EXAMPLE:role/CodePipelineServiceRole
Stages : {Source, Build, Beta, TestStage}
Version : 1
```
**Example 2: This example gets detailed information about the specified pipeline.**
```
$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)
}
}
```
**Output:**
```
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
```
+ For API details, see [GetPipeline](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example gets general information about the specified pipeline.**
```
Get-CPPipeline -Name CodePipelineDemo -Version 1
```
**Output:**
```
ArtifactStore : Amazon.CodePipeline.Model.ArtifactStore
Name : CodePipelineDemo
RoleArn : arn:aws:iam::80398EXAMPLE:role/CodePipelineServiceRole
Stages : {Source, Build, Beta, TestStage}
Version : 1
```
**Example 2: This example gets detailed information about the specified pipeline.**
```
$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)
}
}
```
**Output:**
```
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
```
+ For API details, see [GetPipeline](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `GetPipelineState` with a CLI
The following code examples show how to use `GetPipelineState`.
------
#### [ CLI ]
**AWS CLI**
**To get information about the state of a pipeline**
This example returns the most recent state of a pipeline named MyFirstPipeline.
Command:
```
aws codepipeline get-pipeline-state --name MyFirstPipeline
```
Output:
```
{
"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
}
```
+ For API details, see [GetPipelineState](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/get-pipeline-state.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example gets general information about the stages for the specified pipeline.**
```
Get-CPPipelineState -Name CodePipelineDemo
```
**Output:**
```
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
```
**Example 2: This example gets detailed information about the state of the specified pipeline.**
```
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)
}
}
```
**Output:**
```
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 =
```
+ For API details, see [GetPipelineState](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example gets general information about the stages for the specified pipeline.**
```
Get-CPPipelineState -Name CodePipelineDemo
```
**Output:**
```
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
```
**Example 2: This example gets detailed information about the state of the specified pipeline.**
```
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)
}
}
```
**Output:**
```
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 =
```
+ For API details, see [GetPipelineState](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `ListActionTypes` with a CLI
The following code examples show how to use `ListActionTypes`.
------
#### [ CLI ]
**AWS CLI**
**To view the action types available**
Used by itself, the list-action-types command returns the structure of all actions available to your AWS account. This example uses the --action-owner-filter option to return only custom actions.
Command:
```
aws codepipeline list-action-types --action-owner-filter Custom
```
Output:
```
{
"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}"
}
}
]
}
```
+ For API details, see [ListActionTypes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/list-action-types.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example gets information about all available actions for the specified owner.**
```
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)
}
```
**Output:**
```
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}
```
+ For API details, see [ListActionTypes](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example gets information about all available actions for the specified owner.**
```
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)
}
```
**Output:**
```
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}
```
+ For API details, see [ListActionTypes](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `ListPipelines` with a CLI
The following code examples show how to use `ListPipelines`.
------
#### [ CLI ]
**AWS CLI**
**To view a list of pipelines**
This example lists all AWS CodePipeline pipelines associated with the user's AWS account.
Command:
```
aws codepipeline list-pipelines
```
Output:
```
{
"pipelines": [
{
"updated": 1439504274.641,
"version": 1,
"name": "MyFirstPipeline",
"created": 1439504274.641
},
{
"updated": 1436461837.992,
"version": 2,
"name": "MySecondPipeline",
"created": 1436460801.381
}
]
}
```
+ For API details, see [ListPipelines](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/list-pipelines.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example gets a list of available pipelines.**
```
Get-CPPipelineList
```
**Output:**
```
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
```
+ For API details, see [ListPipelines](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example gets a list of available pipelines.**
```
Get-CPPipelineList
```
**Output:**
```
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
```
+ For API details, see [ListPipelines](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `PollForJobs` with a CLI
The following code examples show how to use `PollForJobs`.
------
#### [ CLI ]
**AWS CLI**
**To view any available jobs**
This example returns information about any jobs for a job worker to act upon. This example uses a pre-defined JSON file (MyActionTypeInfo.json) to supply information about the action type for which the job worker processes jobs. This command is only used for custom actions. When this command is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline. This command will also return any secret values defined for the action, if any are defined.
Command:
```
aws codepipeline poll-for-jobs --cli-input-json file://MyActionTypeInfo.json
```
JSON file sample contents:
```
{
"actionTypeId": {
"category": "Test",
"owner": "Custom",
"provider": "MyJenkinsProviderName",
"version": "1"
},
"maxBatchSize": 5,
"queryParam": {
"ProjectName": "MyJenkinsTestProject"
}
}
```
Output:
```
{
"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"
}
]
}
```
+ For API details, see [PollForJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/poll-for-jobs.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example gets information about all actionable jobs for the specified action category, owner, provider, version, and query parameters.**
```
Get-CPActionableJobList -ActionTypeId_Category Build -ActionTypeId_Owner Custom -ActionTypeId_Provider MyCustomProviderName -ActionTypeId_Version 1 -QueryParam @{"ProjectName" = "MyProjectName"}
```
**Output:**
```
AccountId Data Id Nonce
--------- ---- -- -----
80398EXAMPLE Amazon.CodePipeline.Model.JobData 0de392f5-712d-4f41-ace3-f57a0EXAMPLE 3
```
+ For API details, see [PollForJobs](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example gets information about all actionable jobs for the specified action category, owner, provider, version, and query parameters.**
```
Get-CPActionableJobList -ActionTypeId_Category Build -ActionTypeId_Owner Custom -ActionTypeId_Provider MyCustomProviderName -ActionTypeId_Version 1 -QueryParam @{"ProjectName" = "MyProjectName"}
```
**Output:**
```
AccountId Data Id Nonce
--------- ---- -- -----
80398EXAMPLE Amazon.CodePipeline.Model.JobData 0de392f5-712d-4f41-ace3-f57a0EXAMPLE 3
```
+ For API details, see [PollForJobs](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `StartPipelineExecution` with a CLI
The following code examples show how to use `StartPipelineExecution`.
------
#### [ CLI ]
**AWS CLI**
**To run the latest revision through a pipeline**
This example runs the latest revision present in the source stage of a pipeline through the pipeline named "MyFirstPipeline".
Command:
```
aws codepipeline start-pipeline-execution --name MyFirstPipeline
```
Output:
```
{
"pipelineExecutionId": "3137f7cb-7cf7-EXAMPLE"
}
```
+ For API details, see [StartPipelineExecution](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/start-pipeline-execution.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example starts running the specified pipeline.**
```
Start-CPPipelineExecution -Name CodePipelineDemo
```
+ For API details, see [StartPipelineExecution](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example starts running the specified pipeline.**
```
Start-CPPipelineExecution -Name CodePipelineDemo
```
+ For API details, see [StartPipelineExecution](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `UpdatePipeline` with a CLI
The following code examples show how to use `UpdatePipeline`.
------
#### [ CLI ]
**AWS CLI**
**To update the structure of a pipeline**
This example uses the update-pipeline command with the --cli-input-json argument. This example uses a pre-defined JSON file (MyFirstPipeline.json) to update the structure of a pipeline. AWS CodePipeline recognizes the pipeline name contained in the JSON file, and then applies any changes from modified fields in the pipeline structure to update the pipeline.
Use the following guidelines when creating the pre-defined JSON file:
If you are working with a pipeline structure retrieved using the get-pipeline command, you must remove the metadata section from the pipeline structure in the JSON file (the "metadata": \$1 \$1 lines and the "created," "pipelineARN," and "updated" fields within).The pipeline name cannot be changed.
Command:
```
aws codepipeline update-pipeline --cli-input-json file://MyFirstPipeline.json
```
Sample JSON file contents:
```
{
"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
}
}
```
Output:
```
{
"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
}
}
```
+ For API details, see [UpdatePipeline](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/update-pipeline.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example updates the specified existing pipeline with the specified settings.**
```
$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
```
**Output:**
```
ArtifactStore : Amazon.CodePipeline.Model.ArtifactStore
Name : CodePipelineDemo
RoleArn : arn:aws:iam::80398EXAMPLE:role/CodePipelineServiceRole
Stages : {InputFiles, TestDeployment}
Version : 2
```
+ For API details, see [UpdatePipeline](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example updates the specified existing pipeline with the specified settings.**
```
$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
```
**Output:**
```
ArtifactStore : Amazon.CodePipeline.Model.ArtifactStore
Name : CodePipelineDemo
RoleArn : arn:aws:iam::80398EXAMPLE:role/CodePipelineServiceRole
Stages : {InputFiles, TestDeployment}
Version : 2
```
+ For API details, see [UpdatePipeline](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------