AWS CodeStar Exemples de notifications utilisant AWS CLI

Pour créer une règle de notification

L'create-notification-ruleexemple 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 dans le Guide de l’utilisateur de la console Outils pour développeurs AWS .

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 dans le Guide de l’utilisateur de la console Outils pour développeurs AWS .

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 dans le Guide de l’utilisateur de la console Outils pour développeurs AWS .

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 dans le Guide de l’utilisateur de la console Outils pour développeurs AWS .

Pour obtenir une liste des types d’événement pour une règle de notification

L'list-event-typesexemple 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 dans le Guide de l’utilisateur de la console Outils pour développeurs AWS .

Pour extraire une liste de règles de notification

L'list-notification-rulesexemple 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 dans le Guide de l’utilisateur de la console Outils pour développeurs AWS .

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 dans le Guide de l’utilisateur de la console Outils pour développeurs AWS .

Pour extraire une liste des cibles de règle de notification

L'list-targetsexemple 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 dans le Guide de l’utilisateur de la console Outils pour développeurs AWS .

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 dans le Guide de l’utilisateur de la console Outils pour développeurs AWS .

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 dans le Guide de l’utilisateur de la console Outils pour développeurs AWS .

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 dans le Guide de l’utilisateur de la console Outils pour développeurs AWS .

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 dans le Guide de l’utilisateur de la console Outils pour développeurs AWS .

Pour mettre à jour une règle de notification

L'update-notification-ruleexemple 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 dans le Guide de l’utilisateur de la console Outils pour développeurs AWS .