

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

# Neptune イベント API
<a name="api-events"></a>

**アクション:**
+ [CreateEventSubscription (アクション)](#CreateEventSubscription)
+ [DeleteEventSubscription (アクション)](#DeleteEventSubscription)
+ [ModifyEventSubscription (アクション)](#ModifyEventSubscription)
+ [DescribeEventSubscriptions (アクション)](#DescribeEventSubscriptions)
+ [AddSourceIdentifierToSubscription (アクション)](#AddSourceIdentifierToSubscription)
+ [RemoveSourceIdentifierFromSubscription (アクション)](#RemoveSourceIdentifierFromSubscription)
+ [DescribeEvents (アクション)](#DescribeEvents)
+ [DescribeEventCategories (アクション)](#DescribeEventCategories)

**構造:**
+ [イベント (構造)](#Event)
+ [EventCategoriesMap (構造)](#EventCategoriesMap)
+ [EventSubscription (構造)](#EventSubscription)

## CreateEventSubscription (アクション)
<a name="CreateEventSubscription"></a>

         この API の AWS CLI 名は `create-event-subscription` です。

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

通知するソースの種類 (SourceType) を指定し、イベントをトリガーする Neptune ソース (SourceIds) のリストを提供し、通知を受けたいイベントのイベントカテゴリのリスト (EventCategories) を指定することができます。たとえば、SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup を指定できます。

SourceType = db-instance や SourceIdentifier = myDBInstance1 のように [SourceType] と [SourceIds] の両方を指定した場合は、指定したソースのすべての db-instance イベントが通知されます。[SourceType] を指定し、[SourceIdentifier] を指定しないと、すべての Neptune ソースについて、指定したソースタイプのイベントの通知を受け取ります。[SourceType] も [SourceIdentifier] も指定しない場合は、お客様のアカウントに属しているすべての Neptune ソースから生成されたイベントの通知を受け取ります。

**[リクエスト**]
+ **Enabled** (CLI では: `--enabled`) — BooleanOptional、タイプ: `boolean` (ブール値 (真または偽))。

   ブール値。サブスクリプションを有効にするには **true** に設定し、サブスクリプションを作成するがアクティブにしない場合は **false** に設定します。
+ **EventCategories** (CLI では: `--event-categories`) — タイプ: `string` (UTF-8 でエンコードされた文字列) の文字列。

   サブスクライブする SourceType のイベントカテゴリのリスト。**DescribeEventCategories** アクションを使用して、特定の SourceType のカテゴリのリストを表示できます。
+ **SnsTopicArn** (CLI では: `--sns-topic-arn`) — *必須:* `string` タイプの文字列 (UTF-8 でエンコードされた文字列)。

  イベント通知用に作成された SNS トピックの Amazon リソースネーム (ARN)。ARN は、トピックを作成してそれをサブスクライブするときに Amazon SNS によって作成されます。
+ **SourceIds** (CLI では: `--source-ids`) — タイプ: `string` (UTF-8 でエンコードされた文字列) の文字列。

  イベントが返されるイベントソースの識別子のリスト。指定しない場合は、すべてのソースはレスポンスに含まれます。識別子は文字で開始し、ASCII 文字、数字、ハイフンのみを使用できます。最後の文字をハイフンにすることはできず、ハイフンを 2 つ続けて使用することもできません。

  制約:
  + SourceIds が入力されている場合は、SourceType も指定する必要があります。
  + ソースタイプが DB インスタンスである場合は、`DBInstanceIdentifier` を指定する必要があります。
  + ソースタイプが DB セキュリティグループである場合は、`DBSecurityGroupName` を指定する必要があります。
  + ソースタイプが DB パラメータグループである場合は、`DBParameterGroupName` を指定する必要があります。
  + ソースタイプが DB スナップショットである場合は、`DBSnapshotIdentifier` を指定する必要があります。
+ **SourceType** (CLI では: `--source-type`) — タイプ: `string` (UTF-8 でエンコードされた文字列) の文字列。

  イベントを生成しているソースの種類。たとえば、DB インスタンスによって生成されたイベントの通知を受けたい場合は、このパラメータを db-instance に設定します。この値が指定されていない場合は、すべてのイベントが返されます。

  有効な値: `db-instance` \$1 `db-cluster` \$1 `db-parameter-group` \$1 `db-security-group` \$1 `db-snapshot` \$1 `db-cluster-snapshot`
+ **SubscriptionName** (CLI では: `--subscription-name`) — *必須:* `string` タイプの文字列 (UTF-8 でエンコードされた文字列)。

  サブスクリプションの名前。

  制約: この名前は 255 文字未満である必要があります。
+ **Tags** (CLI では: `--tags`) - [Tag](api-other-apis.md#Tag) オブジェクトの配列。

  新しいイベントサブスクリプションに適用されるタグ。

**レスポンス**

[DescribeEventSubscriptions (アクション)](#DescribeEventSubscriptions) アクションの呼び出しが成功した結果が含まれています。
+ **CustomerAwsId** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  イベント通知サブスクリプションに関連付けられている Amazon 顧客アカウント。
+ **CustSubscriptionId** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  イベント通知サブスクリプション ID。
+ **Enabled** — ブール値、タイプ: `boolean` (ブール値 (真または偽))。

  サブスクリプションが有効になっているかどうかを示すブール値。True はサブスクリプションが有効になっていることを表します。
+ **EventCategoriesList** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  イベント通知サブスクリプションのイベントカテゴリのリスト。
+ **EventSubscriptionArn** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  イベントサブスクリプションの Amazon リソースネーム (ARN)。
+ **SnsTopicArn** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  イベント通知サブスクリプションのトピック ARN。
+ **SourceIdsList** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  イベント通知サブスクリプションのソース ID のリスト。
+ **SourceType** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  イベント通知サブスクリプションのソースタイプ。
+ **Status** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

   イベント通知サブスクリプションのステータス。

  制約:

  次のいずれかを指定できます。作成 \$1 変更 \$1 削除 \$1 アクティブ \$1 権限なし \$1 トピックがありません

  ステータス「権限なし」は、Neptune が SNS トピックに投稿するアクセス許可を失ったことを示します。ステータス「トピックがありません」は、サブスクリプションの作成後にトピックが削除されたことを示します。
+ **SubscriptionCreationTime** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  イベント通知サブスクリプションが作成された時刻。

**エラー**
+ [EventSubscriptionQuotaExceededFault](api-faults.md#EventSubscriptionQuotaExceededFault)
+ [SubscriptionAlreadyExistFault](api-faults.md#SubscriptionAlreadyExistFault)
+ [SNSInvalidTopicFault](api-faults.md#SNSInvalidTopicFault)
+ [SNSNoAuthorizationFault](api-faults.md#SNSNoAuthorizationFault)
+ [SNSTopicArnNotFoundFault](api-faults.md#SNSTopicArnNotFoundFault)
+ [SubscriptionCategoryNotFoundFault](api-faults.md#SubscriptionCategoryNotFoundFault)
+ [SourceNotFoundFault](api-faults.md#SourceNotFoundFault)

## DeleteEventSubscription (アクション)
<a name="DeleteEventSubscription"></a>

         この API の AWS CLI 名は `delete-event-subscription` です。

イベント通知サブスクリプションを削除します。

**[リクエスト**]
+ **SubscriptionName** (CLI では: `--subscription-name`) — *必須:* `string` タイプの文字列 (UTF-8 でエンコードされた文字列)。

  削除したいイベント通知サブスクリプションの名前。

**レスポンス**

[DescribeEventSubscriptions (アクション)](#DescribeEventSubscriptions) アクションの呼び出しが成功した結果が含まれています。
+ **CustomerAwsId** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  イベント通知サブスクリプションに関連付けられている Amazon 顧客アカウント。
+ **CustSubscriptionId** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  イベント通知サブスクリプション ID。
+ **Enabled** — ブール値、タイプ: `boolean` (ブール値 (真または偽))。

  サブスクリプションが有効になっているかどうかを示すブール値。True はサブスクリプションが有効になっていることを表します。
+ **EventCategoriesList** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  イベント通知サブスクリプションのイベントカテゴリのリスト。
+ **EventSubscriptionArn** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  イベントサブスクリプションの Amazon リソースネーム (ARN)。
+ **SnsTopicArn** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  イベント通知サブスクリプションのトピック ARN。
+ **SourceIdsList** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  イベント通知サブスクリプションのソース ID のリスト。
+ **SourceType** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  イベント通知サブスクリプションのソースタイプ。
+ **Status** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

   イベント通知サブスクリプションのステータス。

  制約:

  次のいずれかを指定できます。作成 \$1 変更 \$1 削除 \$1 アクティブ \$1 権限なし \$1 トピックがありません

  ステータス「権限なし」は、Neptune が SNS トピックに投稿するアクセス許可を失ったことを示します。ステータス「トピックがありません」は、サブスクリプションの作成後にトピックが削除されたことを示します。
+ **SubscriptionCreationTime** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  イベント通知サブスクリプションが作成された時刻。

**エラー**
+ [SubscriptionNotFoundFault](api-faults.md#SubscriptionNotFoundFault)
+ [InvalidEventSubscriptionStateFault](api-faults.md#InvalidEventSubscriptionStateFault)

## ModifyEventSubscription (アクション)
<a name="ModifyEventSubscription"></a>

         この API の AWS CLI 名は `modify-event-subscription` です。

既存の RDS イベント通知サブスクリプションを変更します。この呼び出しを使ってソース識別子を変更することはできません。サブスクリプションのソース識別子を変更するには、[AddSourceIdentifierToSubscription (アクション)](#AddSourceIdentifierToSubscription) と [RemoveSourceIdentifierFromSubscription (アクション)](#RemoveSourceIdentifierFromSubscription) の呼び出しを使用します。

**DescribeEventCategories** アクションを使用して、特定の SourceType のイベントカテゴリのリストを表示できます。

**[リクエスト**]
+ **Enabled** (CLI では: `--enabled`) — BooleanOptional、タイプ: `boolean` (ブール値 (真または偽))。

   ブール値。サブスクリプションを有効にするには、**true** に設定します。
+ **EventCategories** (CLI では: `--event-categories`) — タイプ: `string` (UTF-8 でエンコードされた文字列) の文字列。

   サブスクライブする SourceType のイベントカテゴリのリスト。**DescribeEventCategories** アクションを使用して、特定の SourceType のカテゴリのリストを表示できます。
+ **SnsTopicArn** (CLI では: `--sns-topic-arn`) — タイプ: `string` (UTF-8 でエンコードされた文字列) の文字列。

  イベント通知用に作成された SNS トピックの Amazon リソースネーム (ARN)。ARN は、トピックを作成してそれをサブスクライブするときに Amazon SNS によって作成されます。
+ **SourceType** (CLI では: `--source-type`) — タイプ: `string` (UTF-8 でエンコードされた文字列) の文字列。

  イベントを生成しているソースの種類。たとえば、DB インスタンスによって生成されたイベントの通知を受けたい場合は、このパラメータを db-instance に設定します。この値が指定されていない場合は、すべてのイベントが返されます。

  有効な値: db-instance \$1 db-parameter-group \$1 db-security-group \$1 db-snapshot
+ **SubscriptionName** (CLI では: `--subscription-name`) — *必須:* `string` タイプの文字列 (UTF-8 でエンコードされた文字列)。

  イベント通知サブスクリプションの名前。

**レスポンス**

[DescribeEventSubscriptions (アクション)](#DescribeEventSubscriptions) アクションの呼び出しが成功した結果が含まれています。
+ **CustomerAwsId** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  イベント通知サブスクリプションに関連付けられている Amazon 顧客アカウント。
+ **CustSubscriptionId** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  イベント通知サブスクリプション ID。
+ **Enabled** — ブール値、タイプ: `boolean` (ブール値 (真または偽))。

  サブスクリプションが有効になっているかどうかを示すブール値。True はサブスクリプションが有効になっていることを表します。
+ **EventCategoriesList** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  イベント通知サブスクリプションのイベントカテゴリのリスト。
+ **EventSubscriptionArn** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  イベントサブスクリプションの Amazon リソースネーム (ARN)。
+ **SnsTopicArn** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  イベント通知サブスクリプションのトピック ARN。
+ **SourceIdsList** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  イベント通知サブスクリプションのソース ID のリスト。
+ **SourceType** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  イベント通知サブスクリプションのソースタイプ。
+ **Status** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

   イベント通知サブスクリプションのステータス。

  制約:

  次のいずれかを指定できます。作成 \$1 変更 \$1 削除 \$1 アクティブ \$1 権限なし \$1 トピックがありません

  ステータス「権限なし」は、Neptune が SNS トピックに投稿するアクセス許可を失ったことを示します。ステータス「トピックがありません」は、サブスクリプションの作成後にトピックが削除されたことを示します。
+ **SubscriptionCreationTime** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  イベント通知サブスクリプションが作成された時刻。

**エラー**
+ [EventSubscriptionQuotaExceededFault](api-faults.md#EventSubscriptionQuotaExceededFault)
+ [SubscriptionNotFoundFault](api-faults.md#SubscriptionNotFoundFault)
+ [SNSInvalidTopicFault](api-faults.md#SNSInvalidTopicFault)
+ [SNSNoAuthorizationFault](api-faults.md#SNSNoAuthorizationFault)
+ [SNSTopicArnNotFoundFault](api-faults.md#SNSTopicArnNotFoundFault)
+ [SubscriptionCategoryNotFoundFault](api-faults.md#SubscriptionCategoryNotFoundFault)

## DescribeEventSubscriptions (アクション)
<a name="DescribeEventSubscriptions"></a>

         この API の AWS CLI 名は `describe-event-subscriptions` です。

顧客アカウントのサブスクリプションの説明をすべて表示します。サブスクリプションの説明には、CustomerID、SourceType、SourceID SNSTopicARN SubscriptionName、CreationTime、およびステータスが含まれます。

SubscriptionName を指定した場合は、そのサブスクリプションの説明を一覧表示します。

**[リクエスト**]
+ **Filters** (CLI では: `--filters`) - [フィルター](api-datatypes.md#Filter) オブジェクトの配列。

  このパラメータは、現在サポートされていません。
+ **Marker** (CLI では: `--marker`) — タイプ: `string` (UTF-8 でエンコードされた文字列) の文字列。

   以前の DescribeOrderableDBInstanceOptions リクエストによって提供されたオプションのページ分割トークン。このパラメータを指定した場合、レスポンスには `MaxRecords` で指定された値まで、マーカーを超えるレコードのみが含まれます。
+ **MaxRecords** (CLI では: `--max-records`) — IntegerOptional、タイプ: `integer` (符号付き 32 ビット整数)。

   レスポンスに含めるレコードの最大数。指定された `MaxRecords` の値よりも多くのレコードが存在する場合、マーカーと呼ばれるページ割りトークンがレスポンスに含まれるため、残りの結果を取得できます。

  デフォルト: 100

  制約: 最小 20、最大 100。
+ **SubscriptionName** (CLI では: `--subscription-name`) — タイプ: `string` (UTF-8 でエンコードされた文字列) の文字列。

  記述するイベント通知サブスクリプションの名前。

**応答**
+ **EventSubscriptionsList** – [EventSubscription](#EventSubscription) オブジェクトの配列。

  EventSubscriptions データ型のリスト。
+ **Marker** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

   以前の DescribeOrderableDBInstanceOptions リクエストによって提供されたオプションのページ分割トークン。このパラメータを指定した場合、レスポンスには `MaxRecords` で指定された値まで、マーカーを超えるレコードのみが含まれます。

**エラー**
+ [SubscriptionNotFoundFault](api-faults.md#SubscriptionNotFoundFault)

## AddSourceIdentifierToSubscription (アクション)
<a name="AddSourceIdentifierToSubscription"></a>

         この API の AWS CLI 名は `add-source-identifier-to-subscription` です。

既存のイベント通知サブスクリプションにソース識別子を追加します。

**[リクエスト**]
+ **SourceIdentifier** (CLI では: `--source-identifier`) — *必須:* `string` タイプの文字列 (UTF-8 でエンコードされた文字列)。

  追加されるイベントソースの識別子。

  制約:
  + ソースタイプが DB インスタンスである場合は、`DBInstanceIdentifier` を指定する必要があります。
  + ソースタイプが DB セキュリティグループである場合は、`DBSecurityGroupName` を指定する必要があります。
  + ソースタイプが DB パラメータグループである場合は、`DBParameterGroupName` を指定する必要があります。
  + ソースタイプが DB スナップショットである場合は、`DBSnapshotIdentifier` を指定する必要があります。
+ **SubscriptionName** (CLI では: `--subscription-name`) — *必須:* `string` タイプの文字列 (UTF-8 でエンコードされた文字列)。

  ソース識別子を追加するイベント通知サブスクリプションの名前。

**レスポンス**

[DescribeEventSubscriptions (アクション)](#DescribeEventSubscriptions) アクションの呼び出しが成功した結果が含まれています。
+ **CustomerAwsId** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  イベント通知サブスクリプションに関連付けられている Amazon 顧客アカウント。
+ **CustSubscriptionId** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  イベント通知サブスクリプション ID。
+ **Enabled** — ブール値、タイプ: `boolean` (ブール値 (真または偽))。

  サブスクリプションが有効になっているかどうかを示すブール値。True はサブスクリプションが有効になっていることを表します。
+ **EventCategoriesList** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  イベント通知サブスクリプションのイベントカテゴリのリスト。
+ **EventSubscriptionArn** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  イベントサブスクリプションの Amazon リソースネーム (ARN)。
+ **SnsTopicArn** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  イベント通知サブスクリプションのトピック ARN。
+ **SourceIdsList** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  イベント通知サブスクリプションのソース ID のリスト。
+ **SourceType** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  イベント通知サブスクリプションのソースタイプ。
+ **Status** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

   イベント通知サブスクリプションのステータス。

  制約:

  次のいずれかを指定できます。作成 \$1 変更 \$1 削除 \$1 アクティブ \$1 権限なし \$1 トピックがありません

  ステータス「権限なし」は、Neptune が SNS トピックに投稿するアクセス許可を失ったことを示します。ステータス「トピックがありません」は、サブスクリプションの作成後にトピックが削除されたことを示します。
+ **SubscriptionCreationTime** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  イベント通知サブスクリプションが作成された時刻。

**エラー**
+ [SubscriptionNotFoundFault](api-faults.md#SubscriptionNotFoundFault)
+ [SourceNotFoundFault](api-faults.md#SourceNotFoundFault)

## RemoveSourceIdentifierFromSubscription (アクション)
<a name="RemoveSourceIdentifierFromSubscription"></a>

         この API の AWS CLI 名は `remove-source-identifier-from-subscription` です。

既存のイベント通知サブスクリプションからソース識別子を削除します。

**[リクエスト**]
+ **SourceIdentifier** (CLI では: `--source-identifier`) — *必須:* `string` タイプの文字列 (UTF-8 でエンコードされた文字列)。

   DB インスタンスの場合は **DB インスタンス識別子**など、サブスクリプションから削除されるソース識別子、またはセキュリティグループの名前。
+ **SubscriptionName** (CLI では: `--subscription-name`) — *必須:* `string` タイプの文字列 (UTF-8 でエンコードされた文字列)。

  ソース識別子を削除するイベント通知サブスクリプションの名前。

**レスポンス**

[DescribeEventSubscriptions (アクション)](#DescribeEventSubscriptions) アクションの呼び出しが成功した結果が含まれています。
+ **CustomerAwsId** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  イベント通知サブスクリプションに関連付けられている Amazon 顧客アカウント。
+ **CustSubscriptionId** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  イベント通知サブスクリプション ID。
+ **Enabled** — ブール値、タイプ: `boolean` (ブール値 (真または偽))。

  サブスクリプションが有効になっているかどうかを示すブール値。True はサブスクリプションが有効になっていることを表します。
+ **EventCategoriesList** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  イベント通知サブスクリプションのイベントカテゴリのリスト。
+ **EventSubscriptionArn** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  イベントサブスクリプションの Amazon リソースネーム (ARN)。
+ **SnsTopicArn** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  イベント通知サブスクリプションのトピック ARN。
+ **SourceIdsList** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  イベント通知サブスクリプションのソース ID のリスト。
+ **SourceType** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  イベント通知サブスクリプションのソースタイプ。
+ **Status** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

   イベント通知サブスクリプションのステータス。

  制約:

  次のいずれかを指定できます。作成 \$1 変更 \$1 削除 \$1 アクティブ \$1 権限なし \$1 トピックがありません

  ステータス「権限なし」は、Neptune が SNS トピックに投稿するアクセス許可を失ったことを示します。ステータス「トピックがありません」は、サブスクリプションの作成後にトピックが削除されたことを示します。
+ **SubscriptionCreationTime** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  イベント通知サブスクリプションが作成された時刻。

**エラー**
+ [SubscriptionNotFoundFault](api-faults.md#SubscriptionNotFoundFault)
+ [SourceNotFoundFault](api-faults.md#SourceNotFoundFault)

## DescribeEvents (アクション)
<a name="DescribeEvents"></a>

         この API の AWS CLI 名は `describe-events` です。

DB インスタンス、DB セキュリティグループ、DB スナップショット、DB パラメータグループに関連する過去 14 日間のイベントを返します。特定の DB インスタンス、DB セキュリティグループ、データベーススナップショット、または DB パラメータグループに固有のイベントは、名前をパラメータとして指定することによって取得できます。デフォルトでは、過去 1 時間のイベントが返されます。

**[リクエスト**]
+ **Duration** (CLI では: `--duration`) — IntegerOptional、タイプ: `integer` (符号付き 32 ビット整数)。

  イベントを取得するための分数。

  デフォルト: 60
+ **EndTime** (CLI では: `--end-time`) — TStamp、タイプ: `timestamp` (通常は 1970 年 1 月 1 日深夜 0 時からのオフセットとして定義される特定時点)。

   ISO 8601 形式で指定された、イベントを取得する時間間隔の終了時刻。ISO 8601 の詳細については、[ISO8601 Wikipedia](http://en.wikipedia.org/wiki/ISO_8601) のページを参照してください。

  例: 2009-07-08T18:00Z
+ **EventCategories** (CLI では: `--event-categories`) — タイプ: `string` (UTF-8 でエンコードされた文字列) の文字列。

  イベント通知サブスクリプションの通知をトリガーするイベントカテゴリのリスト。
+ **Filters** (CLI では: `--filters`) - [フィルター](api-datatypes.md#Filter) オブジェクトの配列。

  このパラメータは、現在サポートされていません。
+ **Marker** (CLI では: `--marker`) — タイプ: `string` (UTF-8 でエンコードされた文字列) の文字列。

   以前の DescribeEvents リクエストによって提供されたオプションのページ分割トークン。このパラメータを指定した場合、レスポンスには `MaxRecords` で指定された値まで、マーカーを超えるレコードのみが含まれます。
+ **MaxRecords** (CLI では: `--max-records`) — IntegerOptional、タイプ: `integer` (符号付き 32 ビット整数)。

   レスポンスに含めるレコードの最大数。指定された `MaxRecords` の値よりも多くのレコードが存在する場合、マーカーと呼ばれるページ割りトークンがレスポンスに含まれるため、残りの結果を取得できます。

  デフォルト: 100

  制約: 最小 20、最大 100。
+ **SourceIdentifier** (CLI では: `--source-identifier`) — タイプ: `string` (UTF-8 でエンコードされた文字列) の文字列。

  イベントが返されるイベントソースの識別子。指定しない場合は、すべてのソースはレスポンスに含まれます。

  制約:
  + SourceIdentifier が入力されている場合は、SourceType も指定する必要があります。
  + ソースタイプが `DBInstance` である場合は、`DBInstanceIdentifier` を指定する必要があります。
  + ソースタイプが `DBSecurityGroup` である場合は、`DBSecurityGroupName` を指定する必要があります。
  + ソースタイプが `DBParameterGroup` である場合は、`DBParameterGroupName` を指定する必要があります。
  + ソースタイプが `DBSnapshot` である場合は、`DBSnapshotIdentifier` を指定する必要があります。
  + ハイフンを、文字列の最後に使用したり、2 つ続けて使用したりすることはできません。
+ **SourceType**(CLI では: `--source-type`) — SourceType、タイプ: `string` (UTF-8 でエンコードされた文字列)。

  イベントソースのイベントを取得します。値を指定しない場合、すべてのイベントが返されます。
+ **StartTime** (CLI では: `--start-time`) — TStamp、タイプ: `timestamp` (通常は 1970 年 1 月 1 日深夜 0 時からのオフセットとして定義される特定時点)。

   ISO 8601 形式で指定された、イベントを取得する時間間隔の開始時刻。ISO 8601 の詳細については、[ISO8601 Wikipedia](http://en.wikipedia.org/wiki/ISO_8601) のページを参照してください。

  例: 2009-07-08T18:00Z

**応答**
+ **Events** – [イベント](#Event) オブジェクトの配列。

   [イベント (構造)](#Event) インスタンスのリスト。
+ **Marker** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

   以前の Events リクエストによって提供されたオプションのページ分割トークン。このパラメータを指定した場合、レスポンスには `MaxRecords` で指定された値まで、マーカーを超えるレコードのみが含まれます。

## DescribeEventCategories (アクション)
<a name="DescribeEventCategories"></a>

         この API の AWS CLI 名は `describe-event-categories` です。

すべてのイベントソースタイプか、指定されている場合は、指定されたソースタイプのイベントカテゴリのリストを表示します。

**[リクエスト**]
+ **Filters** (CLI では: `--filters`) - [フィルター](api-datatypes.md#Filter) オブジェクトの配列。

  このパラメータは、現在サポートされていません。
+ **SourceType** (CLI では: `--source-type`) — タイプ: `string` (UTF-8 でエンコードされた文字列) の文字列。

  イベントを生成しているソースの種類。

  有効な値: db-instance \$1 db-parameter-group \$1 db-security-group \$1 db-snapshot

**応答**
+ **EventCategoriesMapList** – [EventCategoriesMap](#EventCategoriesMap) オブジェクトの配列。

  EventCategoriesMap データ型のリスト。

## *構造:*
<a name="api-events-structures-spacer"></a>

## イベント (構造)
<a name="Event"></a>

 このデータ型は、[DescribeEvents (アクション)](#DescribeEvents) アクションのレスポンス要素として使用されます。

**フィールド**
+ **Date** — TStamp、タイプ: `timestamp` (一般的には 1970 年 1 月 1 日深夜 0 時からのオフセットとして定義される特定時点)。

  イベントの日付と時刻を指定します。
+ **EventCategories** — これはタイプ `string` の文字列です (UTF-8 でエンコードされた文字列)。

  イベントのカテゴリを指定します。
+ **Message** — これはタイプ `string` の文字列です (UTF-8 でエンコードされた文字列)。

  このイベントのテキストを入力します。
+ **SourceArn** — これはタイプ `string` の文字列です (UTF-8 でエンコードされた文字列)。

  イベントの Amazon リソースネーム (ARN)
+ **SourceIdentifier** — これはタイプ `string` の文字列です (UTF-8 でエンコードされた文字列)。

  イベントの発生元の識別子を入力します。
+ **SourceType** — SourceType、タイプ: `string` (UTF-8 でエンコードされた文字列)。

  このイベントのソースタイプを指定します。

## EventCategoriesMap (構造)
<a name="EventCategoriesMap"></a>

[DescribeEventCategories (アクション)](#DescribeEventCategories) アクションの呼び出しが成功した結果が含まれています。

**フィールド**
+ **EventCategories** - 文字列、タイプ: `string` (UTF-8 でエンコードされた文字列)。

  指定されたソースタイプのイベントカテゴリ
+ **SourceType** — これはタイプ `string` の文字列です (UTF-8 でエンコードされた文字列)。

  返されたカテゴリに属しているソースタイプ

## EventSubscription (構造)
<a name="EventSubscription"></a>

[DescribeEventSubscriptions (アクション)](#DescribeEventSubscriptions) アクションの呼び出しが成功した結果が含まれています。

**フィールド**
+ **CustomerAwsId** - 文字列、タイプ: `string` (UTF-8 でエンコードされた文字列)。

  イベント通知サブスクリプションに関連付けられている Amazon 顧客アカウント。
+ **CustSubscriptionId** — これはタイプ `string` の文字列です (UTF-8 でエンコードされた文字列)。

  イベント通知サブスクリプション ID。
+ **Enabled** — ブール値、タイプ: `boolean` (ブール値 (真または偽))。

  サブスクリプションが有効になっているかどうかを示すブール値。True はサブスクリプションが有効になっていることを表します。
+ **EventCategoriesList** — これはタイプ `string` の文字列です (UTF-8 でエンコードされた文字列)。

  イベント通知サブスクリプションのイベントカテゴリのリスト。
+ **EventSubscriptionArn** — これはタイプ `string` の文字列です (UTF-8 でエンコードされた文字列)。

  イベントサブスクリプションの Amazon リソースネーム (ARN)。
+ **SnsTopicArn** — これはタイプ `string` の文字列です (UTF-8 でエンコードされた文字列)。

  イベント通知サブスクリプションのトピック ARN。
+ **SourceIdsList** — これはタイプ `string` の文字列です (UTF-8 でエンコードされた文字列)。

  イベント通知サブスクリプションのソース ID のリスト。
+ **SourceType** — これはタイプ `string` の文字列です (UTF-8 でエンコードされた文字列)。

  イベント通知サブスクリプションのソースタイプ。
+ **Status** — これはタイプ `string` の文字列です (UTF-8 でエンコードされた文字列)。

   イベント通知サブスクリプションのステータス。

  制約:

  次のいずれかを指定できます。作成 \$1 変更 \$1 削除 \$1 アクティブ \$1 権限なし \$1 トピックがありません

  ステータス「権限なし」は、Neptune が SNS トピックに投稿するアクセス許可を失ったことを示します。ステータス「トピックがありません」は、サブスクリプションの作成後にトピックが削除されたことを示します。
+ **SubscriptionCreationTime** — これはタイプ `string` の文字列です (UTF-8 でエンコードされた文字列)。

  イベント通知サブスクリプションが作成された時刻。

`EventSubscription` は、以下のレスポンス要素として使用されます。
+ [CreateEventSubscription](#CreateEventSubscription)
+ [ModifyEventSubscription](#ModifyEventSubscription)
+ [AddSourceIdentifierToSubscription](#AddSourceIdentifierToSubscription)
+ [RemoveSourceIdentifierFromSubscription](#RemoveSourceIdentifierFromSubscription)
+ [DeleteEventSubscription](#DeleteEventSubscription)