libZSservicesZSamazonka-route53resolverZSamazonka-route53resolver
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Route53Resolver.ListResolverQueryLogConfigs

Description

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

Creating a Request

data ListResolverQueryLogConfigs Source #

See: newListResolverQueryLogConfigs smart constructor.

Constructors

ListResolverQueryLogConfigs' 

Fields

  • filters :: Maybe [Filter]

    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.

  • nextToken :: Maybe Text

    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.

  • sortOrder :: Maybe 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.

  • maxResults :: Maybe Natural

    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.

  • sortBy :: Maybe Text

    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 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 for CreatorRequestId 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 Amazon Web Services account number of the account that created the configuration
    • ShareStatus: 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.

Instances

Instances details
Eq ListResolverQueryLogConfigs Source # 
Instance details

Defined in Amazonka.Route53Resolver.ListResolverQueryLogConfigs

Read ListResolverQueryLogConfigs Source # 
Instance details

Defined in Amazonka.Route53Resolver.ListResolverQueryLogConfigs

Show ListResolverQueryLogConfigs Source # 
Instance details

Defined in Amazonka.Route53Resolver.ListResolverQueryLogConfigs

Generic ListResolverQueryLogConfigs Source # 
Instance details

Defined in Amazonka.Route53Resolver.ListResolverQueryLogConfigs

Associated Types

type Rep ListResolverQueryLogConfigs :: Type -> Type #

NFData ListResolverQueryLogConfigs Source # 
Instance details

Defined in Amazonka.Route53Resolver.ListResolverQueryLogConfigs

Hashable ListResolverQueryLogConfigs Source # 
Instance details

Defined in Amazonka.Route53Resolver.ListResolverQueryLogConfigs

ToJSON ListResolverQueryLogConfigs Source # 
Instance details

Defined in Amazonka.Route53Resolver.ListResolverQueryLogConfigs

AWSPager ListResolverQueryLogConfigs Source # 
Instance details

Defined in Amazonka.Route53Resolver.ListResolverQueryLogConfigs

AWSRequest ListResolverQueryLogConfigs Source # 
Instance details

Defined in Amazonka.Route53Resolver.ListResolverQueryLogConfigs

ToHeaders ListResolverQueryLogConfigs Source # 
Instance details

Defined in Amazonka.Route53Resolver.ListResolverQueryLogConfigs

ToPath ListResolverQueryLogConfigs Source # 
Instance details

Defined in Amazonka.Route53Resolver.ListResolverQueryLogConfigs

ToQuery ListResolverQueryLogConfigs Source # 
Instance details

Defined in Amazonka.Route53Resolver.ListResolverQueryLogConfigs

type Rep ListResolverQueryLogConfigs Source # 
Instance details

Defined in Amazonka.Route53Resolver.ListResolverQueryLogConfigs

type Rep ListResolverQueryLogConfigs = D1 ('MetaData "ListResolverQueryLogConfigs" "Amazonka.Route53Resolver.ListResolverQueryLogConfigs" "libZSservicesZSamazonka-route53resolverZSamazonka-route53resolver" 'False) (C1 ('MetaCons "ListResolverQueryLogConfigs'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter])) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "sortOrder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SortOrder)) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "sortBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))
type AWSResponse ListResolverQueryLogConfigs Source # 
Instance details

Defined in Amazonka.Route53Resolver.ListResolverQueryLogConfigs

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 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 for CreatorRequestId 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 Amazon Web Services account number of the account that created the configuration
  • ShareStatus: 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 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 for CreatorRequestId 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 Amazon Web Services account number of the account that created the configuration
  • ShareStatus: 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 #

Constructors

ListResolverQueryLogConfigsResponse' 

Fields

  • totalFilteredCount :: Maybe Int

    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.

  • resolverQueryLogConfigs :: Maybe [ResolverQueryLogConfig]

    A list that contains one ResolverQueryLogConfig element for each query logging configuration that matches the values that you specified for Filter.

  • nextToken :: Maybe Text

    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.

  • totalCount :: Maybe Int

    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.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq ListResolverQueryLogConfigsResponse Source # 
Instance details

Defined in Amazonka.Route53Resolver.ListResolverQueryLogConfigs

Read ListResolverQueryLogConfigsResponse Source # 
Instance details

Defined in Amazonka.Route53Resolver.ListResolverQueryLogConfigs

Show ListResolverQueryLogConfigsResponse Source # 
Instance details

Defined in Amazonka.Route53Resolver.ListResolverQueryLogConfigs

Generic ListResolverQueryLogConfigsResponse Source # 
Instance details

Defined in Amazonka.Route53Resolver.ListResolverQueryLogConfigs

NFData ListResolverQueryLogConfigsResponse Source # 
Instance details

Defined in Amazonka.Route53Resolver.ListResolverQueryLogConfigs

type Rep ListResolverQueryLogConfigsResponse Source # 
Instance details

Defined in Amazonka.Route53Resolver.ListResolverQueryLogConfigs

type Rep ListResolverQueryLogConfigsResponse = D1 ('MetaData "ListResolverQueryLogConfigsResponse" "Amazonka.Route53Resolver.ListResolverQueryLogConfigs" "libZSservicesZSamazonka-route53resolverZSamazonka-route53resolver" 'False) (C1 ('MetaCons "ListResolverQueryLogConfigsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "totalFilteredCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "resolverQueryLogConfigs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ResolverQueryLogConfig]))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "totalCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

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.