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.
CreateEventSubscription
Crea una suscripción de notificación de eventos de Amazon DocumentDB. Esta acción requiere un nombre de recurso de Amazon (ARN) de tema creado por la consola de Amazon DocumentDB, la consola de Amazon SNS o la API de Amazon SNS. Para obtener un ARN con Amazon SNS, debe crear un tema en Amazon SNS y suscribirse al tema. El ARN se muestra en la consola de Amazon SNS.
Puede especificar el tipo de origen (SourceType) sobre el que desea recibir notificaciones. También puede proporcionar una lista de las fuentes de Amazon DocumentDB (SourceIds) que desencadenan los eventos y puede proporcionar una lista de categorías de eventos (EventCategories) para los eventos de los que desee recibir notificaciones. Por ejemplo, puede especificar SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 y EventCategories = Availability, Backup.
Si especifica ambos valores SourceType y SourceIds, como, por ejemplo, SourceType = db-instance y SourceIdentifier = myDBInstance1, recibirá todos los eventos db-instance del origen especificado. Si especifica un SourceType, pero no especifica SourceIdentifier, recibirá notificaciones de los eventos de ese tipo de origen para todos sus orígenes de Amazon DocumentDB. Si no especifica ni SourceType ni SourceIdentifier, recibirá notificaciones de los eventos generados desde todos los orígenes de Amazon DocumentDB que pertenezcan a su cuenta de cliente.
Parámetros de la solicitud
Para obtener información sobre los parámetros comunes a todas las acciones, consulte Parámetros comunes.
- SnsTopicArn
-
El Nombre de recurso de Amazon (ARN) del tema SNS creado para la notificación de eventos. El ARN es creado por Amazon SNS al crear un tema y suscribirse a él.
Tipo: cadena
Obligatorio: sí
- SubscriptionName
-
El nombre de la suscripción.
Restricciones: el nombre debe tener menos de 255 caracteres.
Tipo: cadena
Obligatorio: sí
- Enabled
-
Establezca un valor booleano en
truepara activar la suscripción y enfalsepara crear la suscripción, pero sin activarla.Tipo: Booleano
Obligatorio: no
- EventCategories. EventCategoryN.
-
Una lista de las categorías de eventos para un
SourceTypea los que desea suscribirse.Tipo: matriz de cadenas
Obligatorio: no
- SourceIds. SourceIdN.
-
La lista de identificadores de los orígenes de eventos para los que se devuelven eventos. Si no se especifica, se incluyen todos los orígenes en la respuesta. Un identificador debe comenzar por una letra y solo deben contener letras ASCII, números y guiones; y no pueden terminar con un guion o contener dos guiones consecutivos.
Restricciones:
-
Si se proporciona
SourceIds, también se debe proporcionarSourceType. -
Si el tipo de origen es una instancia, debe proporcionarse un
DBInstanceIdentifier. -
Si el tipo de origen es un grupo de seguridad, debe proporcionarse un
DBSecurityGroupName. -
Si el tipo de origen es un grupo de parámetros, debe proporcionarse un
DBParameterGroupName. -
Si el tipo de origen es una instantánea de base de datos, debe proporcionarse un
DBSnapshotIdentifier.
Tipo: matriz de cadenas
Obligatorio: no
-
- SourceType
-
El tipo de origen que está generando los eventos. Por ejemplo, si desea recibir una notificación de eventos generados por una instancia, defina este parámetro como
db-instance. Si no se especifica este valor, se devuelven todos los eventos.Valores válidos:
db-instance,db-cluster,db-parameter-group,db-security-group,db-cluster-snapshotTipo: cadena
Requerido: no
- Tags.Tag.N
-
Las etiquetas que se asignarán a la suscripción de eventos.
Tipo: matriz de objetos Tag
Obligatorio: no
Elementos de respuesta
El servicio devuelve el siguiente elemento.
- EventSubscription
-
Información detallada sobre un evento al que se ha suscrito.
Tipo: objeto EventSubscription
Errores
Para obtener información acerca de los errores comunes a todas las acciones, consulte Errores comunes.
- EventSubscriptionQuotaExceeded
-
Ha alcanzado el número máximo de suscripciones a eventos.
Código de estado HTTP: 400
- SNSInvalidTopic
-
Amazon SNS ha respondido que hay un problema con el tema especificado.
Código de estado HTTP: 400
- SNSNoAuthorization
-
No tiene permiso para publicar en el tema SNS Nombre de recurso de Amazon (ARN).
Código de estado HTTP: 400
- SNSTopicArnNotFound
-
El nombre de recurso de Amazon (ARN) del tema de SNS no existe.
Código de estado HTTP: 404
- SourceNotFound
-
No se ha encontrado el origen solicitado.
Código de estado HTTP: 404
- SubscriptionAlreadyExist
-
El nombre de suscripción proporcionado ya existe.
Código de estado HTTP: 400
- SubscriptionCategoryNotFound
-
La categoría proporcionada no existe.
Código de estado HTTP: 404
Véase también
Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulte lo siguiente:
