Route53Resolver / Client / list_resolver_query_log_configs
list_resolver_query_log_configs#
- Route53Resolver.Client.list_resolver_query_log_configs(**kwargs)#
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.
See also: AWS API Documentation
Request Syntax
response = client.list_resolver_query_log_configs( MaxResults=123, NextToken='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], SortBy='string', SortOrder='ASCENDING'|'DESCENDING' )
- Parameters:
MaxResults (integer) – 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 forMaxResults
, Resolver returns up to 100 query logging configurations.NextToken (string) –
For the first
ListResolverQueryLogConfigs
request, omit this value.If there are more than
MaxResults
query logging configurations that match the values that you specify forFilters
, you can submit anotherListResolverQueryLogConfigs
request to get the next group of configurations. In the next request, specify the value ofNextToken
from the previous response.Filters (list) –
An optional specification to return a subset of query logging configurations.
Note
If you submit a second or subsequent
ListResolverQueryLogConfigs
request and specify theNextToken
parameter, you must use the same values forFilters
, if any, as in the previous request.(dict) –
For Resolver list operations ( ListResolverEndpoints, ListResolverRules, ListResolverRuleAssociations, ListResolverQueryLogConfigs, ListResolverQueryLogConfigAssociations), and ListResolverDnssecConfigs), an optional specification to return a subset of objects.
To filter objects, such as Resolver endpoints or Resolver rules, you specify
Name
andValues
. For example, to list only inbound Resolver endpoints, specifyDirection
forName
and specifyINBOUND
forValues
.Name (string) –
The name of the parameter that you want to use to filter objects.
The valid values for
Name
depend on the action that you’re including the filter in, ListResolverEndpoints, ListResolverRules, ListResolverRuleAssociations, ListResolverQueryLogConfigs, or ListResolverQueryLogConfigAssociations.Note
In early versions of Resolver, values for
Name
were listed as uppercase, with underscore (_) delimiters. For example,CreatorRequestId
was originally listed asCREATOR_REQUEST_ID
. Uppercase values forName
are still supported.ListResolverEndpoints
Valid values for
Name
include the following:CreatorRequestId
: The value that you specified when you created the Resolver endpoint.Direction
: Whether you want to return inbound or outbound Resolver endpoints. If you specifyDIRECTION
forName
, specifyINBOUND
orOUTBOUND
forValues
.HostVPCId
: The ID of the VPC that inbound DNS queries pass through on the way from your network to your VPCs in a region, or the VPC that outbound queries pass through on the way from your VPCs to your network. In a CreateResolverEndpoint request,SubnetId
indirectly identifies the VPC. In a GetResolverEndpoint request, the VPC ID for a Resolver endpoint is returned in theHostVPCId
element.IpAddressCount
: The number of IP addresses that you have associated with the Resolver endpoint.Name
: The name of the Resolver endpoint.SecurityGroupIds
: The IDs of the VPC security groups that you specified when you created the Resolver endpoint.Status
: The status of the Resolver endpoint. If you specifyStatus
forName
, specify one of the following status codes forValues
:CREATING
,OPERATIONAL
,UPDATING
,AUTO_RECOVERING
,ACTION_NEEDED
, orDELETING
. For more information, seeStatus
in ResolverEndpoint.
ListResolverRules
Valid values for
Name
include the following:CreatorRequestId
: The value that you specified when you created the Resolver rule.DomainName
: The domain name for which Resolver is forwarding DNS queries to your network. In the value that you specify forValues
, include a trailing dot (.) after the domain name. For example, if the domain name is example.com, specify the following value. Note the “.” aftercom
:example.com.
Name
: The name of the Resolver rule.ResolverEndpointId
: The ID of the Resolver endpoint that the Resolver rule is associated with.
Note
You can filter on the Resolver endpoint only for rules that have a value of
FORWARD
forRuleType
.Status
: The status of the Resolver rule. If you specifyStatus
forName
, specify one of the following status codes forValues
:COMPLETE
,DELETING
,UPDATING
, orFAILED
.Type
: The type of the Resolver rule. If you specifyTYPE
forName
, specifyFORWARD
orSYSTEM
forValues
.
ListResolverRuleAssociations
Valid values for
Name
include the following:Name
: The name of the Resolver rule association.ResolverRuleId
: The ID of the Resolver rule that is associated with one or more VPCs.Status
: The status of the Resolver rule association. If you specifyStatus
forName
, specify one of the following status codes forValues
:CREATING
,COMPLETE
,DELETING
, orFAILED
.VPCId
: The ID of the VPC that the Resolver rule is associated with.
ListResolverQueryLogConfigs
Valid values for
Name
include the following:Arn
: The ARN for the query logging configuration.AssociationCount
: The number of VPCs that are associated with the query logging configuration.CreationTime
: The date and time that the query logging configuration was created, in Unix time format and Coordinated Universal Time (UTC).CreatorRequestId
: A unique string that identifies the request that created the query logging configuration.Destination
: The Amazon Web Services service that you want to forward query logs to. Valid values include the following:S3
CloudWatchLogs
KinesisFirehose
DestinationArn
: The ARN of the location that Resolver is sending query logs to. This value can be the ARN for an S3 bucket, a CloudWatch Logs log group, or a Kinesis Data Firehose delivery stream.Id
: The ID of the query logging configurationName
: The name of the query logging configurationOwnerId
: The Amazon Web Services account ID for the account that created the query logging configuration.ShareStatus
: An indication of whether the query logging configuration is shared with other Amazon Web Services accounts, or was shared with the current account by another Amazon Web Services account. Valid values include:NOT_SHARED
,SHARED_WITH_ME
, orSHARED_BY_ME
.Status
: The status of the query logging configuration. If you specifyStatus
forName
, specify the applicable status code forValues
:CREATING
,CREATED
,DELETING
, orFAILED
. For more information, see Status.
ListResolverQueryLogConfigAssociations
Valid values for
Name
include the following:CreationTime
: The date and time that the VPC was associated with the query logging configuration, in Unix time format and Coordinated Universal Time (UTC).Error
: If the value ofStatus
isFAILED
, specify the cause:DESTINATION_NOT_FOUND
orACCESS_DENIED
.Id
: The ID of the query logging association.ResolverQueryLogConfigId
: The ID of the query logging configuration that a VPC is associated with.ResourceId
: The ID of the Amazon VPC that is associated with the query logging configuration.Status
: The status of the query logging association. If you specifyStatus
forName
, specify the applicable status code forValues
:CREATING
,CREATED
,DELETING
, orFAILED
. For more information, see Status.
Values (list) –
When you’re using a
List
operation and you want the operation to return a subset of objects, such as Resolver endpoints or Resolver rules, the value of the parameter that you want to use to filter objects. For example, to list only inbound Resolver endpoints, specifyDirection
forName
and specifyINBOUND
forValues
.(string) –
SortBy (string) –
The element that you want Resolver to sort query logging configurations by.
Note
If you submit a second or subsequent
ListResolverQueryLogConfigs
request and specify theNextToken
parameter, you must use the same value forSortBy
, if any, as in the previous request.Valid values include the following elements:
Arn
: The ARN of the query logging configurationAssociationCount
: The number of VPCs that are associated with the specified configurationCreationTime
: The date and time that Resolver returned when the configuration was createdCreatorRequestId
: The value that was specified forCreatorRequestId
when the configuration was createdDestinationArn
: The location that logs are sent toId
: The ID of the configurationName
: The name of the configurationOwnerId
: The Amazon Web Services account number of the account that created the configurationShareStatus
: Whether the configuration is shared with other Amazon Web Services accounts or shared with the current account by another Amazon Web Services account. Sharing is configured through Resource Access Manager (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.
SortOrder (string) –
If you specified a value for
SortBy
, the order that you want query logging configurations to be listed in,ASCENDING
orDESCENDING
.Note
If you submit a second or subsequent
ListResolverQueryLogConfigs
request and specify theNextToken
parameter, you must use the same value forSortOrder
, if any, as in the previous request.
- Return type:
dict
- Returns:
Response Syntax
{ 'NextToken': 'string', 'TotalCount': 123, 'TotalFilteredCount': 123, 'ResolverQueryLogConfigs': [ { 'Id': 'string', 'OwnerId': 'string', 'Status': 'CREATING'|'CREATED'|'DELETING'|'FAILED', 'ShareStatus': 'NOT_SHARED'|'SHARED_WITH_ME'|'SHARED_BY_ME', 'AssociationCount': 123, 'Arn': 'string', 'Name': 'string', 'DestinationArn': 'string', 'CreatorRequestId': 'string', 'CreationTime': 'string' }, ] }
Response Structure
(dict) –
NextToken (string) –
If there are more than
MaxResults
query logging configurations, you can submit anotherListResolverQueryLogConfigs
request to get the next group of configurations. In the next request, specify the value ofNextToken
from the previous response.TotalCount (integer) –
The total number of query logging configurations that were created by the current account in the specified Region. This count can differ from the number of query logging configurations that are returned in a
ListResolverQueryLogConfigs
response, depending on the values that you specify in the request.TotalFilteredCount (integer) –
The total number of query logging configurations that were created by the current account in the specified Region and that match the filters that were specified in the
ListResolverQueryLogConfigs
request. For the total number of query logging configurations that were created by the current account in the specified Region, seeTotalCount
.ResolverQueryLogConfigs (list) –
A list that contains one
ResolverQueryLogConfig
element for each query logging configuration that matches the values that you specified forFilter
.(dict) –
In the response to a CreateResolverQueryLogConfig, DeleteResolverQueryLogConfig, GetResolverQueryLogConfig, or ListResolverQueryLogConfigs request, a complex type that contains settings for one query logging configuration.
Id (string) –
The ID for the query logging configuration.
OwnerId (string) –
The Amazon Web Services account ID for the account that created the query logging configuration.
Status (string) –
The status of the specified query logging 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 can’t deliver logs to the location that is specified in 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.
ShareStatus (string) –
An indication of whether the query logging configuration is shared with other Amazon Web Services accounts, or was shared with the current account by another Amazon Web Services account. Sharing is configured through Resource Access Manager (RAM).
AssociationCount (integer) –
The number of VPCs that are associated with the query logging configuration.
Arn (string) –
The ARN for the query logging configuration.
Name (string) –
The name of the query logging configuration.
DestinationArn (string) –
The ARN of the resource that you want Resolver to send query logs: an Amazon S3 bucket, a CloudWatch Logs log group, or a Kinesis Data Firehose delivery stream.
CreatorRequestId (string) –
A unique string that identifies the request that created the query logging configuration. The
CreatorRequestId
allows failed requests to be retried without the risk of running the operation twice.CreationTime (string) –
The date and time that the query logging configuration was created, in Unix time format and Coordinated Universal Time (UTC).
Exceptions