listResolverQueryLogConfigs method
Lists information about the specified query logging configurations. Each configuration defines where you want Resolver to save DNS query logs and specifies the VPCs that you want to log queries for.
May throw InvalidNextTokenException. May throw InvalidRequestException. May throw InvalidParameterException. May throw InternalServiceErrorException. May throw ThrottlingException. May throw AccessDeniedException.
Parameter filters
:
An optional specification to return a subset of query logging
configurations.
Parameter maxResults
:
The maximum number of query logging configurations that you want to return
in the response to a ListResolverQueryLogConfigs
request. If
you don't specify a value for MaxResults
, Resolver returns up
to 100 query logging configurations.
Parameter nextToken
:
For the first ListResolverQueryLogConfigs
request, omit this
value.
If there are more than MaxResults
query logging
configurations that match the values that you specify for
Filters
, you can submit another
ListResolverQueryLogConfigs
request to get the next group of
configurations. 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 configurations
by.
Valid values include the following elements:
-
Arn
: The ARN of the query logging configuration -
AssociationCount
: The number of VPCs that are associated with the specified configuration -
CreationTime
: The date and time that Resolver returned when the configuration was created -
CreatorRequestId
: The value that was specified forCreatorRequestId
when the configuration was created -
DestinationArn
: The location that logs are sent to -
Id
: The ID of the configuration -
Name
: The name of the configuration -
OwnerId
: The AWS account number of the account that created the configuration -
ShareStatus
: Whether the configuration is shared with other AWS accounts or shared with the current account by another AWS account. Sharing is configured through AWS Resource Access Manager (AWS RAM). -
Status
: The current status of the configuration. Valid values include the following:-
CREATING
: Resolver is creating the query logging configuration. -
CREATED
: The query logging configuration was successfully created. Resolver is logging queries that originate in the specified VPC. -
DELETING
: Resolver is deleting this query logging configuration. -
FAILED
: Resolver either couldn't create or couldn't delete the query logging configuration. 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 configurations to be listed in, ASCENDING
or
DESCENDING
.
Implementation
Future<ListResolverQueryLogConfigsResponse> listResolverQueryLogConfigs({
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.ListResolverQueryLogConfigs'
};
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 ListResolverQueryLogConfigsResponse.fromJson(jsonResponse.body);
}