Esempi per l’API Notifications per AWS CodeStar con AWS CLI - AWS Command Line Interface
Operazioni

Esempi per l’API Notifications per AWS CodeStar con AWS CLI

Gli esempi di codice seguenti mostrano come eseguire azioni e implementare scenari comuni utilizzando AWS Command Line Interface con l’API Notifications per AWS CodeStar.

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

Ogni esempio include un link al codice sorgente completo, dove è possibile trovare le istruzioni su come configurare ed eseguire il codice nel contesto.

Argomenti

Operazioni

L’esempio di codice seguente mostra come utilizzare create-notification-rule.

AWS CLI

Per creare una regola di notifica

Nell’esempio seguente create-notification-rule utilizza un file JSON denominato rule.json per creare una regola di notifica denominata MyNotificationRule per un repository denominato MyDemoRepo nell’account AWS specificato. Le notifiche con il tipo di dettaglio FULL vengono inviate all’argomento Amazon SNS di destinazione specificato quando vengono creati rami 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 AWSGuida per l’utente della console degli strumenti per sviluppatori.

L’esempio di codice seguente mostra come utilizzare delete-notification-rule.

AWS CLI

Per eliminare una regola di notifica

Nell’esempio seguente delete-notification-rule 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 AWSGuida per l’utente della console degli strumenti per sviluppatori.

L’esempio di codice seguente mostra come utilizzare delete-target.

AWS CLI

Per eliminare una destinazione delle regole di notifica

Nell’esempio seguente delete-target 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 AWSGuida per l’utente della console degli strumenti per sviluppatori.

  • Per informazioni dettagliate sull’API, consulta DeleteTarget in AWS CLI Command Reference.

L’esempio di codice seguente mostra come utilizzare describe-notification-rule.

AWS CLI

Come recuperare i dettagli di una regola di notifica

Nell’esempio seguente describe-notification-rule 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 AWSGuida per l’utente della console degli strumenti per sviluppatori.

L’esempio di codice seguente mostra come utilizzare list-event-types.

AWS CLI

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

Nell’esempio seguente list-event-types recupera un elenco filtrato di tutti i tipi di eventi di notifica disponibili per le applicazioni CodeDeploy. 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 AWSGuida per l’utente della console degli strumenti per sviluppatori.

  • Per informazioni dettagliate sull’API, consulta ListEventTypes in AWS CLI Command Reference.

L’esempio di codice seguente mostra come utilizzare list-notification-rules.

AWS CLI

Come recuperare un elenco di regole di notifica

Nell’esempio seguente list-notification-rules recupera un elenco di tutte le regole di notifica nella Regione AWS 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 AWSGuida per l’utente della console degli strumenti per sviluppatori.

L’esempio di codice seguente mostra come utilizzare list-tags-for-resource.

AWS CLI

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

Nell’esempio seguente list-tags-for-resource 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 AWSGuida per l’utente della console degli strumenti per sviluppatori.

  • Per informazioni dettagliate sull'API, consulta ListTagsForResource nella Documentazione di riferimento dei comandi della AWS CLI.

L’esempio di codice seguente mostra come utilizzare list-targets.

AWS CLI

Come recuperare un elenco di destinazioni di regole di notifica

Nell’esempio seguente list-targets recupera un elenco di tutte le destinazioni delle regole di notifica nella Regione AWS 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 AWSGuida per l’utente della console degli strumenti per sviluppatori.

  • Per informazioni dettagliate sull’API, consulta ListTargets in AWS CLI Command Reference.

L’esempio di codice seguente mostra come utilizzare subscribe.

AWS CLI

Come aggiungere una destinazione a una regola di notifica

Nell’esempio seguente subscribe 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 Add or Remove an Amazon SNS Topic as a Target for a Notification Rule nella Guida per l’utente della console degli strumenti per sviluppatori AWS.

  • Per informazioni dettagliate sulle API, consulta Subscribe nel Riferimento ai comandi AWS CLI.

L’esempio di codice seguente mostra come utilizzare tag-resource.

AWS CLI

Come aggiungere un tag a una regola di notifica

Nell’esempio seguente tag-resource 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 AWSGuida per l’utente della console degli strumenti per sviluppatori.

  • Per informazioni dettagliate sulle API, consulta TagResource nel Riferimento ai comandi AWS CLI.

L’esempio di codice seguente mostra come utilizzare unsubscribe.

AWS CLI

Per rimuovere una destinazione da una regola di notifica

Nell’esempio seguente unsubscribe 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 Add or Remove an Amazon SNS Topic as a Target for a Notification Rule nella Guida per l’utente della console degli strumenti per sviluppatori AWS.

  • Per informazioni dettagliate sulle API, consulta Unsubscribe nel Riferimento ai comandi AWS CLI.

L’esempio di codice seguente mostra come utilizzare untag-resource.

AWS CLI

Come rimuovere un tag da una regola di notifica

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 AWSGuida per l’utente della console degli strumenti per sviluppatori.

  • Per i dettagli dell'API, consulta UntagResource in Riferimento ai comandi della AWS CLI.

L’esempio di codice seguente mostra come utilizzare update-notification-rule.

AWS CLI

Come aggiornare una regola di notifica

Nell’esempio seguente update-notification-rule aggiorna una regola di notifica denominata MyNotificationRule nell’account AWS 123456789012 utilizzando un file JSON denominato update.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 AWSGuida per l’utente della console degli strumenti per sviluppatori.