Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.
CreateEventSubscription
Crée un abonnement aux notifications d'événements Amazon DocumentDB. Cette action nécessite un nom de ressource Amazon (ARN) de rubrique créé à l'aide de la console Amazon DocumentDB, de la console Amazon SNS ou de l'API Amazon SNS. Pour obtenir un ARN avec Amazon SNS, vous devez créer une rubrique dans Amazon SNS et vous y abonner. L'ARN est affiché dans la console Amazon SNS.
Vous pouvez spécifier le type de source (SourceType) dont vous souhaitez être informé. Vous pouvez également fournir une liste des sources Amazon DocumentDB (SourceIds) qui déclenchent les événements, ainsi qu'une liste de catégories d'événements (EventCategories) pour les événements dont vous souhaitez être informé. Par exemple, vous pouvez spécifierSourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 etEventCategories = Availability, Backup.
Si vous spécifiez à la fois le SourceType et SourceIds (tel que SourceType = db-instance etSourceIdentifier = myDBInstance1), vous êtes informé de tous les db-instance événements relatifs à la source spécifiée. Si vous spécifiez a SourceType mais pas aSourceIdentifier, vous êtes informé des événements associés à ce type de source pour toutes vos sources Amazon DocumentDB. Si vous ne spécifiez SourceType ni leSourceIdentifier, vous êtes informé des événements générés par toutes les sources Amazon DocumentDB appartenant à votre compte client.
Paramètres de demande
Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez Paramètres courants.
- SnsTopicArn
-
Amazon Resource Name (ARN) de la rubrique SNS créé pour la notification d'événements. Amazon SNS crée l'ARN lorsque vous créez une rubrique et que vous vous y abonnez.
Type : String
Obligatoire : oui
- SubscriptionName
-
Nom de l'abonnement.
Contraintes : Le nom doit comporter moins de 255 caractères.
Type : String
Obligatoire : oui
- Enabled
-
Valeur booléenne ; définie sur
truepour activer l'abonnement, définie pourfalsecréer l'abonnement mais pas pour l'activer.Type : booléen
Obligatoire : non
- EventCategories. EventCategoryN.
-
Liste des catégories d'événements
SourceTypeauxquels vous souhaitez vous abonner.Type : tableau de chaînes
Obligatoire : non
- SourceIds. SourceIdN.
-
Liste des identifiants des sources d'événements pour lesquels des événements sont renvoyés. Si la valeur n'est pas spécifiée, toutes les sources sont incluses dans la réponse. Un identifiant doit commencer par une lettre et contenir uniquement des lettres ASCII, des chiffres et des tirets. Il ne doit pas se terminer par un tiret ou contenir deux tirets consécutifs.
Contraintes :
-
S'
SourceIdsils sont fournis, ilsSourceTypedoivent également être fournis. -
Si le type de source est une instance, un
DBInstanceIdentifierdoit être fourni. -
Si le type de source est un groupe de sécurité, un
DBSecurityGroupNamedoit être fourni. -
Si le type de source est un groupe de paramètres, un
DBParameterGroupNamedoit être fourni. -
Si le type de source est un instantané, un
DBSnapshotIdentifierdoit être fourni.
Type : tableau de chaînes
Obligatoire : non
-
- SourceType
-
Type de source qui génère les événements. Par exemple, si vous souhaitez être informé des événements générés par une instance, vous devez définir ce paramètre sur
db-instance. Si cette valeur n'est pas spécifiée, tous les événements sont renvoyés.Valeurs valides:
db-instance,db-cluster,db-parameter-group,db-security-group,db-cluster-snapshotType : chaîne
Obligatoire : non
- Étiquettes.Tag.N
-
Les tags à attribuer à l'abonnement à l'événement.
Type : tableau d’objets Tag
Obligatoire : non
Éléments de réponse
L'élément suivant est renvoyé par le service.
- EventSubscription
-
Informations détaillées sur un événement auquel vous vous êtes inscrit.
Type : objet EventSubscription
Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez Erreurs courantes.
- EventSubscriptionQuotaExceeded
-
Vous avez atteint le nombre maximum d'abonnements aux événements.
Code d’état HTTP : 400
- SNSInvalidTopic
-
Amazon SNS a répondu qu'il y avait un problème avec le sujet spécifié.
Code d’état HTTP : 400
- SNSNoAuthorization
-
Vous n'êtes pas autorisé à publier sur la rubrique SNS Amazon Resource Name (ARN).
Code d’état HTTP : 400
- SNSTopicArnNotFound
-
La rubrique SNS Amazon Resource Name (ARN) n'existe pas.
Code d’état HTTP : 404
- SourceNotFound
-
La source demandée n'a pas pu être trouvée.
Code d’état HTTP : 404
- SubscriptionAlreadyExist
-
Le nom d'abonnement fourni existe déjà.
Code d’état HTTP : 400
- SubscriptionCategoryNotFound
-
La catégorie fournie n'existe pas.
Code d’état HTTP : 404
consultez aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
