# Ejemplos de canalizaciones de EventBridge con la AWS CLI
En los siguientes ejemplos de código, se muestra cómo realizar acciones e implementar escenarios comunes mediante la AWS Command Line Interface con canalizaciones de EventBridge.
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
### `create-pipe`
En el siguiente ejemplo de código, se muestra cómo utilizar `create-pipe`.
**AWS CLI**
**Creación de una canalización**
En el siguiente ejemplo de `create-pipe`, se crea una canalización denominada `Demo_Pipe` con SQS como origen y el grupo de registro de CloudWatch como destino de la canalización.
```
aws pipes create-pipe \
--name Demo_Pipe \
--desired-state RUNNING \
--role-arn arn:aws:iam::123456789012:role/service-role/Amazon_EventBridge_Pipe_Demo_Pipe_28b3aa4f \
--source arn:aws:sqs:us-east-1:123456789012:Demo_Queue \
--target arn:aws:logs:us-east-1:123456789012:log-group:/aws/pipes/Demo_LogGroup
```
Salida:
```
{
"Arn": "arn:aws:pipes:us-east-1:123456789012:pipe/Demo_Pipe",
"Name": "Demo_Pipe",
"DesiredState": "RUNNING",
"CurrentState": "CREATING",
"CreationTime": "2024-10-08T12:33:59-05:00",
"LastModifiedTime": "2024-10-08T12:33:59.684839-05:00"
}
```
Para obtener más información, consulte [Conceptos de canalizaciones de Amazon EventBridge](https://docs.aws.amazon.com/eventbridge/latest/userguide/pipes-concepts.html) en la *Guía del usuario de Amazon EventBridge*.
+ Para obtener información sobre la API, consulte [CreatePipe](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pipes/create-pipe.html) en la *Referencia de comandos de la AWS CLI*.
### `delete-pipe`
En el siguiente ejemplo de código, se muestra cómo utilizar `delete-pipe`.
**AWS CLI**
**Eliminación de una canalización existente**
En el siguiente ejemplo de `delete-pipe`, se elimina una canalización denominada `Demo_Pipe` en la cuenta especificada.
```
aws pipes delete-pipe \
--name Demo_Pipe
```
Salida:
```
{
"Arn": "arn:aws:pipes:us-east-1:123456789012:pipe/Demo_Pipe",
"Name": "Demo_Pipe",
"DesiredState": "STOPPED",
"CurrentState": "DELETING",
"CreationTime": "2024-10-08T09:29:10-05:00",
"LastModifiedTime": "2024-10-08T11:57:22-05:00"
}
```
Para obtener más información, consulte [Conceptos de canalizaciones de Amazon EventBridge](https://docs.aws.amazon.com/eventbridge/latest/userguide/pipes-concepts.html) en la *Guía del usuario de Amazon EventBridge*.
+ Para obtener información sobre la API, consulte [DeletePipe](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pipes/delete-pipe.html) en la *Referencia de comandos de la AWS CLI*.
### `describe-pipe`
En el siguiente ejemplo de código, se muestra cómo utilizar `describe-pipe`.
**AWS CLI**
**Recuperación de información sobre una canalización**
En el siguiente ejemplo de `describe-pipe`, se muestra información acerca de la canalización `Demo_Pipe` en la cuenta especificada.
```
aws pipes describe-pipe \
--name Demo_Pipe
```
Salida:
```
{
"Arn": "arn:aws:pipes:us-east-1:123456789012:pipe/Demo_Pipe",
"Name": "Demo_Pipe",
"DesiredState": "RUNNING",
"CurrentState": "RUNNING",
"StateReason": "User initiated",
"Source": "arn:aws:sqs:us-east-1:123456789012:Demo_Queue",
"SourceParameters": {
"SqsQueueParameters": {
"BatchSize": 1
}
},
"EnrichmentParameters": {},
"Target": "arn:aws:logs:us-east-1:123456789012:log-group:/aws/pipes/Demo_LogGroup",
"TargetParameters": {},
"RoleArn": "arn:aws:iam::123456789012:role/service-role/Amazon_EventBridge_Pipe_Demo_Pipe_28b3aa4f",
"Tags": {},
"CreationTime": "2024-10-08T09:29:10-05:00",
"LastModifiedTime": "2024-10-08T10:23:47-05:00",
"LogConfiguration": {
"CloudwatchLogsLogDestination": {
"LogGroupArn": "arn:aws:logs:us-east-1:123456789012:log-group:/aws/vendedlogs/pipes/Demo_Pipe"
},
"Level": "ERROR"
}
}
```
Para obtener más información, consulte [Conceptos de canalizaciones de Amazon EventBridge](https://docs.aws.amazon.com/eventbridge/latest/userguide/pipes-concepts.html) en la *Guía del usuario de Amazon EventBridge*.
+ Para obtener información sobre la API, consulte [DescribePipe](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pipes/describe-pipe.html) en la *Referencia de comandos de la AWS CLI*.
### `list-pipes`
En el siguiente ejemplo de código, se muestra cómo utilizar `list-pipes`.
**AWS CLI**
**Recuperación de una lista de canalizaciones**
En el siguiente ejemplo de `list-pipes`, se muestran todas las canalizaciones de la cuenta especificada.
```
aws pipes list-pipes
```
Salida:
```
{
"Pipes": [
{
"Name": "Demo_Pipe",
"Arn": "arn:aws:pipes:us-east-1:123456789012:pipe/Demo_Pipe",
"DesiredState": "RUNNING",
"CurrentState": "RUNNING",
"StateReason": "User initiated",
"CreationTime": "2024-10-08T09:29:10-05:00",
"LastModifiedTime": "2024-10-08T10:23:47-05:00",
"Source": "arn:aws:sqs:us-east-1:123456789012:Demo_Queue",
"Target": "arn:aws:logs:us-east-1:123456789012:log-group:/aws/pipes/Demo_LogGroup"
}
]
}
```
Para obtener más información, consulte [Conceptos de canalizaciones de Amazon EventBridge](https://docs.aws.amazon.com/eventbridge/latest/userguide/pipes-concepts.html) en la *Guía del usuario de Amazon EventBridge*.
+ Para obtener información sobre la API, consulte [ListPipes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pipes/list-pipes.html) en la *Referencia de comandos de la AWS CLI*.
### `list-tags-for-resource`
En el siguiente ejemplo de código, se muestra cómo utilizar `list-tags-for-resource`.
**AWS CLI**
**Muestra de las etiquetas asociadas a una canalización existente**
En el siguiente ejemplo de `list-tags-for-resource`, se muestran todas las etiquetas asociadas a una canalización denominada `Demo_Pipe` en la cuenta especificada.
```
aws pipes list-tags-for-resource \
--resource-arn arn:aws:pipes:us-east-1:123456789012:pipe/Demo_Pipe
```
Salida:
```
{
"tags": {
"stack": "Production",
"team": "DevOps"
}
}
```
Para obtener más información, consulte [Conceptos de canalizaciones de Amazon EventBridge](https://docs.aws.amazon.com/eventbridge/latest/userguide/pipes-concepts.html) en la *Guía del usuario de Amazon EventBridge*.
+ Para ver los detalles de la API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pipes/list-tags-for-resource.html) en la *Referencia de comandos de la AWS CLI*.
### `start-pipe`
En el siguiente ejemplo de código, se muestra cómo utilizar `start-pipe`.
**AWS CLI**
**Inicio de una canalización existente**
En el siguiente ejemplo de `start-pipe`, se inicia una canalización denominada `Demo_Pipe` en la cuenta especificada.
```
aws pipes start-pipe \
--name Demo_Pipe
```
Salida:
```
{
"Arn": "arn:aws:pipes:us-east-1:123456789012:pipe/Demo_Pipe",
"Name": "Demo_Pipe",
"DesiredState": "RUNNING",
"CurrentState": "STARTING",
"CreationTime": "2024-10-08T09:29:10-05:00",
"LastModifiedTime": "2024-10-08T10:17:24-05:00"
}
```
Para más información, consulte [Inicio o detención de una canalización de Amazon EventBridge](https://docs.aws.amazon.com/eventbridge/latest/userguide/pipes-start-stop.html) en la *Guía del usuario de Amazon EventBridge*.
+ Para obtener información sobre la API, consulte [StartPipe](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pipes/start-pipe.html) en la *Referencia de comandos de la AWS CLI*.
### `stop-pipe`
En el siguiente ejemplo de código, se muestra cómo utilizar `stop-pipe`.
**AWS CLI**
**Detención de una canalización existente**
En el siguiente ejemplo de `stop-pipe`, se detiene una canalización denominada `Demo_Pipe` en la cuenta especificada.
```
aws pipes stop-pipe \
--name Demo_Pipe
```
Salida:
```
{
"Arn": "arn:aws:pipes:us-east-1:123456789012:pipe/Demo_Pipe",
"Name": "Demo_Pipe",
"DesiredState": "STOPPED",
"CurrentState": "STOPPING",
"CreationTime": "2024-10-08T09:29:10-05:00",
"LastModifiedTime": "2024-10-08T09:29:49-05:00"
}
```
Para más información, consulte [Inicio o detención de una canalización de Amazon EventBridge](https://docs.aws.amazon.com/eventbridge/latest/userguide/pipes-start-stop.html) en la *Guía del usuario de Amazon EventBridge*.
+ Para obtener información sobre la API, consulte [StopPipe](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pipes/stop-pipe.html) en la *Referencia de comandos de la AWS CLI*.
### `tag-resource`
En el siguiente ejemplo de código, se muestra cómo utilizar `tag-resource`.
**AWS CLI**
**Etiquetado de una canalización existente**
En el siguiente ejemplo de `tag-resource`, se etiqueta una canalización denominada `Demo_Pipe`. Si el comando se ejecuta correctamente, no se muestra ningún resultado.
```
aws pipes tag-resource \
--resource-arn arn:aws:pipes:us-east-1:123456789012:pipe/Demo_Pipe \
--tags stack=Production
```
Para obtener más información, consulte [Conceptos de canalizaciones de Amazon EventBridge](https://docs.aws.amazon.com/eventbridge/latest/userguide/pipes-concepts.html) en la *Guía del usuario de Amazon EventBridge*.
+ Para ver los detalles de la API, consulte [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pipes/tag-resource.html) en la *Referencia de comandos de la AWS CLI*.
### `untag-resource`
En el siguiente ejemplo de código, se muestra cómo utilizar `untag-resource`.
**AWS CLI**
**Eliminación de una etiqueta de una canalización existente**
En el siguiente ejemplo de `untag-resource`, se elimina una etiqueta con la clave `stack` de la canalización denominada `Demo_Pipe`. Si el comando se ejecuta correctamente, no se muestra ningún resultado.
```
aws pipes untag-resource \
--resource-arn arn:aws:pipes:us-east-1:123456789012:pipe/Demo_Pipe \
--tags stack
```
Para obtener más información, consulte [Conceptos de canalizaciones de Amazon EventBridge](https://docs.aws.amazon.com/eventbridge/latest/userguide/pipes-concepts.html) en la *Guía del usuario de Amazon EventBridge*.
+ Para ver los detalles de la API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pipes/untag-resource.html) en la *Referencia de comandos de la AWS CLI*.
### `update-pipe`
En el siguiente ejemplo de código, se muestra cómo utilizar `update-pipe`.
**AWS CLI**
**Actualización de una canalización existente**
En el siguiente ejemplo de `update-pipe`, se actualiza la canalización denominada `Demo_Pipe` agregando un parámetro de configuración de registro de CloudWatch. Asegúrese de actualizar el rol de ejecución de la canalización para que tenga los permisos correctos para el destino del registro.
```
aws pipes update-pipe \
--name Demo_Pipe \
--desired-state RUNNING \
--log-configuration CloudwatchLogsLogDestination={LogGroupArn=arn:aws:logs:us-east-1:123456789012:log-group:/aws/vendedlogs/pipes/Demo_Pipe},Level=TRACE \
--role-arn arn:aws:iam::123456789012:role/service-role/Amazon_EventBridge_Pipe_Demo_Pipe_28b3aa4f
```
Salida:
```
{
"Arn": "arn:aws:pipes:us-east-1:123456789012:pipe/Demo_Pipe",
"Name": "Demo_Pipe",
"DesiredState": "RUNNING",
"CurrentState": "UPDATING",
"CreationTime": "2024-10-08T09:29:10-05:00",
"LastModifiedTime": "2024-10-08T11:35:48-05:00"
}
```
Para obtener más información, consulte [Conceptos de canalizaciones de Amazon EventBridge](https://docs.aws.amazon.com/eventbridge/latest/userguide/pipes-concepts.html) en la *Guía del usuario de Amazon EventBridge*.
+ Para obtener información sobre la API, consulte [UpdatePipe](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pipes/update-pipe.html) en la *Referencia de comandos de la AWS CLI*.