本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。
Neptune 事件 API
動作:
結構：
CreateEventSubscription (動作)
此 API 的 AWS CLI 名稱是：create-event-subscription。
建立事件通知訂閱。這個動作需要 Neptune 主控台、SNS 主控台或 SNS API 建立的主題 ARN (Amazon Resource Name)。若要使用 SNS 取得 ARN，您必須在 Amazon SNS 中建立一個主題並訂閱該主題。SNS 主控台中會顯示 ARN。
您可以指定想要接到通知的來源類型 (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 Resource Name (ARN)。此 ARN 是當您建立並訂閱主題時由 Amazon SNS 所建立。
-
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 Resource Name (ARN)。
-
SnsTopicArn – 字串，類型為：
string(UTF-8 編碼的字串)。事件通知訂閱的主題 ARN。
-
SourceIdsList – 字串，類型為：
string(UTF-8 編碼的字串)。事件通知訂閱來源 ID 的清單。
-
SourceType – 字串，類型為：
string(UTF-8 編碼的字串)。事件通知訂閱的來源類型。
-
Status – 字串，類型為：
string(UTF-8 編碼的字串)。事件通知訂閱的狀態。
約束:
可以是下列其中之一：建立 | 修改 | 刪除 | 作用中 | 無許可 | 主題不存在
狀態「無許可」表示 Neptune 不再具有發佈 SNS 主題的許可。狀態「主題不存在」表示主題在訂閱建立後已遭刪除。
-
SubscriptionCreationTime – 字串，類型為：
string(UTF-8 編碼的字串)。事件通知訂閱建立的時間。
錯誤
DeleteEventSubscription (動作)
此 API 的 AWS 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 Resource Name (ARN)。
-
SnsTopicArn – 字串，類型為：
string(UTF-8 編碼的字串)。事件通知訂閱的主題 ARN。
-
SourceIdsList – 字串，類型為：
string(UTF-8 編碼的字串)。事件通知訂閱來源 ID 的清單。
-
SourceType – 字串，類型為：
string(UTF-8 編碼的字串)。事件通知訂閱的來源類型。
-
Status – 字串，類型為：
string(UTF-8 編碼的字串)。事件通知訂閱的狀態。
約束:
可以是下列其中之一：建立 | 修改 | 刪除 | 作用中 | 無許可 | 主題不存在
狀態「無許可」表示 Neptune 不再具有發佈 SNS 主題的許可。狀態「主題不存在」表示主題在訂閱建立後已遭刪除。
-
SubscriptionCreationTime – 字串，類型為：
string(UTF-8 編碼的字串)。事件通知訂閱建立的時間。
ModifyEventSubscription (動作)
此 API 的 AWS 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 Resource Name (ARN)。此 ARN 是當您建立並訂閱主題時由 Amazon SNS 所建立。
-
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 Resource Name (ARN)。
-
SnsTopicArn – 字串，類型為：
string(UTF-8 編碼的字串)。事件通知訂閱的主題 ARN。
-
SourceIdsList – 字串，類型為：
string(UTF-8 編碼的字串)。事件通知訂閱來源 ID 的清單。
-
SourceType – 字串，類型為：
string(UTF-8 編碼的字串)。事件通知訂閱的來源類型。
-
Status – 字串，類型為：
string(UTF-8 編碼的字串)。事件通知訂閱的狀態。
約束:
可以是下列其中之一：建立 | 修改 | 刪除 | 作用中 | 無許可 | 主題不存在
狀態「無許可」表示 Neptune 不再具有發佈 SNS 主題的許可。狀態「主題不存在」表示主題在訂閱建立後已遭刪除。
-
SubscriptionCreationTime – 字串，類型為：
string(UTF-8 編碼的字串)。事件通知訂閱建立的時間。
錯誤
DescribeEventSubscriptions (動作)
此 API 的 AWS 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 的 AWS 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 Resource Name (ARN)。
-
SnsTopicArn – 字串，類型為：
string(UTF-8 編碼的字串)。事件通知訂閱的主題 ARN。
-
SourceIdsList – 字串，類型為：
string(UTF-8 編碼的字串)。事件通知訂閱來源 ID 的清單。
-
SourceType – 字串，類型為：
string(UTF-8 編碼的字串)。事件通知訂閱的來源類型。
-
Status – 字串，類型為：
string(UTF-8 編碼的字串)。事件通知訂閱的狀態。
約束:
可以是下列其中之一：建立 | 修改 | 刪除 | 作用中 | 無許可 | 主題不存在
狀態「無許可」表示 Neptune 不再具有發佈 SNS 主題的許可。狀態「主題不存在」表示主題在訂閱建立後已遭刪除。
-
SubscriptionCreationTime – 字串，類型為：
string(UTF-8 編碼的字串)。事件通知訂閱建立的時間。
RemoveSourceIdentifierFromSubscription (動作)
此 API 的 AWS 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 Resource Name (ARN)。
-
SnsTopicArn – 字串，類型為：
string(UTF-8 編碼的字串)。事件通知訂閱的主題 ARN。
-
SourceIdsList – 字串，類型為：
string(UTF-8 編碼的字串)。事件通知訂閱來源 ID 的清單。
-
SourceType – 字串，類型為：
string(UTF-8 編碼的字串)。事件通知訂閱的來源類型。
-
Status – 字串，類型為：
string(UTF-8 編碼的字串)。事件通知訂閱的狀態。
約束:
可以是下列其中之一：建立 | 修改 | 刪除 | 作用中 | 無許可 | 主題不存在
狀態「無許可」表示 Neptune 不再具有發佈 SNS 主題的許可。狀態「主題不存在」表示主題在訂閱建立後已遭刪除。
-
SubscriptionCreationTime – 字串，類型為：
string(UTF-8 編碼的字串)。事件通知訂閱建立的時間。
DescribeEvents (動作)
此 API 的 AWS CLI 名稱是：describe-events。
傳回過去 14 天與資料庫執行個體、資料庫安全群組、資料庫快照和資料庫參數群組有關的事件。提供名稱做為參數可取得特定資料庫執行個體、資料庫安全群組、資料庫快照或資料庫參數群組的專屬事件。根據預設，會傳回過去一小時的事件。
請求
-
Duration (在 CLI 中：
--duration) – IntegerOptional，類型為：integer(帶正負號的 32 位元整數)。擷取事件的分鐘數。
預設：60
-
EndTime (在 CLI 中：
--end-time) – TStamp，類型為：timestamp(一個時間點，通常定義為 1970-01-01 午夜的偏移量)。擷取事件的時間間隔終點，以 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-01-01 午夜的偏移量)。擷取事件的時間間隔起點，以 ISO 8601 格式指定。如需 ISO 8601 的詳細資訊，請前往 ISO8601 Wikipedia 頁面
。 範例：2009-07-08T18:00Z
回應
-
Events – 一個 事件 物件陣列。
Event (結構) 執行個體的清單。
-
Marker – 字串，類型為：
string(UTF-8 編碼的字串)。前一個 Events 請求提供的選用分頁字符。若指定此參數，則回應只會包含超過標記的記錄，直到
MaxRecords指定的值為止。
DescribeEventCategories (動作)
此 API 的 AWS 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-01-01 午夜的偏移量)。指定事件的日期和時間。
-
EventCategories - 這是字串，類型為：
string(UTF-8 編碼的字串)。指定事件類別。
-
Message - 這是字串，類型為：
string(UTF-8 編碼的字串)。提供此事件的文字。
-
SourceArn - 這是字串，類型為：
string(UTF-8 編碼的字串)。事件的 Amazon Resource Name (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 Resource Name (ARN)。
-
SnsTopicArn - 這是字串，類型為：
string(UTF-8 編碼的字串)。事件通知訂閱的主題 ARN。
-
SourceIdsList - 這是字串，類型為：
string(UTF-8 編碼的字串)。事件通知訂閱來源 ID 的清單。
-
SourceType - 這是字串，類型為：
string(UTF-8 編碼的字串)。事件通知訂閱的來源類型。
-
Status - 這是字串，類型為：
string(UTF-8 編碼的字串)。事件通知訂閱的狀態。
約束:
可以是下列其中之一：建立 | 修改 | 刪除 | 作用中 | 無許可 | 主題不存在
狀態「無許可」表示 Neptune 不再具有發佈 SNS 主題的許可。狀態「主題不存在」表示主題在訂閱建立後已遭刪除。
-
SubscriptionCreationTime - 這是字串，類型為：
string(UTF-8 編碼的字串)。事件通知訂閱建立的時間。
EventSubscription 會用來做為以下項目的回應元素：
