Beispiele für die Verwendung der AWS CLI mit AWS CodeStar-Benachrichtigungen - AWS Command Line Interface
Aktionen

Beispiele für die Verwendung der AWS CLI mit AWS CodeStar-Benachrichtigungen

Die folgenden Codebeispiele zeigen, wie Sie Aktionen durchführen und gängige Szenarien implementieren, indem Sie die AWS Command Line Interface mit AWS CodeStar-Benachrichtigungen nutzen.

Aktionen sind Codeauszüge aus größeren Programmen und müssen im Kontext ausgeführt werden. Während Aktionen Ihnen zeigen, wie Sie einzelne Service-Funktionen aufrufen, können Sie Aktionen im Kontext der zugehörigen Szenarien anzeigen.

Jedes Beispiel enthält einen Link zum vollständigen Quellcode, wo Sie Anleitungen zum Einrichten und Ausführen des Codes im Kontext finden.

Themen

Aktionen

Das folgende Codebeispiel zeigt, wie create-notification-rule verwendet wird.

AWS CLI

So erstellen Sie eine Benachrichtigungsregel

Das folgende create-notification-rule-Beispiel verwendet eine JSON-Datei mit dem Namen rule.json, um eine Benachrichtigungsregel namens MyNotificationRule für ein Repository mit dem Namen MyDemoRepo im angegebenen AWS-Konto zu erstellen. Benachrichtigungen mit dem Detailtyp FULL werden an das angegebene Amazon-SNS-Thema gesendet, wenn Zweige und Tags erstellt werden.

aws codestar-notifications create-notification-rule \
    --cli-input-json file://rule.json

Inhalt von 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"
}

Ausgabe:

{
    "Arn": "arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/dc82df7a-EXAMPLE"
}

Weitere Informationen finden Sie unter Erstellen einer Benachrichtigungsregel im Benutzerhandbuch zur AWS-Entwicklertools-Konsole.

Das folgende Codebeispiel zeigt, wie delete-notification-rule verwendet wird.

AWS CLI

So löschen Sie eine Benachrichtigungsregel

Im folgenden delete-notification-rule-Beispiel wird die angegebene Benachrichtigungsregel gelöscht.

aws codestar-notifications delete-notification-rule \
    --arn arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/dc82df7a-EXAMPLE

Ausgabe:

{
    "Arn": "arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/dc82df7a-EXAMPLE"
}

Weitere Informationen finden Sie unter Löschen einer Benachrichtigungsregel im Benutzerhandbuch zur AWS-Entwicklertools-Konsole.

Das folgende Codebeispiel zeigt, wie delete-target verwendet wird.

AWS CLI

So löschen Sie ein Benachrichtigungsregelziel

Im folgenden delete-target-Beispiel wird das angegebene Ziel aus allen Benachrichtigungsregeln entfernt, die für die Verwendung dieses Ziels als Ziel konfiguriert sind. Anschließend wird das Ziel gelöscht.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Löschen eines Benachrichtigungsregelziels im Benutzerhandbuch zur AWS-Entwicklertools-Konsole.

  • API-Details finden Sie unter DeleteTarget in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie describe-notification-rule verwendet wird.

AWS CLI

So rufen Sie Details zu einer Benachrichtigungsregel ab

Im folgenden describe-notification-rule-Beispiel werden die Details der angegebenen Benachrichtigungsregel abgerufen.

aws codestar-notifications describe-notification-rule \
    --arn arn:aws:codestar-notifications:us-west-2:123456789012:notificationrule/dc82df7a-EXAMPLE

Ausgabe:

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

Weitere Informationen finden Sie unter Anzeigen von Benachrichtigungsregeln im Benutzerhandbuch zur AWS-Entwicklertools-Konsole.

Das folgende Codebeispiel zeigt, wie list-event-types verwendet wird.

AWS CLI

So rufen Sie eine Liste mit Ereignistypen für eine Benachrichtigungsregel ab

Im folgenden list-event-types-Beispiel wird eine gefilterte Liste aller verfügbaren Benachrichtigungsereignistypen für CodeDeploy-Anwendungen abgerufen. Wenn Sie stattdessen keinen Filter verwenden, gibt der Befehl alle Benachrichtigungsereignistypen für alle Ressourcentypen zurück.

aws codestar-notifications list-event-types \
    --filters Name=SERVICE_NAME,Value=CodeDeploy

Ausgabe:

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

Weitere Informationen finden Sie unter Erstellen einer Benachrichtigungsregel im Benutzerhandbuch zur AWS-Entwicklertools-Konsole.

  • API-Details finden Sie unter ListEventTypes in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie list-notification-rules verwendet wird.

AWS CLI

So rufen Sie eine Liste von Benachrichtigungsregeln ab

Im folgenden list-notification-rules-Beispiel wird eine Liste mit allen Benachrichtigungsregeln in der angegebenen AWS-Region abgerufen.

aws codestar-notifications list-notification-rules --region us-east-1

Ausgabe:

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

