listResolverQueryLogConfigAssociations method

Future<ListResolverQueryLogConfigAssociationsResponse> listResolverQueryLogConfigAssociations({
  1. List<Filter>? filters,
  2. int? maxResults,
  3. String? nextToken,
  4. String? sortBy,
  5. SortOrder? sortOrder,
})

Lists information about associations between Amazon VPCs and query logging configurations.

May throw InvalidParameterException. May throw InvalidRequestException. May throw LimitExceededException. May throw InternalServiceErrorException. May throw ThrottlingException. May throw AccessDeniedException.

Parameter filters : An optional specification to return a subset of query logging associations.

Parameter maxResults : The maximum number of query logging associations that you want to return in the response to a ListResolverQueryLogConfigAssociations request. If you don't specify a value for MaxResults, Resolver returns up to 100 query logging associations.

Parameter nextToken : For the first ListResolverQueryLogConfigAssociations request, omit this value.

If there are more than MaxResults query logging associations that match the values that you specify for Filters, you can submit another ListResolverQueryLogConfigAssociations request to get the next group of associations. In the next request, specify the value of NextToken from the previous response.

Parameter sortBy : The element that you want Resolver to sort query logging associations by. Valid values include the following elements:

  • CreationTime: The ID of the query logging association.
  • Error: If the value of Status is FAILED, the value of Error indicates the cause:
    • DESTINATION_NOT_FOUND: The specified destination (for example, an Amazon S3 bucket) was deleted.
    • ACCESS_DENIED: Permissions don't allow sending logs to the destination.
    If Status is a value other than FAILED, ERROR is null.
  • Id: The ID of the query logging association
  • ResolverQueryLogConfigId: The ID of the query logging configuration
  • ResourceId: The ID of the VPC that is associated with the query logging configuration
  • Status: The current status of the configuration. Valid values include the following:
    • CREATING: Resolver is creating an association between an Amazon VPC and a query logging configuration.
    • CREATED: The association between an Amazon VPC and a query logging configuration was successfully created. Resolver is logging queries that originate in the specified VPC.
    • DELETING: Resolver is deleting this query logging association.
    • FAILED: Resolver either couldn't create or couldn't delete the query logging association. Here are two common causes:
      • The specified destination (for example, an Amazon S3 bucket) was deleted.
      • Permissions don't allow sending logs to the destination.

Parameter sortOrder : If you specified a value for SortBy, the order that you want query logging associations to be listed in, ASCENDING or DESCENDING.

Implementation

Future<ListResolverQueryLogConfigAssociationsResponse>
    listResolverQueryLogConfigAssociations({
  List<Filter>? filters,
  int? maxResults,
  String? nextToken,
  String? sortBy,
  SortOrder? sortOrder,
}) async {
  _s.validateNumRange(
    'maxResults',
    maxResults,
    1,
    100,
  );
  _s.validateStringLength(
    'sortBy',
    sortBy,
    1,
    64,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'Route53Resolver.ListResolverQueryLogConfigAssociations'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      if (filters != null) 'Filters': filters,
      if (maxResults != null) 'MaxResults': maxResults,
      if (nextToken != null) 'NextToken': nextToken,
      if (sortBy != null) 'SortBy': sortBy,
      if (sortOrder != null) 'SortOrder': sortOrder.toValue(),
    },
  );

  return ListResolverQueryLogConfigAssociationsResponse.fromJson(
      jsonResponse.body);
}