Weitere AWS SDK-Beispiele sind im GitHub Repo [AWS Doc SDK Examples](https://github.com/awsdocs/aws-doc-sdk-examples) verfügbar.
Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.
# Grundlegende Beispiele für die Verwendung CodePipeline AWS SDKs
Die folgenden Codebeispiele zeigen, wie die Grundlagen von AWS CodePipeline with verwendet AWS SDKs werden.
**Contents**
+ [Aktionen](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)
# Aktionen zur CodePipeline Verwendung AWS SDKs
Die folgenden Codebeispiele zeigen, wie Sie einzelne CodePipeline Aktionen mit ausführen AWS SDKs. Jedes Beispiel enthält einen Link zu GitHub, wo Sie Anweisungen zum Einrichten und Ausführen des Codes finden.
Die folgenden Beispiele enthalten nur die am häufigsten verwendeten Aktionen. Eine vollständige Liste finden Sie in der [AWS CodePipeline -API-Referenz](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)
# Verwendung von `AcknowledgeJob` mit einer CLI
Die folgenden Code-Beispiele zeigen, wie `AcknowledgeJob` verwendet wird.
------
#### [ CLI ]
**AWS CLI**
**So rufen Sie Informationen zu einem angegebenen Auftrag ab**
In diesem Beispiel werden Informationen zu einem angegebenen Auftrag zurückgegeben, einschließlich des Status dieses Jobs, falls vorhanden. Dieser Befehl wird nur für Auftragsworker und benutzerdefinierte Aktionen verwendet. Verwenden Sie aws poll-for-jobs codepipeline, um den Wert von nonce und die Job-ID zu ermitteln.
Befehl:
```
aws codepipeline acknowledge-job --job-id f4f4ff82-2d11-EXAMPLE --nonce 3
```
Ausgabe:
```
{
"status": "InProgress"
}
```
+ Einzelheiten zur API finden Sie [AcknowledgeJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/acknowledge-job.html)in der *AWS CLI Befehlsreferenz*.
------
#### [ PowerShell ]
**Tools für PowerShell V4**
**Beispiel 1: In diesem Beispiel wird der Status eines bestimmten Auftrags abgerufen.**
```
Confirm-CPJob -JobId f570dc12-5ef3-44bc-945a-6e133EXAMPLE -Nonce 3
```
**Ausgabe:**
```
Value
-----
InProgress
```
+ Einzelheiten zur API finden Sie unter [AcknowledgeJob AWS -Tools für PowerShell](https://docs.aws.amazon.com/powershell/v4/reference)*Cmdlet-Referenz (V4).*
**Tools für V5 PowerShell **
**Beispiel 1: In diesem Beispiel wird der Status eines bestimmten Auftrags abgerufen.**
```
Confirm-CPJob -JobId f570dc12-5ef3-44bc-945a-6e133EXAMPLE -Nonce 3
```
**Ausgabe:**
```
Value
-----
InProgress
```
+ Einzelheiten zur API finden Sie unter [AcknowledgeJob AWS -Tools für PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet-Referenz (*V5).
------
# Verwendung von `CreateCustomActionType` mit einer CLI
Die folgenden Code-Beispiele zeigen, wie `CreateCustomActionType` verwendet wird.
------
#### [ CLI ]
**AWS CLI**
**So erstellen Sie eine benutzerdefinierte Aktion**
In diesem Beispiel wird eine benutzerdefinierte Aktion für die AWS CodePipeline Verwendung einer bereits erstellten JSON-Datei (hier MyCustomAction .json genannt) erstellt, die die Struktur der benutzerdefinierten Aktion enthält. Weitere Informationen zu den Anforderungen für die Erstellung einer benutzerdefinierten Aktion, einschließlich der Struktur der Datei, finden Sie im AWS CodePipeline Benutzerhandbuch.
```
aws codepipeline create-custom-action-type --cli-input-json file://MyCustomAction.json
```
Inhalt der JSON-Datei `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
}
}
```
Dieser Befehl gibt die Struktur der benutzerdefinierten Aktion zurück.
+ Einzelheiten zur API finden Sie [CreateCustomActionType](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/create-custom-action-type.html)in der *AWS CLI Befehlsreferenz*.
------
#### [ PowerShell ]
**Tools für PowerShell V4**
**Beispiel 1: In diesem Beispiel wird eine neue benutzerdefinierte Aktion mit den angegebenen Eigenschaften erstellt.**
```
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
```
**Ausgabe:**
```
ActionConfigurationProperties : {ProjectName}
Id : Amazon.CodePipeline.Model.ActionTypeId
InputArtifactDetails : Amazon.CodePipeline.Model.ArtifactDetails
OutputArtifactDetails : Amazon.CodePipeline.Model.ArtifactDetails
Settings : Amazon.CodePipeline.Model.ActionTypeSettings
```
+ Einzelheiten zur API finden Sie unter [CreateCustomActionType AWS -Tools für PowerShell](https://docs.aws.amazon.com/powershell/v4/reference)*Cmdlet-Referenz (V4).*
**Tools für V5 PowerShell **
**Beispiel 1: In diesem Beispiel wird eine neue benutzerdefinierte Aktion mit den angegebenen Eigenschaften erstellt.**
```
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
```
**Ausgabe:**
```
ActionConfigurationProperties : {ProjectName}
Id : Amazon.CodePipeline.Model.ActionTypeId
InputArtifactDetails : Amazon.CodePipeline.Model.ArtifactDetails
OutputArtifactDetails : Amazon.CodePipeline.Model.ArtifactDetails
Settings : Amazon.CodePipeline.Model.ActionTypeSettings
```
+ Einzelheiten zur API finden Sie unter [CreateCustomActionType AWS -Tools für PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet-Referenz (*V5).
------
# Verwendung von `CreatePipeline` mit einer CLI
Die folgenden Code-Beispiele zeigen, wie `CreatePipeline` verwendet wird.
------
#### [ CLI ]
**AWS CLI**
**Um eine Pipeline zu erstellen**
In diesem Beispiel wird eine Pipeline AWS CodePipeline unter Verwendung einer bereits erstellten JSON-Datei (hier MySecondPipeline .json genannt) erstellt, die die Struktur der Pipeline enthält. Weitere Informationen zu den Anforderungen für die Erstellung einer Pipeline, einschließlich der Struktur der Datei, finden Sie im AWS CodePipeline Benutzerhandbuch.
Befehl:
```
aws codepipeline create-pipeline --cli-input-json file://MySecondPipeline.json
```
Beispielinhalt für die JSON-Datei:
```
{
"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
}
}
```
Ausgabe:
```
This command returns the structure of the pipeline.
```
+ Einzelheiten zur API finden Sie [CreatePipeline](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/create-pipeline.html)in der *AWS CLI Befehlsreferenz*.
------
#### [ PowerShell ]
**Tools für PowerShell V4**
**Beispiel 1: In diesem Beispiel wird eine neue Pipeline mit den angegebenen Einstellungen erstellt.**
```
$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
```
**Ausgabe:**
```
ArtifactStore : Amazon.CodePipeline.Model.ArtifactStore
Name : CodePipelineDemo
RoleArn : arn:aws:iam::80398EXAMPLE:role/CodePipelineServiceRole
Stages : {Source, Beta}
Version : 1
```
+ Einzelheiten zur API finden Sie unter [CreatePipeline AWS -Tools für PowerShell](https://docs.aws.amazon.com/powershell/v4/reference)*Cmdlet-Referenz (V4).*
**Tools für V5 PowerShell **
**Beispiel 1: In diesem Beispiel wird eine neue Pipeline mit den angegebenen Einstellungen erstellt.**
```
$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
```
**Ausgabe:**
```
ArtifactStore : Amazon.CodePipeline.Model.ArtifactStore
Name : CodePipelineDemo
RoleArn : arn:aws:iam::80398EXAMPLE:role/CodePipelineServiceRole
Stages : {Source, Beta}
Version : 1
```
+ Einzelheiten zur API finden Sie unter [CreatePipeline AWS -Tools für PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet-Referenz (*V5).
------
# Verwendung von `DeleteCustomActionType` mit einer CLI
Die folgenden Code-Beispiele zeigen, wie `DeleteCustomActionType` verwendet wird.
------
#### [ CLI ]
**AWS CLI**
**So löschen Sie eine benutzerdefinierte Aktion**
In diesem Beispiel AWS CodePipeline wird eine benutzerdefinierte Aktion mithilfe einer bereits erstellten JSON-Datei (hier DeleteMyCustomAction .json genannt) gelöscht, die den Aktionstyp, den Anbieternamen und die Versionsnummer der zu löschenden Aktion enthält. Verwenden Sie den list-action-types Befehl, um die richtigen Werte für Kategorie, Version und Anbieter anzuzeigen.
Befehl:
```
aws codepipeline delete-custom-action-type --cli-input-json file://DeleteMyCustomAction.json
```
Beispielinhalt für die JSON-Datei:
```
{
"category": "Build",
"version": "1",
"provider": "MyJenkinsProviderName"
}
```
Ausgabe:
```
None.
```
+ Einzelheiten zur API finden Sie [DeleteCustomActionType](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/delete-custom-action-type.html)unter *AWS CLI Befehlsreferenz*.
------
#### [ PowerShell ]
**Tools für PowerShell V4**
**Beispiel 1: In diesem Beispiel wird die angegebene benutzerdefinierte Aktion gelöscht. Der Befehl fordert Sie auf, den Vorgang zu bestätigen, bevor er ausgeführt wird. Fügen Sie den Parameter -Force hinzu, um die benutzerdefinierte Aktion ohne Prompt zu löschen.**
```
Remove-CPCustomActionType -Category Build -Provider MyBuildProviderName -Version 1
```
+ Einzelheiten zur API finden Sie unter [DeleteCustomActionType AWS -Tools für PowerShell](https://docs.aws.amazon.com/powershell/v4/reference)*Cmdlet-Referenz (V4).*
**Tools für V5 PowerShell **
**Beispiel 1: In diesem Beispiel wird die angegebene benutzerdefinierte Aktion gelöscht. Der Befehl fordert Sie auf, den Vorgang zu bestätigen, bevor er ausgeführt wird. Fügen Sie den Parameter -Force hinzu, um die benutzerdefinierte Aktion ohne Prompt zu löschen.**
```
Remove-CPCustomActionType -Category Build -Provider MyBuildProviderName -Version 1
```
+ Einzelheiten zur API finden Sie unter [DeleteCustomActionType AWS -Tools für PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet-Referenz (*V5).
------
# Verwendung von `DeletePipeline` mit einer CLI
Die folgenden Code-Beispiele zeigen, wie `DeletePipeline` verwendet wird.
------
#### [ CLI ]
**AWS CLI**
**Um eine Pipeline zu löschen**
In diesem Beispiel wird eine Pipeline mit dem Namen MySecondPipeline von AWS CodePipeline gelöscht. Verwenden Sie den Befehl list-pipelines, um eine Liste der Pipelines anzuzeigen, die Ihrem Konto zugeordnet sind. AWS
Befehl:
```
aws codepipeline delete-pipeline --name MySecondPipeline
```
Ausgabe:
```
None.
```
+ *Einzelheiten zur API finden Sie unter [DeletePipeline](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/delete-pipeline.html)Befehlsreferenz.AWS CLI *
------
#### [ PowerShell ]
**Tools für PowerShell V4**
**Beispiel 1: In diesem Beispiel wird die angegebene Pipeline gelöscht. Der Befehl fordert Sie auf, den Vorgang zu bestätigen, bevor er ausgeführt wird. Fügen Sie den Parameter -Force hinzu, um die Pipeline ohne Prompt zu löschen.**
```
Remove-CPPipeline -Name CodePipelineDemo
```
+ Einzelheiten zur API finden Sie unter [DeletePipeline AWS -Tools für PowerShell](https://docs.aws.amazon.com/powershell/v4/reference)*Cmdlet-Referenz (V4).*
**Tools für V5 PowerShell **
**Beispiel 1: In diesem Beispiel wird die angegebene Pipeline gelöscht. Der Befehl fordert Sie auf, den Vorgang zu bestätigen, bevor er ausgeführt wird. Fügen Sie den Parameter -Force hinzu, um die Pipeline ohne Prompt zu löschen.**
```
Remove-CPPipeline -Name CodePipelineDemo
```
+ Einzelheiten zur API finden Sie unter [DeletePipeline AWS -Tools für PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet-Referenz (*V5).
------
# Verwendung von `DisableStageTransition` mit einer CLI
Die folgenden Code-Beispiele zeigen, wie `DisableStageTransition` verwendet wird.
------
#### [ CLI ]
**AWS CLI**
**So deaktivieren Sie den Übergang zu einer Phase in einer Pipeline**
In diesem Beispiel werden Übergänge in die Betaphase der MyFirstPipeline Pipeline in AWS CodePipeline deaktiviert.
Befehl:
```
aws codepipeline disable-stage-transition --pipeline-name MyFirstPipeline --stage-name Beta --transition-type Inbound
```
Ausgabe:
```
None.
```
+ Einzelheiten zur API finden Sie [DisableStageTransition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/disable-stage-transition.html)in der *AWS CLI Befehlsreferenz.*
------
#### [ PowerShell ]
**Tools für PowerShell V4**
**Beispiel 1: In diesem Beispiel wird der eingehende Übergang für die angegebene Phase in der angegebenen Pipeline deaktiviert.**
```
Disable-CPStageTransition -PipelineName CodePipelineDemo -Reason "Disabling temporarily." -StageName Beta -TransitionType Inbound
```
+ Einzelheiten zur API finden Sie unter [DisableStageTransition AWS -Tools für PowerShell](https://docs.aws.amazon.com/powershell/v4/reference)*Cmdlet-Referenz (V4).*
**Tools für V5 PowerShell **
**Beispiel 1: In diesem Beispiel wird der eingehende Übergang für die angegebene Phase in der angegebenen Pipeline deaktiviert.**
```
Disable-CPStageTransition -PipelineName CodePipelineDemo -Reason "Disabling temporarily." -StageName Beta -TransitionType Inbound
```
+ Einzelheiten zur API finden Sie unter [DisableStageTransition AWS -Tools für PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet-Referenz (*V5).
------
# Verwendung von `EnableStageTransition` mit einer CLI
Die folgenden Code-Beispiele zeigen, wie `EnableStageTransition` verwendet wird.
------
#### [ CLI ]
**AWS CLI**
**So aktivieren Sie einen Übergang zu einer Phase in einer Pipeline**
Dieses Beispiel ermöglicht Übergänge in die Beta-Phase der MyFirstPipeline Pipeline in AWS CodePipeline.
Befehl:
```
aws codepipeline enable-stage-transition --pipeline-name MyFirstPipeline --stage-name Beta --transition-type Inbound
```
Ausgabe:
```
None.
```
+ Einzelheiten zur API finden Sie [EnableStageTransition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/enable-stage-transition.html)in der *AWS CLI Befehlsreferenz*.
------
#### [ PowerShell ]
**Tools für PowerShell V4**
**Beispiel 1: In diesem Beispiel wird der eingehende Übergang für die angegebene Phase in der angegebenen Pipeline aktiviert.**
```
Enable-CPStageTransition -PipelineName CodePipelineDemo -StageName Beta -TransitionType Inbound
```
+ Einzelheiten zur API finden Sie unter [EnableStageTransition AWS -Tools für PowerShell](https://docs.aws.amazon.com/powershell/v4/reference)*Cmdlet-Referenz (V4).*
**Tools für V5 PowerShell **
**Beispiel 1: In diesem Beispiel wird der eingehende Übergang für die angegebene Phase in der angegebenen Pipeline aktiviert.**
```
Enable-CPStageTransition -PipelineName CodePipelineDemo -StageName Beta -TransitionType Inbound
```
+ Einzelheiten zur API finden Sie unter [EnableStageTransition AWS -Tools für PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet-Referenz (*V5).
------
# Verwendung von `GetJobDetails` mit einer CLI
Die folgenden Code-Beispiele zeigen, wie `GetJobDetails` verwendet wird.
------
#### [ CLI ]
**AWS CLI**
**So rufen Sie Details zu einem Auftrag ab**
In diesem Beispiel werden Details zu einem Auftrag zurückgegeben, dessen ID durch „f4f4ff82-2d11-EXAMPLE“ dargestellt wird. Dieser Befehl wird nur für benutzerdefinierte Aktionen verwendet. Wenn dieser Befehl aufgerufen wird, werden temporäre Anmeldeinformationen für den Amazon S3 S3-Bucket AWS CodePipeline zurückgegeben, der zum Speichern von Artefakten für die Pipeline verwendet wird, falls dies für die benutzerdefinierte Aktion erforderlich ist. Dieser Befehl gibt auch alle geheimen Werte zurück, die für die Aktion definiert wurden, sofern welche definiert wurden.
Befehl:
```
aws codepipeline get-job-details --job-id f4f4ff82-2d11-EXAMPLE
```
Ausgabe:
```
{
"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"
}
}
```
+ Einzelheiten zur API finden Sie [GetJobDetails](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/get-job-details.html)in der *AWS CLI Befehlsreferenz*.
------
#### [ PowerShell ]
**Tools für PowerShell V4**
**Beispiel 1: In diesem Beispiel werden allgemeine Informationen zum angegebenen Auftrag abgerufen.**
```
Get-CPJobDetail -JobId f570dc12-5ef3-44bc-945a-6e133EXAMPLE
```
**Ausgabe:**
```
AccountId Data Id
--------- ---- --
80398EXAMPLE Amazon.CodePipeline.Model.JobData f570dc12-5ef3-44bc-945a-6e133EXAMPLE
```
**Beispiel 2: In diesem Beispiel werden detaillierte Informationen zum angegebenen Auftrag abgerufen.**
```
$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)
```
**Ausgabe:**
```
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
```
+ Einzelheiten zur API finden Sie unter [GetJobDetails AWS -Tools für PowerShell](https://docs.aws.amazon.com/powershell/v4/reference)*Cmdlet-Referenz (V4).*
**Tools für V5 PowerShell **
**Beispiel 1: In diesem Beispiel werden allgemeine Informationen zum angegebenen Auftrag abgerufen.**
```
Get-CPJobDetail -JobId f570dc12-5ef3-44bc-945a-6e133EXAMPLE
```
**Ausgabe:**
```
AccountId Data Id
--------- ---- --
80398EXAMPLE Amazon.CodePipeline.Model.JobData f570dc12-5ef3-44bc-945a-6e133EXAMPLE
```
**Beispiel 2: In diesem Beispiel werden detaillierte Informationen zum angegebenen Auftrag abgerufen.**
```
$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)
```
**Ausgabe:**
```
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
```
+ Einzelheiten zur API finden Sie unter [GetJobDetails AWS -Tools für PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet-Referenz (*V5).
------
# Verwendung von `GetPipeline` mit einer CLI
Die folgenden Code-Beispiele zeigen, wie `GetPipeline` verwendet wird.
------
#### [ CLI ]
**AWS CLI**
**So zeigen Sie die Struktur einer Pipeline an**
In diesem Beispiel wird die Struktur einer Pipeline mit dem Namen zurückgegeben MyFirstPipeline.
Befehl:
```
aws codepipeline get-pipeline --name MyFirstPipeline
```
Ausgabe:
```
{
"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
}
}
```
+ Einzelheiten zur API finden Sie [GetPipeline](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/get-pipeline.html)unter *AWS CLI Befehlsreferenz*.
------
#### [ PowerShell ]
**Tools für PowerShell V4**
**Beispiel 1: In diesem Beispiel werden allgemeine Informationen zur angegebenen Pipeline abgerufen.**
```
Get-CPPipeline -Name CodePipelineDemo -Version 1
```
**Ausgabe:**
```
ArtifactStore : Amazon.CodePipeline.Model.ArtifactStore
Name : CodePipelineDemo
RoleArn : arn:aws:iam::80398EXAMPLE:role/CodePipelineServiceRole
Stages : {Source, Build, Beta, TestStage}
Version : 1
```
**Beispiel 2: In diesem Beispiel werden detaillierte Informationen zur angegebenen Pipeline abgerufen.**
```
$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)
}
}
```
**Ausgabe:**
```
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
```
+ Einzelheiten zur API finden Sie unter [GetPipeline AWS -Tools für PowerShell](https://docs.aws.amazon.com/powershell/v4/reference)*Cmdlet-Referenz (V4).*
**Tools für V5 PowerShell **
**Beispiel 1: In diesem Beispiel werden allgemeine Informationen zur angegebenen Pipeline abgerufen.**
```
Get-CPPipeline -Name CodePipelineDemo -Version 1
```
**Ausgabe:**
```
ArtifactStore : Amazon.CodePipeline.Model.ArtifactStore
Name : CodePipelineDemo
RoleArn : arn:aws:iam::80398EXAMPLE:role/CodePipelineServiceRole
Stages : {Source, Build, Beta, TestStage}
Version : 1
```
**Beispiel 2: In diesem Beispiel werden detaillierte Informationen zur angegebenen Pipeline abgerufen.**
```
$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)
}
}
```
**Ausgabe:**
```
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
```
+ Einzelheiten zur API finden Sie unter [GetPipeline AWS -Tools für PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet-Referenz (*V5).
------
# Verwendung von `GetPipelineState` mit einer CLI
Die folgenden Code-Beispiele zeigen, wie `GetPipelineState` verwendet wird.
------
#### [ CLI ]
**AWS CLI**
**So rufen Sie Informationen zum Status einer Pipeline ab**
In diesem Beispiel wird der letzte Status einer Pipeline mit dem Namen zurückgegeben MyFirstPipeline.
Befehl:
```
aws codepipeline get-pipeline-state --name MyFirstPipeline
```
Ausgabe:
```
{
"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
}
```
+ Einzelheiten zur API finden Sie [GetPipelineState](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/get-pipeline-state.html)unter *AWS CLI Befehlsreferenz*.
------
#### [ PowerShell ]
**Tools für PowerShell V4**
**Beispiel 1: In diesem Beispiel werden allgemeine Informationen zu den Phasen der angegebenen Pipeline abgerufen.**
```
Get-CPPipelineState -Name CodePipelineDemo
```
**Ausgabe:**
```
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
```
**Beispiel 2: In diesem Beispiel werden detaillierte Informationen über den Status der angegebenen Pipeline abgerufen.**
```
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)
}
}
```
**Ausgabe:**
```
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 =
```
+ Einzelheiten zur API finden Sie unter [GetPipelineState AWS -Tools für PowerShell](https://docs.aws.amazon.com/powershell/v4/reference)*Cmdlet-Referenz (V4).*
**Tools für V5 PowerShell **
**Beispiel 1: In diesem Beispiel werden allgemeine Informationen zu den Phasen der angegebenen Pipeline abgerufen.**
```
Get-CPPipelineState -Name CodePipelineDemo
```
**Ausgabe:**
```
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
```
**Beispiel 2: In diesem Beispiel werden detaillierte Informationen über den Status der angegebenen Pipeline abgerufen.**
```
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)
}
}
```
**Ausgabe:**
```
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 =
```
+ Einzelheiten zur API finden Sie unter [GetPipelineState AWS -Tools für PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet-Referenz (*V5).
------
# Verwendung von `ListActionTypes` mit einer CLI
Die folgenden Code-Beispiele zeigen, wie `ListActionTypes` verwendet wird.
------
#### [ CLI ]
**AWS CLI**
**So zeigen Sie die verfügbaren Aktionstypen an**
Der list-action-types Befehl wird von sich aus verwendet und gibt die Struktur aller Aktionen zurück, die für Ihr AWS Konto verfügbar sind. In diesem Beispiel wird die action-owner-filter Option -- verwendet, um nur benutzerdefinierte Aktionen zurückzugeben.
Befehl:
```
aws codepipeline list-action-types --action-owner-filter Custom
```
Ausgabe:
```
{
"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}"
}
}
]
}
```
+ Einzelheiten zur API finden Sie [ListActionTypes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/list-action-types.html)in der *AWS CLI Befehlsreferenz*.
------
#### [ PowerShell ]
**Tools für PowerShell V4**
**Beispiel 1: In diesem Beispiel werden Informationen über alle verfügbaren Aktionen für den angegebenen Besitzer abgerufen.**
```
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)
}
```
**Ausgabe:**
```
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}
```
+ Einzelheiten zur API finden Sie unter [ListActionTypes AWS -Tools für PowerShell](https://docs.aws.amazon.com/powershell/v4/reference)*Cmdlet-Referenz (V4).*
**Tools für V5 PowerShell **
**Beispiel 1: In diesem Beispiel werden Informationen über alle verfügbaren Aktionen für den angegebenen Besitzer abgerufen.**
```
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)
}
```
**Ausgabe:**
```
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}
```
+ Einzelheiten zur API finden Sie unter [ListActionTypes AWS -Tools für PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet-Referenz (*V5).
------
# Verwendung von `ListPipelines` mit einer CLI
Die folgenden Code-Beispiele zeigen, wie `ListPipelines` verwendet wird.
------
#### [ CLI ]
**AWS CLI**
**So zeigen Sie eine Liste von Pipelines an**
In diesem Beispiel werden alle AWS CodePipeline Pipelines aufgeführt, die dem AWS Konto des Benutzers zugeordnet sind.
Befehl:
```
aws codepipeline list-pipelines
```
Ausgabe:
```
{
"pipelines": [
{
"updated": 1439504274.641,
"version": 1,
"name": "MyFirstPipeline",
"created": 1439504274.641
},
{
"updated": 1436461837.992,
"version": 2,
"name": "MySecondPipeline",
"created": 1436460801.381
}
]
}
```
+ Einzelheiten zur API finden Sie unter [ListPipelines AWS CLI](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/list-pipelines.html)*Befehlsreferenz.*
------
#### [ PowerShell ]
**Tools für PowerShell V4**
**Beispiel 1: In diesem Beispiel wird eine Liste der verfügbaren Pipelines abgerufen.**
```
Get-CPPipelineList
```
**Ausgabe:**
```
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
```
+ Einzelheiten zur API finden Sie unter [ListPipelines AWS -Tools für PowerShell](https://docs.aws.amazon.com/powershell/v4/reference)*Cmdlet-Referenz (V4).*
**Tools für V5 PowerShell **
**Beispiel 1: In diesem Beispiel wird eine Liste der verfügbaren Pipelines abgerufen.**
```
Get-CPPipelineList
```
**Ausgabe:**
```
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
```
+ Einzelheiten zur API finden Sie unter [ListPipelines AWS -Tools für PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet-Referenz (*V5).
------
# Verwendung von `PollForJobs` mit einer CLI
Die folgenden Code-Beispiele zeigen, wie `PollForJobs` verwendet wird.
------
#### [ CLI ]
**AWS CLI**
**So zeigen Sie alle verfügbaren Jobs an**
In diesem Beispiel werden Informationen zu allen Aufträgen zurückgegeben, auf die ein Auftragsworker reagieren kann. In diesem Beispiel wird eine vordefinierte JSON-Datei (MyActionTypeInfo.json) verwendet, um Informationen über den Aktionstyp bereitzustellen, für den der Job Worker Jobs verarbeitet. Dieser Befehl wird nur für benutzerdefinierte Aktionen verwendet. Wenn dieser Befehl aufgerufen wird, werden temporäre Anmeldeinformationen für den Amazon S3 S3-Bucket AWS CodePipeline zurückgegeben, der zum Speichern von Artefakten für die Pipeline verwendet wird. Dieser Befehl gibt auch alle geheimen Werte zurück, die für die Aktion definiert wurden, sofern welche definiert wurden.
Befehl:
```
aws codepipeline poll-for-jobs --cli-input-json file://MyActionTypeInfo.json
```
Beispielinhalt für die JSON-Datei:
```
{
"actionTypeId": {
"category": "Test",
"owner": "Custom",
"provider": "MyJenkinsProviderName",
"version": "1"
},
"maxBatchSize": 5,
"queryParam": {
"ProjectName": "MyJenkinsTestProject"
}
}
```
Ausgabe:
```
{
"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"
}
]
}
```
+ Einzelheiten zur API finden Sie [PollForJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/poll-for-jobs.html)in der *AWS CLI Befehlsreferenz*.
------
#### [ PowerShell ]
**Tools für PowerShell V4**
**Beispiel 1: In diesem Beispiel werden Informationen über alle Aufträge abgerufen, die für die angegebene Aktionskategorie, den Besitzer, den Anbieter, die Version und die Abfrageparameter ausgeführt werden können.**
```
Get-CPActionableJobList -ActionTypeId_Category Build -ActionTypeId_Owner Custom -ActionTypeId_Provider MyCustomProviderName -ActionTypeId_Version 1 -QueryParam @{"ProjectName" = "MyProjectName"}
```
**Ausgabe:**
```
AccountId Data Id Nonce
--------- ---- -- -----
80398EXAMPLE Amazon.CodePipeline.Model.JobData 0de392f5-712d-4f41-ace3-f57a0EXAMPLE 3
```
+ Einzelheiten zur API finden Sie unter [PollForJobs AWS -Tools für PowerShell](https://docs.aws.amazon.com/powershell/v4/reference)*Cmdlet-Referenz (V4).*
**Tools für V5 PowerShell **
**Beispiel 1: In diesem Beispiel werden Informationen über alle Aufträge abgerufen, die für die angegebene Aktionskategorie, den Besitzer, den Anbieter, die Version und die Abfrageparameter ausgeführt werden können.**
```
Get-CPActionableJobList -ActionTypeId_Category Build -ActionTypeId_Owner Custom -ActionTypeId_Provider MyCustomProviderName -ActionTypeId_Version 1 -QueryParam @{"ProjectName" = "MyProjectName"}
```
**Ausgabe:**
```
AccountId Data Id Nonce
--------- ---- -- -----
80398EXAMPLE Amazon.CodePipeline.Model.JobData 0de392f5-712d-4f41-ace3-f57a0EXAMPLE 3
```
+ Einzelheiten zur API finden Sie unter [PollForJobs AWS -Tools für PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet-Referenz (*V5).
------
# Verwendung von `StartPipelineExecution` mit einer CLI
Die folgenden Code-Beispiele zeigen, wie `StartPipelineExecution` verwendet wird.
------
#### [ CLI ]
**AWS CLI**
**So führen Sie die neueste Revision über eine Pipeline aus**
In diesem Beispiel wird die neueste Version, die sich in der Quellphase einer Pipeline befindet, über die Pipeline mit dem Namen "MyFirstPipeline" ausgeführt.
Befehl:
```
aws codepipeline start-pipeline-execution --name MyFirstPipeline
```
Ausgabe:
```
{
"pipelineExecutionId": "3137f7cb-7cf7-EXAMPLE"
}
```
+ Einzelheiten zur API finden Sie [StartPipelineExecution](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/start-pipeline-execution.html)unter *AWS CLI Befehlsreferenz*.
------
#### [ PowerShell ]
**Tools für PowerShell V4**
**Beispiel 1: In diesem Beispiel wird mit der Ausführung der angegebenen Pipeline begonnen.**
```
Start-CPPipelineExecution -Name CodePipelineDemo
```
+ Einzelheiten zur API finden Sie unter [StartPipelineExecution AWS -Tools für PowerShell](https://docs.aws.amazon.com/powershell/v4/reference)*Cmdlet-Referenz (V4).*
**Tools für V5 PowerShell **
**Beispiel 1: In diesem Beispiel wird mit der Ausführung der angegebenen Pipeline begonnen.**
```
Start-CPPipelineExecution -Name CodePipelineDemo
```
+ Einzelheiten zur API finden Sie unter [StartPipelineExecution AWS -Tools für PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet-Referenz (*V5).
------
# Verwendung von `UpdatePipeline` mit einer CLI
Die folgenden Code-Beispiele zeigen, wie `UpdatePipeline` verwendet wird.
------
#### [ CLI ]
**AWS CLI**
**So aktualisieren Sie die Struktur einer Pipeline**
In diesem Beispiel wird der Befehl update-pipeline mit dem Argument -- cli-input-json verwendet. In diesem Beispiel wird eine vordefinierte JSON-Datei (MyFirstPipeline.json) verwendet, um die Struktur einer Pipeline zu aktualisieren. AWS CodePipeline erkennt den in der JSON-Datei enthaltenen Pipeline-Namen und wendet dann alle Änderungen an geänderten Feldern in der Pipeline-Struktur an, um die Pipeline zu aktualisieren.
Beachten Sie beim Erstellen der vordefinierten JSON-Datei die folgenden Richtlinien:
Wenn Sie mit einer Pipeline-Struktur arbeiten, die mit dem Befehl „get-pipeline“ abgerufen wurde, müssen Sie den Metadatenabschnitt aus der Pipeline-Struktur in der JSON-Datei entfernen (die Zeilen mit „metadata“: \$1\$1 und die darin enthaltenen Felder „created“, „pipelineARN“ und „updated“). Der Pipeline-Name kann nicht geändert werden.
Befehl:
```
aws codepipeline update-pipeline --cli-input-json file://MyFirstPipeline.json
```
Inhalt einer JSON-Beispieldatei:
```
{
"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
}
}
```
Ausgabe:
```
{
"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
}
}
```
+ Einzelheiten zur API finden Sie [UpdatePipeline](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/update-pipeline.html)in der *AWS CLI Befehlsreferenz*.
------
#### [ PowerShell ]
**Tools für PowerShell V4**
**Beispiel 1: In diesem Beispiel wird die angegebene vorhandene Pipeline mit den angegebenen Einstellungen aktualisiert.**
```
$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
```
**Ausgabe:**
```
ArtifactStore : Amazon.CodePipeline.Model.ArtifactStore
Name : CodePipelineDemo
RoleArn : arn:aws:iam::80398EXAMPLE:role/CodePipelineServiceRole
Stages : {InputFiles, TestDeployment}
Version : 2
```
+ Einzelheiten zur API finden Sie unter [UpdatePipeline AWS -Tools für PowerShell](https://docs.aws.amazon.com/powershell/v4/reference)*Cmdlet-Referenz (V4).*
**Tools für V5 PowerShell **
**Beispiel 1: In diesem Beispiel wird die angegebene vorhandene Pipeline mit den angegebenen Einstellungen aktualisiert.**
```
$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
```
**Ausgabe:**
```
ArtifactStore : Amazon.CodePipeline.Model.ArtifactStore
Name : CodePipelineDemo
RoleArn : arn:aws:iam::80398EXAMPLE:role/CodePipelineServiceRole
Stages : {InputFiles, TestDeployment}
Version : 2
```
+ Einzelheiten zur API finden Sie unter [UpdatePipeline AWS -Tools für PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet-Referenz (*V5).
------