CreateEventSubscription

Erstellt ein Abonnement für Amazon DocumentDB DocumentDB-Ereignisbenachrichtigungen. Für diese Aktion ist ein Thema mit dem Amazon Resource Name (ARN) erforderlich, das mithilfe der Amazon DocumentDB DocumentDB-Konsole, der Amazon SNS SNS-Konsole oder der Amazon SNS SNS-API erstellt wurde. Um einen ARN mit Amazon SNS zu erhalten, müssen Sie ein Thema in Amazon SNS erstellen und das Thema abonnieren. Der ARN wird in der Amazon SNS SNS-Konsole angezeigt.

Sie können den Typ der Quelle (SourceType) angeben, über die Sie benachrichtigt werden möchten. Sie können auch eine Liste der Amazon DocumentDB DocumentDB-Quellen (SourceIds) angeben, die die Ereignisse auslösen, und Sie können eine Liste von Ereigniskategorien (EventCategories) für Ereignisse bereitstellen, über die Sie benachrichtigt werden möchten. Sie können beispielsweise angebenSourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 undEventCategories = Availability, Backup.

Wenn Sie sowohl als auch angeben SourceIds (z. B. SourceType = db-instance undSourceIdentifier = myDBInstance1), werden Sie über alle db-instance Ereignisse für die angegebene Quelle informiert. SourceType Wenn Sie eine angeben, SourceType aber keine angebenSourceIdentifier, erhalten Sie eine Benachrichtigung über die Ereignisse für diesen Quelltyp für alle Ihre Amazon DocumentDB DocumentDB-Quellen. Wenn Sie weder das noch das SourceType angeben, werden Sie über Ereignisse informiertSourceIdentifier, die aus allen Amazon DocumentDB DocumentDB-Quellen generiert wurden, die zu Ihrem Kundenkonto gehören.

Anforderungsparameter

Informationen zu den Parametern, die alle Aktionen gemeinsam haben, finden Sie unter Allgemeine Parameter.

SnsTopicArn

Der Amazon-Ressourcenname (ARN) des SNS-Themas, das für die Ereignisbenachrichtigung erstellt wurde. Amazon SNS erstellt den ARN, wenn Sie ein Thema erstellen und es abonnieren.

Typ: Zeichenfolge

Erforderlich: Ja

SubscriptionName

Der Name des Abonnements.

Einschränkungen: Der Name muss weniger als 255 Zeichen lang sein.

Typ: Zeichenfolge

Erforderlich: Ja

Enabled

Ein boolescher Wert. Wird auf gesetzt, true um das Abonnement zu aktivieren, gesetzt auf, false um das Abonnement zu erstellen, aber nicht zu aktivieren.

Typ: Boolesch

Erforderlich: Nein

EventCategories. EventCategoryN

Eine Liste der Veranstaltungskategorien für eineSourceType, die Sie abonnieren möchten.

Typ: Zeichenfolgen-Array

Erforderlich: Nein

SourceIds. SourceIdN

Die Liste der IDs der Ereignisquellen, für die Ereignisse zurückgegeben werden. Wenn nicht angegeben, werden alle Quellen zur Antwort hinzugefügt. Eine ID muss mit einem Buchstaben beginnen und darf nur ASCII-Buchstaben, Ziffern und Bindestriche enthalten; sie darf nicht mit einem Bindestrich oder zwei aufeinander folgenden Bindestrichen enden.

Einschränkungen:

• Wenn SourceIds angegeben, SourceType muss auch angegeben werden.

• Wenn der Quelltyp eine Instanz ist, DBInstanceIdentifier muss a angegeben werden.

• Wenn der Quelltyp eine Sicherheitsgruppe ist, DBSecurityGroupName muss a angegeben werden.

• Wenn der Quelltyp eine Parametergruppe ist, DBParameterGroupName muss a angegeben werden.

• Wenn der Quelltyp ein Snapshot ist, DBSnapshotIdentifier muss a angegeben werden.

Typ: Zeichenfolgen-Array

Erforderlich: Nein

SourceType

Der Typ der Quelle, die die Ereignisse generiert. Wenn Sie beispielsweise über Ereignisse informiert werden möchten, die von einer Instanz generiert wurden, würden Sie diesen Parameter auf setzendb-instance. Wenn der Wert nicht angegeben ist, werden alle Ereignisse zurückgegeben.

Gültige Werte: db-instance, db-cluster, db-parameter-group, db-security-group, db-cluster-snapshot

Typ: Zeichenfolge

Erforderlich: Nein

Tags.Tag.N

Die Tags, die dem Event-Abonnement zugewiesen werden sollen.

Typ: Array von Tag-Objekten

Erforderlich: Nein

Antwortelemente

Das folgende Element wird vom Dienst zurückgegeben.

EventSubscription

Detaillierte Informationen zu einer Veranstaltung, die Sie abonniert haben.

Typ: EventSubscription Objekt

Fehler

Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter Häufige Fehler.

EventSubscriptionQuotaExceeded

Sie haben die maximale Anzahl von Event-Abonnements erreicht.

HTTP Status Code: 400

SNSInvalidTopic

Amazon SNS hat geantwortet, dass es ein Problem mit dem angegebenen Thema gibt.

HTTP Status Code: 400

SNSNoAuthorization

Sie sind nicht berechtigt, zum SNS-Thema Amazon Resource Name (ARN) zu veröffentlichen.

HTTP Status Code: 400

SNSTopicArnNotFound

Das SNS-Thema Amazon Resource Name (ARN) existiert nicht.

HTTP Status Code: 404

SourceNotFound

Die angeforderte Quelle konnte nicht gefunden werden.

HTTP Status Code: 404

SubscriptionAlreadyExist

Der angegebene Abonnementname ist bereits vorhanden.

HTTP Status Code: 400

SubscriptionCategoryNotFound

Die angegebene Kategorie ist nicht vorhanden.

HTTP Status Code: 404

Weitere Informationen finden Sie unter:

Weitere Informationen zur Verwendung dieser API in einem der sprachspezifischen AWS SDKs finden Sie im Folgenden:

• AWS -Befehlszeilenschnittstelle

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go v2

• AWS SDK for Java V2

• AWS SDK für JavaScript V3

• AWS SDK for PHP V3

• AWS SDK für Python

• AWS SDK for Ruby V3