AWS CodeStar Exemplos de notificações usando AWS CLI - AWS SDKExemplos de código
Ações

Há mais AWS SDK exemplos disponíveis no GitHub repositório AWS Doc SDK Examples.

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

AWS CodeStar Exemplos de notificações usando AWS CLI

Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com AWS CodeStar notificações.

Ações são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar funções de serviço individuais, é possível ver as ações no contexto em seus cenários relacionados.

Cada exemplo inclui um link para o código-fonte completo, onde você pode encontrar instruções sobre como configurar e executar o código no contexto.

Tópicos

Ações

O código de exemplo a seguir mostra como usar create-notification-rule.

AWS CLI

Para criar uma regra de notificação

O create-notification-rule exemplo a seguir usa um JSON arquivo chamado rule.json para criar uma regra de notificação com o nome MyNotificationRule de um repositório nomeado MyDemoRepo na AWS conta especificada. As notificações com o tipo de FULL detalhe são enviadas para o SNS tópico de destino especificado da Amazon quando filiais e tags são criadas.

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

Conteúdo de 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"
}

Saída:

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

Para obter mais informações, consulte Criar uma regra de notificação no Guia do usuário do AWS Developer Tools Console.

O código de exemplo a seguir mostra como usar delete-notification-rule.

AWS CLI

Para excluir uma regra de notificação

O delete-notification-rule exemplo a seguir exclui a regra de notificação especificada.

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

Saída:

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

Para obter mais informações, consulte Excluir uma regra de notificação no Guia do usuário do AWS Developer Tools Console.

O código de exemplo a seguir mostra como usar delete-target.

AWS CLI

Para excluir um alvo de regra de notificação

O delete-target exemplo a seguir remove o alvo especificado de todas as regras de notificação configuradas para usá-lo como alvo e, em seguida, exclui o alvo.

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

Este comando não produz saída.

Para obter mais informações, consulte Excluir um alvo de regra de notificação no Guia do usuário do AWS Developer Tools Console.

  • Para API obter detalhes, consulte DeleteTargetna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar describe-notification-rule.

AWS CLI

Para recuperar detalhes de uma regra de notificação

O describe-notification-rule exemplo a seguir recupera os detalhes da regra de notificação especificada.

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

Saída:

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

Para obter mais informações, consulte Exibir regras de notificação no Guia do usuário do AWS Developer Tools Console.

O código de exemplo a seguir mostra como usar list-event-types.

AWS CLI

Para obter uma lista de tipos de eventos para uma regra de notificação

O list-event-types exemplo a seguir recupera uma lista filtrada de todos os tipos de eventos de notificação disponíveis para CodeDeploy aplicativos. Se, em vez disso, você não usar nenhum filtro, o comando retornará todos os tipos de eventos de notificação para todos os tipos de recursos.

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

Saída:

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

Para obter mais informações, consulte Criar uma regra de notificação no Guia do usuário do AWS Developer Tools Console.

  • Para API obter detalhes, consulte ListEventTypesna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar list-notification-rules.

AWS CLI

Para recuperar uma lista de regras de notificação

O list-notification-rules exemplo a seguir recupera uma lista de todas as regras de notificação na AWS região especificada.

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

Saída:

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

Para obter mais informações, consulte Exibir regras de notificação no Guia do usuário do AWS Developer Tools Console.

O código de exemplo a seguir mostra como usar list-tags-for-resource.

AWS CLI

Para obter uma lista de tags anexadas a uma regra de notificação

O list-tags-for-resource exemplo a seguir recupera uma lista de todas as tags anexadas à regra de notificação especificada. Neste exemplo, a regra de notificação atualmente não tem tags associadas a ela.

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

Saída:

{
    "Tags": {}
}

Para obter mais informações, consulte Criar uma regra de notificação no Guia do usuário do AWS Developer Tools Console.

O código de exemplo a seguir mostra como usar list-targets.

AWS CLI

Para recuperar uma lista de alvos de regras de notificação

O list-targets exemplo a seguir recupera uma lista de todos os alvos da regra de notificação na AWS região especificada.

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

Saída:

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

Para obter mais informações, consulte Exibir metas de regras de notificação no Guia do usuário do AWS Developer Tools Console.

  • Para API obter detalhes, consulte ListTargetsna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar subscribe.

AWS CLI

Para adicionar um alvo a uma regra de notificação

O subscribe exemplo a seguir adiciona um SNS tópico da Amazon como destino para a regra de notificação especificada.

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

Saída:

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

Para obter mais informações, consulte Adicionar ou remover um SNS tópico da Amazon como alvo para uma regra de notificação no Guia do usuário do AWS Developer Tools Console.

  • Para API obter detalhes, consulte Inscrever-se na Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar tag-resource.

AWS CLI

Para adicionar uma tag a uma regra de notificação

O tag-resource exemplo a seguir adiciona uma tag com o nome da chave Team e o valor de Li_Juan à regra de notificação especificada.

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

Saída:

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

Para obter mais informações, consulte Criar uma regra de notificação no Guia do usuário do AWS Developer Tools Console.

  • Para API obter detalhes, consulte TagResourcena Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar unsubscribe.

AWS CLI

Para remover um alvo de uma regra de notificação

O unsubscribe exemplo a seguir remove um SNS tópico da Amazon como alvo da regra de notificação especificada.

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

Saída:

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

Para obter mais informações, consulte Adicionar ou remover um SNS tópico da Amazon como alvo para uma regra de notificação no Guia do usuário do AWS Developer Tools Console.

O código de exemplo a seguir mostra como usar untag-resource.

AWS CLI

Para remover uma tag de uma regra de notificação

O untag-resource exemplo a seguir remove a tag com o nome Team da chave da regra de notificação especificada.

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

Este comando não produz saída.

Para obter mais informações, consulte Editar uma regra de notificação no Guia do usuário do AWS Developer Tools Console.

  • Para API obter detalhes, consulte UntagResourcena Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar update-notification-rule.

AWS CLI

Para atualizar uma regra de notificação

O update-notification-rule exemplo a seguir atualiza uma regra de notificação nomeada MyNotificationRule na AWS conta 123456789012 usando um JSON arquivo chamadoupdate.json.

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

Conteúdo de 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"
}

Saída:

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

Para obter mais informações, consulte Editar uma regra de notificação no Guia do usuário do AWS Developer Tools Console.