describeEvents method

Future<EventsMessage> describeEvents({ int? duration, DateTime? endTime, String? marker, int? maxRecords, String? sourceIdentifier, SourceType? sourceType, DateTime? startTime, })

Returns events related to clusters, cache security groups, and cache parameter groups. You can obtain events specific to a particular cluster, cache security group, or cache parameter group by providing the name as a parameter.

By default, only the events occurring within the last hour are returned; however, you can retrieve up to 14 days' worth of events if necessary.

May throw InvalidParameterValueException. May throw InvalidParameterCombinationException.

Parameter duration : The number of minutes worth of events to retrieve.

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

Example: 2017-03-30T07:03:49.555Z

Parameter marker : An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

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

Default: 100

Constraints: minimum 20; maximum 100.

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

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

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

Example: 2017-03-30T07:03:49.555Z

Implementation

Future<EventsMessage> describeEvents({
  int? duration,
  DateTime? endTime,
  String? marker,
  int? maxRecords,
  String? sourceIdentifier,
  SourceType? sourceType,
  DateTime? startTime,
}) async {
  final $request = <String, dynamic>{};
  duration?.also((arg) => $request['Duration'] = arg);
  endTime?.also((arg) => $request['EndTime'] = _s.iso8601ToJson(arg));
  marker?.also((arg) => $request['Marker'] = arg);
  maxRecords?.also((arg) => $request['MaxRecords'] = arg);
  sourceIdentifier?.also((arg) => $request['SourceIdentifier'] = arg);
  sourceType?.also((arg) => $request['SourceType'] = arg.toValue());
  startTime?.also((arg) => $request['StartTime'] = _s.iso8601ToJson(arg));
  final $result = await _protocol.send(
    $request,
    action: 'DescribeEvents',
    version: '2015-02-02',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['DescribeEventsMessage'],
    shapes: shapes,
    resultWrapper: 'DescribeEventsResult',
  );
  return EventsMessage.fromXml($result);
}