本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。
Neptune 事件 API
操作：
结构：
CreateEventSubscription （动作）
此 AP Amazon I 的 CLI 名称是:create-event-subscription。
创建事件通知订阅。此操作需要一个通过 Neptune 控制台、SNS 控制台或 SNS API 创建的主题 ARN（Amazon 资源名称）。要使用 SNS 获取 ARN，您必须在 Amazon SNS 中创建主题并订阅该主题。ARN 显示在 SNS 控制台中。
您可以指定要接收通知的来源 (SourceType) 的类型，提供触发事件的 Neptune 源列表 (SourceIds)，并为要通知的事件提供事件类别列表 (EventCategories)。例如，你可以指定 SourceType = db-instance、= mydbinstance1、mydbinstance2 和 SourceIds = 可用性、Backup。 EventCategories
如果您同时指定 SourceType 和 SourceIds，例如 SourceType = db-instance 和 SourceIdentifier = myDBInstance1，则会通知您指定源的所有数据库实例事件。如果指定 SourceType 但未指定 a SourceIdentifier，则会收到所有 Neptune 源中该源类型的事件通知。如果您未指定 the no SourceType r SourceIdentifier，则系统会通知您从属于您的客户账户的所有 Neptune 来源生成的事件。
请求
-
Enabled（在 CLI 中:
--enabled）— a 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）。在您创建主题并订阅到该主题时，由 Amazon SNS 创建 ARN。
-
SourceIds（在 CLI 中：
--source-ids）– 一个字符串，类型为：string（UTF-8 编码的字符串）。为其返回事件的事件源的标识符列表。如果未指定，则响应中包含所有源。标识符必须以字母开头，并且只能包含 ASCII 字母、数字和连字符，不能以连字符结尾，也不能包含两个连续的连字符。
约束：
-
如果 SourceIds 已提供，则还 SourceType 必须提供。
-
如果源类型是数据库实例，则必须提供
DBInstanceIdentifier。 -
如果源类型是数据库安全组，则必须提供
DBSecurityGroupName。 -
如果源类型是数据库参数组，则必须提供
DBParameterGroupName。 -
如果源类型是数据库快照，则必须提供
DBSnapshotIdentifier。
-
-
SourceType（在 CLI 中：
--source-type）– 一个字符串，类型为：string（UTF-8 编码的字符串）。生成事件的源的类型。例如，如果您要接收由数据库实例生成的事件的通知，则应将此参数设置为 db-instance。如果未指定此值，则将返回所有事件。
有效值：
db-instance|db-cluster|db-parameter-group|db-security-group|db-snapshot|db-cluster-snapshot -
SubscriptionName（在 CLI 中：
--subscription-name）– 必需：一个字符串，类型为：string（UTF-8 编码的字符串）。订阅的名称。
约束：名称必须少于 255 个字符。
-
Tags：（在 CLI 中：
--tags）Tag 对象的数组。要应用到新事件订阅的标签。
响应
包含成功调用 DescribeEventSubscriptions （动作） 操作的结果。
-
CustomerAwsId – 一个字符串，类型为：
string（UTF-8 编码的字符串）。与事件通知订阅关联的 Amazon 客户账户。
-
CustSubscriptionId – 一个字符串，类型为：
string（UTF-8 编码的字符串）。事件通知订阅 ID。
-
Enabled - 一个布尔值，类型为：
boolean[布尔值（true 或 false）]。指示是否启用订阅的布尔值。True 表示订阅已启用。
-
EventCategoriesList – 一个字符串，类型为：
string（UTF-8 编码的字符串）。事件通知订阅的事件类别列表。
-
EventSubscriptionArn – 一个字符串，类型为：
string（UTF-8 编码的字符串）。事件订阅的 Amazon 资源名称 (ARN)。
-
SnsTopicArn – 一个字符串，类型为：
string（UTF-8 编码的字符串）。事件通知订阅的主题 ARN。
-
SourceIdsList – 一个字符串，类型为：
string（UTF-8 编码的字符串）。事件通知订 IDs 阅的来源列表。
-
SourceType – 一个字符串，类型为：
string（UTF-8 编码的字符串）。事件通知订阅的源类型。
-
Status – 一个字符串，类型为：
string（UTF-8 编码的字符串）。事件通知订阅的状态。
约束：
可以是以下之一：创建 | 修改 | 删除 | 活动 | 无权限 | topic-not-exist
状态“no-permission”指示 Neptune 不再有权发布到此 SNS 主题。状态 “topic-not-exist” 表示该主题在创建订阅后已被删除。
-
SubscriptionCreationTime – 一个字符串，类型为：
string（UTF-8 编码的字符串）。创建事件订阅通知的时间。
错误
DeleteEventSubscription （动作）
此 AP Amazon I 的 CLI 名称是:delete-event-subscription。
删除事件通知订阅。
请求
-
SubscriptionName（在 CLI 中：
--subscription-name）– 必需：一个字符串，类型为：string（UTF-8 编码的字符串）。您要删除的事件通知订阅的名称。
响应
包含成功调用 DescribeEventSubscriptions （动作） 操作的结果。
-
CustomerAwsId – 一个字符串，类型为：
string（UTF-8 编码的字符串）。与事件通知订阅关联的 Amazon 客户账户。
-
CustSubscriptionId – 一个字符串，类型为：
string（UTF-8 编码的字符串）。事件通知订阅 ID。
-
Enabled - 一个布尔值，类型为：
boolean[布尔值（true 或 false）]。指示是否启用订阅的布尔值。True 表示订阅已启用。
-
EventCategoriesList – 一个字符串，类型为：
string（UTF-8 编码的字符串）。事件通知订阅的事件类别列表。
-
EventSubscriptionArn – 一个字符串，类型为：
string（UTF-8 编码的字符串）。事件订阅的 Amazon 资源名称 (ARN)。
-
SnsTopicArn – 一个字符串，类型为：
string（UTF-8 编码的字符串）。事件通知订阅的主题 ARN。
-
SourceIdsList – 一个字符串，类型为：
string（UTF-8 编码的字符串）。事件通知订 IDs 阅的来源列表。
-
SourceType – 一个字符串，类型为：
string（UTF-8 编码的字符串）。事件通知订阅的源类型。
-
Status – 一个字符串，类型为：
string（UTF-8 编码的字符串）。事件通知订阅的状态。
约束：
可以是以下之一：创建 | 修改 | 删除 | 活动 | 无权限 | topic-not-exist
状态“no-permission”指示 Neptune 不再有权发布到此 SNS 主题。状态 “topic-not-exist” 表示该主题在创建订阅后已被删除。
-
SubscriptionCreationTime – 一个字符串，类型为：
string（UTF-8 编码的字符串）。创建事件订阅通知的时间。
ModifyEventSubscription （动作）
此 AP Amazon I 的 CLI 名称是:modify-event-subscription。
修改现有的事件通知订阅。请注意，您无法使用此调用修改源标识符；要更改订阅的源标识符，请使用 AddSourceIdentifierToSubscription （动作） 和 RemoveSourceIdentifierFromSubscription （动作） 调用。
您可以使用DescribeEventCategories操作查看给定 SourceType 事件类别的列表。
请求
-
Enabled（在 CLI 中:
--enabled）— a BooleanOptional，类型为：boolean（布尔值（真或假））。布尔值；设置为 true 可激活订阅。
-
EventCategories（在 CLI 中：
--event-categories）– 一个字符串，类型为：string（UTF-8 编码的字符串）。您要订阅的事件类别列表。 SourceType 您可以使用DescribeEventCategories操作查看给定类别 SourceType 的列表。
-
SnsTopicArn（在 CLI 中：
--sns-topic-arn）– 一个字符串，类型为：string（UTF-8 编码的字符串）。为事件通知创建的 SNS 主题的 Amazon 资源名称（ARN）。在您创建主题并订阅到该主题时，由 Amazon SNS 创建 ARN。
-
SourceType（在 CLI 中：
--source-type）– 一个字符串，类型为：string（UTF-8 编码的字符串）。生成事件的源的类型。例如，如果您要接收由数据库实例生成的事件的通知，则应将此参数设置为 db-instance。如果未指定此值，则将返回所有事件。
有效值：数据库实例 | | db-parameter-group | db-security-group db-snapshot
-
SubscriptionName（在 CLI 中：
--subscription-name）– 必需：一个字符串，类型为：string（UTF-8 编码的字符串）。事件通知订阅的名称。
响应
包含成功调用 DescribeEventSubscriptions （动作） 操作的结果。
-
CustomerAwsId – 一个字符串，类型为：
string（UTF-8 编码的字符串）。与事件通知订阅关联的 Amazon 客户账户。
-
CustSubscriptionId – 一个字符串，类型为：
string（UTF-8 编码的字符串）。事件通知订阅 ID。
-
Enabled - 一个布尔值，类型为：
boolean[布尔值（true 或 false）]。指示是否启用订阅的布尔值。True 表示订阅已启用。
-
EventCategoriesList – 一个字符串，类型为：
string（UTF-8 编码的字符串）。事件通知订阅的事件类别列表。
-
EventSubscriptionArn – 一个字符串，类型为：
string（UTF-8 编码的字符串）。事件订阅的 Amazon 资源名称 (ARN)。
-
SnsTopicArn – 一个字符串，类型为：
string（UTF-8 编码的字符串）。事件通知订阅的主题 ARN。
-
SourceIdsList – 一个字符串，类型为：
string（UTF-8 编码的字符串）。事件通知订 IDs 阅的来源列表。
-
SourceType – 一个字符串，类型为：
string（UTF-8 编码的字符串）。事件通知订阅的源类型。
-
Status – 一个字符串，类型为：
string（UTF-8 编码的字符串）。事件通知订阅的状态。
约束：
可以是以下之一：创建 | 修改 | 删除 | 活动 | 无权限 | topic-not-exist
状态“no-permission”指示 Neptune 不再有权发布到此 SNS 主题。状态 “topic-not-exist” 表示该主题在创建订阅后已被删除。
-
SubscriptionCreationTime – 一个字符串，类型为：
string（UTF-8 编码的字符串）。创建事件订阅通知的时间。
错误
DescribeEventSubscriptions （动作）
此 AP Amazon I 的 CLI 名称是:describe-event-subscriptions。
列出客户账户的所有订阅描述。订阅的描述包括 SNSTopic ARN SubscriptionName、客户 ID、、 SourceType SourceID 和状态。 CreationTime
如果指定 SubscriptionName，则会列出该订阅的描述。
请求
-
Filters：（在 CLI 中：
--filters）筛选条件 对象的数组。当前不支持此参数。
-
Marker（在 CLI 中：
--marker）– 一个字符串，类型为：string（UTF-8 编码的字符串）。之前 DescribeOrderableDBInstance的 Options 请求提供的可选分页令牌。如果指定此参数，则响应仅包含标记之外的记录，最大数量为
MaxRecords指定的值。 -
MaxRecords（在 CLI 中:
--max-records）— a IntegerOptional，类型为：integer（带符号的 32 位整数）。包括在响应中的最大记录数。如果存在的记录数超过了指定的
MaxRecords值，则在响应中包含称为标记的分页记号，以便检索剩余的结果。默认值：100
约束：最低为 20，最高为 100。
-
SubscriptionName（在 CLI 中：
--subscription-name）– 一个字符串，类型为：string（UTF-8 编码的字符串）。您要描述的事件通知订阅的名称。
响应
-
EventSubscriptionsList – EventSubscription 对象的数组。
EventSubscriptions 数据类型列表。
-
Marker – 一个字符串，类型为：
string（UTF-8 编码的字符串）。之前 DescribeOrderableDBInstance的 Options 请求提供的可选分页令牌。如果指定此参数，则响应仅包含标记之外的记录，最大数量为
MaxRecords指定的值。
AddSourceIdentifierToSubscription （动作）
此 AP Amazon I 的 CLI 名称是:add-source-identifier-to-subscription。
将源标识符添加到现有事件通知订阅。
请求
-
SourceIdentifier（在 CLI 中：
--source-identifier）– 必需：一个字符串，类型为：string（UTF-8 编码的字符串）。要添加的事件源的标识符。
约束：
-
如果源类型是数据库实例，则必须提供
DBInstanceIdentifier。 -
如果源类型是数据库安全组，则必须提供
DBSecurityGroupName。 -
如果源类型是数据库参数组，则必须提供
DBParameterGroupName。 -
如果源类型是数据库快照，则必须提供
DBSnapshotIdentifier。
-
-
SubscriptionName（在 CLI 中：
--subscription-name）– 必需：一个字符串，类型为：string（UTF-8 编码的字符串）。要源标识符添加到的事件通知订阅的名称。
响应
包含成功调用 DescribeEventSubscriptions （动作） 操作的结果。
-
CustomerAwsId – 一个字符串，类型为：
string（UTF-8 编码的字符串）。与事件通知订阅关联的 Amazon 客户账户。
-
CustSubscriptionId – 一个字符串，类型为：
string（UTF-8 编码的字符串）。事件通知订阅 ID。
-
Enabled - 一个布尔值，类型为：
boolean[布尔值（true 或 false）]。指示是否启用订阅的布尔值。True 表示订阅已启用。
-
EventCategoriesList – 一个字符串，类型为：
string（UTF-8 编码的字符串）。事件通知订阅的事件类别列表。
-
EventSubscriptionArn – 一个字符串，类型为：
string（UTF-8 编码的字符串）。事件订阅的 Amazon 资源名称 (ARN)。
-
SnsTopicArn – 一个字符串，类型为：
string（UTF-8 编码的字符串）。事件通知订阅的主题 ARN。
-
SourceIdsList – 一个字符串，类型为：
string（UTF-8 编码的字符串）。事件通知订 IDs 阅的来源列表。
-
SourceType – 一个字符串，类型为：
string（UTF-8 编码的字符串）。事件通知订阅的源类型。
-
Status – 一个字符串，类型为：
string（UTF-8 编码的字符串）。事件通知订阅的状态。
约束：
可以是以下之一：创建 | 修改 | 删除 | 活动 | 无权限 | topic-not-exist
状态“no-permission”指示 Neptune 不再有权发布到此 SNS 主题。状态 “topic-not-exist” 表示该主题在创建订阅后已被删除。
-
SubscriptionCreationTime – 一个字符串，类型为：
string（UTF-8 编码的字符串）。创建事件订阅通知的时间。
RemoveSourceIdentifierFromSubscription （动作）
此 AP Amazon I 的 CLI 名称是:remove-source-identifier-from-subscription。
从现有事件通知订阅中删除源标识符。
请求
-
SourceIdentifier（在 CLI 中：
--source-identifier）– 必需：一个字符串，类型为：string（UTF-8 编码的字符串）。要从订阅中删除的源标识符，例如数据库实例的数据库实例标识符或安全组的名称。
-
SubscriptionName（在 CLI 中：
--subscription-name）– 必需：一个字符串，类型为：string（UTF-8 编码的字符串）。从中删除源标识符的事件通知订阅的名称。
响应
包含成功调用 DescribeEventSubscriptions （动作） 操作的结果。
-
CustomerAwsId – 一个字符串，类型为：
string（UTF-8 编码的字符串）。与事件通知订阅关联的 Amazon 客户账户。
-
CustSubscriptionId – 一个字符串，类型为：
string（UTF-8 编码的字符串）。事件通知订阅 ID。
-
Enabled - 一个布尔值，类型为：
boolean[布尔值（true 或 false）]。指示是否启用订阅的布尔值。True 表示订阅已启用。
-
EventCategoriesList – 一个字符串，类型为：
string（UTF-8 编码的字符串）。事件通知订阅的事件类别列表。
-
EventSubscriptionArn – 一个字符串，类型为：
string（UTF-8 编码的字符串）。事件订阅的 Amazon 资源名称 (ARN)。
-
SnsTopicArn – 一个字符串，类型为：
string（UTF-8 编码的字符串）。事件通知订阅的主题 ARN。
-
SourceIdsList – 一个字符串，类型为：
string（UTF-8 编码的字符串）。事件通知订 IDs 阅的来源列表。
-
SourceType – 一个字符串，类型为：
string（UTF-8 编码的字符串）。事件通知订阅的源类型。
-
Status – 一个字符串，类型为：
string（UTF-8 编码的字符串）。事件通知订阅的状态。
约束：
可以是以下之一：创建 | 修改 | 删除 | 活动 | 无权限 | topic-not-exist
状态“no-permission”指示 Neptune 不再有权发布到此 SNS 主题。状态 “topic-not-exist” 表示该主题在创建订阅后已被删除。
-
SubscriptionCreationTime – 一个字符串，类型为：
string（UTF-8 编码的字符串）。创建事件订阅通知的时间。
DescribeEvents （动作）
此 AP Amazon I 的 CLI 名称是:describe-events。
返回过去 14 天与数据库实例、数据库安全组、数据库快照和数据库参数组相关的事件。对于特定的数据库实例、数据库安全组、数据库快照或数据库参数组，特定于它们的事件可以通过提供名称作为参数来获取。默认情况下，返回过去一小时的事件。
请求
-
Duration（在 CLI 中:
--duration）— a IntegerOptional，类型为：integer（带符号的 32 位整数）。从中检索事件的分钟数。
默认值：60
-
EndTime（在 CLI 中:
--end-time）— a TStamp，类型为：timestamp（一个时间点，通常定义为从 1970-01-01 午夜开始的偏移量）。要检索事件的时间段的结束，以 ISO 8601 格式指定。有关 ISO 8601 的更多信息，请访问 ISO8601 维基百科页面
。 示例：2009-07-08T18:00Z
-
EventCategories（在 CLI 中：
--event-categories）– 一个字符串，类型为：string（UTF-8 编码的字符串）。触发事件通知订阅的通知的事件类别列表。
-
Filters：（在 CLI 中：
--filters）筛选条件 对象的数组。当前不支持此参数。
-
Marker（在 CLI 中：
--marker）– 一个字符串，类型为：string（UTF-8 编码的字符串）。先前 DescribeEvents 请求提供的可选分页令牌。如果指定此参数，则响应仅包含标记之外的记录，最大数量为
MaxRecords指定的值。 -
MaxRecords（在 CLI 中:
--max-records）— a IntegerOptional，类型为：integer（带符号的 32 位整数）。包括在响应中的最大记录数。如果存在的记录数超过了指定的
MaxRecords值，则在响应中包含称为标记的分页记号，以便检索剩余的结果。默认值：100
约束：最低为 20，最高为 100。
-
SourceIdentifier（在 CLI 中：
--source-identifier）– 一个字符串，类型为：string（UTF-8 编码的字符串）。为其返回事件的事件源的标识符。如果未指定，则响应中包含所有源。
约束：
-
如果 SourceIdentifier 已提供，则还 SourceType 必须提供。
-
如果源类型是
DBInstance，则必须提供DBInstanceIdentifier。 -
如果源类型是
DBSecurityGroup，则必须提供DBSecurityGroupName。 -
如果源类型是
DBParameterGroup，则必须提供DBParameterGroupName。 -
如果源类型是
DBSnapshot，则必须提供DBSnapshotIdentifier。 -
不能以连字符结束或包含两个连续连字符。
-
-
SourceType（在 CLI 中:
--source-type）— a SourceType，类型为：string（UTF-8 编码的字符串）。要从中检索事件的事件源。如果未指定值，则返回所有事件。
-
StartTime（在 CLI 中:
--start-time）— a TStamp，类型为：timestamp（一个时间点，通常定义为从 1970-01-01 午夜开始的偏移量）。要检索事件的时间段的开始，以 ISO 8601 格式指定。有关 ISO 8601 的更多信息，请访问 ISO8601 维基百科页面
。 示例：2009-07-08T18:00Z
响应
DescribeEventCategories （动作）
此 AP Amazon I 的 CLI 名称是:describe-event-categories。
显示所有事件源类型的类别列表；或如果指定，则显示指定源类型的类别列表。
请求
-
Filters：（在 CLI 中：
--filters）筛选条件 对象的数组。当前不支持此参数。
-
SourceType（在 CLI 中：
--source-type）– 一个字符串，类型为：string（UTF-8 编码的字符串）。生成事件的源的类型。
有效值：数据库实例 | | db-parameter-group | db-security-group db-snapshot
响应
-
EventCategoriesMapList – EventCategoriesMap 对象的数组。
EventCategoriesMap 数据类型列表。
结构：
Event（结构）
此数据类型用作 DescribeEvents （动作） 操作中的响应元素。
字段
-
Date— 这是一个 TStamp，类型为：
timestamp（一个时间点，通常定义为从 1970-01-01 年午夜开始的偏移量）。指定事件的日期和时间。
-
EventCategories – 这是一个字符串，类型为：
string（UTF-8 编码的字符串）。指定事件的类别。
-
Message – 这是一个字符串，类型为：
string（UTF-8 编码的字符串）。提供此事件的文本。
-
SourceArn – 这是一个字符串，类型为：
string（UTF-8 编码的字符串）。事件的 Amazon 资源名称 (ARN)。
-
SourceIdentifier – 这是一个字符串，类型为：
string（UTF-8 编码的字符串）。提供事件的源的标识符。
-
SourceType— 这是一个 SourceType，类型为：
string（UTF-8 编码的字符串）。为此事件指定源类型。
EventCategoriesMap （结构）
包含成功调用 DescribeEventCategories （动作） 操作的结果。
字段
-
EventCategories – 这是一个字符串，类型为：
string（UTF-8 编码的字符串）。指定源类型的事件类别
-
SourceType – 这是一个字符串，类型为：
string（UTF-8 编码的字符串）。返回的类别所属的源类型
EventSubscription （结构）
包含成功调用 DescribeEventSubscriptions （动作） 操作的结果。
字段
-
CustomerAwsId – 这是一个字符串，类型为：
string（UTF-8 编码的字符串）。与事件通知订阅关联的 Amazon 客户账户。
-
CustSubscriptionId – 这是一个字符串，类型为：
string（UTF-8 编码的字符串）。事件通知订阅 ID。
-
Enabled - 这是一个布尔值，类型为：
boolean[布尔值（true 或 false）]。指示是否启用订阅的布尔值。True 表示订阅已启用。
-
EventCategoriesList – 这是一个字符串，类型为：
string（UTF-8 编码的字符串）。事件通知订阅的事件类别列表。
-
EventSubscriptionArn – 这是一个字符串，类型为：
string（UTF-8 编码的字符串）。事件订阅的 Amazon 资源名称 (ARN)。
-
SnsTopicArn – 这是一个字符串，类型为：
string（UTF-8 编码的字符串）。事件通知订阅的主题 ARN。
-
SourceIdsList – 这是一个字符串，类型为：
string（UTF-8 编码的字符串）。事件通知订 IDs 阅的来源列表。
-
SourceType – 这是一个字符串，类型为：
string（UTF-8 编码的字符串）。事件通知订阅的源类型。
-
Status – 这是一个字符串，类型为：
string（UTF-8 编码的字符串）。事件通知订阅的状态。
约束：
可以是以下之一：创建 | 修改 | 删除 | 活动 | 无权限 | topic-not-exist
状态“no-permission”指示 Neptune 不再有权发布到此 SNS 主题。状态 “topic-not-exist” 表示该主题在创建订阅后已被删除。
-
SubscriptionCreationTime – 这是一个字符串，类型为：
string（UTF-8 编码的字符串）。创建事件订阅通知的时间。
EventSubscription 用作下列对象的响应元素：