AWS CodeStar Esempi di notifiche utilizzando AWS CLI - AWS Command Line Interface
Azioni

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

AWS CodeStar Esempi di notifiche utilizzando AWS CLI

I seguenti esempi di codice mostrano come eseguire azioni e implementare scenari comuni utilizzando AWS Command Line Interface with AWS CodeStar Notifications.

Le azioni sono estratti di codice da programmi più grandi e devono essere eseguite nel contesto. Sebbene le azioni mostrino come richiamare le singole funzioni del servizio, è possibile visualizzarle contestualizzate negli scenari correlati.

Ogni esempio include un link al codice sorgente completo, in cui vengono fornite le istruzioni su come configurare ed eseguire il codice nel contesto.

Argomenti

Azioni

Il seguente esempio di codice mostra come utilizzarecreate-notification-rule.

AWS CLI

Come creare una regola di notifica

L'create-notification-ruleesempio seguente utilizza un file JSON denominato rule.json per creare una regola di notifica denominata MyNotificationRule per un repository denominato MyDemoRepo nell'account specificato AWS . Le notifiche con il tipo di dettaglio FULL vengono inviate all’argomento Amazon SNS di destinazione specificato quando vengono creati ramificazioni e tag.

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

Contenuto di 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"
}

Output:

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

Per ulteriori informazioni, consulta Creazione di una regola di notifica nella Guida per l’utente della console degli strumenti per sviluppatori AWS .

Il seguente esempio di codice mostra come utilizzaredelete-notification-rule.

AWS CLI

Come eliminare una regola di notifica

L’esempio delete-notification-rule seguente elimina la regola di notifica specificata.

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

Output:

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

Per ulteriori informazioni, consulta Eliminazione di una regola di notifica nella Guida per l’utente della console degli strumenti per sviluppatori AWS .

Il seguente esempio di codice mostra come utilizzaredelete-target.

AWS CLI

Come eliminare una destinazione delle regole di notifica

L’esempio delete-target seguente rimuove la destinazione da tutte le regole di notifica configurate per l’utilizzo come destinazione, quindi elimina la destinazione.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Eliminazione di una destinazione delle regole di notifica nella Guida per l’utente della console degli strumenti per sviluppatori AWS .

Il seguente esempio di codice mostra come utilizzaredescribe-notification-rule.

AWS CLI

Come recuperare i dettagli di una regola di notifica

L’esempio describe-notification-rule seguente recupera i dettagli della regola di notifica specificata.

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

Output:

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

Per ulteriori informazioni, consulta Visualizzazione delle regole di notifica nella Guida per l’utente della console degli strumenti per sviluppatori AWS .

Il seguente esempio di codice mostra come utilizzarelist-event-types.

AWS CLI

Come un elenco dei tipi di eventi per le regole di notifica

L'list-event-typesesempio seguente recupera un elenco filtrato di tutti i tipi di eventi di notifica disponibili per CodeDeploy le applicazioni. Se invece non si utilizza alcun filtro, il comando restituisce tutti i tipi di eventi di notifica per tutti i tipi di risorse.

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

Output:

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

Per ulteriori informazioni, consulta Creazione di una regola di notifica nella Guida per l’utente della console degli strumenti per sviluppatori AWS .

  • Per i dettagli sull'API, vedere ListEventTypesin AWS CLI Command Reference.

Il seguente esempio di codice mostra come utilizzarelist-notification-rules.

AWS CLI

Come recuperare un elenco di regole di notifica

L'list-notification-rulesesempio seguente recupera un elenco di tutte le regole di notifica nella AWS regione specificata.

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

Output:

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

Per ulteriori informazioni, consulta Visualizzazione delle regole di notifica nella Guida per l’utente della console degli strumenti per sviluppatori AWS .

Il seguente esempio di codice mostra come utilizzarelist-tags-for-resource.

AWS CLI

Come ottenere un elenco di tag allegati a una regola di notifica

L’esempio list-tags-for-resource seguente recupera un elenco di tutti i tag associati alla regola di notifica specificata. In questo esempio, alla regola di notifica non sono attualmente associati tag.

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

Output:

{
    "Tags": {}
}

Per ulteriori informazioni, consulta Creazione di una regola di notifica nella Guida per l’utente della console degli strumenti per sviluppatori AWS .

Il seguente esempio di codice mostra come utilizzarelist-targets.

AWS CLI

Come recuperare un elenco di destinazioni di regole di notifica

L'list-targetsesempio seguente recupera un elenco di tutti gli obiettivi delle regole di notifica nella AWS regione specificata.

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

Output:

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

Per ulteriori informazioni, consulta Visualizzazione delle destinazioni delle regole di notifica nella Guida per l’utente della console degli strumenti per sviluppatori AWS .

  • Per i dettagli sull'API, vedere ListTargetsin AWS CLI Command Reference.

Il seguente esempio di codice mostra come utilizzaresubscribe.

AWS CLI

Come aggiungere una destinazione a una regola di notifica

L’esempio subscribe seguente aggiunge un argomento Amazon SNS come destinazione per la regola di notifica specificata.

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

Output:

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

Per ulteriori informazioni, consulta Aggiungere o rimuovere un argomento Amazon SNS come una destinazione per una regola di notifica nella Guida per l’utente della console degli strumenti per sviluppatori AWS .

  • Per informazioni dettagliate sull’API, consulta Subscribe nella documentazione di riferimento dei comandi della AWS CLI .

Il seguente esempio di codice mostra come utilizzaretag-resource.

AWS CLI

Come aggiungere un tag a una regola di notifica

L’esempio tag-resource seguente aggiunge un tag con il nome di chiave Team e il valore Li_Juan alla regole di notifica specificata.

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

Output:

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

Per ulteriori informazioni, consulta Creazione di una regola di notifica nella Guida per l’utente della console degli strumenti per sviluppatori AWS .

Il seguente esempio di codice mostra come utilizzareunsubscribe.

AWS CLI

Come rimuovere una destinazione da una regola di notifica

L’esempio unsubscribe seguente rimuove un argomento Amazon SNS come destinazione dalla regola di notifica specificata.

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

Output:

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

Per ulteriori informazioni, consulta Aggiungere o rimuovere un argomento Amazon SNS come una destinazione per una regola di notifica nella Guida per l’utente della console degli strumenti per sviluppatori AWS .

  • Per informazioni dettagliate sull’API, consulta Unsubscribe nella documentazione di riferimento dei comandi della AWS CLI .

Il seguente esempio di codice mostra come utilizzareuntag-resource.

AWS CLI

Come rimuovere un tag da una regola di destinazione

L’esempio untag-resource seguente rimuove il tag con il nome di chiave Team dalla regola di notifica specificata.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Modifica di una regola di notifica nella Guida per l’utente della console degli strumenti per sviluppatori AWS .

Il seguente esempio di codice mostra come utilizzareupdate-notification-rule.

AWS CLI

Come aggiornare una regola di notifica

L'update-notification-ruleesempio seguente aggiorna una regola di notifica denominata MyNotificationRule nell' AWS account 123456789012 utilizzando un file JSON denominatoupdate.json.

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

Contenuto di 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"
}

Output:

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

Per ulteriori informazioni, consulta Modifica di una regola di notifica nella Guida per l’utente della console degli strumenti per sviluppatori AWS .