Neptune Events API - Amazon Neptune

Neptune Events API

Structures:

Actions:

Event (structure)

This data type is used as a response element in the DescribeEvents (action) action.

Fields

  • Date – Timestamp.

    Specifies the date and time of the event.

  • EventCategories – An array of EventCategory— UTF-8 strings.

    Specifies the category for the event.

  • Message – UTF-8 string.

    Provides the text of this event.

  • SourceArn – UTF-8 string.

    The Amazon Resource Name (ARN) for the event.

  • SourceIdentifier – UTF-8 string.

    Provides the identifier for the source of the event.

  • SourceType – UTF-8 string (valid values: db-instance="" | db-parameter-group="" | db-security-group="" | db-snapshot="" | db-cluster="" | db-cluster-snapshot="").

    Specifies the source type for this event.

EventCategoriesMap (structure)

Contains the results of a successful invocation of the DescribeEventCategories (action) action.

Fields

  • EventCategories – An array of EventCategory— UTF-8 strings.

    The event categories for the specified source type

  • SourceType – UTF-8 string.

    The source type that the returned categories belong to

EventSubscription (structure)

Contains the results of a successful invocation of the DescribeEventSubscriptions (action) action.

Fields

  • CustomerAwsId – UTF-8 string.

    The AWS customer account associated with the event notification subscription.

  • CustSubscriptionId – UTF-8 string.

    The event notification subscription Id.

  • Enabled – Boolean.

    A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.

  • EventCategoriesList – An array of EventCategory— UTF-8 strings.

    A list of event categories for the event notification subscription.

  • EventSubscriptionArn – UTF-8 string.

    The Amazon Resource Name (ARN) for the event subscription.

  • SnsTopicArn – UTF-8 string.

    The topic ARN of the event notification subscription.

  • SourceIdsList – An array of SourceId— UTF-8 strings.

    A list of source IDs for the event notification subscription.

  • SourceType – UTF-8 string.

    The source type for the event notification subscription.

  • Status – UTF-8 string.

    The status of the event notification subscription.

    Constraints:

    Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist

    The status "no-permission" indicates that Neptune no longer has permission to post to the SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created.

  • SubscriptionCreationTime – UTF-8 string.

    The time the event notification subscription was created.

EventSubscription is used as the response element for:

CreateEventSubscription (action)

        The AWS CLI name for this API is: create-event-subscription,  and the Python name is: create_event_subscription.

Creates an event notification subscription. This action requires a topic ARN (Amazon Resource Name) created by either the Neptune console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.

