Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
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.
This operation returns paginated results.
Synopsis
- data ListResolverQueryLogConfigs = ListResolverQueryLogConfigs' {}
- newListResolverQueryLogConfigs :: ListResolverQueryLogConfigs
- listResolverQueryLogConfigs_filters :: Lens' ListResolverQueryLogConfigs (Maybe [Filter])
- listResolverQueryLogConfigs_nextToken :: Lens' ListResolverQueryLogConfigs (Maybe Text)
- listResolverQueryLogConfigs_sortOrder :: Lens' ListResolverQueryLogConfigs (Maybe SortOrder)
- listResolverQueryLogConfigs_maxResults :: Lens' ListResolverQueryLogConfigs (Maybe Natural)
- listResolverQueryLogConfigs_sortBy :: Lens' ListResolverQueryLogConfigs (Maybe Text)
- data ListResolverQueryLogConfigsResponse = ListResolverQueryLogConfigsResponse' {}
- newListResolverQueryLogConfigsResponse :: Int -> ListResolverQueryLogConfigsResponse
- listResolverQueryLogConfigsResponse_totalFilteredCount :: Lens' ListResolverQueryLogConfigsResponse (Maybe Int)
- listResolverQueryLogConfigsResponse_resolverQueryLogConfigs :: Lens' ListResolverQueryLogConfigsResponse (Maybe [ResolverQueryLogConfig])
- listResolverQueryLogConfigsResponse_nextToken :: Lens' ListResolverQueryLogConfigsResponse (Maybe Text)
- listResolverQueryLogConfigsResponse_totalCount :: Lens' ListResolverQueryLogConfigsResponse (Maybe Int)
- listResolverQueryLogConfigsResponse_httpStatus :: Lens' ListResolverQueryLogConfigsResponse Int
Creating a Request
data ListResolverQueryLogConfigs Source #
See: newListResolverQueryLogConfigs
smart constructor.
ListResolverQueryLogConfigs' | |
|
Instances
newListResolverQueryLogConfigs :: ListResolverQueryLogConfigs Source #
Create a value of ListResolverQueryLogConfigs
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:ListResolverQueryLogConfigs'
, listResolverQueryLogConfigs_filters
- An optional specification to return a subset of query logging
configurations.
If you submit a second or subsequent ListResolverQueryLogConfigs
request and specify the NextToken
parameter, you must use the same
values for Filters
, if any, as in the previous request.
$sel:nextToken:ListResolverQueryLogConfigs'
, listResolverQueryLogConfigs_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.
$sel:sortOrder:ListResolverQueryLogConfigs'
, listResolverQueryLogConfigs_sortOrder
- If you specified a value for SortBy
, the order that you want query
logging configurations to be listed in, ASCENDING
or DESCENDING
.
If you submit a second or subsequent ListResolverQueryLogConfigs
request and specify the NextToken
parameter, you must use the same
value for SortOrder
, if any, as in the previous request.
$sel:maxResults:ListResolverQueryLogConfigs'
, listResolverQueryLogConfigs_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.
$sel:sortBy:ListResolverQueryLogConfigs'
, listResolverQueryLogConfigs_sortBy
- The element that you want Resolver to sort query logging configurations
by.
If you submit a second or subsequent ListResolverQueryLogConfigs
request and specify the NextToken
parameter, you must use the same
value for SortBy
, 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.
Request Lenses
listResolverQueryLogConfigs_filters :: Lens' ListResolverQueryLogConfigs (Maybe [Filter]) Source #
An optional specification to return a subset of query logging configurations.
If you submit a second or subsequent ListResolverQueryLogConfigs
request and specify the NextToken
parameter, you must use the same
values for Filters
, if any, as in the previous request.
listResolverQueryLogConfigs_nextToken :: Lens' ListResolverQueryLogConfigs (Maybe Text) Source #
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.
listResolverQueryLogConfigs_sortOrder :: Lens' ListResolverQueryLogConfigs (Maybe SortOrder) Source #
If you specified a value for SortBy
, the order that you want query
logging configurations to be listed in, ASCENDING
or DESCENDING
.
If you submit a second or subsequent ListResolverQueryLogConfigs
request and specify the NextToken
parameter, you must use the same
value for SortOrder
, if any, as in the previous request.
listResolverQueryLogConfigs_maxResults :: Lens' ListResolverQueryLogConfigs (Maybe Natural) Source #
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.
listResolverQueryLogConfigs_sortBy :: Lens' ListResolverQueryLogConfigs (Maybe Text) Source #
The element that you want Resolver to sort query logging configurations by.
If you submit a second or subsequent ListResolverQueryLogConfigs
request and specify the NextToken
parameter, you must use the same
value for SortBy
, 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.
Destructuring the Response
data ListResolverQueryLogConfigsResponse Source #
See: newListResolverQueryLogConfigsResponse
smart constructor.
ListResolverQueryLogConfigsResponse' | |
|
Instances
newListResolverQueryLogConfigsResponse Source #
Create a value of ListResolverQueryLogConfigsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:totalFilteredCount:ListResolverQueryLogConfigsResponse'
, listResolverQueryLogConfigsResponse_totalFilteredCount
- 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, see TotalCount
.
$sel:resolverQueryLogConfigs:ListResolverQueryLogConfigsResponse'
, listResolverQueryLogConfigsResponse_resolverQueryLogConfigs
- A list that contains one ResolverQueryLogConfig
element for each query
logging configuration that matches the values that you specified for
Filter
.
$sel:nextToken:ListResolverQueryLogConfigs'
, listResolverQueryLogConfigsResponse_nextToken
- If there are more than MaxResults
query logging configurations, 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.
$sel:totalCount:ListResolverQueryLogConfigsResponse'
, listResolverQueryLogConfigsResponse_totalCount
- 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.
$sel:httpStatus:ListResolverQueryLogConfigsResponse'
, listResolverQueryLogConfigsResponse_httpStatus
- The response's http status code.
Response Lenses
listResolverQueryLogConfigsResponse_totalFilteredCount :: Lens' ListResolverQueryLogConfigsResponse (Maybe Int) Source #
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, see TotalCount
.
listResolverQueryLogConfigsResponse_resolverQueryLogConfigs :: Lens' ListResolverQueryLogConfigsResponse (Maybe [ResolverQueryLogConfig]) Source #
A list that contains one ResolverQueryLogConfig
element for each query
logging configuration that matches the values that you specified for
Filter
.
listResolverQueryLogConfigsResponse_nextToken :: Lens' ListResolverQueryLogConfigsResponse (Maybe Text) Source #
If there are more than MaxResults
query logging configurations, 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.
listResolverQueryLogConfigsResponse_totalCount :: Lens' ListResolverQueryLogConfigsResponse (Maybe Int) Source #
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.
listResolverQueryLogConfigsResponse_httpStatus :: Lens' ListResolverQueryLogConfigsResponse Int Source #
The response's http status code.