AWS CodeStar Ejemplos de notificaciones que utilizan AWS CLI

Para crear una regla de notificación

En el siguiente create-notification-rule ejemplo, se utiliza un JSON archivo denominado rule.json para crear una regla de notificación con el nombre MyNotificationRule de un repositorio nombrado MyDemoRepo en la AWS cuenta especificada. Las notificaciones con el tipo de FULL detalle se envían al SNS tema de Amazon de destino especificado cuando se crean las sucursales y las etiquetas.

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

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

Salida:

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

Para obtener más información, consulte Crear una regla de notificación en la Guía del usuario de AWS Developer Tools Console.

Para eliminar una regla de notificación

En el siguiente delete-notification-rule ejemplo, se elimina la regla de notificación especificada.

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

Salida:

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

Para obtener más información, consulte Eliminar una regla de notificación en la Guía del usuario de AWS Developer Tools Console.

Para eliminar un objetivo de regla de notificación

En el siguiente delete-target ejemplo, se elimina el objetivo especificado de todas las reglas de notificación configuradas para usarlo como destino y, a continuación, se elimina el objetivo.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte Eliminar un objetivo de regla de notificación en la Guía del usuario de AWS Developer Tools Console.

Para recuperar los detalles de una regla de notificación

En el siguiente describe-notification-rule ejemplo, se recuperan los detalles de la regla de notificación especificada.

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

Salida:

{
    "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 obtener más información, consulte Ver las reglas de notificación en la Guía del usuario de AWS Developer Tools Console.

Para obtener una lista de los tipos de eventos de una regla de notificación

En el siguiente list-event-types ejemplo, se recupera una lista filtrada de todos los tipos de eventos de notificación disponibles para CodeDeploy las aplicaciones. Si, por el contrario, no utiliza ningún filtro, el comando devuelve todos los tipos de eventos de notificación para todos los tipos de recursos.

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

Salida:

{
    "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 obtener más información, consulte Crear una regla de notificación en la Guía del usuario de AWS Developer Tools Console.

Para recuperar una lista de reglas de notificación

En el siguiente list-notification-rules ejemplo, se recupera una lista de todas las reglas de notificación de la AWS región especificada.

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

Salida:

{
    "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 obtener más información, consulte Ver las reglas de notificación en la Guía del usuario de AWS Developer Tools Console.

Para obtener una lista de etiquetas adjuntas a una regla de notificación

En el siguiente list-tags-for-resource ejemplo, se recupera una lista de todas las etiquetas adjuntas a la regla de notificación especificada. En este ejemplo, la regla de notificación actualmente no tiene ninguna etiqueta asociada.

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

Salida:

{
    "Tags": {}
}

Para obtener más información, consulte Crear una regla de notificación en la Guía del usuario de AWS Developer Tools Console.

Para recuperar una lista de los objetivos de las reglas de notificación

En el siguiente list-targets ejemplo, se recupera una lista de todos los objetivos de las reglas de notificación de la AWS región especificada.

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

Salida:

{
    "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 obtener más información, consulte Ver los objetivos de las reglas de notificación en la Guía del usuario de AWS Developer Tools Console.

Para añadir un objetivo a una regla de notificación

En el siguiente subscribe ejemplo, se añade un SNS tema de Amazon como destino para la regla de notificación 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

Salida:

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

Para obtener más información, consulte Añadir o eliminar un SNS tema de Amazon como objetivo de una regla de notificación en la Guía del usuario de AWS Developer Tools Console.

Para añadir una etiqueta a una regla de notificación

En el siguiente tag-resource ejemplo, se agrega una etiqueta con el nombre de clave Team y el valor de Li_Juan a la regla de notificación especificada.

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

Salida:

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

Para obtener más información, consulte Crear una regla de notificación en la Guía del usuario de AWS Developer Tools Console.

Para eliminar un objetivo de una regla de notificación

En el siguiente unsubscribe ejemplo, se elimina un SNS tema de Amazon como objetivo de la regla de notificación 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

Salida:

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

Para obtener más información, consulte Añadir o eliminar un SNS tema de Amazon como objetivo de una regla de notificación en la Guía del usuario de AWS Developer Tools Console.

Para eliminar una etiqueta de una regla de notificación

En el siguiente untag-resource ejemplo, se elimina la etiqueta con el nombre Team de clave de la regla de notificación especificada.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte Editar una regla de notificación en la Guía del usuario de AWS Developer Tools Console.

Para actualizar una regla de notificación

En el siguiente update-notification-rule ejemplo, se actualiza una regla de notificación nombrada MyNotificationRule en la AWS cuenta 123456789012 mediante un JSON archivo denominadoupdate.json.

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

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

Salida:

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

Para obtener más información, consulte Editar una regla de notificación en la Guía del usuario de AWS Developer Tools Console.