You can specify the type of source (SourceType) you want to be notified of, provide a list of Neptune sources (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup.

If you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIdentifier = myDBInstance1, you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you receive notice of the events for that source type for all your Neptune sources. If you do not specify either the SourceType nor the SourceIdentifier, you are notified of events generated from all Neptune sources belonging to your customer account.

Request

  • Enabled  (in the CLI: --enabled,  or in Python: enabled) – Boolean.

    A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.

  • EventCategories  (in the CLI: --event-categories,  or in Python: event_categories) – An array of EventCategory— UTF-8 strings.

    A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType by using the DescribeEventCategories action.

  • SnsTopicArn  (in the CLI: --sns-topic-arn,  or in Python: sns_topic_arn) – Required: UTF-8 string.

    The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

  • SourceIds  (in the CLI: --source-ids,  or in Python: source_ids) – An array of SourceId— UTF-8 strings.

    The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.

    Constraints:

    • If SourceIds are supplied, SourceType must also be provided.

    • If the source type is a DB instance, then a DBInstanceIdentifier must be supplied.

    • If the source type is a DB security group, a DBSecurityGroupName must be supplied.

    • If the source type is a DB parameter group, a DBParameterGroupName must be supplied.

    • If the source type is a DB snapshot, a DBSnapshotIdentifier must be supplied.

  • SourceType  (in the CLI: --source-type,  or in Python: source_type) – UTF-8 string.

    The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned.

    Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot

  • SubscriptionName  (in the CLI: --subscription-name,  or in Python: subscription_name) – Required: UTF-8 string.

    The name of the subscription.

    Constraints: The name must be less than 255 characters.

  • Tags  (in the CLI: --tags,  or in Python: tags) – An array of Tag Tag objects.

    The tags to be applied to the new event subscription.

Response

Contains the results of a successful invocation of the DescribeEventSubscriptions (action) action.

  • CustomerAwsId  (in the CLI: --customer-aws-id,  or in Python: customer_aws_id) – UTF-8 string.

    The AWS customer account associated with the event notification subscription.

  • CustSubscriptionId  (in the CLI: --cust-subscription-id,  or in Python: cust_subscription_id) – UTF-8 string.

    The event notification subscription Id.

  • Enabled  (in the CLI: --enabled,  or in Python: enabled) – Boolean.

    A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.

  • EventCategoriesList  (in the CLI: --event-categories-list,  or in Python: event_categories_list) – An array of EventCategory— UTF-8 strings.

    A list of event categories for the event notification subscription.

  • EventSubscriptionArn  (in the CLI: --event-subscription-arn,  or in Python: event_subscription_arn) – UTF-8 string.

    The Amazon Resource Name (ARN) for the event subscription.

  • SnsTopicArn  (in the CLI: --sns-topic-arn,  or in Python: sns_topic_arn) – UTF-8 string.

    The topic ARN of the event notification subscription.

  • SourceIdsList  (in the CLI: --source-ids-list,  or in Python: source_ids_list) – An array of SourceId— UTF-8 strings.

    A list of source IDs for the event notification subscription.

  • SourceType  (in the CLI: --source-type,  or in Python: source_type) – UTF-8 string.

    The source type for the event notification subscription.

  • Status  (in the CLI: --status,  or in Python: status) – UTF-8 string.

    The status of the event notification subscription.

    Constraints:

    Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist

    The status "no-permission" indicates that Neptune no longer has permission to post to the SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created.

  • SubscriptionCreationTime  (in the CLI: --subscription-creation-time,  or in Python: subscription_creation_time) – UTF-8 string.

    The time the event notification subscription was created.

DeleteEventSubscription (action)

        The AWS CLI name for this API is: delete-event-subscription,  and the Python name is: delete_event_subscription.

Deletes an event notification subscription.

Request

  • SubscriptionName  (in the CLI: --subscription-name,  or in Python: subscription_name) – Required: UTF-8 string.

    The name of the event notification subscription you want to delete.

Response

Contains the results of a successful invocation of the DescribeEventSubscriptions (action) action.

  • CustomerAwsId  (in the CLI: --customer-aws-id,  or in Python: customer_aws_id) – UTF-8 string.

    The AWS customer account associated with the event notification subscription.

  • CustSubscriptionId  (in the CLI: --cust-subscription-id,  or in Python: cust_subscription_id) – UTF-8 string.

    The event notification subscription Id.

  • Enabled  (in the CLI: --enabled,  or in Python: enabled) – Boolean.

    A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.

  • EventCategoriesList  (in the CLI: --event-categories-list,  or in Python: event_categories_list) – An array of EventCategory— UTF-8 strings.

    A list of event categories for the event notification subscription.

  • EventSubscriptionArn  (in the CLI: --event-subscription-arn,  or in Python: event_subscription_arn) – UTF-8 string.

    The Amazon Resource Name (ARN) for the event subscription.

  • SnsTopicArn  (in the CLI: --sns-topic-arn,  or in Python: sns_topic_arn) – UTF-8 string.

    The topic ARN of the event notification subscription.

  • SourceIdsList  (in the CLI: --source-ids-list,  or in Python: source_ids_list) – An array of SourceId— UTF-8 strings.

    A list of source IDs for the event notification subscription.

  • SourceType  (in the CLI: --source-type,  or in Python: source_type) – UTF-8 string.

    The source type for the event notification subscription.

  • Status  (in the CLI: --status,  or in Python: status) – UTF-8 string.

    The status of the event notification subscription.

    Constraints:

    Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist

    The status "no-permission" indicates that Neptune no longer has permission to post to the SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created.

  • SubscriptionCreationTime  (in the CLI: --subscription-creation-time,  or in Python: subscription_creation_time) – UTF-8 string.

    The time the event notification subscription was created.

ModifyEventSubscription (action)

        The AWS CLI name for this API is: modify-event-subscription,  and the Python name is: modify_event_subscription.

Modifies an existing event notification subscription. Note that you can't modify the source identifiers using this call; to change source identifiers for a subscription, use the AddSourceIdentifierToSubscription (action) and RemoveSourceIdentifierFromSubscription (action) calls.

You can see a list of the event categories for a given SourceType by using the DescribeEventCategories action.

Request

  • Enabled  (in the CLI: --enabled,  or in Python: enabled) – Boolean.

    A Boolean value; set to true to activate the subscription.

  • EventCategories  (in the CLI: --event-categories,  or in Python: event_categories) – An array of EventCategory— UTF-8 strings.

    A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType by using the DescribeEventCategories action.

  • SnsTopicArn  (in the CLI: --sns-topic-arn,  or in Python: sns_topic_arn) – UTF-8 string.

    The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

  • SourceType  (in the CLI: --source-type,  or in Python: source_type) – UTF-8 string.

    The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned.

    Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot

  • SubscriptionName  (in the CLI: --subscription-name,  or in Python: subscription_name) – Required: UTF-8 string.

    The name of the event notification subscription.

Response

Contains the results of a successful invocation of the DescribeEventSubscriptions (action) action.

  • CustomerAwsId  (in the CLI: --customer-aws-id,  or in Python: customer_aws_id) – UTF-8 string.

    The AWS customer account associated with the event notification subscription.

  • CustSubscriptionId  (in the CLI: --cust-subscription-id,  or in Python: cust_subscription_id) – UTF-8 string.

    The event notification subscription Id.

  • Enabled  (in the CLI: --enabled,  or in Python: enabled) – Boolean.

    A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.

  • EventCategoriesList  (in the CLI: --event-categories-list,  or in Python: event_categories_list) – An array of EventCategory— UTF-8 strings.

    A list of event categories for the event notification subscription.

  • EventSubscriptionArn  (in the CLI: --event-subscription-arn,  or in Python: event_subscription_arn) – UTF-8 string.

    The Amazon Resource Name (ARN) for the event subscription.

  • SnsTopicArn  (in the CLI: --sns-topic-arn,  or in Python: sns_topic_arn) – UTF-8 string.

    The topic ARN of the event notification subscription.

  • SourceIdsList  (in the CLI: --source-ids-list,  or in Python: source_ids_list) – An array of SourceId— UTF-8 strings.

    A list of source IDs for the event notification subscription.

  • SourceType  (in the CLI: --source-type,  or in Python: source_type) – UTF-8 string.

    The source type for the event notification subscription.

  • Status  (in the CLI: --status,  or in Python: status) – UTF-8 string.

    The status of the event notification subscription.

    Constraints:

    Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist

    The status "no-permission" indicates that Neptune no longer has permission to post to the SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created.

  • SubscriptionCreationTime  (in the CLI: --subscription-creation-time,  or in Python: subscription_creation_time) – UTF-8 string.

    The time the event notification subscription was created.

DescribeEventSubscriptions (action)

        The AWS CLI name for this API is: describe-event-subscriptions,  and the Python name is: describe_event_subscriptions.

Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.

If you specify a SubscriptionName, lists the description for that subscription.

Request

  • Filters  (in the CLI: --filters,  or in Python: filters) – An array of Filter Filter objects.

    This parameter is not currently supported.

  • Marker  (in the CLI: --marker,  or in Python: marker) – UTF-8 string.

    An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

  • MaxRecords  (in the CLI: --max-records,  or in Python: max_records) – Number (integer).

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

    Default: 100

    Constraints: Minimum 20, maximum 100.

  • SubscriptionName  (in the CLI: --subscription-name,  or in Python: subscription_name) – UTF-8 string.

    The name of the event notification subscription you want to describe.

Response

  • EventSubscriptionsList  (in the CLI: --event-subscriptions-list,  or in Python: event_subscriptions_list) – An array of EventSubscription EventSubscription objects.

    A list of EventSubscriptions data types.

  • Marker  (in the CLI: --marker,  or in Python: marker) – UTF-8 string.

    An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

AddSourceIdentifierToSubscription (action)

        The AWS CLI name for this API is: add-source-identifier-to-subscription,  and the Python name is: add_source_identifier_to_subscription.

Adds a source identifier to an existing event notification subscription.

Request

  • SourceIdentifier  (in the CLI: --source-identifier,  or in Python: source_identifier) – Required: UTF-8 string.

    The identifier of the event source to be added.

    Constraints:

    • If the source type is a DB instance, then a DBInstanceIdentifier must be supplied.

    • If the source type is a DB security group, a DBSecurityGroupName must be supplied.

    • If the source type is a DB parameter group, a DBParameterGroupName must be supplied.

    • If the source type is a DB snapshot, a DBSnapshotIdentifier must be supplied.

  • SubscriptionName  (in the CLI: --subscription-name,  or in Python: subscription_name) – Required: UTF-8 string.

    The name of the event notification subscription you want to add a source identifier to.

Response

Contains the results of a successful invocation of the DescribeEventSubscriptions (action) action.

  • CustomerAwsId  (in the CLI: --customer-aws-id,  or in Python: customer_aws_id) – UTF-8 string.

    The AWS customer account associated with the event notification subscription.

  • CustSubscriptionId  (in the CLI: --cust-subscription-id,  or in Python: cust_subscription_id) – UTF-8 string.

    The event notification subscription Id.

  • Enabled  (in the CLI: --enabled,  or in Python: enabled) – Boolean.

    A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.

  • EventCategoriesList  (in the CLI: --event-categories-list,  or in Python: event_categories_list) – An array of EventCategory— UTF-8 strings.

    A list of event categories for the event notification subscription.

  • EventSubscriptionArn  (in the CLI: --event-subscription-arn,  or in Python: event_subscription_arn) – UTF-8 string.

    The Amazon Resource Name (ARN) for the event subscription.

  • SnsTopicArn  (in the CLI: --sns-topic-arn,  or in Python: sns_topic_arn) – UTF-8 string.

    The topic ARN of the event notification subscription.

  • SourceIdsList  (in the CLI: --source-ids-list,  or in Python: source_ids_list) – An array of SourceId— UTF-8 strings.

    A list of source IDs for the event notification subscription.

  • SourceType  (in the CLI: --source-type,  or in Python: source_type) – UTF-8 string.

    The source type for the event notification subscription.

  • Status  (in the CLI: --status,  or in Python: status) – UTF-8 string.

    The status of the event notification subscription.

    Constraints:

    Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist

    The status "no-permission" indicates that Neptune no longer has permission to post to the SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created.

  • SubscriptionCreationTime  (in the CLI: --subscription-creation-time,  or in Python: subscription_creation_time) – UTF-8 string.

    The time the event notification subscription was created.

RemoveSourceIdentifierFromSubscription (action)

        The AWS CLI name for this API is: remove-source-identifier-from-subscription,  and the Python name is: remove_source_identifier_from_subscription.

Removes a source identifier from an existing event notification subscription.

Request

  • SourceIdentifier  (in the CLI: --source-identifier,  or in Python: source_identifier) – Required: UTF-8 string.

    The source identifier to be removed from the subscription, such as the DB instance identifier for a DB instance or the name of a security group.

  • SubscriptionName  (in the CLI: --subscription-name,  or in Python: subscription_name) – Required: UTF-8 string.

    The name of the event notification subscription you want to remove a source identifier from.

Response

Contains the results of a successful invocation of the DescribeEventSubscriptions (action) action.

  • CustomerAwsId  (in the CLI: --customer-aws-id,  or in Python: customer_aws_id) – UTF-8 string.

    The AWS customer account associated with the event notification subscription.

  • CustSubscriptionId  (in the CLI: --cust-subscription-id,  or in Python: cust_subscription_id) – UTF-8 string.

    The event notification subscription Id.

  • Enabled  (in the CLI: --enabled,  or in Python: enabled) – Boolean.

    A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.

  • EventCategoriesList  (in the CLI: --event-categories-list,  or in Python: event_categories_list) – An array of EventCategory— UTF-8 strings.

    A list of event categories for the event notification subscription.

  • EventSubscriptionArn  (in the CLI: --event-subscription-arn,  or in Python: event_subscription_arn) – UTF-8 string.

    The Amazon Resource Name (ARN) for the event subscription.

  • SnsTopicArn  (in the CLI: --sns-topic-arn,  or in Python: sns_topic_arn) – UTF-8 string.

    The topic ARN of the event notification subscription.

  • SourceIdsList  (in the CLI: --source-ids-list,  or in Python: source_ids_list) – An array of SourceId— UTF-8 strings.

    A list of source IDs for the event notification subscription.

  • SourceType  (in the CLI: --source-type,  or in Python: source_type) – UTF-8 string.

    The source type for the event notification subscription.

  • Status  (in the CLI: --status,  or in Python: status) – UTF-8 string.

    The status of the event notification subscription.

    Constraints:

    Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist

    The status "no-permission" indicates that Neptune no longer has permission to post to the SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created.

  • SubscriptionCreationTime  (in the CLI: --subscription-creation-time,  or in Python: subscription_creation_time) – UTF-8 string.

    The time the event notification subscription was created.

DescribeEvents (action)

        The AWS CLI name for this API is: describe-events,  and the Python name is: describe_events.

Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB instance, DB security group, database snapshot, or DB parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.

Request

  • Duration  (in the CLI: --duration,  or in Python: duration) – Number (integer).

    The number of minutes to retrieve events for.

    Default: 60

  • EndTime  (in the CLI: --end-time,  or in Python: end_time) – Timestamp.

    The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

    Example: 2009-07-08T18:00Z

  • EventCategories  (in the CLI: --event-categories,  or in Python: event_categories) – An array of EventCategory— UTF-8 strings.

    A list of event categories that trigger notifications for a event notification subscription.

  • Filters  (in the CLI: --filters,  or in Python: filters) – An array of Filter Filter objects.

    This parameter is not currently supported.

  • Marker  (in the CLI: --marker,  or in Python: marker) – UTF-8 string.

    An optional pagination token provided by a previous DescribeEvents request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

  • MaxRecords  (in the CLI: --max-records,  or in Python: max_records) – Number (integer).

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

    Default: 100

    Constraints: Minimum 20, maximum 100.

  • SourceIdentifier  (in the CLI: --source-identifier,  or in Python: source_identifier) – UTF-8 string.

    The identifier of the event source for which events are returned. If not specified, then all sources are included in the response.

    Constraints:

    • If SourceIdentifier is supplied, SourceType must also be provided.

    • If the source type is DBInstance, then a DBInstanceIdentifier must be supplied.

    • If the source type is DBSecurityGroup, a DBSecurityGroupName must be supplied.

    • If the source type is DBParameterGroup, a DBParameterGroupName must be supplied.

    • If the source type is DBSnapshot, a DBSnapshotIdentifier must be supplied.

    • Cannot end with a hyphen or contain two consecutive hyphens.

  • SourceType  (in the CLI: --source-type,  or in Python: source_type) – UTF-8 string (valid values: db-instance="" | db-parameter-group="" | db-security-group="" | db-snapshot="" | db-cluster="" | db-cluster-snapshot="").

    The event source to retrieve events for. If no value is specified, all events are returned.

  • StartTime  (in the CLI: --start-time,  or in Python: start_time) – Timestamp.

    The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

    Example: 2009-07-08T18:00Z

Response

  • Events  (in the CLI: --events,  or in Python: events) – An array of Event Event objects.

    A list of Event (structure) instances.

  • Marker  (in the CLI: --marker,  or in Python: marker) – UTF-8 string.

    An optional pagination token provided by a previous Events request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

DescribeEventCategories (action)

        The AWS CLI name for this API is: describe-event-categories,  and the Python name is: describe_event_categories.

Displays a list of categories for all event source types, or, if specified, for a specified source type.

Request

  • Filters  (in the CLI: --filters,  or in Python: filters) – An array of Filter Filter objects.

    This parameter is not currently supported.

  • SourceType  (in the CLI: --source-type,  or in Python: source_type) – UTF-8 string.

    The type of source that is generating the events.

    Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot

Response

  • EventCategoriesMapList  (in the CLI: --event-categories-map-list,  or in Python: event_categories_map_list) – An array of EventCategoriesMap EventCategoriesMap objects.

    A list of EventCategoriesMap data types.