describeAffectedEntities method

Future<DescribeAffectedEntitiesResponse> describeAffectedEntities({ required EntityFilter filter, String? locale, int? maxResults, String? nextToken, })

Returns a list of entities that have been affected by the specified events, based on the specified filter criteria. Entities can refer to individual customer resources, groups of customer resources, or any other construct, depending on the AWS service. Events that have impact beyond that of the affected entities, or where the extent of impact is unknown, include at least one entity indicating this.

At least one event ARN is required. Results are sorted by the lastUpdatedTime of the entity, starting with the most recent.

May throw InvalidPaginationToken. May throw UnsupportedLocale.

Parameter filter : Values to narrow the results returned. At least one event ARN is required.

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<DescribeAffectedEntitiesResponse> describeAffectedEntities({
  required EntityFilter filter,
  String? locale,
  int? maxResults,
  String? nextToken,
}) async {
  ArgumentError.checkNotNull(filter, 'filter');
  _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.DescribeAffectedEntities'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'filter': filter,
      if (locale != null) 'locale': locale,
      if (maxResults != null) 'maxResults': maxResults,
      if (nextToken != null) 'nextToken': nextToken,
    },
  );

  return DescribeAffectedEntitiesResponse.fromJson(jsonResponse.body);
}