本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。
Neptune 事件 API
操作:
结构：
CreateEventSubscription（操作）
此 API 的 Amazon 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 并且 EventCategories = Availability, Backup。
如果您同时指定 SourceType 和 SourceIds，例如 SourceType = db-instance 和 SourceIdentifier = myDBInstance1，您将收到指定源的所有 db-instance 事件的通知。如果指定 SourceType，但未指定 SourceIdentifier，则将收到所有 Neptune 源的该源类型事件的通知。如果既未指定 SourceType，也未指定 SourceIdentifier，则将收到通过属于客户账户的所有 Neptune 源生成的事件的通知。
请求
-
Enabled（在 CLI 中：
--enabled）– BooleanOptional，类型为：boolean[布尔值（true 或 false）]。一个布尔值；设置为 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）标签 对象的数组。要应用到新事件订阅的标签。
响应
包含成功调用 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 编码的字符串）。事件通知订阅的源 ID 列表。
-
SourceType – 一个字符串，类型为：
string（UTF-8 编码的字符串）。事件通知订阅的源类型。
-
Status – 一个字符串，类型为：
string（UTF-8 编码的字符串）。事件通知订阅的状态。
约束：
可以为以下值之一：creating | modifying | deleting | active | no-permission | topic-not-exist
状态“no-permission”指示 Neptune 不再有权发布到此 SNS 主题。状态“topic-not-exist”指示主题在创建订阅之后删除。
-
SubscriptionCreationTime – 一个字符串，类型为：
string（UTF-8 编码的字符串）。创建事件订阅通知的时间。
错误
DeleteEventSubscription（操作）
此 API 的 Amazon 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 编码的字符串）。事件通知订阅的源 ID 列表。
-
SourceType – 一个字符串，类型为：
string（UTF-8 编码的字符串）。事件通知订阅的源类型。
-
Status – 一个字符串，类型为：
string（UTF-8 编码的字符串）。事件通知订阅的状态。
约束：
可以为以下值之一：creating | modifying | deleting | active | no-permission | topic-not-exist
状态“no-permission”指示 Neptune 不再有权发布到此 SNS 主题。状态“topic-not-exist”指示主题在创建订阅之后删除。
-
SubscriptionCreationTime – 一个字符串，类型为：
string（UTF-8 编码的字符串）。创建事件订阅通知的时间。
ModifyEventSubscription（操作）
此 API 的 Amazon CLI 名称为：modify-event-subscription。
修改现有的事件通知订阅。请注意，您无法使用此调用修改源标识符；要更改订阅的源标识符，请使用 AddSourceIdentifierToSubscription（操作） 和 RemoveSourceIdentifierFromSubscription（操作） 调用。
您可以使用 DescribeEventCategories 操作，查看指定 SourceType 的事件类别的列表。
请求
-
Enabled（在 CLI 中：
--enabled）– BooleanOptional，类型为：boolean[布尔值（true 或 false）]。布尔值；设置为 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-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 编码的字符串）。事件通知订阅的源 ID 列表。
-
SourceType – 一个字符串，类型为：
string（UTF-8 编码的字符串）。事件通知订阅的源类型。
-
Status – 一个字符串，类型为：
string（UTF-8 编码的字符串）。事件通知订阅的状态。
约束：
可以为以下值之一：creating | modifying | deleting | active | no-permission | topic-not-exist
状态“no-permission”指示 Neptune 不再有权发布到此 SNS 主题。状态“topic-not-exist”指示主题在创建订阅之后删除。
-
SubscriptionCreationTime – 一个字符串，类型为：
string（UTF-8 编码的字符串）。创建事件订阅通知的时间。
错误
DescribeEventSubscriptions（操作）
此 API 的 Amazon CLI 名称为：describe-event-subscriptions。
列出客户账户的所有订阅描述。订阅的描述包括 SubscriptionName、SNSTopicARN、CustomerID、SourceType、SourceID、CreationTime 和 Status。
如果您指定了 SubscriptionName，则列出该订阅的描述。
请求
-
Filters：（在 CLI 中：
--filters）筛选条件 对象的数组。当前不支持此参数。
-
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 对象的数组。
EventSubscriptions 数据类型的列表。
-
Marker – 一个字符串，类型为：
string（UTF-8 编码的字符串）。由之前的 DescribeOrderableDBInstanceOptions 请求提供的可选分页标记。如果指定此参数，则响应仅包含标记之外的记录，最大数量为
MaxRecords指定的值。
AddSourceIdentifierToSubscription（操作）
此 API 的 Amazon 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 编码的字符串）。事件通知订阅的源 ID 列表。
-
SourceType – 一个字符串，类型为：
string（UTF-8 编码的字符串）。事件通知订阅的源类型。
-
Status – 一个字符串，类型为：
string（UTF-8 编码的字符串）。事件通知订阅的状态。
约束：
可以为以下值之一：creating | modifying | deleting | active | no-permission | topic-not-exist
状态“no-permission”指示 Neptune 不再有权发布到此 SNS 主题。状态“topic-not-exist”指示主题在创建订阅之后删除。
-
SubscriptionCreationTime – 一个字符串，类型为：
string（UTF-8 编码的字符串）。创建事件订阅通知的时间。
RemoveSourceIdentifierFromSubscription（操作）
此 API 的 Amazon 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 编码的字符串）。事件通知订阅的源 ID 列表。
-
SourceType – 一个字符串，类型为：
string（UTF-8 编码的字符串）。事件通知订阅的源类型。
-
Status – 一个字符串，类型为：
string（UTF-8 编码的字符串）。事件通知订阅的状态。
约束：
可以为以下值之一：creating | modifying | deleting | active | no-permission | topic-not-exist
状态“no-permission”指示 Neptune 不再有权发布到此 SNS 主题。状态“topic-not-exist”指示主题在创建订阅之后删除。
-
SubscriptionCreationTime – 一个字符串，类型为：
string（UTF-8 编码的字符串）。创建事件订阅通知的时间。
DescribeEvents（操作）
此 API 的 Amazon CLI 名称为：describe-events。
返回过去 14 天与数据库实例、数据库安全组、数据库快照和数据库参数组相关的事件。对于特定的数据库实例、数据库安全组、数据库快照或数据库参数组，特定于它们的事件可以通过提供名称作为参数来获取。默认情况下，返回过去一小时的事件。
请求
-
Duration（在 CLI 中：
--duration）– IntegerOptional，类型为：integer（带符号的 32 位整数）。从中检索事件的分钟数。
默认值：60
-
EndTime（在 CLI 中：
--end-time） – TStamp，类型为：timestamp（一个时间点，通常定义为与 1970 年 1 月 1 日午夜的偏移量）。要检索事件的时间段的结束，以 ISO 8601 格式指定。有关 ISO 8601 的更多信息，请转至 ISO8601 Wikipedia 页面
。 示例：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）– 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）– SourceType，类型为：string（UTF-8 编码的字符串）。要从中检索事件的事件源。如果未指定值，则返回所有事件。
-
StartTime（在 CLI 中：
--start-time） – TStamp，类型为：timestamp（一个时间点，通常定义为与 1970 年 1 月 1 日午夜的偏移量）。要检索事件的时间段的开始，以 ISO 8601 格式指定。有关 ISO 8601 的更多信息，请转至 ISO8601 Wikipedia 页面
。 示例：2009-07-08T18:00Z
响应
DescribeEventCategories（操作）
此 API 的 Amazon CLI 名称为：describe-event-categories。
显示所有事件源类型的类别列表；或如果指定，则显示指定源类型的类别列表。
请求
-
Filters：（在 CLI 中：
--filters）筛选条件 对象的数组。当前不支持此参数。
-
SourceType（在 CLI 中：
--source-type）– 一个字符串，类型为：string（UTF-8 编码的字符串）。生成事件的源的类型。
有效值：db-instance | db-parameter-group | db-security-group | db-snapshot
响应
-
EventCategoriesMapList – EventCategoriesMap 对象的数组。
EventCategoriesMap 数据类型的列表。
结构：
Event（结构）
此数据类型用作 DescribeEvents（操作） 操作中的响应元素。
字段
-
Date – 这是 TStamp，类型为：
timestamp（一个时间点，通常定义为与 1970 年 1 月 1 日午夜的偏移量）。指定事件的日期和时间。
-
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 编码的字符串）。事件通知订阅的源 ID 列表。
-
SourceType – 这是一个字符串，类型为：
string（UTF-8 编码的字符串）。事件通知订阅的源类型。
-
Status – 这是一个字符串，类型为：
string（UTF-8 编码的字符串）。事件通知订阅的状态。
约束：
可以为以下值之一：creating | modifying | deleting | active | no-permission | topic-not-exist
状态“no-permission”指示 Neptune 不再有权发布到此 SNS 主题。状态“topic-not-exist”指示主题在创建订阅之后删除。
-
SubscriptionCreationTime – 这是一个字符串，类型为：
string（UTF-8 编码的字符串）。创建事件订阅通知的时间。
EventSubscription 用作下列对象的响应元素：