Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.
Conceptos de notificación
Configurar y utilizar notificaciones resulta más sencillo si comprende los conceptos y términos. Aquí encontrará algunos conceptos que debe conocer cuando usa las notificaciones.
Temas
- Notificaciones
- Reglas de notificación
- Eventos
- Tipos de detalles
- implementación
- Notificaciones y AWS CodeStar Notifications
- Eventos de reglas de notificación en repositorios
- Eventos de reglas de notificación en proyectos de compilación
- Eventos de reglas de notificación en aplicaciones de implementación
- Eventos de reglas de notificación en canalizaciones
Notificaciones
Una notificación es un mensaje que incluye información sobre los eventos que se producen en los recursos que usted y sus desarrolladores utilizan. Puede configurar notificaciones para que los usuarios de un recurso, como, por ejemplo, un proyecto de compilación, un repositorio, una aplicación de implementación o una canalización, reciban correos electrónicos sobre los tipos de eventos que especifique en función de la regla de notificación que cree.
Las notificaciones para AWS CodeCommit pueden contener información de identidad del usuario, como un nombre de visualización o una dirección de email, mediante el uso de etiquetas de sesión. CodeCommit admite el uso de etiquetas de sesión, que son atributos de par clave-valor que se pasan cuando asume un rol de IAM, utiliza credenciales temporales o federa un usuario en AWS Security Token Service (AWS STS). También puede asociar etiquetas a un usuario de IAM. CodeCommit incluye los valores de displayName y emailAddress en el contenido de la notificación en caso de que esas etiquetas estén presentes. Para obtener más información, consulte Uso de etiquetas para proporcionar información adicional de identidad en CodeCommit.
importante
Las notificaciones incluyen información específica del proyecto, como, por ejemplo, estados de compilación, estado de implementación, líneas de código que tienen comentarios y aprobaciones de canalizaciones. El contenido de las notificaciones puede cambiar a medida que se añaden nuevas características. Como práctica recomendada de seguridad, debe revisar regularmente los destinos de las reglas de notificación y los suscriptores del tema de Amazon SNS. Para obtener más información, consulte Descripción del contenido y la seguridad de las notificaciones.
Reglas de notificación
Una regla de notificación es un recurso de AWS que se crea para especificar cuándo y dónde se envían las notificaciones. Define:
-
Las condiciones en las que se crea una notificación. Estas condiciones se basan en los eventos que elija, que son específicos del tipo de recurso. Entre los tipos de recursos admitidos, se incluyen proyectos de compilación de AWS CodeBuild, aplicaciones de implementación en AWS CodeDeploy, canalizaciones de AWS CodePipeline y repositorios de AWS CodeCommit.
-
Los destinos a los que se envía la notificación. Puede especificar hasta 10 destinos para una regla de notificación.
Las reglas de notificación se aplican a proyectos de compilación individuales, aplicaciones de implementación, canalizaciones y repositorios. Las reglas de notificación tienen nombres fáciles de recordar definidos por el usuario y nombres de recursos de Amazon (ARN). Las reglas de notificación deben crearse en la misma región de AWS en la que existe el recurso. Por ejemplo, si su proyecto de compilación está en la región EE. UU. Este (Ohio), la regla de notificación también debe crearse en la región EE. UU. Este (Ohio).
Puede definir hasta 10 reglas de notificación para un recurso.
Eventos
Un evento es un cambio de estado en un recurso que desea monitorear. Cada recurso tiene una lista de tipos de eventos entre los que puede elegir. Al configurar una regla de notificación en un recurso, usted especifica los eventos que hacen que se envíen notificaciones. Por ejemplo, si configura notificaciones para un repositorio en CodeCommit y selecciona Created (Creado) en Pull request (Solicitud de extracción) y en Branches and tags (Ramificaciones y etiquetas), se envía una notificación cada vez que un usuario de dicho repositorio crea una solicitud de extracción, ramificación o etiqueta de Git.
Tipos de detalles
Al crear una regla de notificación, puede elegir el nivel de detalle o el tipo de detalle que se va a incluir en las notificaciones (Full [Completo] o Basic [Básico]). El valor Full (Completo), que es el predeterminado, incluye toda la información disponible para el evento en la notificación, incluida la información mejorada que proporcionan los servicios para eventos específicos. El valor Basic (Básico) incluye solo un subconjunto de la información disponible.
En la siguiente tabla se muestra la información mejorada disponible para tipos de eventos específicos y se describen las diferencias entre los tipos de detalles.
| Servicio | Evento | Full incluye | Basic no incluye |
|---|---|---|---|
|
CodeCommit |
Comentarios sobre confirmaciones Comentarios sobre solicitudes de extracción |
Todos los detalles del evento y el contenido del comentario, incluidas las respuestas o los hilos de comentarios. También incluye el número de línea y la línea de código sobre la que se realizó el comentario. |
El contenido del comentario, el número de línea, la línea de código ni los hilos de comentarios. |
|
CodeCommit |
Solicitud de extracción creada |
Todos los detalles del evento y el número de archivos que se agregaron, se modificaron o se eliminaron en la solicitud de extracción en relación con la rama de destino. |
Ninguna lista de archivos ni detalles acerca de si la rama de origen de la solicitud de extracción ha agregado, modificado o eliminado archivos. |
|
CodePipeline |
Requiere aprobación manual |
Todos los detalles del evento y los datos personalizados (si están configurados). La notificación también incluye un enlace a la aprobación requerida en la canalización. |
No hay datos personalizados ni enlaces. |
|
CodePipeline |
Error al ejecutar la acción Error al ejecutar la canalización Error al ejecutar la etapa |
Todos los detalles del evento y el contenido del mensaje del error correspondiente. |
Ningún contenido de mensaje de error. |
implementación
Un destino es una ubicación para recibir notificaciones de reglas de notificación. Los tipos de destinos permitidos son temas de Amazon SNS y clientes de AWS Chatbot configurados para canales de Slack o Microsoft Teams. Todos los usuarios suscritos al destino reciben notificaciones sobre los eventos que especifique en la regla de notificación.
Si desea ampliar el alcance de las notificaciones, puede configurar manualmente la integración entre las notificaciones y AWS Chatbot para que las notificaciones se envíen a las salas de chat de Amazon Chime. A continuación, puede elegir el tema de Amazon SNS que está configurado para ese cliente de AWS Chatbot como destino de la regla de notificación. Para obtener más información, consulte Para integrar notificaciones en AWS Chatbot y Amazon Chime.
Si decide utilizar un cliente de AWS Chatbot como destino, primero debe crear ese cliente en AWS Chatbot. Cuando se elige un cliente de AWS Chatbot como destino para una regla de notificación, se configura un tema de Amazon SNS para ese cliente de AWS Chatbot con todas las políticas necesarias para que las notificaciones se envíen al canal de Slack o Microsoft Teams. No es necesario configurar ningún tema de Amazon SNS existente para el cliente de AWS Chatbot.
Puede elegir crear un tema de Amazon SNS como destino durante la creación de una regla de notificación (recomendado). También puede elegir un tema de Amazon SNS existente que se encuentre en la misma región de AWS que la regla de notificación, pero debe configurarlo con la política requerida. El tema de Amazon SNS que utilice para un destino debe estar presente en su cuenta de AWS. También debe estar presente en la misma región de AWS que la regla de notificación y que el recurso de AWS para el que se creó la regla.
Por ejemplo, si crea una regla de notificación para un repositorio en la región EE. UU. Este (Ohio), el tema de Amazon SNS también debe existir en dicha región. Si crea un tema de Amazon SNS como parte de la creación de una regla de notificación, el tema se configura con la política necesaria para permitir la publicación de eventos en él. Este es el mejor método para trabajar con destinos y reglas de notificación. Si decide utilizar un tema ya existente o crear uno manualmente, debe configurarlo con los permisos requeridos para que los usuarios reciban notificaciones. Para obtener más información, consulte Configuración de los temas de Amazon SNS para las notificaciones.
nota
Si desea utilizar un tema de Amazon SNS existente en lugar de crear uno nuevo, en Targets (Destinos), elija su ARN. Asegúrese de que el tema tiene la política de acceso adecuada y de que la lista de suscriptores contiene solo aquellos usuarios que tienen permiso para ver información sobre el recurso. Si el tema de Amazon SNS corresponde a uno que se utilizaba para las notificaciones de CodeCommit antes del 5 de noviembre de 2019, contendrá una política que permite a CodeCommit publicar en ella y que contenga permisos distintos a los necesarios para AWS CodeStar Notifications. No se recomienda usar estos temas. Si desea usar uno creado para dicha experiencia, debe agregar la política requerida a AWS CodeStar Notifications además de la que ya existe. Para obtener más información, consulte Configuración de los temas de Amazon SNS para las notificaciones y Descripción del contenido y la seguridad de las notificaciones.
Notificaciones y AWS CodeStar Notifications
Las notificaciones, aunque son una característica de la consola de herramientas para desarrolladores, tienen su propia API, AWS CodeStar Notifications. También tiene su propio tipo de recurso AWS (reglas de notificación), permisos y eventos. Los eventos para las reglas de notificación se registran en AWS CloudTrail. Las acciones de la API se pueden permitir o denegar a través de políticas de IAM.
Eventos de reglas de notificación en repositorios
| Categoría | Eventos | Id. de evento |
|---|---|---|
|
Comentarios |
On commits (Sobre confirmaciones) On pull requests (Sobre solicitudes de extracción) |
|
| Aprobaciones |
Status changed (Estado cambiado) Invalidación de reglas |
|
|
Pull request (Solicitud de extracción) |
Created (Creado) Source updated (Origen actualizado) Status changed (Estado cambiado) Merged (Fusionado) |
|
|
Branches and tags (Ramificaciones y etiquetas) |
Created (Creado) Deleted (Eliminado) Actualizado |
codecommit-repository-branches-and-tags-updated |
Eventos de reglas de notificación en proyectos de compilación
| Categoría | Eventos | Id. de evento |
|---|---|---|
|
Build state (Estado de compilación) |
Con error Succeeded In-progress (En curso) Stopped (Detenido) |
|
|
Build phase (Fase de compilación) |
Error Correcto |
|
Eventos de reglas de notificación en aplicaciones de implementación
| Categoría | Eventos | Id. de evento |
|---|---|---|
|
Implementación |
Con error Succeeded Started |
codedeploy-application-deployment-started |
Eventos de reglas de notificación en canalizaciones
| Categoría | Eventos | Id. de evento |
|---|---|---|
|
Action execution (Ejecución de acciones) |
Succeeded Con error Cancelado Started |
|
|
Stage execution (Ejecución de etapas) |
Started Succeeded RESUMED (REANUDADO) Cancelado Con error |
|
|
Pipeline execution (Ejecución de canalizaciones) |
Con error Cancelado Started RESUMED (REANUDADO) Succeeded SUPERSEDED (SUSTITUIDO) |
|
|
Manual approval (Aprobación manual) |
Con error Needed (Necesario) Succeeded |
codepipeline-pipeline-manual-approval-succeeded |
