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

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

AWS CodeStar Beispiele für Benachrichtigungen mit AWS CLI

Die folgenden Codebeispiele zeigen Ihnen, wie Sie mithilfe von AWS Command Line Interface with AWS CodeStar Notifications Aktionen ausführen und allgemeine Szenarien implementieren.

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 Siecreate-notification-rule.

AWS CLI

Um eine Benachrichtigungsregel zu erstellen

Im folgenden create-notification-rule Beispiel wird eine JSON-Datei mit dem Namen verwendetrule.json, um eine Benachrichtigungsregel zu erstellen, MyNotificationRule die nach einem Repository benannt ist, das MyDemoRepo im angegebenen AWS Konto benannt ist. 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 die Verwendungdelete-notification-rule.

AWS CLI

Um eine Benachrichtigungsregel zu löschen

Im folgenden Beispiel für delete-notification-rule 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 die Verwendungdelete-target.

AWS CLI

Um ein Ziel für eine Benachrichtigungsregel zu löschen

Im folgenden Beispiel für delete-target 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.

  • Einzelheiten zur API finden Sie DeleteTargetin der AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungdescribe-notification-rule.

AWS CLI

So rufen Sie Details zu einer Benachrichtigungsregel ab

Im folgenden Beispiel für describe-notification-rule 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 die Verwendunglist-event-types.

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.

Das folgende Codebeispiel zeigt die Verwendunglist-notification-rules.

AWS CLI

So rufen Sie eine Liste mit Benachrichtigungsregeln ab

Im folgenden list-notification-rules Beispiel wird eine Liste aller 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 die Verwendunglist-tags-for-resource.

AWS CLI

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

Im folgenden Beispiel für list-tags-for-resource 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 die Verwendunglist-targets.

AWS CLI

So rufen Sie eine Liste mit Benachrichtigungsregelzielen ab

Im folgenden list-targets Beispiel wird eine Liste aller Benachrichtigungsregelziele 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.

Das folgende Codebeispiel zeigt die Verwendungsubscribe.

AWS CLI

Um ein Ziel zu einer Benachrichtigungsregel hinzuzufügen

Im folgenden Beispiel für subscribe 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.

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

Das folgende Codebeispiel zeigt die Verwendungtag-resource.

AWS CLI

Um einer Benachrichtigungsregel ein Tag hinzuzufügen

Im folgenden Beispiel für tag-resource 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.

  • Einzelheiten zur API finden Sie TagResourcein der AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungunsubscribe.

AWS CLI

Um ein Ziel aus einer Benachrichtigungsregel zu entfernen

Im folgenden Beispiel für unsubscribe 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.

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

Das folgende Codebeispiel zeigt die Verwendunguntag-resource.

AWS CLI

Um ein Tag aus einer Benachrichtigungsregel zu entfernen

Im folgenden Beispiel für untag-resource 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.

  • Einzelheiten zur API finden Sie UntagResourcein der AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungupdate-notification-rule.

AWS CLI

So aktualisieren Sie eine Benachrichtigungsregel

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

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.