ListResolverQueryLogConfigAssociations - Amazon Route 53

ListResolverQueryLogConfigAssociations

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

Request Syntax

{ "Filters": [ { "Name": "string", "Values": [ "string" ] } ], "MaxResults": number, "NextToken": "string", "SortBy": "string", "SortOrder": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Filters

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

Note

If you submit a second or subsequent ListResolverQueryLogConfigAssociations request and specify the NextToken parameter, you must use the same values for Filters, if any, as in the previous request.

Type: Array of Filter objects

Required: No

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.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

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.

Type: String

Required: No

SortBy

The element that you want Resolver to sort query logging associations by.

Note

If you submit a second or subsequent ListResolverQueryLogConfigAssociations 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:

  • 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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Required: No

SortOrder

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

Note

If you submit a second or subsequent ListResolverQueryLogConfigAssociations request and specify the NextToken parameter, you must use the same value for SortOrder, if any, as in the previous request.

Type: String

Valid Values: ASCENDING | DESCENDING

Required: No

Response Syntax

{ "NextToken": "string", "ResolverQueryLogConfigAssociations": [ { "CreationTime": "string", "Error": "string", "ErrorMessage": "string", "Id": "string", "ResolverQueryLogConfigId": "string", "ResourceId": "string", "Status": "string" } ], "TotalCount": number, "TotalFilteredCount": number }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken

If there are more than MaxResults query logging associations, 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.

Type: String

ResolverQueryLogConfigAssociations

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

Type: Array of ResolverQueryLogConfigAssociation objects

TotalCount

The total number of query logging associations that were created by the current account in the specified Region. This count can differ from the number of associations that are returned in a ListResolverQueryLogConfigAssociations response, depending on the values that you specify in the request.

Type: Integer

TotalFilteredCount

The total number of query logging associations that were created by the current account in the specified Region and that match the filters that were specified in the ListResolverQueryLogConfigAssociations request. For the total number of associations that were created by the current account in the specified Region, see TotalCount.

Type: Integer

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

The current account doesn't have the IAM permissions required to perform the specified Resolver operation.

HTTP Status Code: 400

InternalServiceErrorException

We encountered an unknown error. Try again in a few minutes.

HTTP Status Code: 400

InvalidParameterException

One or more parameters in this request are not valid.

HTTP Status Code: 400

InvalidRequestException

The request is invalid.

HTTP Status Code: 400

LimitExceededException

The request caused one or more limits to be exceeded.

HTTP Status Code: 400

ThrottlingException

The request was throttled. Try again in a few minutes.

HTTP Status Code: 400

Examples

ListResolverQueryLogConfigAssociations Example

This example illustrates one usage of ListResolverQueryLogConfigAssociations.

Sample Request

POST / HTTP/1.1 Host: route53resolver.us-east-2.amazonaws.com Accept-Encoding: identity Content-Length: 283 X-Amz-Target: Route53Resolver.ListResolverQueryLogConfigAssociations X-Amz-Date: 20200415T191344Z User-Agent: aws-cli/1.16.45 Python/2.7.10 Darwin/16.7.0 botocore/1.12.35 Content-Type: application/x-amz-json-1.1 Authorization: AWS4-HMAC-SHA256 Credential=AKIAJJ2SONIPEXAMPLE/20181101/us-east-2/route53resolver/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=[calculated-signature] { "Filters": [ { "Name": "Status", "Values": "CREATED" } ], "MaxResults": 10, "SortBy": "DestinationArn", "SortOrder": "ASCENDING" }

Sample Response

HTTP/1.1 200 OK Date: Thu, 01 Nov 2018 19:13:44 GMT Content-Type: application/x-amz-json-1.1 Content-Length: 531 x-amzn-RequestId: 08afd081-9d67-4281-a277-b3880example Connection: keep-alive { "MaxResults": 10, "ResolverQueryLogConfigAssociations": [ { "CreationTime": "2020-04-15T18:52:23.30Z", "Error": "", "ErrorMessage": "", "Id": "rqlca-ff85e1ffexample", "ResolverQueryLogConfigId": "rqlc-8ca61fe7cexample", "Resource": "vpc-03cf94c75cexample", "Status": "CREATED" } ], "TotalCount": 10, "TotalFilteredCount": 1 }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: