DescribeEventsMessage

import type { DescribeEventsMessage } from "https://aws-api.deno.dev/v0.4/services/docdb.ts?docs=full";

Represents the input to "DescribeEvents".

interface DescribeEventsMessage {

Duration?: number | null;

EndTime?: Date | number | null;

EventCategories?: string[] | null;

Filters?: Filter[] | null;

Marker?: string | null;

MaxRecords?: number | null;

SourceIdentifier?: string | null;

SourceType?: SourceType | null;

StartTime?: Date | number | null;

}

§Properties

Duration?: number | null

[src]

The number of minutes to retrieve events for.

Default: 60

EndTime?: Date | number | null

[src]

The end of the time interval for which to retrieve events, specified in ISO 8601 format.

Example: 2009-07-08T18:00Z

EventCategories?: string[] | null

[src]

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

Filters?: Filter[] | null

[src]

This parameter is not currently supported.

Marker?: string | null

[src]

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?: number | null

[src]

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 | null

[src]

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?: SourceType | null

[src]

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

StartTime?: Date | number | null

[src]

The beginning of the time interval to retrieve events for, specified in ISO 8601 format.

Example: 2009-07-08T18:00Z