

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

# CreateEventSubscription
<a name="API_CreateEventSubscription"></a>

Amazon DocumentDB のイベント通知サブスクリプションを作成します。このアクションには、Amazon DocumentDB コンソール、Amazon SNS コンソール、または Amazon SNS API を使用して作成したトピック ARN (Amazon リソースネーム) が必要です。SNS で ARN を取得するには、Amazon SNS でトピックを作成し、そのトピックをサブスクライブする必要があります。ARN は Amazon SNS コンソールに表示されます。

通知を受け取る対象となるソースの種類 (`SourceType`) を指定ができます。また、イベントをトリガーする Amazon DocumentDB ソース (`SourceIds`) のリストを提供して、通知を受けるイベントのカテゴリ (`EventCategories`) のリストを提供できます。例えば、`SourceType = db-instance`、`SourceIds = mydbinstance1, mydbinstance2`、`EventCategories = Availability, Backup` と指定できます。

`SourceType` と `SourceIds` を、[`SourceType = db-instance`] と [`SourceIdentifier = myDBInstance1`] などに指定すると、指定したソースのすべての `db-instance` イベントが通知されます。[`SourceType` SourceType] を指定し、[`SourceIdentifier` SourceIdentifier] を指定しない場合、指定したAmazon DocumentDB ソースのすべてのイベント通知を受け取ります。`SourceType` も `SourceIdentifier` も指定しない場合、顧客アカウントに属する Amazon DocumentDB ソースから生成されたすべてのイベントの通知を受け取ります。

## リクエストパラメーター
<a name="API_CreateEventSubscription_RequestParameters"></a>

 すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。

 ** SnsTopicArn **   
イベント通知用に作成された SNS トピックの Amazon リソースネーム (ARN)。ARN は、トピックを作成してそれをサブスクライブするときに Amazon SNS によって作成されます。  
タイプ: 文字列  
必須: はい

 ** SubscriptionName **   
サブスクリプションの名前。  
制約: この名前は 255 文字未満である必要があります。  
タイプ: 文字列  
必須: はい

 ** Enabled **   
 ブール値。サブスクリプションを有効にする場合は `true` に設定し、サブスクリプションを作成するが有効にしない場合は `false` に設定します。  
タイプ: ブール値  
必須: いいえ

 **EventCategories.EventCategory.N**   
 サブスクライブする `SourceType` のイベントカテゴリのリスト。  
型: 文字列の配列  
必須: いいえ

 **SourceIds.SourceId.N**   
イベントが返されるイベントソースの識別子のリスト。指定しない場合は、すべてのソースはレスポンスに含まれます。識別子は文字で開始し、ASCII 文字、数字、ハイフンのみを使用できます。最後の文字をハイフンにすることはできず、ハイフンを 2 つ続けて使用することもできません。  
制約:  
+ `SourceIds` が指定される場合、`SourceType` も指定する必要があります。
+ ソースタイプがインスタンスである場合は、`DBInstanceIdentifier` を指定する必要があります。
+ ソースタイプがセキュリティグループである場合は、`DBSecurityGroupName` を指定する必要があります。
+ ソースタイプがパラメータグループである場合は、`DBParameterGroupName` を指定する必要があります。
+ ソースタイプがスナップショットである場合は、`DBSnapshotIdentifier` を指定する必要があります。
型: 文字列の配列  
必須: いいえ

 ** SourceType **   
イベントを生成しているソースの種類。例えば、インスタンスが生成したイベントの通知を受ける場合は、このパラメータを `db-instance` に設定します。この値を指定しない場合、すべてのイベントが返されます。  
有効な値:`db-instance`、`db-cluster`、`db-parameter-group`、`db-security-group`、`db-cluster-snapshot`  
タイプ: 文字列  
必須: いいえ

 **Tags.Tag.N**   
イベントサブスクリプションに割り当てられるタグ。  
タイプ: [Tag](API_Tag.md) オブジェクトの配列  
必須: いいえ

## レスポンス要素
<a name="API_CreateEventSubscription_ResponseElements"></a>

以下の要素がサービスによって返されます。

 ** EventSubscription **   
サブスクライブしたイベントの詳細情報。  
型: [EventSubscription](API_EventSubscription.md) オブジェクト

## エラー
<a name="API_CreateEventSubscription_Errors"></a>

すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。

 ** EventSubscriptionQuotaExceeded **   
イベントサブスクリプション数が最大に達しました。  
HTTP ステータスコード: 400

 ** SNSInvalidTopic **   
Amazon SNS は、指定されたトピックに問題があると回答しました。  
HTTP ステータスコード: 400

 ** SNSNoAuthorization **   
SNS トピックの Amazon リソースネーム (ARN) に発行する権限がありません。  
HTTP ステータスコード: 400

 ** SNSTopicArnNotFound **   
SNS トピックの Amazon リソースネーム (ARN) が存在しません。  
HTTP ステータスコード: 404

 ** SourceNotFound **   
リクエストされたリソースが見つかりませんでした。  
HTTP ステータスコード: 404

 ** SubscriptionAlreadyExist **   
指定されたサブスクリプション名はすでに存在します。  
HTTP ステータスコード: 400

 ** SubscriptionCategoryNotFound **   
指定されたカテゴリは存在しません。  
HTTP ステータスコード: 404

## 以下の資料も参照してください。
<a name="API_CreateEventSubscription_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/CreateEventSubscription) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CreateEventSubscription) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CreateEventSubscription) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CreateEventSubscription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CreateEventSubscription) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CreateEventSubscription) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CreateEventSubscription) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CreateEventSubscription) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CreateEventSubscription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CreateEventSubscription) 