D'autres exemples de AWS SDK sont disponibles dans le référentiel [AWS Doc SDK Examples](https://github.com/awsdocs/aws-doc-sdk-examples) GitHub .
Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.
# AWS CodeStar Exemples de notifications utilisant AWS CLI
Les exemples de code suivants vous montrent comment effectuer des actions et implémenter des scénarios courants à l' AWS Command Line Interface aide AWS CodeStar des notifications.
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.
**Topics**
+ [Actions](#actions)
## Actions
### `create-notification-rule`
L'exemple de code suivant montre comment utiliser`create-notification-rule`.
**AWS CLI**
**Pour créer une règle de notification**
L'`create-notification-rule`exemple suivant utilise un fichier JSON nommé `rule.json` pour créer une règle de notification nommée `MyNotificationRule` pour un référentiel nommé `MyDemoRepo` dans le AWS compte spécifié. Les notifications avec le type de détail `FULL` sont envoyées à la rubrique Amazon SNS cible spécifiée lorsque les branches et les balises sont créées.
```
aws codestar-notifications create-notification-rule \
--cli-input-json file://rule.json
```
Contenu de `rule.json` :
```
{
"Name": "MyNotificationRule",
"EventTypeIds": [
"codecommit-repository-branches-and-tags-created"
],
"Resource": "arn:aws:codecommit:us-east-1:123456789012:MyDemoRepo",
"Targets": [
{
"TargetType": "SNS",
"TargetAddress": "arn:aws:sns:us-east-1:123456789012:MyNotificationTopic"
}
],
"Status": "ENABLED",
"DetailType": "FULL"
}
```
Sortie :
```
{
"Arn": "arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/dc82df7a-EXAMPLE"
}
```
Pour plus d’informations, consultez [Création d’une règle de notification](https://docs.aws.amazon.com/codestar-notifications/latest/userguide/notification-rule-create.html) dans le *Guide de l’utilisateur de la console Outils pour développeurs AWS *.
+ Pour plus de détails sur l'API, reportez-vous [CreateNotificationRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-notifications/create-notification-rule.html)à la section *Référence des AWS CLI commandes*.
### `delete-notification-rule`
L'exemple de code suivant montre comment utiliser`delete-notification-rule`.
**AWS CLI**
**Pour supprimer une règle de notification**
L’exemple `delete-notification-rule` suivant supprime la règle de notification spécifiée.
```
aws codestar-notifications delete-notification-rule \
--arn arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/dc82df7a-EXAMPLE
```
Sortie :
```
{
"Arn": "arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/dc82df7a-EXAMPLE"
}
```
Pour plus d’informations, consultez [Suppression d’une règle de notification](https://docs.aws.amazon.com/codestar-notifications/latest/userguide/notification-rule-delete.html) dans le *Guide de l’utilisateur de la console Outils pour développeurs AWS *.
+ Pour plus de détails sur l'API, reportez-vous [DeleteNotificationRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-notifications/delete-notification-rule.html)à la section *Référence des AWS CLI commandes*.
### `delete-target`
L'exemple de code suivant montre comment utiliser`delete-target`.
**AWS CLI**
**Pour supprimer une cible de règle de notification**
L’exemple `delete-target` suivant supprime la cible spécifiée de toutes les règles de notification configurées pour l’utiliser comme cible, puis supprime la cible elle-même.
```
aws codestar-notifications delete-target \
--target-address arn:aws:sns:us-east-1:123456789012:MyNotificationTopic \
--force-unsubscribe-all
```
Cette commande ne produit aucune sortie.
Pour plus d’informations, consultez [Suppression d’une cible de règle de notification](https://docs.aws.amazon.com/codestar-notifications/latest/userguide/notification-target-delete.html) dans le *Guide de l’utilisateur de la console Outils pour développeurs AWS *.
+ Pour plus de détails sur l'API, reportez-vous [DeleteTarget](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-notifications/delete-target.html)à la section *Référence des AWS CLI commandes*.
### `describe-notification-rule`
L'exemple de code suivant montre comment utiliser`describe-notification-rule`.
**AWS CLI**
**Pour extraire des informations sur une règle de notification**
L’exemple `describe-notification-rule` suivant extrait des informations sur la règle de notification spécifiée.
```
aws codestar-notifications describe-notification-rule \
--arn arn:aws:codestar-notifications:us-west-2:123456789012:notificationrule/dc82df7a-EXAMPLE
```
Sortie :
```
{
"LastModifiedTimestamp": 1569199844.857,
"EventTypes": [
{
"ServiceName": "CodeCommit",
"EventTypeName": "Branches and tags: Created",
"ResourceType": "Repository",
"EventTypeId": "codecommit-repository-branches-and-tags-created"
}
],
"Status": "ENABLED",
"DetailType": "FULL",
"Resource": "arn:aws:codecommit:us-west-2:123456789012:MyDemoRepo",
"Arn": "arn:aws:codestar-notifications:us-west-w:123456789012:notificationrule/dc82df7a-EXAMPLE",
"Targets": [
{
"TargetStatus": "ACTIVE",
"TargetAddress": "arn:aws:sns:us-west-2:123456789012:MyNotificationTopic",
"TargetType": "SNS"
}
],
"Name": "MyNotificationRule",
"CreatedTimestamp": 1569199844.857,
"CreatedBy": "arn:aws:iam::123456789012:user/Mary_Major"
}
```
Pour plus d’informations, consultez [Affichage des règles de notification](https://docs.aws.amazon.com/codestar-notifications/latest/userguide/notification-rule-view.html) dans le *Guide de l’utilisateur de la console Outils pour développeurs AWS *.
+ Pour plus de détails sur l'API, reportez-vous [DescribeNotificationRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-notifications/describe-notification-rule.html)à la section *Référence des AWS CLI commandes*.
### `list-event-types`
L'exemple de code suivant montre comment utiliser`list-event-types`.
**AWS CLI**
**Pour obtenir une liste des types d’événement pour une règle de notification**
L'`list-event-types`exemple suivant extrait une liste filtrée de tous les types d'événements de notification disponibles pour les CodeDeploy applications. Si vous n’utilisez aucun filtre, la commande renvoie tous les types d’événements de notification pour tous les types de ressources.
```
aws codestar-notifications list-event-types \
--filters Name=SERVICE_NAME,Value=CodeDeploy
```
Sortie :
```
{
"EventTypes": [
{
"EventTypeId": "codedeploy-application-deployment-succeeded",
"ServiceName": "CodeDeploy",
"EventTypeName": "Deployment: Succeeded",
"ResourceType": "Application"
},
{
"EventTypeId": "codedeploy-application-deployment-failed",
"ServiceName": "CodeDeploy",
"EventTypeName": "Deployment: Failed",
"ResourceType": "Application"
},
{
"EventTypeId": "codedeploy-application-deployment-started",
"ServiceName": "CodeDeploy",
"EventTypeName": "Deployment: Started",
"ResourceType": "Application"
}
]
}
```
Pour plus d’informations, consultez [Création d’une règle de notification](https://docs.aws.amazon.com/codestar-notifications/latest/userguide/notification-rule-create.html) dans le *Guide de l’utilisateur de la console Outils pour développeurs AWS *.
+ Pour plus de détails sur l'API, reportez-vous [ListEventTypes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-notifications/list-event-types.html)à la section *Référence des AWS CLI commandes*.
### `list-notification-rules`
L'exemple de code suivant montre comment utiliser`list-notification-rules`.
**AWS CLI**
**Pour extraire une liste de règles de notification**
L'`list-notification-rules`exemple suivant extrait une liste de toutes les règles de notification dans la AWS région spécifiée.
```
aws codestar-notifications list-notification-rules --region us-east-1
```
Sortie :
```
{
"NotificationRules": [
{
"Id": "dc82df7a-EXAMPLE",
"Arn": "arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/dc82df7a-EXAMPLE"
},
{
"Id": "8d1f0983-EXAMPLE",
"Arn": "arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/8d1f0983-EXAMPLE"
}
]
}
```
Pour plus d’informations, consultez [Affichage des règles de notification](https://docs.aws.amazon.com/codestar-notifications/latest/userguide/notification-rule-view.html) dans le *Guide de l’utilisateur de la console Outils pour développeurs AWS *.
+ Pour plus de détails sur l'API, reportez-vous [ListNotificationRules](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-notifications/list-notification-rules.html)à la section *Référence des AWS CLI commandes*.
### `list-tags-for-resource`
L'exemple de code suivant montre comment utiliser`list-tags-for-resource`.
**AWS CLI**
**Pour obtenir la liste des balises attachées à une règle de notification**
L’exemple `list-tags-for-resource` suivant extrait une liste de toutes les balises associées à la règle de notification spécifiée. Dans cet exemple, aucune balise n’est actuellement associée à la règle de notification.
```
aws codestar-notifications list-tags-for-resource \
--arn arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/fe1efd35-EXAMPLE
```
Sortie :
```
{
"Tags": {}
}
```
Pour plus d’informations, consultez [Création d’une règle de notification](https://docs.aws.amazon.com/codestar-notifications/latest/userguide/notification-rule-create.html) dans le *Guide de l’utilisateur de la console Outils pour développeurs AWS *.
+ Pour plus de détails sur l'API, reportez-vous [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-notifications/list-tags-for-resource.html)à la section *Référence des AWS CLI commandes*.
### `list-targets`
L'exemple de code suivant montre comment utiliser`list-targets`.
**AWS CLI**
**Pour extraire une liste des cibles de règle de notification**
L'`list-targets`exemple suivant extrait une liste de toutes les cibles des règles de notification dans la AWS région spécifiée.
```
aws codestar-notifications list-targets \
--region us-east-1
```
Sortie :
```
{
"Targets": [
{
"TargetAddress": "arn:aws:sns:us-east-1:123456789012:MySNSTopicForNotificationRules",
"TargetType": "SNS",
"TargetStatus": "ACTIVE"
},
{
"TargetAddress": "arn:aws:sns:us-east-1:123456789012:MySNSTopicForNotificationsAboutMyDemoRepo",
"TargetType": "SNS",
"TargetStatus": "ACTIVE"
}
]
}
```
Pour plus d’informations, consultez [Affichage des cibles de règle de notification](https://docs.aws.amazon.com/codestar-notifications/latest/userguide/notification-target-view.html) dans le *Guide de l’utilisateur de la console Outils pour développeurs AWS *.
+ Pour plus de détails sur l'API, reportez-vous [ListTargets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-notifications/list-targets.html)à la section *Référence des AWS CLI commandes*.
### `subscribe`
L'exemple de code suivant montre comment utiliser`subscribe`.
**AWS CLI**
**Pour ajouter une cible à une règle de notification**
L’exemple `subscribe` suivant ajoute une rubrique Amazon SNS en tant que cible pour la règle de notification spécifiée.
```
aws codestar-notifications subscribe \
--arn arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/dc82df7a-EXAMPLE \
--target TargetType=SNS,TargetAddress=arn:aws:sns:us-east-1:123456789012:MyNotificationTopic
```
Sortie :
```
{
"Arn": "arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/dc82df7a-EXAMPLE"
}
```
Pour plus d’informations, consultez [Ajout ou suppression d’une rubrique Amazon SNS comme cible pour une règle de notification](https://docs.aws.amazon.com/codestar-notifications/latest/userguide/notification-target-change-rule.html) dans le *Guide de l’utilisateur de la console Outils pour développeurs AWS *.
+ Pour plus d’informations sur l’API, consultez [Subscribe](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-notifications/subscribe.html) dans la *Référence des commandes AWS CLI *.
### `tag-resource`
L'exemple de code suivant montre comment utiliser`tag-resource`.
**AWS CLI**
**Pour ajouter une balise à une règle de notification**
L’exemple `tag-resource` suivant ajoute une balise avec le nom de clé `Team` et une valeur `Li_Juan` à la règle de notification spécifiée.
```
aws codestar-notifications tag-resource \
--arn arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/fe1efd35-EXAMPLE \
--tags Team=Li_Juan
```
Sortie :
```
{
"Tags": {
"Team": "Li_Juan"
}
}
```
Pour plus d’informations, consultez [Création d’une règle de notification](https://docs.aws.amazon.com/codestar-notifications/latest/userguide/notification-rule-create.html) dans le *Guide de l’utilisateur de la console Outils pour développeurs AWS *.
+ Pour plus de détails sur l'API, reportez-vous [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-notifications/tag-resource.html)à la section *Référence des AWS CLI commandes*.
### `unsubscribe`
L'exemple de code suivant montre comment utiliser`unsubscribe`.
**AWS CLI**
**Pour supprimer une cible d’une règle de notification**
L’exemple `unsubscribe` suivant supprime une rubrique Amazon SNS en tant que cible de la règle de notification spécifiée.
```
aws codestar-notifications unsubscribe \
--arn arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/dc82df7a-EXAMPLE \
--target TargetType=SNS,TargetAddress=arn:aws:sns:us-east-1:123456789012:MyNotificationTopic
```
Sortie :
```
{
"Arn": "arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/dc82df7a-EXAMPLE"
"TargetAddress": "arn:aws:sns:us-east-1:123456789012:MyNotificationTopic"
}
```
Pour plus d’informations, consultez [Ajout ou suppression d’une rubrique Amazon SNS comme cible pour une règle de notification](https://docs.aws.amazon.com/codestar-notifications/latest/userguide/notification-target-change-rule.html) dans le *Guide de l’utilisateur de la console Outils pour développeurs AWS *.
+ Pour plus de détails sur l’API, consultez [Unsubscribe](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-notifications/unsubscribe.html) dans la *Référence des commandes de l’AWS CLI *.
### `untag-resource`
L'exemple de code suivant montre comment utiliser`untag-resource`.
**AWS CLI**
**Pour supprimer une balise d’une règle de notification**
L’exemple `untag-resource` suivant supprime la balise avec le nom de clé `Team` de la règle de notification spécifiée.
```
aws codestar-notifications untag-resource \
--arn arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/fe1efd35-EXAMPLE \
--tag-keys Team
```
Cette commande ne produit aucune sortie.
Pour plus d’informations, consultez [Modification d’une règle de notification](https://docs.aws.amazon.com/codestar-notifications/latest/userguide/notification-rule-edit.html) dans le *Guide de l’utilisateur de la console Outils pour développeurs AWS *.
+ Pour plus de détails sur l'API, reportez-vous [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-notifications/untag-resource.html)à la section *Référence des AWS CLI commandes*.
### `update-notification-rule`
L'exemple de code suivant montre comment utiliser`update-notification-rule`.
**AWS CLI**
**Pour mettre à jour une règle de notification**
L'`update-notification-rule`exemple suivant met à jour une règle de notification nommée `MyNotificationRule` dans le AWS compte à `123456789012` l'aide d'un fichier JSON nommé`update.json`.
```
aws codestar-notifications update-notification-rule \
--cli-input-json file://update.json
```
Contenu de `update.json` :
```
{
"Name": "MyUpdatedNotificationRule",
"EventTypeIds": [
"codecommit-repository-branches-and-tags-created"
],
"Resource": "arn:aws:codecommit:us-east-1:123456789012:MyDemoRepo",
"Targets": [
{
"TargetType": "SNS",
"TargetAddress": "arn:aws:sns:us-east-1:123456789012:MyNotificationTopic"
}
],
"Status": "ENABLED",
"DetailType": "FULL"
}
```
Sortie :
```
{
"Arn": "arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/dc82df7a-EXAMPLE"
}
```
Pour plus d’informations, consultez [Modification d’une règle de notification](https://docs.aws.amazon.com/dtconsole/latest/userguide/notification-rule-edit.html) dans le *Guide de l’utilisateur de la console Outils pour développeurs AWS *.
+ Pour plus de détails sur l'API, reportez-vous [UpdateNotificationRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-notifications/update-notification-rule.html)à la section *Référence des AWS CLI commandes*.