AWS CodeStar Beispiele für Benachrichtigungen mit AWS CLI - AWS SDK-Codebeispiele
Aktionen

Weitere AWS SDK-Beispiele sind im Repo AWS Doc SDK Examples GitHub verfügbar.

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 Szenarios anzeigen.

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

Themen

Aktionen

Das folgende Codebeispiel zeigt die Verwendungcreate-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 FULL Detailtyp werden an das angegebene Amazon SNS SNS-Zielthema gesendet, wenn Branches 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 Eine Benachrichtigungsregel erstellen im AWS Developer Tools Console-Benutzerhandbuch.

Das folgende Codebeispiel zeigt die Verwendungdelete-notification-rule.

AWS CLI

Um eine Benachrichtigungsregel zu löschen

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 AWS Developer Tools Console-Benutzerhandbuch.

Das folgende Codebeispiel zeigt die Verwendungdelete-target.

AWS CLI

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

Im folgenden delete-target Beispiel wird das angegebene Ziel aus allen Benachrichtigungsregeln entfernt, die so konfiguriert sind, dass es als Ziel verwendet wird. 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 AWS Developer Tools Console-Benutzerhandbuch.

  • Einzelheiten zur API finden Sie DeleteTargetunter AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungdescribe-notification-rule.

AWS CLI

Um Details einer Benachrichtigungsregel abzurufen

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 Benachrichtigungsregeln anzeigen im AWS Developer Tools Console-Benutzerhandbuch.

Das folgende Codebeispiel zeigt die Verwendunglist-event-types.

AWS CLI

Um eine Liste von Ereignistypen für eine Benachrichtigungsregel abzurufen

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 AWS Developer Tools Console-Benutzerhandbuch.

  • Einzelheiten zur API finden Sie ListEventTypesunter AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendunglist-notification-rules.

AWS CLI

Um eine Liste von Benachrichtigungsregeln abzurufen

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 Benachrichtigungsregeln anzeigen im AWS Developer Tools Console-Benutzerhandbuch.

Das folgende Codebeispiel zeigt die Verwendunglist-tags-for-resource.

AWS CLI

Um eine Liste von Tags abzurufen, die an eine Benachrichtigungsregel angehängt sind

Im folgenden list-tags-for-resource Beispiel wird eine Liste aller Tags abgerufen, die der angegebenen Benachrichtigungsregel zugeordnet 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 AWS Developer Tools Console-Benutzerhandbuch.

Das folgende Codebeispiel zeigt die Verwendunglist-targets.

AWS CLI

Um eine Liste von Zielen für Benachrichtigungsregeln abzurufen

Im folgenden list-targets Beispiel wird eine Liste aller Ziele für Benachrichtigungsregeln 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 Ziele für Benachrichtigungsregeln anzeigen im AWS Developer Tools Console-Benutzerhandbuch.

  • Einzelheiten zur API finden Sie ListTargetsunter AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungsubscribe.

AWS CLI

Um ein Ziel zu einer Benachrichtigungsregel hinzuzufügen

Im folgenden subscribe Beispiel wird ein Amazon SNS 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 SNS-Themas als Ziel für eine Benachrichtigungsregel im AWS Developer Tools Console-Benutzerhandbuch.

  • API-Details 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 tag-resource Beispiel wird der angegebenen Benachrichtigungsregel ein Tag mit dem Schlüsselnamen Team und Li_Juan dem Wert von 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 AWS Developer Tools Console-Benutzerhandbuch.

  • Einzelheiten zur API finden Sie TagResourceunter AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungunsubscribe.

AWS CLI

Um ein Ziel aus einer Benachrichtigungsregel zu entfernen

Im folgenden unsubscribe Beispiel wird ein Amazon SNS 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 SNS-Themas als Ziel für eine Benachrichtigungsregel im AWS Developer Tools Console-Benutzerhandbuch.

  • API-Details 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 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 AWS Developer Tools Console-Benutzerhandbuch.

  • Einzelheiten zur API finden Sie UntagResourceunter AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungupdate-notification-rule.

AWS CLI

Um eine Benachrichtigungsregel zu aktualisieren

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 AWS Developer Tools Console-Benutzerhandbuch.