# Exemplos do EventBridge Pipes usando a AWS CLI
Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando a AWS Command Line Interface com o EventBridge Pipes.
*Ações* são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.
Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.
**Topics**
+ [Ações](#actions)
## Ações
### `create-pipe`
O código de exemplo a seguir mostra como usar `create-pipe`.
**AWS CLI**
**Como criar um pipe**
O exemplo de `create-pipe` a seguir cria um pipe chamado `Demo_Pipe` com o SQS como origem e o grupo de logs do CloudWatch como destino do pipe.
```
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
```
Resultado:
```
{
"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"
}
```
Consulte mais informações em [Amazon EventBridge Pipes concepts](https://docs.aws.amazon.com/eventbridge/latest/userguide/pipes-concepts.html) no *Guia do usuário do Amazon EventBridge*.
+ Consulte detalhes da API em [CreatePipe](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pipes/create-pipe.html) na *Referência de comandos da AWS CLI*.
### `delete-pipe`
O código de exemplo a seguir mostra como usar `delete-pipe`.
**AWS CLI**
**Como excluir um pipe existente**
O exemplo de `delete-pipe` a seguir exclui um pipe chamado `Demo_Pipe` na conta especificada.
```
aws pipes delete-pipe \
--name Demo_Pipe
```
Resultado:
```
{
"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"
}
```
Consulte mais informações em [Amazon EventBridge Pipes concepts](https://docs.aws.amazon.com/eventbridge/latest/userguide/pipes-concepts.html) no *Guia do usuário do Amazon EventBridge*.
+ Consulte detalhes da API em [DeletePipe](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pipes/delete-pipe.html) na *Referência de comandos da AWS CLI*.
### `describe-pipe`
O código de exemplo a seguir mostra como usar `describe-pipe`.
**AWS CLI**
**Como recuperar informações sobre um pipe**
O exemplo de `describe-pipe` a seguir exibe as informações sobre o pipe `Demo_Pipe` na conta especificada.
```
aws pipes describe-pipe \
--name Demo_Pipe
```
Resultado:
```
{
"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"
}
}
```
Consulte mais informações em [Amazon EventBridge Pipes concepts](https://docs.aws.amazon.com/eventbridge/latest/userguide/pipes-concepts.html) no *Guia do usuário do Amazon EventBridge*.
+ Consulte detalhes da API em [DescribePipe](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pipes/describe-pipe.html) na *Referência de comandos da AWS CLI*.
### `list-pipes`
O código de exemplo a seguir mostra como usar `list-pipes`.
**AWS CLI**
**Como recuperar uma lista de pipes**
O exemplo de `list-pipes` a seguir mostra todos os pipes na conta especificada.
```
aws pipes list-pipes
```
Resultado:
```
{
"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"
}
]
}
```
Consulte mais informações em [Amazon EventBridge Pipes concepts](https://docs.aws.amazon.com/eventbridge/latest/userguide/pipes-concepts.html) no *Guia do usuário do Amazon EventBridge*.
+ Consulte detalhes da API em [ListPipes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pipes/list-pipes.html) na *Referência de comandos da AWS CLI*.
### `list-tags-for-resource`
O código de exemplo a seguir mostra como usar `list-tags-for-resource`.
**AWS CLI**
**Como listar as tags associadas a um pipe existente**
O exemplo de `list-tags-for-resource` a seguir lista todas as tags associadas a um pipe chamado `Demo_Pipe` na conta especificada.
```
aws pipes list-tags-for-resource \
--resource-arn arn:aws:pipes:us-east-1:123456789012:pipe/Demo_Pipe
```
Resultado:
```
{
"tags": {
"stack": "Production",
"team": "DevOps"
}
}
```
Consulte mais informações em [Amazon EventBridge Pipes concepts](https://docs.aws.amazon.com/eventbridge/latest/userguide/pipes-concepts.html) no *Guia do usuário do Amazon EventBridge*.
+ Para obter detalhes sobre a API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pipes/list-tags-for-resource.html) na *AWS CLI Command Reference*.
### `start-pipe`
O código de exemplo a seguir mostra como usar `start-pipe`.
**AWS CLI**
**Como iniciar um pipe existente**
O exemplo de `start-pipe` a seguir inicia um pipe chamado `Demo_Pipe` na conta especificada.
```
aws pipes start-pipe \
--name Demo_Pipe
```
Resultado:
```
{
"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"
}
```
Consulte mais informações em [Starting or stopping an Amazon EventBridge pipe](https://docs.aws.amazon.com/eventbridge/latest/userguide/pipes-start-stop.html) no *Guia do usuário do Amazon EventBridge*.
+ Consulte detalhes da API em [StartPipe](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pipes/start-pipe.html) na *Referência de comandos da AWS CLI*.
### `stop-pipe`
O código de exemplo a seguir mostra como usar `stop-pipe`.
**AWS CLI**
**Como interromper um pipe existente**
O exemplo de `stop-pipe` a seguir interrompe um pipe chamado `Demo_Pipe` na conta especificada.
```
aws pipes stop-pipe \
--name Demo_Pipe
```
Resultado:
```
{
"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"
}
```
Consulte mais informações em [Starting or stopping an Amazon EventBridge pipe](https://docs.aws.amazon.com/eventbridge/latest/userguide/pipes-start-stop.html) no *Guia do usuário do Amazon EventBridge*.
+ Consulte detalhes da API em [StopPipe](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pipes/stop-pipe.html) na *Referência de comandos da AWS CLI*.
### `tag-resource`
O código de exemplo a seguir mostra como usar `tag-resource`.
**AWS CLI**
**Como marcar um pipe existente**
O exemplo de `tag-resource` a seguir marca um pipe chamado `Demo_Pipe`. Se o comando for bem-sucedido, nenhuma saída será retornada.
```
aws pipes tag-resource \
--resource-arn arn:aws:pipes:us-east-1:123456789012:pipe/Demo_Pipe \
--tags stack=Production
```
Consulte mais informações em [Amazon EventBridge Pipes concepts](https://docs.aws.amazon.com/eventbridge/latest/userguide/pipes-concepts.html) no *Guia do usuário do Amazon EventBridge*.
+ Consulte detalhes da API em [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pipes/tag-resource.html) na *Referência de comandos da AWS CLI*.
### `untag-resource`
O código de exemplo a seguir mostra como usar `untag-resource`.
**AWS CLI**
**Como remover uma tag de um pipe existente**
O exemplo de `untag-resource` a seguir remove uma tag com a chave `stack` do pipe chamado `Demo_Pipe`. Se o comando for bem-sucedido, nenhuma saída será retornada.
```
aws pipes untag-resource \
--resource-arn arn:aws:pipes:us-east-1:123456789012:pipe/Demo_Pipe \
--tags stack
```
Consulte mais informações em [Amazon EventBridge Pipes concepts](https://docs.aws.amazon.com/eventbridge/latest/userguide/pipes-concepts.html) no *Guia do usuário do Amazon EventBridge*.
+ Para obter detalhes sobre a API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pipes/untag-resource.html) na *Referência de comandos da AWS CLI*.
### `update-pipe`
O código de exemplo a seguir mostra como usar `update-pipe`.
**AWS CLI**
**Como atualizar um pipeline existente**
O exemplo de `update-pipe` a seguir atualiza o pipe chamado `Demo_Pipe` adicionando um parâmetro de configuração do log do CloudWatch. Atualize o perfil de execução do pipe para que ele tenha as permissões corretas para o destino do log.
```
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
```
Resultado:
```
{
"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"
}
```
Consulte mais informações em [Amazon EventBridge Pipes concepts](https://docs.aws.amazon.com/eventbridge/latest/userguide/pipes-concepts.html) no *Guia do usuário do Amazon EventBridge*.
+ Consulte detalhes da API em [UpdatePipe](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pipes/update-pipe.html) na *Referência de comandos da AWS CLI*.