Weitere Informationen finden Sie unter Anzeigen von Benachrichtigungsregeln im Benutzerhandbuch zur AWS-Entwicklertools-Konsole.

Das folgende Codebeispiel zeigt, wie list-tags-for-resource verwendet wird.

AWS CLI

So rufen Sie eine Liste von Tags ab, die an eine Benachrichtigungsregel angehängt sind

Im folgenden list-tags-for-resource-Beispiel wird eine Liste aller Tags abgerufen, die an die angegebene Benachrichtigungsregel angehängt sind. In diesem Beispiel sind der Benachrichtigungsregel derzeit keine Tags zugeordnet.

aws codestar-notifications list-tags-for-resource \
    --arn arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/fe1efd35-EXAMPLE

Ausgabe:

{
    "Tags": {}
}

Weitere Informationen finden Sie unter Erstellen einer Benachrichtigungsregel im Benutzerhandbuch zur AWS-Entwicklertools-Konsole.

Das folgende Codebeispiel zeigt, wie list-targets verwendet wird.

AWS CLI

So rufen Sie eine Liste mit Benachrichtigungsregelzielen ab

Im folgenden list-targets-Beispiel wird eine Liste mit allen Benachrichtigungsregelzielen in der angegebenen AWS-Region abgerufen.

aws codestar-notifications list-targets \
    --region us-east-1

Ausgabe:

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

Weitere Informationen finden Sie unter Anzeigen von Benachrichtigungsregelzielen im Benutzerhandbuch zur AWS-Entwicklertools-Konsole.

  • API-Details finden Sie unter ListTargets in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie subscribe verwendet wird.

AWS CLI

So fügen Sie einer Benachrichtigungsregel ein Ziel hinzu

Im folgenden subscribe-Beispiel wird ein Amazon-SNS-Thema als Ziel für die angegebene Benachrichtigungsregel hinzugefügt.

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

Ausgabe:

{
    "Arn": "arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/dc82df7a-EXAMPLE"
}

Weitere Informationen finden Sie unter Hinzufügen oder Entfernen eines Amazon-SNS-Themas als Ziel für eine Benachrichtigungsregel im Benutzerhandbuch zur AWS-Entwicklertools-Konsole.

  • API-Details finden Sie unter Subscribe in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie tag-resource verwendet wird.

AWS CLI

So fügen Sie einer Benachrichtigungsregel ein Tag hinzu

Im folgenden tag-resource-Beispiel wird der angegebenen Benachrichtigungsregel ein Tag mit dem Schlüsselnamen Team und dem Wert Li_Juan hinzugefügt.

aws codestar-notifications tag-resource \
    --arn arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/fe1efd35-EXAMPLE \
    --tags Team=Li_Juan

Ausgabe:

{
    "Tags": {
        "Team": "Li_Juan"
    }
}

Weitere Informationen finden Sie unter Erstellen einer Benachrichtigungsregel im Benutzerhandbuch zur AWS-Entwicklertools-Konsole.

  • API-Details finden Sie unter TagResource in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie unsubscribe verwendet wird.

AWS CLI

So entfernen Sie ein Ziel aus einer Benachrichtigungsregel

Im folgenden unsubscribe-Beispiel wird ein Amazon-SNS-Thema als Ziel aus der angegebenen Benachrichtigungsregel entfernt.

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

Ausgabe:

{
    "Arn": "arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/dc82df7a-EXAMPLE"
    "TargetAddress": "arn:aws:sns:us-east-1:123456789012:MyNotificationTopic"
}

Weitere Informationen finden Sie unter Hinzufügen oder Entfernen eines Amazon-SNS-Themas als Ziel für eine Benachrichtigungsregel im Benutzerhandbuch zur AWS-Entwicklertools-Konsole.

  • API-Details finden Sie unter Unsubscribe in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie untag-resource verwendet wird.

AWS CLI

So entfernen Sie ein Tag aus einer Benachrichtigungsregel

Im folgenden untag-resource-Beispiel wird das Tag mit dem Schlüsselnamen Team aus der angegebenen Benachrichtigungsregel entfernt.

aws codestar-notifications untag-resource \
    --arn arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/fe1efd35-EXAMPLE \
    --tag-keys Team

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Bearbeiten einer Benachrichtigungsregel im Benutzerhandbuch zur AWS-Entwicklertools-Konsole.

  • API-Details finden Sie unter UntagResource in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie update-notification-rule verwendet wird.

AWS CLI

So aktualisieren Sie eine Benachrichtigungsregel

Im folgenden update-notification-rule-Beispiel wird eine Benachrichtigungsregel mit dem Namen MyNotificationRule im AWS-Konto 123456789012 mithilfe einer JSON-Datei namens update.json aktualisiert.

aws codestar-notifications update-notification-rule \
    --cli-input-json file://update.json

Inhalt von 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"
}

Ausgabe:

{
    "Arn": "arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/dc82df7a-EXAMPLE"
}

Weitere Informationen finden Sie unter Bearbeiten einer Benachrichtigungsregel im Benutzerhandbuch zur AWS-Entwicklertools-Konsole.