Jump to Content

New API Documentation - Developer Preview Available

We are excited to announce the developer preview of our new API documentation for AWS SDK for JavaScript v3. Please follow instructions on the landing page to leave us your feedback.

Interface DescribeEventsCommandInputProtected

The input for DescribeEventsCommand.

Hierarchy

Properties

Duration?: number

The number of minutes' worth of events to retrieve.

EndTime?: Date

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

MaxResults?: number

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

The value for MaxResults must be between 20 and 100.

NextToken?: string

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

SourceName?: string

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

SourceType?: string

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

StartTime?: Date

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