Exemples d’utilisation de l’AWS CLI avec EventBridge Pipes - AWS Command Line Interface
Actions

Exemples d’utilisation de l’AWS CLI avec EventBridge Pipes

Les exemples de code suivants montrent comment réaliser des actions et mettre en œuvre des scénarios courants en utilisant l’AWS Command Line Interface avec Pipelines EventBridge.

Les actions sont des extraits de code de programmes plus larges et doivent être exécutées dans leur contexte. Alors que les actions vous indiquent comment appeler des fonctions de service individuelles, vous pouvez les voir en contexte dans leurs scénarios associés.

Chaque exemple inclut un lien vers le code source complet, où vous trouverez des instructions sur la configuration et l’exécution du code en contexte.

Rubriques

Actions

L’exemple de code suivant montre comment utiliser create-pipe.

AWS CLI

Pour créer un pipeline

L’exemple create-pipe suivant crée un pipeline nommé Demo_Pipe avec SQS comme source et groupe de journaux CloudWatch comme cible pour le pipeline.

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

Sortie :

{
    "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"
}

Pour plus d’informations, consultez Amazon EventBridge Pipes concepts dans le Guide de l’utilisateur Amazon EventBridge.

  • Pour plus de détails sur l’API, consultez CreatePipe dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser delete-pipe.

AWS CLI

Pour supprimer un pipeline existant

L’exemple delete-pipe suivant supprime le pipeline nommé Demo_Pipe dans le compte spécifié.

aws pipes delete-pipe \
    --name Demo_Pipe

Sortie :

{
    "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"
}

Pour plus d’informations, consultez Amazon EventBridge Pipes concepts dans le Guide de l’utilisateur Amazon EventBridge.

  • Pour plus de détails sur l’API, consultez DeletePipe dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-pipe.

AWS CLI

Pour récupérer les informations sur un pipeline

L’exemple describe-pipe suivant affiche les informations sur le pipeline Demo_Pipe dans le compte spécifié.

aws pipes describe-pipe \
    --name Demo_Pipe

Sortie :

{
    "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"
    }
}

Pour plus d’informations, consultez Amazon EventBridge Pipes concepts dans le Guide de l’utilisateur Amazon EventBridge.

  • Pour plus de détails sur l’API, consultez DescribePipe dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser list-pipes.

AWS CLI

Pour récupérer une liste de pipelines

L’exemple list-pipes suivant montre tous les pipelines du compte spécifié.

aws pipes list-pipes

Sortie :

{
    "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"
        }
    ]
}

Pour plus d’informations, consultez Amazon EventBridge Pipes concepts dans le Guide de l’utilisateur Amazon EventBridge.

  • Pour plus de détails sur l’API, consultez ListPipes dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser list-tags-for-resource.

AWS CLI

Pour répertorier les balises associées à un pipeline existant

L’exemple list-tags-for-resource suivant répertorie toutes les balises associées à un pipeline nommé Demo_Pipe dans le compte spécifié.

aws pipes list-tags-for-resource \
    --resource-arn arn:aws:pipes:us-east-1:123456789012:pipe/Demo_Pipe

Sortie :

{
    "tags": {
        "stack": "Production",
        "team": "DevOps"
    }
}

Pour plus d’informations, consultez Amazon EventBridge Pipes concepts dans le Guide de l’utilisateur Amazon EventBridge.

  • Pour plus de détails sur l’API, consultez ListTagsForResource dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser start-pipe.

AWS CLI

Pour démarrer un pipeline existant

L’exemple start-pipe suivant démarre un pipeline nommé Demo_Pipe dans le compte spécifié.

aws pipes start-pipe \
    --name Demo_Pipe

Sortie :

{
    "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"
}

Pour plus d’informations, consultez Starting or stopping an Amazon EventBridge pipe dans le Guide de l’utilisateur Amazon EventBridge.

  • Pour plus de détails sur l’API, consultez StartPipe dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser stop-pipe.

AWS CLI

Pour arrêter un pipeline existant

L’exemple stop-pipe suivant arrête un pipeline nommé Demo_Pipe dans le compte spécifié.

aws pipes stop-pipe \
    --name Demo_Pipe

Sortie :

{
    "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"
}

Pour plus d’informations, consultez Starting or stopping an Amazon EventBridge pipe dans le Guide de l’utilisateur Amazon EventBridge.

  • Pour plus de détails sur l’API, consultez StopPipe dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser tag-resource.

AWS CLI

Pour baliser un pipeline existant

L’exemple tag-resource suivant balise un pipeline nommé Demo_Pipe. Si la commande réussit, aucune sortie n’est renvoyée.

aws pipes tag-resource \
    --resource-arn arn:aws:pipes:us-east-1:123456789012:pipe/Demo_Pipe \
    --tags stack=Production

Pour plus d’informations, consultez Amazon EventBridge Pipes concepts dans le Guide de l’utilisateur Amazon EventBridge.

  • Pour plus de détails sur l’API, consultez TagResource dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser untag-resource.

AWS CLI

Pour supprimer une balise d’un pipeline existant

L’exemple untag-resource suivant supprime une balise avec la clé stack du pipeline nommé Demo_Pipe. Si la commande réussit, aucune sortie n’est renvoyée.

aws pipes untag-resource \
    --resource-arn arn:aws:pipes:us-east-1:123456789012:pipe/Demo_Pipe \
    --tags stack

Pour plus d’informations, consultez Amazon EventBridge Pipes concepts dans le Guide de l’utilisateur Amazon EventBridge.

  • Pour plus de détails sur l’API, consultez UntagResource dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser update-pipe.

AWS CLI

Pour mettre à jour un pipeline existant

L’exemple update-pipe suivant met à jour le pipeline nommé Demo_Pipe en ajoutant un paramètre de configuration CloudWatch Log. Assurez-vous de mettre à jour le rôle d’exécution du pipeline afin qu’il dispose des autorisations appropriées pour la destination du journal.

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

Sortie :

{
    "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"
}

Pour plus d’informations, consultez Amazon EventBridge Pipes concepts dans le Guide de l’utilisateur Amazon EventBridge.

  • Pour plus de détails sur l’API, consultez UpdatePipe dans la Référence des commandes de l’AWS CLI.