Esta documentación es para la versión 1 de AWS CLI. Para obtener documentación relacionada con la versión 2 de AWS CLI, consulte la Guía del usuario de la versión 2.
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.
Temas
Acciones
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 denominadaDemo_Pipecon SQS como origen y el grupo de registro de CloudWatch como destino de la canalización.aws pipes create-pipe \ --nameDemo_Pipe\ --desired-stateRUNNING\ --role-arnarn:aws:iam::123456789012:role/service-role/Amazon_EventBridge_Pipe_Demo_Pipe_28b3aa4f\ --sourcearn:aws:sqs:us-east-1:123456789012:Demo_Queue\ --targetarn:aws:logs:us-east-1:123456789012:log-group:/aws/pipes/Demo_LogGroupSalida:
{ "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 en la Guía del usuario de Amazon EventBridge.
-
Para obtener información sobre la API, consulte CreatePipe
en la Referencia de comandos de la AWS CLI.
-
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 denominadaDemo_Pipeen la cuenta especificada.aws pipes delete-pipe \ --nameDemo_PipeSalida:
{ "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 en la Guía del usuario de Amazon EventBridge.
-
Para obtener información sobre la API, consulte DeletePipe
en la Referencia de comandos de la AWS CLI.
-
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ónDemo_Pipeen la cuenta especificada.aws pipes describe-pipe \ --nameDemo_PipeSalida:
{ "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 en la Guía del usuario de Amazon EventBridge.
-
Para obtener información sobre la API, consulte DescribePipe
en la Referencia de comandos de la AWS CLI.
-
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-pipesSalida:
{ "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 en la Guía del usuario de Amazon EventBridge.
-
Para obtener información sobre la API, consulte ListPipes
en la Referencia de comandos de la AWS CLI.
-
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 denominadaDemo_Pipeen la cuenta especificada.aws pipes list-tags-for-resource \ --resource-arnarn:aws:pipes:us-east-1:123456789012:pipe/Demo_PipeSalida:
{ "tags": { "stack": "Production", "team": "DevOps" } }Para obtener más información, consulte Conceptos de canalizaciones de Amazon EventBridge en la Guía del usuario de Amazon EventBridge.
-
Para ver los detalles de la API, consulte ListTagsForResource
en la Referencia de comandos de la AWS CLI.
-
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 denominadaDemo_Pipeen la cuenta especificada.aws pipes start-pipe \ --nameDemo_PipeSalida:
{ "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 en la Guía del usuario de Amazon EventBridge.
-
Para obtener información sobre la API, consulte StartPipe
en la Referencia de comandos de la AWS CLI.
-
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 denominadaDemo_Pipeen la cuenta especificada.aws pipes stop-pipe \ --nameDemo_PipeSalida:
{ "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 en la Guía del usuario de Amazon EventBridge.
-
Para obtener información sobre la API, consulte StopPipe
en la Referencia de comandos de la AWS CLI.
-
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 denominadaDemo_Pipe. Si el comando se ejecuta correctamente, no se muestra ningún resultado.aws pipes tag-resource \ --resource-arnarn:aws:pipes:us-east-1:123456789012:pipe/Demo_Pipe\ --tagsstack=ProductionPara obtener más información, consulte Conceptos de canalizaciones de Amazon EventBridge en la Guía del usuario de Amazon EventBridge.
-
Para ver los detalles de la API, consulte TagResource
en la Referencia de comandos de la AWS CLI.
-
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 clavestackde la canalización denominadaDemo_Pipe. Si el comando se ejecuta correctamente, no se muestra ningún resultado.aws pipes untag-resource \ --resource-arnarn:aws:pipes:us-east-1:123456789012:pipe/Demo_Pipe\ --tagsstackPara obtener más información, consulte Conceptos de canalizaciones de Amazon EventBridge en la Guía del usuario de Amazon EventBridge.
-
Para ver los detalles de la API, consulte UntagResource
en la Referencia de comandos de la AWS CLI.
-
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 denominadaDemo_Pipeagregando 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 \ --nameDemo_Pipe\ --desired-stateRUNNING\ --log-configurationCloudwatchLogsLogDestination={LogGroupArn=arn:aws:logs:us-east-1:123456789012:log-group:/aws/vendedlogs/pipes/Demo_Pipe},Level=TRACE\ --role-arnarn:aws:iam::123456789012:role/service-role/Amazon_EventBridge_Pipe_Demo_Pipe_28b3aa4fSalida:
{ "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 en la Guía del usuario de Amazon EventBridge.
-
Para obtener información sobre la API, consulte UpdatePipe
en la Referencia de comandos de la AWS CLI.
-
