describeEvents method

Future<DescribeEventsResponse> describeEvents({ EventFilter? filter, String? locale, int? maxResults, String? nextToken, })

Returns information about events that meet the specified filter criteria. Events are returned in a summary form and do not include the detailed description, any additional metadata that depends on the event type, or any affected resources. To retrieve that information, use the DescribeEventDetails and DescribeAffectedEntities operations.

If no filter criteria are specified, all events are returned. Results are sorted by lastModifiedTime, starting with the most recent event.

• When you call the DescribeEvents operation and specify an entity for the entityValues parameter, AWS Health might return public events that aren't specific to that resource. For example, if you call DescribeEvents and specify an ID for an Amazon Elastic Compute Cloud (Amazon EC2) instance, AWS Health might return events that aren't specific to that resource or service. To get events that are specific to a service, use the services parameter in the filter object. For more information, see Event.
• This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

May throw InvalidPaginationToken. May throw UnsupportedLocale.

Parameter filter : Values to narrow the results returned.

Parameter locale : The locale (language) to return information in. English (en) is the default and the only supported value at this time.

Parameter maxResults : The maximum number of items to return in one batch, between 10 and 100, inclusive.

Parameter nextToken : If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

Implementation

Future<DescribeEventsResponse> describeEvents({
  EventFilter? filter,
  String? locale,
  int? maxResults,
  String? nextToken,
}) async {
  _s.validateStringLength(
    'locale',
    locale,
    2,
    256,
  );
  _s.validateNumRange(
    'maxResults',
    maxResults,
    10,
    100,
  );
  _s.validateStringLength(
    'nextToken',
    nextToken,
    4,
    10000,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'AWSHealth_20160804.DescribeEvents'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      if (filter != null) 'filter': filter,
      if (locale != null) 'locale': locale,
      if (maxResults != null) 'maxResults': maxResults,
      if (nextToken != null) 'nextToken': nextToken,
    },
  );

  return DescribeEventsResponse.fromJson(jsonResponse.body);
}