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à.
I seguenti esempi di codice mostrano come eseguire azioni e implementare scenari comuni utilizzando AWS Command Line Interface with AWS CodeStar Notifications.
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 collegamento al codice sorgente completo, in cui è possibile trovare istruzioni su come configurare ed eseguire il codice nel contesto.
Argomenti
Operazioni
Il seguente esempio di codice mostra come utilizzarecreate-notification-rule
.
- AWS CLI
-
Per creare una regola di notifica
L'
create-notification-rule
esempio seguente utilizza un file JSON denominatorule.json
per creare una regola di notifica denominataMyNotificationRule
per un repository denominatoMyDemoRepo
nell'account specificato AWS . Le notifiche con il tipo diFULL
dettaglio 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 Creare una regola di notifica nella Guida per l'utente della console AWS Developer Tools.
-
Per i dettagli sull'API, consulta CreateNotificationRule AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzaredelete-notification-rule
.
- AWS CLI
-
Per eliminare una regola di notifica
L'
delete-notification-rule
esempio 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 Eliminare una regola di notifica nella Guida per l'utente della console AWS Developer Tools.
-
Per i dettagli sull'API, consulta DeleteNotificationRule AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzaredelete-target
.
- AWS CLI
-
Per eliminare un obiettivo di una regola di notifica
L'
delete-target
esempio seguente rimuove la destinazione specificata da tutte le regole di notifica configurate per utilizzarla come destinazione, quindi elimina la destinazione.aws codestar-notifications delete-target \ --target-address
arn:aws:sns:us-east-1:123456789012:MyNotificationTopic
\ --force-unsubscribe-allQuesto comando non produce alcun output.
Per ulteriori informazioni, consulta Eliminare un oggetto con una regola di notifica nella Guida per l'utente della console AWS Developer Tools.
-
Per i dettagli sull'API, consulta DeleteTarget AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzaredescribe-notification-rule
.
- AWS CLI
-
Per recuperare i dettagli di una regola di notifica
L'
describe-notification-rule
esempio 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 Visualizza le regole di notifica nella Guida per l'utente della console AWS Developer Tools.
-
Per i dettagli sull'API, consulta DescribeNotificationRule AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzarelist-event-types
.
- AWS CLI
-
Per ottenere un elenco di tipi di eventi per una regola di notifica
L'
list-event-types
esempio 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 Creare una regola di notifica nella Guida per l'utente della console AWS Developer Tools.
-
Per i dettagli sull'API, consulta ListEventTypes AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzarelist-notification-rules
.
- AWS CLI
-
Per recuperare un elenco di regole di notifica
L'
list-notification-rules
esempio seguente recupera un elenco di tutte le regole di notifica nella regione specificata AWS .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 Visualizza le regole di notifica nella Guida per l'utente della console AWS Developer Tools.
-
Per i dettagli sull'API, consulta ListNotificationRules AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzarelist-tags-for-resource
.
- AWS CLI
-
Per ottenere un elenco di tag allegati a una regola di notifica
L'
list-tags-for-resource
esempio seguente recupera un elenco di tutti i tag allegati 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 Creare una regola di notifica nella Guida per l'utente della console AWS Developer Tools.
-
Per i dettagli sull'API, consulta ListTagsForResource AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzarelist-targets
.
- AWS CLI
-
Per recuperare un elenco di obiettivi delle regole di notifica
L'
list-targets
esempio seguente recupera un elenco di tutti gli obiettivi delle regole di notifica nella regione specificata AWS .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 Visualizza gli obiettivi delle regole di notifica nella Guida per l'utente della console AWS Developer Tools.
-
Per i dettagli sull'API, consulta ListTargets AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzaresubscribe
.
- AWS CLI
-
Per aggiungere un obiettivo a una regola di notifica
L'
subscribe
esempio 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
\ --targetTargetType=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 di Amazon SNS come obiettivo per una regola di notifica nella Guida per l'utente della console AWS Developer Tools.
-
Per informazioni dettagliate sulle API, consulta Subscribe
nel Riferimento ai comandi AWS CLI .
-
Il seguente esempio di codice mostra come usaretag-resource
.
- AWS CLI
-
Per aggiungere un tag a una regola di notifica
L'
tag-resource
esempio seguente aggiunge un tag con il nome della chiaveTeam
e il valore diLi_Juan
alla regola di notifica specificata.aws codestar-notifications tag-resource \ --arn
arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/fe1efd35-EXAMPLE
\ --tagsTeam=Li_Juan
Output:
{ "Tags": { "Team": "Li_Juan" } }
Per ulteriori informazioni, consulta Creare una regola di notifica nella Guida per l'utente della console AWS Developer Tools.
-
Per i dettagli sull'API, consulta TagResource AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareunsubscribe
.
- AWS CLI
-
Per rimuovere un obiettivo da una regola di notifica
L'
unsubscribe
esempio 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
\ --targetTargetType=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 di Amazon SNS come obiettivo per una regola di notifica nella Guida per l'utente della console AWS Developer Tools.
-
Per informazioni dettagliate sulle API, consulta Unsubscribe
nel Riferimento ai comandi AWS CLI .
-
Il seguente esempio di codice mostra come usareuntag-resource
.
- AWS CLI
-
Per rimuovere un tag da una regola di notifica
L'
untag-resource
esempio seguente rimuove il tag con il nome della chiaveTeam
dalla regola di notifica specificata.aws codestar-notifications untag-resource \ --arn
arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/fe1efd35-EXAMPLE
\ --tag-keysTeam
Questo comando non produce alcun output.
Per ulteriori informazioni, consulta Modifica di una regola di notifica nella Guida per l'utente della console AWS Developer Tools.
-
Per i dettagli sull'API, consulta UntagResource AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareupdate-notification-rule
.
- AWS CLI
-
Per aggiornare una regola di notifica
L'
update-notification-rule
esempio seguente aggiorna una regola di notifica denominataMyNotificationRule
nell' AWS account123456789012
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 Modificare una regola di notifica nella Guida per l'utente della console AWS Developer Tools.
-
Per i dettagli sull'API, consulta UpdateNotificationRule AWS CLI
Command Reference.
-