Hay más ejemplos de AWS SDK disponibles en el GitHub repositorio de [ejemplos de AWS Doc SDK](https://github.com/awsdocs/aws-doc-sdk-examples).
Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.
# CodePipeline ejemplos que utilizan AWS CLI
Los siguientes ejemplos de código muestran cómo realizar acciones e implementar escenarios comunes mediante el uso del AWS Command Line Interface with CodePipeline.
Las *acciones* son extractos de código de programas más grandes y deben ejecutarse en contexto. Mientras las acciones muestran cómo llamar a las distintas funciones de servicio, es posible ver las acciones en contexto en los escenarios relacionados.
En cada ejemplo se incluye un enlace al código de origen completo, con instrucciones de configuración y ejecución del código en el contexto.
**Topics**
+ [Acciones](#actions)
## Acciones
### `acknowledge-job`
En el siguiente ejemplo de código, se muestra cómo utilizar `acknowledge-job`.
**AWS CLI**
**Recuperación de información sobre un trabajo especificado**
En este ejemplo, se devuelve información sobre un trabajo especificado, incluido el estado de ese trabajo, en su caso. Esto solo se usa para los procesos de trabajo y las acciones personalizadas. Para determinar el valor de nonce y el identificador del trabajo, utilice aws poll-for-jobs codepipeline.
Comando:
```
aws codepipeline acknowledge-job --job-id f4f4ff82-2d11-EXAMPLE --nonce 3
```
Salida:
```
{
"status": "InProgress"
}
```
+ Para obtener más información sobre la API, consulte la Referencia [AcknowledgeJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/acknowledge-job.html)de *AWS CLI comandos*.
### `create-custom-action-type`
En el siguiente ejemplo de código, se muestra cómo utilizar `create-custom-action-type`.
**AWS CLI**
**Creación de una acción personalizada**
En este ejemplo, se crea una acción personalizada para AWS CodePipeline usar un archivo JSON ya creado (aquí denominado MyCustomAction .json) que contiene la estructura de la acción personalizada. Para obtener más información sobre los requisitos para crear una acción personalizada, incluida la estructura del archivo, consulta la Guía del AWS CodePipeline usuario.
```
aws codepipeline create-custom-action-type --cli-input-json file://MyCustomAction.json
```
Contenido del archivo JSON `MyCustomAction.json`:
```
{
"category": "Build",
"provider": "MyJenkinsProviderName",
"version": "1",
"settings": {
"entityUrlTemplate": "https://192.0.2.4/job/{Config:ProjectName}/",
"executionUrlTemplate": "https://192.0.2.4/job/{Config:ProjectName}/lastSuccessfulBuild/{ExternalExecutionId}/"
},
"configurationProperties": [
{
"name": "MyJenkinsExampleBuildProject",
"required": true,
"key": true,
"secret": false,
"queryable": false,
"description": "The name of the build project must be provided when this action is added to the pipeline.",
"type": "String"
}
],
"inputArtifactDetails": {
"maximumCount": 1,
"minimumCount": 0
},
"outputArtifactDetails": {
"maximumCount": 1,
"minimumCount": 0
}
}
```
Este comando devuelve la estructura de la acción personalizada.
+ Para obtener más información sobre la API, consulte [CreateCustomActionType](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/create-custom-action-type.html)la *Referencia de AWS CLI comandos*.
### `create-pipeline`
En el siguiente ejemplo de código, se muestra cómo utilizar `create-pipeline`.
**AWS CLI**
**Creación de una canalización**
En este ejemplo, se crea una canalización AWS CodePipeline utilizando un archivo JSON ya creado (aquí denominado MySecondPipeline .json) que contiene la estructura de la canalización. Para obtener más información sobre los requisitos para crear una canalización, incluida la estructura del archivo, consulta la Guía del AWS CodePipeline usuario.
Comando:
```
aws codepipeline create-pipeline --cli-input-json file://MySecondPipeline.json
```
Contenidos de muestra del archivo JSON:
```
{
"pipeline": {
"roleArn": "arn:aws:iam::111111111111:role/AWS-CodePipeline-Service",
"stages": [
{
"name": "Source",
"actions": [
{
"inputArtifacts": [],
"name": "Source",
"actionTypeId": {
"category": "Source",
"owner": "AWS",
"version": "1",
"provider": "S3"
},
"outputArtifacts": [
{
"name": "MyApp"
}
],
"configuration": {
"S3Bucket": "awscodepipeline-demo-bucket",
"S3ObjectKey": "aws-codepipeline-s3-aws-codedeploy_linux.zip"
},
"runOrder": 1
}
]
},
{
"name": "Beta",
"actions": [
{
"inputArtifacts": [
{
"name": "MyApp"
}
],
"name": "CodePipelineDemoFleet",
"actionTypeId": {
"category": "Deploy",
"owner": "AWS",
"version": "1",
"provider": "CodeDeploy"
},
"outputArtifacts": [],
"configuration": {
"ApplicationName": "CodePipelineDemoApplication",
"DeploymentGroupName": "CodePipelineDemoFleet"
},
"runOrder": 1
}
]
}
],
"artifactStore": {
"type": "S3",
"location": "codepipeline-us-east-1-11EXAMPLE11"
},
"name": "MySecondPipeline",
"version": 1
}
}
```
Salida:
```
This command returns the structure of the pipeline.
```
+ Para obtener más información sobre la API, consulte [CreatePipeline](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/create-pipeline.html)la *Referencia de AWS CLI comandos*.
### `delete-custom-action-type`
En el siguiente ejemplo de código, se muestra cómo utilizar `delete-custom-action-type`.
**AWS CLI**
**Eliminación de una acción personalizada**
En este ejemplo, se elimina una acción personalizada AWS CodePipeline mediante un archivo JSON ya creado (aquí denominado DeleteMyCustomAction .json) que contiene el tipo de acción, el nombre del proveedor y el número de versión de la acción que se va a eliminar. Usa el list-action-types comando para ver los valores correctos de la categoría, la versión y el proveedor.
Comando:
```
aws codepipeline delete-custom-action-type --cli-input-json file://DeleteMyCustomAction.json
```
Contenidos de muestra del archivo JSON:
```
{
"category": "Build",
"version": "1",
"provider": "MyJenkinsProviderName"
}
```
Salida:
```
None.
```
+ Para obtener más información sobre la API, consulte [DeleteCustomActionType](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/delete-custom-action-type.html)la *Referencia de AWS CLI comandos*.
### `delete-pipeline`
En el siguiente ejemplo de código, se muestra cómo utilizar `delete-pipeline`.
**AWS CLI**
**Para eliminar una canalización**
En este ejemplo, se elimina una canalización cuyo nombre MySecondPipeline es. AWS CodePipeline Usa el comando list-pipelines para ver una lista de las canalizaciones asociadas a tu cuenta. AWS
Comando:
```
aws codepipeline delete-pipeline --name MySecondPipeline
```
Salida:
```
None.
```
+ *Para obtener más información sobre la API, consulta [DeletePipeline](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/delete-pipeline.html)la Referencia de comandos.AWS CLI *
### `delete-webhook`
En el siguiente ejemplo de código, se muestra cómo utilizar `delete-webhook`.
**AWS CLI**
**Eliminación de un webhook**
En el siguiente `delete-webhook` ejemplo, se elimina un webhook para una acción fuente de GitHub la versión 1. Debe usar el comando `deregister-webhook-with-third-party` para anular el registro del webhook antes de eliminarlo.
```
aws codepipeline delete-webhook \
--name my-webhook
```
Este comando no genera ninguna salida.
*Para obtener más información, consulte [Eliminar el webhook de la GitHub fuente](https://docs.aws.amazon.com/codepipeline/latest/userguide/appendix-github-oauth.html#pipelines-webhooks-delete) en la Guía del AWS CodePipeline usuario.*
+ Para obtener más información sobre la API, consulte [DeleteWebhook](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/delete-webhook.html)la *Referencia de AWS CLI comandos*.
### `deregister-webhook-with-third-party`
En el siguiente ejemplo de código, se muestra cómo utilizar `deregister-webhook-with-third-party`.
**AWS CLI**
**Anulación del registro de un webhook**
En el siguiente `deregister-webhook-with-third-party` ejemplo, se elimina un webhook para una acción fuente de GitHub la versión 1. Debe anular el registro del webhook antes de eliminarlo.
```
aws codepipeline deregister-webhook-with-third-party \
--webhook-name my-webhook
```
Este comando no genera ninguna salida.
*Para obtener más información, consulte [Eliminar el webhook de la GitHub fuente](https://docs.aws.amazon.com/codepipeline/latest/userguide/appendix-github-oauth.html#pipelines-webhooks-delete) en la Guía del AWS CodePipeline usuario.*
+ Para obtener más información sobre la API, consulte [DeregisterWebhookWithThirdParty](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/deregister-webhook-with-third-party.html)la *Referencia de AWS CLI comandos*.
### `disable-stage-transition`
En el siguiente ejemplo de código, se muestra cómo utilizar `disable-stage-transition`.
**AWS CLI**
**Deshabilitación de la transición a una etapa de una canalización**
Este ejemplo deshabilita las transiciones a la fase beta de la MyFirstPipeline canalización en AWS CodePipeline.
Comando:
```
aws codepipeline disable-stage-transition --pipeline-name MyFirstPipeline --stage-name Beta --transition-type Inbound
```
Salida:
```
None.
```
+ Para obtener más información sobre la API, consulte [DisableStageTransition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/disable-stage-transition.html)la *Referencia de AWS CLI comandos*.
### `enable-stage-transition`
En el siguiente ejemplo de código, se muestra cómo utilizar `enable-stage-transition`.
**AWS CLI**
**Habilitación de una transición a una etapa de una canalización**
Este ejemplo permite pasar a la fase beta de la MyFirstPipeline canalización en AWS CodePipeline.
Comando:
```
aws codepipeline enable-stage-transition --pipeline-name MyFirstPipeline --stage-name Beta --transition-type Inbound
```
Salida:
```
None.
```
+ Para obtener más información sobre la API, consulte [EnableStageTransition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/enable-stage-transition.html)la *Referencia de AWS CLI comandos*.
### `get-job-details`
En el siguiente ejemplo de código, se muestra cómo utilizar `get-job-details`.
**AWS CLI**
**Obtención de detalles de un trabajo**
En este ejemplo, se devuelve información sobre un trabajo cuyo identificador está representado por f4f4ff82-2d11-EXAMPLE. Este comando solo se usa para las acciones personalizadas. Cuando se llama a este comando, AWS CodePipeline devuelve las credenciales temporales del bucket de Amazon S3 que se utiliza para almacenar los artefactos de la canalización, si es necesario para la acción personalizada. Este comando también devolverá cualquier valor secreto definido para la acción en caso de haber definido alguno.
Comando:
```
aws codepipeline get-job-details --job-id f4f4ff82-2d11-EXAMPLE
```
Salida:
```
{
"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"
}
}
```
+ Para obtener más información sobre la API, consulte [GetJobDetails](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/get-job-details.html)la *Referencia de AWS CLI comandos*.
### `get-pipeline-state`
En el siguiente ejemplo de código, se muestra cómo utilizar `get-pipeline-state`.
**AWS CLI**
**Obtención de información sobre el estado de una canalización**
Este ejemplo devuelve el estado más reciente de una canalización denominada MyFirstPipeline.
Comando:
```
aws codepipeline get-pipeline-state --name MyFirstPipeline
```
Salida:
```
{
"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
}
```
+ Para obtener más información sobre la API, consulte [GetPipelineState](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/get-pipeline-state.html)la *Referencia de AWS CLI comandos*.
### `get-pipeline`
En el siguiente ejemplo de código, se muestra cómo utilizar `get-pipeline`.
**AWS CLI**
**Visualización de la estructura de una canalización**
En este ejemplo se devuelve la estructura de una canalización denominada MyFirstPipeline.
Comando:
```
aws codepipeline get-pipeline --name MyFirstPipeline
```
Salida:
```
{
"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
}
}
```
+ Para obtener más información sobre la API, consulte [GetPipeline](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/get-pipeline.html)la *Referencia de AWS CLI comandos*.
### `list-action-executions`
En el siguiente ejemplo de código, se muestra cómo utilizar `list-action-executions`.
**AWS CLI**
**Para enumerar las ejecuciones de acciones**
En el siguiente ejemplo de `list-action-executions`, se ven los detalles de ejecución de las acciones de una canalización, como, por ejemplo, el ID de ejecución de la acción, los artefactos de entrada, los artefactos de salida, el resultado de la ejecución y el estado.
```
aws codepipeline list-action-executions \
--pipeline-name myPipeline
```
Salida:
```
{
"actionExecutionDetails": [
{
"pipelineExecutionId": "EXAMPLE0-adfc-488e-bf4c-1111111720d3",
"actionExecutionId": "EXAMPLE4-2ee8-4853-bd6a-111111158148",
"pipelineVersion": 12,
"stageName": "Deploy",
"actionName": "Deploy",
"startTime": 1598572628.6,
"lastUpdateTime": 1598572661.255,
"status": "Succeeded",
"input": {
"actionTypeId": {
"category": "Deploy",
"owner": "AWS",
"provider": "CodeDeploy",
"version": "1"
},
"configuration": {
"ApplicationName": "my-application",
"DeploymentGroupName": "my-deployment-group"
},
"resolvedConfiguration": {
"ApplicationName": "my-application",
"DeploymentGroupName": "my-deployment-group"
},
"region": "us-east-1",
"inputArtifacts": [
{
"name": "SourceArtifact",
"s3location": {
"bucket": "artifact-bucket",
"key": "myPipeline/SourceArti/key"
}
}
],
"namespace": "DeployVariables"
},
"output": {
"outputArtifacts": [],
"executionResult": {
"externalExecutionId": "d-EXAMPLEE5",
"externalExecutionSummary": "Deployment Succeeded",
"externalExecutionUrl": "https://myaddress.com"
},
"outputVariables": {}
}
},
{
"pipelineExecutionId": "EXAMPLE0-adfc-488e-bf4c-1111111720d3",
"actionExecutionId": "EXAMPLE5-abb4-4192-9031-11111113a7b0",
"pipelineVersion": 12,
"stageName": "Source",
"actionName": "Source",
"startTime": 1598572624.387,
"lastUpdateTime": 1598572628.16,
"status": "Succeeded",
"input": {
"actionTypeId": {
"category": "Source",
"owner": "AWS",
"provider": "CodeCommit",
"version": "1"
},
"configuration": {
"BranchName": "production",
"PollForSourceChanges": "false",
"RepositoryName": "my-repo"
},
"resolvedConfiguration": {
"BranchName": "production",
"PollForSourceChanges": "false",
"RepositoryName": "my-repo"
},
"region": "us-east-1",
"inputArtifacts": [],
"namespace": "SourceVariables"
},
"output": {
"outputArtifacts": [
{
"name": "SourceArtifact",
"s3location": {
"bucket": "amzn-s3-demo-bucket",
"key": "myPipeline/SourceArti/key"
}
}
],
"executionResult": {
"externalExecutionId": "1111111ad99dcd35914c00b7fbea13995EXAMPLE",
"externalExecutionSummary": "Edited template.yml",
"externalExecutionUrl": "https://myaddress.com"
},
"outputVariables": {
"AuthorDate": "2020-05-08T17:45:43Z",
"BranchName": "production",
"CommitId": "EXAMPLEad99dcd35914c00b7fbea139951111111",
"CommitMessage": "Edited template.yml",
"CommitterDate": "2020-05-08T17:45:43Z",
"RepositoryName": "my-repo"
}
}
},
. . . .
```
Para obtener más información, consulte [Ver ejecuciones de acciones (CLI)](https://docs.aws.amazon.com/codepipeline/latest/userguide/pipelines-view-cli.html#pipelines-action-executions-cli) en la *Guía del AWS CodePipeline usuario*.
+ Para obtener más información sobre la API, consulte [ListActionExecutions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/list-action-executions.html)la *Referencia de AWS CLI comandos*.
### `list-action-types`
En el siguiente ejemplo de código, se muestra cómo utilizar `list-action-types`.
**AWS CLI**
**Visualización de los tipos de acciones disponibles**
Si se usa solo, el list-action-types comando devuelve la estructura de todas las acciones disponibles en tu AWS cuenta. En este ejemplo, se utiliza la action-owner-filter opción -- para devolver solo las acciones personalizadas.
Comando:
```
aws codepipeline list-action-types --action-owner-filter Custom
```
Salida:
```
{
"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}"
}
}
]
}
```
+ Para obtener más información sobre la API, consulte [ListActionTypes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/list-action-types.html)la *Referencia de AWS CLI comandos*.
### `list-pipeline-executions`
En el siguiente ejemplo de código, se muestra cómo utilizar `list-pipeline-executions`.
**AWS CLI**
**Visualización del historial de ejecución de una canalización**
En el siguiente `list-pipeline-executions` ejemplo, se muestra el historial de ejecución de una canalización de tu AWS cuenta.
```
aws codepipeline list-pipeline-executions \
--pipeline-name MyPipeline
```
Salida:
```
{
"pipelineExecutionSummaries": [
{
"lastUpdateTime": 1496380678.648,
"pipelineExecutionId": "7cf7f7cb-3137-539g-j458-d7eu3EXAMPLE",
"startTime": 1496380258.243,
"status": "Succeeded"
},
{
"lastUpdateTime": 1496591045.634,
"pipelineExecutionId": "3137f7cb-8d494hj4-039j-d84l-d7eu3EXAMPLE",
"startTime": 1496590401.222,
"status": "Succeeded"
},
{
"lastUpdateTime": 1496946071.6456,
"pipelineExecutionId": "4992f7jf-7cf7-913k-k334-d7eu3EXAMPLE",
"startTime": 1496945471.5645,
"status": "Succeeded"
}
]
}
```
Para obtener más información, consulta [Ver el historial de ejecuciones](https://docs.aws.amazon.com/codepipeline/latest/userguide/pipelines-view-cli.html#pipelines-executions-cli) en la *Guía del AWS CodePipeline usuario*.
+ Para obtener más información sobre la API, consulte [ListPipelineExecutions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/list-pipeline-executions.html)la *Referencia de AWS CLI comandos*.
### `list-pipelines`
En el siguiente ejemplo de código, se muestra cómo utilizar `list-pipelines`.
**AWS CLI**
**Visualización de una lista de canalizaciones**
En este ejemplo, se enumeran todas AWS CodePipeline las canalizaciones asociadas a la AWS cuenta del usuario.
Comando:
```
aws codepipeline list-pipelines
```
Salida:
```
{
"pipelines": [
{
"updated": 1439504274.641,
"version": 1,
"name": "MyFirstPipeline",
"created": 1439504274.641
},
{
"updated": 1436461837.992,
"version": 2,
"name": "MySecondPipeline",
"created": 1436460801.381
}
]
}
```
+ Para obtener más información sobre la API, consulte [ListPipelines](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/list-pipelines.html)la *Referencia de AWS CLI comandos*.
### `list-tags-for-resource`
En el siguiente ejemplo de código, se muestra cómo utilizar `list-tags-for-resource`.
**AWS CLI**
**Para enumerar etiquetas**
En el siguiente ejemplo de `list-tags-for-resource`, se recupera una lista de todas las etiquetas asociadas al recurso de canalización especificado.
```
aws codepipeline list-tags-for-resource \
--resource-arn arn:aws:codepipeline:us-east-1:123456789012:MyPipeline
```
Salida:
```
{
"tags": {
"Project": "ProjectA",
"IscontainerBased": "true"
}
}
```
Para obtener más información, consulte [Ver etiquetas de una canalización (CLI)](https://docs.aws.amazon.com/codepipeline/latest/userguide/pipelines-tag.html#pipelines-tag-list-cli) en la *Guía del AWS CodePipeline usuario*.
+ Para obtener más información sobre la API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/list-tags-for-resource.html)la *Referencia de AWS CLI comandos*.
### `list-webhooks`
En el siguiente ejemplo de código, se muestra cómo utilizar `list-webhooks`.
**AWS CLI**
**Para enumerar los webhooks**
En el siguiente ejemplo de `list-webhooks`, se recupera una lista de todas las etiquetas asociadas al recurso de canalización especificado.
```
aws codepipeline list-webhooks \
--endpoint-url "https://codepipeline.eu-central-1.amazonaws.com" \
--region "eu-central-1"
```
Salida:
```
{
"webhooks": [
{
"url": "https://webhooks.domain.com/trigger111111111EXAMPLE11111111111111111": {
"authenticationConfiguration": {
"SecretToken": "Secret"
},
"name": "my-webhook",
"authentication": "GITHUB_HMAC",
"targetPipeline": "my-Pipeline",
"targetAction": "Source",
"filters": [
{
"jsonPath": "$.ref",
"matchEquals": "refs/heads/{Branch}"
}
]
},
"arn": "arn:aws:codepipeline:eu-central-1:123456789012:webhook:my-webhook"
}
]
}
```
Para obtener más información, consulta la [sección Lista los webhooks de tu cuenta](https://docs.aws.amazon.com/codepipeline/latest/userguide/appendix-github-oauth.html#pipelines-webhooks-view) en la *Guía del AWS CodePipeline usuario*.
+ Para obtener más información sobre la API, consulta [ListWebhooks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/list-webhooks.html)la *Referencia de AWS CLI comandos*.
### `poll-for-jobs`
En el siguiente ejemplo de código, se muestra cómo utilizar `poll-for-jobs`.
**AWS CLI**
**Visualización de trabajos disponibles**
En este ejemplo, se devuelve información sobre cualquier trabajo en el que pueda actuar un proceso de trabajo. En este ejemplo, se utiliza un archivo JSON predefinido (MyActionTypeInfo.json) para proporcionar información sobre el tipo de acción para el que el trabajador procesa los trabajos. Este comando solo se usa para las acciones personalizadas. Cuando se llama a este comando, AWS CodePipeline devuelve las credenciales temporales del bucket de Amazon S3 que se utiliza para almacenar los artefactos de la canalización. Este comando también devolverá cualquier valor secreto definido para la acción en caso de haber definido alguno.
Comando:
```
aws codepipeline poll-for-jobs --cli-input-json file://MyActionTypeInfo.json
```
Contenidos de muestra del archivo JSON:
```
{
"actionTypeId": {
"category": "Test",
"owner": "Custom",
"provider": "MyJenkinsProviderName",
"version": "1"
},
"maxBatchSize": 5,
"queryParam": {
"ProjectName": "MyJenkinsTestProject"
}
}
```
Salida:
```
{
"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"
}
]
}
```
+ Para obtener más información sobre la API, consulte [PollForJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/poll-for-jobs.html)la *Referencia de AWS CLI comandos*.
### `put-webhook`
En el siguiente ejemplo de código, se muestra cómo utilizar `put-webhook`.
**AWS CLI**
**Creación de un webhook**
En el siguiente `put-webhook` ejemplo, se crea un webhook para una acción fuente de la GitHub versión 1. Tras crear el webhook, debe utilizar el comando register-webhook-with-third -party para registrarlo.
```
aws codepipeline put-webhook \
--cli-input-json file://webhook_json.json \
--region "eu-central-1"
```
Contenido de `webhook_json.json`:
```
{
"webhook": {
"name": "my-webhook",
"targetPipeline": "pipeline_name",
"targetAction": "source_action_name",
"filters": [
{
"jsonPath": "$.ref",
"matchEquals": "refs/heads/{Branch}"
}
],
"authentication": "GITHUB_HMAC",
"authenticationConfiguration": {
"SecretToken": "secret"
}
}
}
```
Salida:
```
{
"webhook": {
"url": "https://webhooks.domain.com/trigger111111111EXAMPLE11111111111111111",
"definition": {
"authenticationConfiguration": {
"SecretToken": "secret"
},
"name": "my-webhook",
"authentication": "GITHUB_HMAC",
"targetPipeline": "pipeline_name",
"targetAction": "Source",
"filters": [
{
"jsonPath": "$.ref",
"matchEquals": "refs/heads/{Branch}"
}
]
},
"arn": "arn:aws:codepipeline:eu-central-1:123456789012:webhook:my-webhook"
},
"tags": [
{
"key": "Project",
"value": "ProjectA"
}
]
}
```
*Para obtener más información, consulte [Crear un webhook para una GitHub fuente](https://docs.aws.amazon.com/codepipeline/latest/userguide/appendix-github-oauth.html#pipelines-webhooks-create) en la Guía del AWS CodePipeline usuario.*
+ Para obtener más información sobre la API, consulte [PutWebhook](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/put-webhook.html)la *Referencia de AWS CLI comandos*.
### `retry-stage-execution`
En el siguiente ejemplo de código, se muestra cómo utilizar `retry-stage-execution`.
**AWS CLI**
**Reintento de acciones con errores**
En el siguiente ejemplo de `retry-stage-execution`, se vuelve a intentar una etapa en la que se produjo un error en la acción.
```
aws codepipeline retry-stage-execution \
--pipeline-name MyPipeline \
--stage-name Deploy \
--pipeline-execution-id b59babff-5f34-EXAMPLE \
--retry-mode FAILED_ACTIONS
```
Salida:
```
{
"pipelineExecutionId": "b59babff-5f34-EXAMPLE"
}
```
Para obtener más información, consulte [Reintentar acciones fallidas (CLI)](https://docs.aws.amazon.com/codepipeline/latest/userguide/actions-retry.html#actions-retry-cli) en la *Guía del AWS CodePipeline usuario*.
+ Para obtener más información sobre la API, consulte [RetryStageExecution](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/retry-stage-execution.html)la *Referencia de AWS CLI comandos*.
### `start-pipeline-execution`
En el siguiente ejemplo de código, se muestra cómo utilizar `start-pipeline-execution`.
**AWS CLI**
**Ejecución de la última revisión a través de una canalización**
En este ejemplo, se ejecuta la última revisión presente en la fase de origen de una canalización a través de la canalización denominada "MyFirstPipeline».
Comando:
```
aws codepipeline start-pipeline-execution --name MyFirstPipeline
```
Salida:
```
{
"pipelineExecutionId": "3137f7cb-7cf7-EXAMPLE"
}
```
+ Para obtener más información sobre la API, consulte [StartPipelineExecution](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/start-pipeline-execution.html)la *Referencia de AWS CLI comandos*.
### `stop-pipeline-execution`
En el siguiente ejemplo de código, se muestra cómo utilizar `stop-pipeline-execution`.
**AWS CLI**
**Detención de la ejecución de una canalización**
En el siguiente ejemplo de `stop-pipeline-execution`, se establece de forma predeterminada esperar hasta que finalicen las acciones en curso y, a continuación, se detiene la canalización. No puede elegir detener y esperar si la ejecución ya se encuentra en un estado Stopping (Deteniéndose). Puede optar por detener y abandonar una ejecución que ya se encuentra en un estado Stopping (Deteniéndose).
```
aws codepipeline stop-pipeline-execution \
--pipeline-name MyFirstPipeline \
--pipeline-execution-id d-EXAMPLE \
--reason "Stopping pipeline after the build action is done"
```
Este comando no devuelve ningún resultado.
Para obtener más información, consulte [Detener una ejecución de canalización (CLI)](https://docs.aws.amazon.com/codepipeline/latest/userguide/pipelines-stop.html#pipelines-stop-cli) en la *Guía del AWS CodePipeline usuario*.
+ Para obtener más información sobre la API, consulte [StopPipelineExecution](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/stop-pipeline-execution.html)la *Referencia de AWS CLI comandos*.
### `tag-resource`
En el siguiente ejemplo de código, se muestra cómo utilizar `tag-resource`.
**AWS CLI**
**Para etiquetar un recurso**
En el siguiente ejemplo de `tag-resource`, se asocia un conjunto de etiquetas proporcionadas a una canalización. Use este comando para añadir o editar etiquetas.
```
aws codepipeline tag-resource \
--resource-arn arn:aws:codepipeline:us-east-1:123456789012:MyPipeline \
--tags key=Project,value=ProjectA key=IscontainerBased,value=true
```
Este comando no genera ninguna salida.
Para obtener más información, consulte [Añadir etiquetas a una canalización (CLI)](https://docs.aws.amazon.com/codepipeline/latest/userguide/pipelines-tag.html#pipelines-tag-add-cli) en la *Guía del AWS CodePipeline usuario*.
+ Para obtener más información sobre la API, consulte [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/tag-resource.html)la *Referencia de AWS CLI comandos*.
### `untag-resource`
En el siguiente ejemplo de código, se muestra cómo utilizar `untag-resource`.
**AWS CLI**
**Para eliminar AWS etiquetas de un recurso de conexiones**
En el siguiente ejemplo de `untag-resource`, se elimina una etiqueta de un recurso especificado.
```
aws codepipeline untag-resource \
--resource-arn arn:aws:codepipeline:us-east-1:123456789012:MyPipeline \
--tag-keys Project IscontainerBased
```
Este comando no genera ninguna salida.
Para obtener más información, consulte [Eliminar etiquetas de una canalización (CLI)](https://docs.aws.amazon.com/codepipeline/latest/userguide/pipelines-tag.html#pipelines-tag-delete-cli) en la *Guía del AWS CodePipeline usuario*.
+ Para obtener más información sobre la API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/untag-resource.html)la *Referencia de AWS CLI comandos*.
### `update-pipeline`
En el siguiente ejemplo de código, se muestra cómo utilizar `update-pipeline`.
**AWS CLI**
**Actualización de la estructura de una canalización**
En este ejemplo, se usa el comando update-pipeline con el argumento --. cli-input-json En este ejemplo, se usa un archivo JSON predefinido (MyFirstPipeline.json) para actualizar la estructura de una canalización. AWS CodePipeline reconoce el nombre de la canalización contenido en el archivo JSON y, a continuación, aplica cualquier cambio de los campos modificados de la estructura de la canalización para actualizarla.
Utilice las siguientes pautas al crear el archivo JSON predefinido:
Si trabaja con una estructura de canalización recuperada mediante el comando get-pipeline, debe eliminar la sección de metadatos de la estructura de canalización del archivo JSON (las líneas metadata: \$1 \$1 y los campos created, pipelineARN y updated que contiene). El nombre de la canalización no se puede cambiar.
Comando:
```
aws codepipeline update-pipeline --cli-input-json file://MyFirstPipeline.json
```
Contenido del archivo JSON de muestra:
```
{
"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
}
}
```
Salida:
```
{
"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
}
}
```
+ Para obtener más información sobre la API, consulta [UpdatePipeline](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/update-pipeline.html)la *Referencia de AWS CLI comandos*.