events

Creates, updates, deletes, gets or lists an events resource.

Overview

Name	events
Type	Resource
Id	aws.docdb.events

Fields

The following fields are returned by SELECT queries:

describe_events

Name	Datatype	Description
date	string	Specifies the date and time of the event.
event_categories	string	Specifies the category for the event.
message	string	Provides the text of this event.
source_arn	string	The Amazon Resource Name (ARN) for the event.
source_identifier	string	Provides the identifier for the source of the event.
source_type	string	Specifies the source type for this event.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_events	select	region	SourceIdentifier, SourceType, StartTime, EndTime, Duration, EventCategories, Filters, MaxRecords, Marker	Returns events related to instances, security groups, snapshots, and DB parameter groups for the past 14 days. You can obtain events specific to a particular DB instance, security group, snapshot, or parameter group by providing the name as a parameter. By default, the events of the past hour are returned.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
Duration	integer	The number of minutes to retrieve events for. Default: 60
EndTime	string (date-time)	The end of the time interval for which to retrieve events, specified in ISO 8601 format. Example: 2009-07-08T18:00Z
EventCategories	array	A list of event categories that trigger notifications for an event notification subscription.
Filters	array	This parameter is not currently supported.
Marker	string	An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
MaxRecords	integer	The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100.
SourceIdentifier	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 provided, SourceType must also be provided. If the source type is DBInstance, a DBInstanceIdentifier must be provided. If the source type is DBSecurityGroup, a DBSecurityGroupName must be provided. If the source type is DBParameterGroup, a DBParameterGroupName must be provided. If the source type is DBSnapshot, a DBSnapshotIdentifier must be provided. Cannot end with a hyphen or contain two consecutive hyphens.
SourceType	string	The event source to retrieve events for. If no value is specified, all events are returned.
StartTime	string (date-time)	The beginning of the time interval to retrieve events for, specified in ISO 8601 format. Example: 2009-07-08T18:00Z

SELECT examples

describe_events

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

SELECT
date,
event_categories,
message,
source_arn,
source_identifier,
source_type
FROM aws.docdb.events
WHERE region = '{{ region }}' -- required
AND SourceIdentifier = '{{ SourceIdentifier }}'
AND SourceType = '{{ SourceType }}'
AND StartTime = '{{ StartTime }}'
AND EndTime = '{{ EndTime }}'
AND Duration = '{{ Duration }}'
AND EventCategories = '{{ EventCategories }}'
AND Filters = '{{ Filters }}'
AND MaxRecords = '{{ MaxRecords }}'
AND Marker = '{{ Marker }}'
;