class Aws::DocDB::Types::DescribeEventsMessage
Represents the input to DescribeEvents.
@note When making an API call, you may pass DescribeEventsMessage
data as a hash: { source_identifier: "String", source_type: "db-instance", # accepts db-instance, db-parameter-group, db-security-group, db-snapshot, db-cluster, db-cluster-snapshot start_time: Time.now, end_time: Time.now, duration: 1, event_categories: ["String"], filters: [ { name: "String", # required values: ["String"], # required }, ], max_records: 1, marker: "String", }
@!attribute [rw] source_identifier
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. @return [String]
@!attribute [rw] source_type
The event source to retrieve events for. If no value is specified, all events are returned. @return [String]
@!attribute [rw] start_time
The beginning of the time interval to retrieve events for, specified in ISO 8601 format. Example: 2009-07-08T18:00Z @return [Time]
@!attribute [rw] end_time
The end of the time interval for which to retrieve events, specified in ISO 8601 format. Example: 2009-07-08T18:00Z @return [Time]
@!attribute [rw] duration
The number of minutes to retrieve events for. Default: 60 @return [Integer]
@!attribute [rw] event_categories
A list of event categories that trigger notifications for an event notification subscription. @return [Array<String>]
@!attribute [rw] filters
This parameter is not currently supported. @return [Array<Types::Filter>]
@!attribute [rw] max_records
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. @return [Integer]
@!attribute [rw] marker
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`. @return [String]
@see docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeEventsMessage AWS API Documentation
Constants
- SENSITIVE