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 FULL détail sont envoyées à la rubrique Amazon SNS cible spécifiée lorsque des branches et des 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 la section Création d'une règle de notification dans le guide de l'utilisateur de la console AWS Developer Tools.

Pour supprimer une règle de notification

L'delete-notification-ruleexemple 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, voir Supprimer une règle de notification dans le guide de l'utilisateur de la console AWS Developer Tools.

Pour supprimer une cible de règle de notification

L'delete-targetexemple 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.

aws codestar-notifications  delete-target \
    --target-address arn:aws:sns:us-east-1:123456789012:MyNotificationTopic \
    --force-unsubscribe-all

Cette commande ne produit aucun résultat.

Pour plus d'informations, voir Supprimer une cible de règle de notification dans le guide de l'utilisateur de la console AWS Developer Tools.

Pour récupérer les détails d'une règle de notification

L'describe-notification-ruleexemple suivant récupère les détails de 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 la section Afficher les règles de notification dans le guide de l'utilisateur de la console AWS Developer Tools.

Pour obtenir la liste des types d'événements 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, voir Création d'une règle de notification dans le guide de l'utilisateur de la console AWS Developer Tools.

Pour récupérer la liste des 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 la section Afficher les règles de notification dans le guide de l'utilisateur de la console AWS Developer Tools.

Pour obtenir la liste des balises associées à une règle de notification

L'list-tags-for-resourceexemple 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, voir Création d'une règle de notification dans le guide de l'utilisateur de la console AWS Developer Tools.

Pour récupérer une liste des cibles des règles 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, voir Afficher les cibles des règles de notification dans le guide de l'utilisateur de la console AWS Developer Tools.

Pour ajouter une cible à une règle de notification

L'subscribeexemple 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 la section Ajouter ou supprimer une rubrique Amazon SNS en tant que cible pour une règle de notification dans le guide de l'utilisateur de la console AWS Developer Tools.

Pour ajouter un tag à une règle de notification

L'tag-resourceexemple suivant ajoute une balise avec le nom de clé Team et la valeur de 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, voir Création d'une règle de notification dans le guide de l'utilisateur de la console AWS Developer Tools.

Pour supprimer une cible d'une règle de notification

L'unsubscribeexemple 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 la section Ajouter ou supprimer une rubrique Amazon SNS en tant que cible pour une règle de notification dans le guide de l'utilisateur de la console AWS Developer Tools.

Pour supprimer un tag d'une règle de notification

L'untag-resourceexemple suivant supprime la balise portant le nom Team de la clé 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 aucun résultat.

Pour plus d'informations, voir Modifier une règle de notification dans le guide de l'utilisateur de la console AWS Developer Tools.

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, voir Modifier une règle de notification dans le guide de l'utilisateur de la console AWS Developer Tools.