# Ejemplos de notificaciones de AWS CodeStar que utilizan la AWS CLI
Los siguientes ejemplos de código muestran cómo realizar acciones e implementar escenarios comunes usando la AWS Command Line Interface para las notificaciones de AWS CodeStar.
Las *acciones* son extractos de código de programas más grandes y deben ejecutarse en contexto. Mientras las acciones muestran cómo llamar a las distintas funciones de servicio, es posible ver las acciones en contexto en los escenarios relacionados.
En cada ejemplo se incluye un enlace al código de origen completo, con instrucciones de configuración y ejecución del código en el contexto.
**Topics**
+ [Acciones](#actions)
## Acciones
### `create-notification-rule`
En el siguiente ejemplo de código, se muestra cómo utilizar `create-notification-rule`.
**AWS CLI**
**Creación de una regla de notificación**
En el siguiente ejemplo de `create-notification-rule`, se usa un archivo JSON denominado `rule.json` para crear una regla de notificación con el nombre `MyNotificationRule` para un repositorio con el nombre `MyDemoRepo` en la cuenta de AWS especificada. Las notificaciones con el tipo de detalle `FULL` se envían al tema de Amazon SNS de destino especificado cuando se crean las ramificaciones y las etiquetas.
```
aws codestar-notifications create-notification-rule \
--cli-input-json file://rule.json
```
Contenido 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 [Create a Notification rule](https://docs.aws.amazon.com/codestar-notifications/latest/userguide/notification-rule-create.html) en la *Guía del usuario de la Consola de herramientas para desarrolladores de AWS*.
+ Para obtener detalles sobre la API, consulte [CreateNotificationRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-notifications/create-notification-rule.html) en la *Referencia de comandos de la AWS CLI*.
### `delete-notification-rule`
En el siguiente ejemplo de código, se muestra cómo utilizar `delete-notification-rule`.
**AWS CLI**
**Eliminación de una regla de notificación**
En el siguiente ejemplo de `delete-notification-rule`, 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 [Delete a Notification rule](https://docs.aws.amazon.com/codestar-notifications/latest/userguide/notification-rule-delete.html) en la *Guía del usuario de la Consola de herramientas para desarrolladores de AWS*.
+ Para obtener detalles sobre la API, consulte [DeleteNotificationRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-notifications/delete-notification-rule.html) en la *Referencia de comandos de la AWS CLI*.
### `delete-target`
En el siguiente ejemplo de código, se muestra cómo utilizar `delete-target`.
**AWS CLI**
**Eliminación de un destino de regla de notificación**
En el siguiente ejemplo de `delete-target`, se elimina el destino especificado de todas las reglas de notificación configuradas para utilizarlo como destino y, a continuación, eliminar el destino.
```
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 [Delete a Notification Rule Target](https://docs.aws.amazon.com/codestar-notifications/latest/userguide/notification-target-delete.html) en la *Guía del usuario de la Consola de herramientas para desarrolladores de AWS*.
+ Para obtener detalles sobre la API, consulte [DeleteTarget](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-notifications/delete-target.html) en la *Referencia de comandos de la AWS CLI*.
### `describe-notification-rule`
En el siguiente ejemplo de código, se muestra cómo utilizar `describe-notification-rule`.
**AWS CLI**
**Visualización de la información de una regla de notificación**
En el siguiente ejemplo de `describe-notification-rule`, se recupera la información 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 [View Notification Rules](https://docs.aws.amazon.com/codestar-notifications/latest/userguide/notification-rule-view.html) en la *Guía del usuario de la Consola de herramientas para desarrolladores de AWS*.
+ Para obtener detalles sobre la API, consulte [DescribeNotificationRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-notifications/describe-notification-rule.html) en la *Referencia de comandos de la AWS CLI*.
### `list-event-types`
En el siguiente ejemplo de código, se muestra cómo utilizar `list-event-types`.
**AWS CLI**
**Obtención de una lista de tipos de eventos de una regla de notificación**
En el siguiente ejemplo de `list-event-types`, se recupera una lista filtrada de todos los tipos de eventos de notificación disponibles para las aplicaciones de CodeDeploy. 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 [Create a Notification Rule](https://docs.aws.amazon.com/codestar-notifications/latest/userguide/notification-rule-create.html) en la *Guía del usuario de la Consola de herramientas para desarrolladores de AWS*.
+ Para obtener detalles sobre la API, consulte [ListEventTypes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-notifications/list-event-types.html) en la *Referencia de comandos de la AWS CLI*.
### `list-notification-rules`
En el siguiente ejemplo de código, se muestra cómo utilizar `list-notification-rules`.
**AWS CLI**
**Visualización de una lista de reglas de notificación**
En el siguiente ejemplo de `list-notification-rules`, se recupera una lista de todas las reglas de notificación de la región de AWS 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 [View Notification Rules](https://docs.aws.amazon.com/codestar-notifications/latest/userguide/notification-rule-view.html) en la *Guía del usuario de la Consola de herramientas para desarrolladores de AWS*.
+ Para obtener detalles sobre la API, consulte [ListNotificationRules](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-notifications/list-notification-rules.html) en la *Referencia de comandos de la AWS CLI*.
### `list-tags-for-resource`
En el siguiente ejemplo de código, se muestra cómo utilizar `list-tags-for-resource`.
**AWS CLI**
**Obtención de una lista de etiquetas asociadas a una regla de notificación**
El siguiente ejemplo de `list-tags-for-resource` recupera una lista de todas las etiquetas asociadas 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 [Create a Notification Rule](https://docs.aws.amazon.com/codestar-notifications/latest/userguide/notification-rule-create.html) en la *Guía del usuario de la Consola de herramientas para desarrolladores de AWS*.
+ Para ver los detalles de la API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-notifications/list-tags-for-resource.html) en la *Referencia de comandos de la AWS CLI*.
### `list-targets`
En el siguiente ejemplo de código, se muestra cómo utilizar `list-targets`.
**AWS CLI**
**Visualización de una lista de destinos de reglas de notificación**
En el siguiente ejemplo de `list-targets`, se recupera una lista de todos los destinos de las reglas de notificación de la región AWS 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 [View Notification Rule Targets](https://docs.aws.amazon.com/codestar-notifications/latest/userguide/notification-target-view.html) en la *Guía del usuario de la Consola de herramientas para desarrolladores de AWS*.
+ Para obtener detalles sobre la API, consulte [ListTargets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-notifications/list-targets.html) en la *Referencia de comandos de la AWS CLI*.
### `subscribe`
En el siguiente ejemplo de código, se muestra cómo utilizar `subscribe`.
**AWS CLI**
**Adición de un destino a una regla de notificación**
En el siguiente ejemplo de `subscribe`, se añade un tema de Amazon SNS 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 [Add or Remove an Amazon SNS Topic as a Target for a Notification Rule](https://docs.aws.amazon.com/codestar-notifications/latest/userguide/notification-target-change-rule.html) en la *Guía del usuario de la Consola de herramientas para desarrolladores de AWS*.
+ Para obtener detalles sobre la API, consulte [Subscribe](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-notifications/subscribe.html) en la *Referencia de comandos de la AWS CLI*.
### `tag-resource`
En el siguiente ejemplo de código, se muestra cómo utilizar `tag-resource`.
**AWS CLI**
**Adición de una etiqueta a una regla de notificación**
En el siguiente ejemplo de `tag-resource`, se añade una etiqueta con el nombre de clave de `Team` y un 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 [Create a Notification Rule](https://docs.aws.amazon.com/codestar-notifications/latest/userguide/notification-rule-create.html) en la *Guía del usuario de la Consola de herramientas para desarrolladores de AWS*.
+ Para ver los detalles de la API, consulte [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-notifications/tag-resource.html) en la *Referencia de comandos de la AWS CLI*.
### `unsubscribe`
En el siguiente ejemplo de código, se muestra cómo utilizar `unsubscribe`.
**AWS CLI**
**Eliminación de un destino de una regla de notificación**
En el siguiente ejemplo de `unsubscribe`, se elimina un tema de Amazon SNS como destino para 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 [Add or Remove an Amazon SNS Topic as a Target for a Notification Rule](https://docs.aws.amazon.com/codestar-notifications/latest/userguide/notification-target-change-rule.html) en la *Guía del usuario de la Consola de herramientas para desarrolladores de AWS*.
+ Para obtener detalles sobre la API, consulte [Unsubscribe](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-notifications/unsubscribe.html) en la *Referencia de comandos de la AWS CLI*.
### `untag-resource`
En el siguiente ejemplo de código, se muestra cómo utilizar `untag-resource`.
**AWS CLI**
**Eliminación de una etiqueta de una regla de notificación**
En el siguiente ejemplo de `untag-resource`, se elimina la etiqueta con el nombre clave `Team` 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 [Edit a Notification Rule](https://docs.aws.amazon.com/codestar-notifications/latest/userguide/notification-rule-edit.html) en la *Guía del usuario de la Consola de herramientas para desarrolladores de AWS*.
+ Para ver los detalles de la API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-notifications/untag-resource.html) en la *Referencia de comandos de la AWS CLI*.
### `update-notification-rule`
En el siguiente ejemplo de código, se muestra cómo utilizar `update-notification-rule`.
**AWS CLI**
**Actualización de una regla de notificación**
En el siguiente ejemplo de `update-notification-rule`, se actualiza una regla de notificación denominada `MyNotificationRule` en la cuenta de AWS `123456789012` usando un archivo JSON denominado `update.json`.
```
aws codestar-notifications update-notification-rule \
--cli-input-json file://update.json
```
Contenido 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 [Edit a notification rule](https://docs.aws.amazon.com/dtconsole/latest/userguide/notification-rule-edit.html) en la *Guía del usuario de la Consola de herramientas para desarrolladores de AWS*.
+ Para obtener detalles sobre la API, consulte [UpdateNotificationRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-notifications/update-notification-rule.html) en la *Referencia de comandos de la AWS CLI*.