Route53Resolver

Client

class Route53Resolver.Client

A low-level client representing Amazon Route 53 Resolver (Route53Resolver):

client = session.create_client('route53resolver')

These are the available methods:

associate_resolver_endpoint_ip_address(**kwargs)

Adds IP addresses to an inbound or an outbound Resolver endpoint. If you want to add more than one IP address, submit one AssociateResolverEndpointIpAddress request for each IP address.

To remove an IP address from an endpoint, see DisassociateResolverEndpointIpAddress .

See also: AWS API Documentation

Request Syntax

response = client.associate_resolver_endpoint_ip_address(
    ResolverEndpointId='string',
    IpAddress={
        'IpId': 'string',
        'SubnetId': 'string',
        'Ip': 'string'
    }
)
Parameters
  • ResolverEndpointId (string) --

    [REQUIRED]

    The ID of the Resolver endpoint that you want to associate IP addresses with.

  • IpAddress (dict) --

    [REQUIRED]

    Either the IPv4 address that you want to add to a Resolver endpoint or a subnet ID. If you specify a subnet ID, Resolver chooses an IP address for you from the available IPs in the specified subnet.

    • IpId (string) --
      Only when removing an IP address from a Resolver endpoint : The ID of the IP address that you want to remove. To get this ID, use GetResolverEndpoint .
    • SubnetId (string) --

      The ID of the subnet that includes the IP address that you want to update. To get this ID, use GetResolverEndpoint .

    • Ip (string) --

      The new IP address.

Return type

dict

Returns

Response Syntax

{
    'ResolverEndpoint': {
        'Id': 'string',
        'CreatorRequestId': 'string',
        'Arn': 'string',
        'Name': 'string',
        'SecurityGroupIds': [
            'string',
        ],
        'Direction': 'INBOUND'|'OUTBOUND',
        'IpAddressCount': 123,
        'HostVPCId': 'string',
        'Status': 'CREATING'|'OPERATIONAL'|'UPDATING'|'AUTO_RECOVERING'|'ACTION_NEEDED'|'DELETING',
        'StatusMessage': 'string',
        'CreationTime': 'string',
        'ModificationTime': 'string'
    }
}

Response Structure

  • (dict) --

    • ResolverEndpoint (dict) --

      The response to an AssociateResolverEndpointIpAddress request.

      • Id (string) --

        The ID of the Resolver endpoint.

      • CreatorRequestId (string) --

        A unique string that identifies the request that created the Resolver endpoint. The CreatorRequestId allows failed requests to be retried without the risk of executing the operation twice.

      • Arn (string) --

        The ARN (Amazon Resource Name) for the Resolver endpoint.

      • Name (string) --

        The name that you assigned to the Resolver endpoint when you submitted a CreateResolverEndpoint request.

      • SecurityGroupIds (list) --

        The ID of one or more security groups that control access to this VPC. The security group must include one or more inbound rules (for inbound endpoints) or outbound rules (for outbound endpoints). Inbound and outbound rules must allow TCP and UDP access. For inbound access, open port 53. For outbound access, open the port that you're using for DNS queries on your network.

        • (string) --
      • Direction (string) --

        Indicates whether the Resolver endpoint allows inbound or outbound DNS queries:

        • INBOUND : allows DNS queries to your VPC from your network
        • OUTBOUND : allows DNS queries from your VPC to your network
      • IpAddressCount (integer) --

        The number of IP addresses that the Resolver endpoint can use for DNS queries.

      • HostVPCId (string) --

        The ID of the VPC that you want to create the Resolver endpoint in.

      • Status (string) --

        A code that specifies the current status of the Resolver endpoint. Valid values include the following:

        • CREATING : Resolver is creating and configuring one or more Amazon VPC network interfaces for this endpoint.
        • OPERATIONAL : The Amazon VPC network interfaces for this endpoint are correctly configured and able to pass inbound or outbound DNS queries between your network and Resolver.
        • UPDATING : Resolver is associating or disassociating one or more network interfaces with this endpoint.
        • AUTO_RECOVERING : Resolver is trying to recover one or more of the network interfaces that are associated with this endpoint. During the recovery process, the endpoint functions with limited capacity because of the limit on the number of DNS queries per IP address (per network interface). For the current limit, see Limits on Route 53 Resolver .
        • ACTION_NEEDED : This endpoint is unhealthy, and Resolver can't automatically recover it. To resolve the problem, we recommend that you check each IP address that you associated with the endpoint. For each IP address that isn't available, add another IP address and then delete the IP address that isn't available. (An endpoint must always include at least two IP addresses.) A status of ACTION_NEEDED can have a variety of causes. Here are two common causes:
          • One or more of the network interfaces that are associated with the endpoint were deleted using Amazon VPC.
          • The network interface couldn't be created for some reason that's outside the control of Resolver.
        • DELETING : Resolver is deleting this endpoint and the associated network interfaces.
      • StatusMessage (string) --

        A detailed description of the status of the Resolver endpoint.

      • CreationTime (string) --

        The date and time that the endpoint was created, in Unix time format and Coordinated Universal Time (UTC).

      • ModificationTime (string) --

        The date and time that the endpoint was last modified, in Unix time format and Coordinated Universal Time (UTC).

Exceptions

associate_resolver_query_log_config(**kwargs)

Associates an Amazon VPC with a specified query logging configuration. Route 53 Resolver logs DNS queries that originate in all of the Amazon VPCs that are associated with a specified query logging configuration. To associate more than one VPC with a configuration, submit one AssociateResolverQueryLogConfig request for each VPC.

Note

The VPCs that you associate with a query logging configuration must be in the same Region as the configuration.

To remove a VPC from a query logging configuration, see DisassociateResolverQueryLogConfig .

See also: AWS API Documentation

Request Syntax

response = client.associate_resolver_query_log_config(
    ResolverQueryLogConfigId='string',
    ResourceId='string'
)
Parameters
  • ResolverQueryLogConfigId (string) --

    [REQUIRED]

    The ID of the query logging configuration that you want to associate a VPC with.

  • ResourceId (string) --

    [REQUIRED]

    The ID of an Amazon VPC that you want this query logging configuration to log queries for.

    Note

    The VPCs and the query logging configuration must be in the same Region.

Return type

dict

Returns

Response Syntax

{
    'ResolverQueryLogConfigAssociation': {
        'Id': 'string',
        'ResolverQueryLogConfigId': 'string',
        'ResourceId': 'string',
        'Status': 'CREATING'|'ACTIVE'|'ACTION_NEEDED'|'DELETING'|'FAILED',
        'Error': 'NONE'|'DESTINATION_NOT_FOUND'|'ACCESS_DENIED'|'INTERNAL_SERVICE_ERROR',
        'ErrorMessage': 'string',
        'CreationTime': 'string'
    }
}

Response Structure

  • (dict) --

    • ResolverQueryLogConfigAssociation (dict) --

      A complex type that contains settings for a specified association between an Amazon VPC and a query logging configuration.

      • Id (string) --

        The ID of the query logging association.

      • ResolverQueryLogConfigId (string) --

        The ID of the query logging configuration that a VPC is associated with.

      • ResourceId (string) --

        The ID of the Amazon VPC that is associated with the query logging configuration.

      • Status (string) --

        The status of the specified query logging association. 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.
      • Error (string) --

        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 the value of Status is a value other than FAILED , Error is null.

      • ErrorMessage (string) --

        Contains additional information about the error. If the value or Error is null, the value of ErrorMessage also is null.

      • CreationTime (string) --

        The date and time that the VPC was associated with the query logging configuration, in Unix time format and Coordinated Universal Time (UTC).

Exceptions

associate_resolver_rule(**kwargs)

Associates a Resolver rule with a VPC. When you associate a rule with a VPC, Resolver forwards all DNS queries for the domain name that is specified in the rule and that originate in the VPC. The queries are forwarded to the IP addresses for the DNS resolvers that are specified in the rule. For more information about rules, see CreateResolverRule .

See also: AWS API Documentation

Request Syntax

response = client.associate_resolver_rule(
    ResolverRuleId='string',
    Name='string',
    VPCId='string'
)
Parameters
  • ResolverRuleId (string) --

    [REQUIRED]

    The ID of the Resolver rule that you want to associate with the VPC. To list the existing Resolver rules, use ListResolverRules .

  • Name (string) -- A name for the association that you're creating between a Resolver rule and a VPC.
  • VPCId (string) --

    [REQUIRED]

    The ID of the VPC that you want to associate the Resolver rule with.

Return type

dict

Returns

Response Syntax

{
    'ResolverRuleAssociation': {
        'Id': 'string',
        'ResolverRuleId': 'string',
        'Name': 'string',
        'VPCId': 'string',
        'Status': 'CREATING'|'COMPLETE'|'DELETING'|'FAILED'|'OVERRIDDEN',
        'StatusMessage': 'string'
    }
}

Response Structure

  • (dict) --

    • ResolverRuleAssociation (dict) --

      Information about the AssociateResolverRule request, including the status of the request.

      • Id (string) --

        The ID of the association between a Resolver rule and a VPC. Resolver assigns this value when you submit an AssociateResolverRule request.

      • ResolverRuleId (string) --

        The ID of the Resolver rule that you associated with the VPC that is specified by VPCId .

      • Name (string) --

        The name of an association between a Resolver rule and a VPC.

      • VPCId (string) --

        The ID of the VPC that you associated the Resolver rule with.

      • Status (string) --

        A code that specifies the current status of the association between a Resolver rule and a VPC.

      • StatusMessage (string) --

        A detailed description of the status of the association between a Resolver rule and a VPC.

Exceptions

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
create_resolver_endpoint(**kwargs)

Creates a Resolver endpoint. There are two types of Resolver endpoints, inbound and outbound:

  • An inbound Resolver endpoint forwards DNS queries to the DNS service for a VPC from your network.
  • An outbound Resolver endpoint forwards DNS queries from the DNS service for a VPC to your network.

See also: AWS API Documentation

Request Syntax

response = client.create_resolver_endpoint(
    CreatorRequestId='string',
    Name='string',
    SecurityGroupIds=[
        'string',
    ],
    Direction='INBOUND'|'OUTBOUND',
    IpAddresses=[
        {
            'SubnetId': 'string',
            'Ip': 'string'
        },
    ],
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • CreatorRequestId (string) --

    [REQUIRED]

    A unique string that identifies the request and that allows failed requests to be retried without the risk of executing the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.

  • Name (string) -- A friendly name that lets you easily find a configuration in the Resolver dashboard in the Route 53 console.
  • SecurityGroupIds (list) --

    [REQUIRED]

    The ID of one or more security groups that you want to use to control access to this VPC. The security group that you specify must include one or more inbound rules (for inbound Resolver endpoints) or outbound rules (for outbound Resolver endpoints). Inbound and outbound rules must allow TCP and UDP access. For inbound access, open port 53. For outbound access, open the port that you're using for DNS queries on your network.

    • (string) --
  • Direction (string) --

    [REQUIRED]

    Specify the applicable value:

    • INBOUND : Resolver forwards DNS queries to the DNS service for a VPC from your network
    • OUTBOUND : Resolver forwards DNS queries from the DNS service for a VPC to your network
  • IpAddresses (list) --

    [REQUIRED]

    The subnets and IP addresses in your VPC that DNS queries originate from (for outbound endpoints) or that you forward DNS queries to (for inbound endpoints). The subnet ID uniquely identifies a VPC.

    • (dict) --

      In a CreateResolverEndpoint request, the IP address that DNS queries originate from (for outbound endpoints) or that you forward DNS queries to (for inbound endpoints). IpAddressRequest also includes the ID of the subnet that contains the IP address.

      • SubnetId (string) -- [REQUIRED]

        The ID of the subnet that contains the IP address.

      • Ip (string) --

        The IP address that you want to use for DNS queries.

  • Tags (list) --

    A list of the tag keys and values that you want to associate with the endpoint.

    • (dict) --

      One tag that you want to add to the specified resource. A tag consists of a Key (a name for the tag) and a Value .

      • Key (string) -- [REQUIRED]

        The name for the tag. For example, if you want to associate Resolver resources with the account IDs of your customers for billing purposes, the value of Key might be account-id .

      • Value (string) -- [REQUIRED]

        The value for the tag. For example, if Key is account-id , then Value might be the ID of the customer account that you're creating the resource for.

Return type

dict

Returns

Response Syntax

{
    'ResolverEndpoint': {
        'Id': 'string',
        'CreatorRequestId': 'string',
        'Arn': 'string',
        'Name': 'string',
        'SecurityGroupIds': [
            'string',
        ],
        'Direction': 'INBOUND'|'OUTBOUND',
        'IpAddressCount': 123,
        'HostVPCId': 'string',
        'Status': 'CREATING'|'OPERATIONAL'|'UPDATING'|'AUTO_RECOVERING'|'ACTION_NEEDED'|'DELETING',
        'StatusMessage': 'string',
        'CreationTime': 'string',
        'ModificationTime': 'string'
    }
}

Response Structure

  • (dict) --

    • ResolverEndpoint (dict) --

      Information about the CreateResolverEndpoint request, including the status of the request.

      • Id (string) --

        The ID of the Resolver endpoint.

      • CreatorRequestId (string) --

        A unique string that identifies the request that created the Resolver endpoint. The CreatorRequestId allows failed requests to be retried without the risk of executing the operation twice.

      • Arn (string) --

        The ARN (Amazon Resource Name) for the Resolver endpoint.

      • Name (string) --

        The name that you assigned to the Resolver endpoint when you submitted a CreateResolverEndpoint request.

      • SecurityGroupIds (list) --

        The ID of one or more security groups that control access to this VPC. The security group must include one or more inbound rules (for inbound endpoints) or outbound rules (for outbound endpoints). Inbound and outbound rules must allow TCP and UDP access. For inbound access, open port 53. For outbound access, open the port that you're using for DNS queries on your network.

        • (string) --
      • Direction (string) --

        Indicates whether the Resolver endpoint allows inbound or outbound DNS queries:

        • INBOUND : allows DNS queries to your VPC from your network
        • OUTBOUND : allows DNS queries from your VPC to your network
      • IpAddressCount (integer) --

        The number of IP addresses that the Resolver endpoint can use for DNS queries.

      • HostVPCId (string) --

        The ID of the VPC that you want to create the Resolver endpoint in.

      • Status (string) --

        A code that specifies the current status of the Resolver endpoint. Valid values include the following:

        • CREATING : Resolver is creating and configuring one or more Amazon VPC network interfaces for this endpoint.
        • OPERATIONAL : The Amazon VPC network interfaces for this endpoint are correctly configured and able to pass inbound or outbound DNS queries between your network and Resolver.
        • UPDATING : Resolver is associating or disassociating one or more network interfaces with this endpoint.
        • AUTO_RECOVERING : Resolver is trying to recover one or more of the network interfaces that are associated with this endpoint. During the recovery process, the endpoint functions with limited capacity because of the limit on the number of DNS queries per IP address (per network interface). For the current limit, see Limits on Route 53 Resolver .
        • ACTION_NEEDED : This endpoint is unhealthy, and Resolver can't automatically recover it. To resolve the problem, we recommend that you check each IP address that you associated with the endpoint. For each IP address that isn't available, add another IP address and then delete the IP address that isn't available. (An endpoint must always include at least two IP addresses.) A status of ACTION_NEEDED can have a variety of causes. Here are two common causes:
          • One or more of the network interfaces that are associated with the endpoint were deleted using Amazon VPC.
          • The network interface couldn't be created for some reason that's outside the control of Resolver.
        • DELETING : Resolver is deleting this endpoint and the associated network interfaces.
      • StatusMessage (string) --

        A detailed description of the status of the Resolver endpoint.

      • CreationTime (string) --

        The date and time that the endpoint was created, in Unix time format and Coordinated Universal Time (UTC).

      • ModificationTime (string) --

        The date and time that the endpoint was last modified, in Unix time format and Coordinated Universal Time (UTC).

Exceptions

create_resolver_query_log_config(**kwargs)

Creates a Resolver query logging configuration, which defines where you want Resolver to save DNS query logs that originate in your VPCs. Resolver can log queries only for VPCs that are in the same Region as the query logging configuration.

To specify which VPCs you want to log queries for, you use AssociateResolverQueryLogConfig . For more information, see AssociateResolverQueryLogConfig .

You can optionally use AWS Resource Access Manager (AWS RAM) to share a query logging configuration with other AWS accounts. The other accounts can then associate VPCs with the configuration. The query logs that Resolver creates for a configuration include all DNS queries that originate in all VPCs that are associated with the configuration.

See also: AWS API Documentation

Request Syntax

response = client.create_resolver_query_log_config(
    Name='string',
    DestinationArn='string',
    CreatorRequestId='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • Name (string) --

    [REQUIRED]

    The name that you want to give the query logging configuration

  • DestinationArn (string) --

    [REQUIRED]

    The ARN of the resource that you want Resolver to send query logs. You can send query logs to an S3 bucket, a CloudWatch Logs log group, or a Kinesis Data Firehose delivery stream. Examples of valid values include the following:

    • S3 bucket : arn:aws:s3:::examplebucket You can optionally append a file prefix to the end of the ARN. arn:aws:s3:::examplebucket/development/
    • CloudWatch Logs log group : arn:aws:logs:us-west-1:123456789012:log-group:/mystack-testgroup-12ABC1AB12A1:*
    • Kinesis Data Firehose delivery stream : arn:aws:kinesis:us-east-2:0123456789:stream/my_stream_name
  • CreatorRequestId (string) --

    [REQUIRED]

    A unique string that identifies the request and that allows failed requests to be retried without the risk of executing the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.

    This field is autopopulated if not provided.

  • Tags (list) --

    A list of the tag keys and values that you want to associate with the query logging configuration.

    • (dict) --

      One tag that you want to add to the specified resource. A tag consists of a Key (a name for the tag) and a Value .

      • Key (string) -- [REQUIRED]

        The name for the tag. For example, if you want to associate Resolver resources with the account IDs of your customers for billing purposes, the value of Key might be account-id .

      • Value (string) -- [REQUIRED]

        The value for the tag. For example, if Key is account-id , then Value might be the ID of the customer account that you're creating the resource for.

Return type

dict

Returns

Response Syntax

{
    'ResolverQueryLogConfig': {
        '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) --

    • ResolverQueryLogConfig (dict) --

      Information about the CreateResolverQueryLogConfig request, including the status of the request.

      • Id (string) --

        The ID for the query logging configuration.

      • OwnerId (string) --

        The AWS 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 AWS accounts, or was shared with the current account by another AWS account. Sharing is configured through AWS Resource Access Manager (AWS 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 executing 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

create_resolver_rule(**kwargs)

For DNS queries that originate in your VPCs, specifies which Resolver endpoint the queries pass through, one domain name that you want to forward to your network, and the IP addresses of the DNS resolvers in your network.

See also: AWS API Documentation

Request Syntax

response = client.create_resolver_rule(
    CreatorRequestId='string',
    Name='string',
    RuleType='FORWARD'|'SYSTEM'|'RECURSIVE',
    DomainName='string',
    TargetIps=[
        {
            'Ip': 'string',
            'Port': 123
        },
    ],
    ResolverEndpointId='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • CreatorRequestId (string) --

    [REQUIRED]

    A unique string that identifies the request and that allows failed requests to be retried without the risk of executing the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.

  • Name (string) -- A friendly name that lets you easily find a rule in the Resolver dashboard in the Route 53 console.
  • RuleType (string) --

    [REQUIRED]

    When you want to forward DNS queries for specified domain name to resolvers on your network, specify FORWARD .

    When you have a forwarding rule to forward DNS queries for a domain to your network and you want Resolver to process queries for a subdomain of that domain, specify SYSTEM .

    For example, to forward DNS queries for example.com to resolvers on your network, you create a rule and specify FORWARD for RuleType . To then have Resolver process queries for apex.example.com, you create a rule and specify SYSTEM for RuleType .

    Currently, only Resolver can create rules that have a value of RECURSIVE for RuleType .

  • DomainName (string) --

    [REQUIRED]

    DNS queries for this domain name are forwarded to the IP addresses that you specify in TargetIps . If a query matches multiple Resolver rules (example.com and www.example.com), outbound DNS queries are routed using the Resolver rule that contains the most specific domain name (www.example.com).

  • TargetIps (list) --

    The IPs that you want Resolver to forward DNS queries to. You can specify only IPv4 addresses. Separate IP addresses with a comma.

    TargetIps is available only when the value of Rule type is FORWARD .
    • (dict) --

      In a CreateResolverRule request, an array of the IPs that you want to forward DNS queries to.

      • Ip (string) -- [REQUIRED]

        One IP address that you want to forward DNS queries to. You can specify only IPv4 addresses.

      • Port (integer) --

        The port at Ip that you want to forward DNS queries to.

  • ResolverEndpointId (string) -- The ID of the outbound Resolver endpoint that you want to use to route DNS queries to the IP addresses that you specify in TargetIps .
  • Tags (list) --

    A list of the tag keys and values that you want to associate with the endpoint.

    • (dict) --

      One tag that you want to add to the specified resource. A tag consists of a Key (a name for the tag) and a Value .

      • Key (string) -- [REQUIRED]

        The name for the tag. For example, if you want to associate Resolver resources with the account IDs of your customers for billing purposes, the value of Key might be account-id .

      • Value (string) -- [REQUIRED]

        The value for the tag. For example, if Key is account-id , then Value might be the ID of the customer account that you're creating the resource for.

Return type

dict

Returns

Response Syntax

{
    'ResolverRule': {
        'Id': 'string',
        'CreatorRequestId': 'string',
        'Arn': 'string',
        'DomainName': 'string',
        'Status': 'COMPLETE'|'DELETING'|'UPDATING'|'FAILED',
        'StatusMessage': 'string',
        'RuleType': 'FORWARD'|'SYSTEM'|'RECURSIVE',
        'Name': 'string',
        'TargetIps': [
            {
                'Ip': 'string',
                'Port': 123
            },
        ],
        'ResolverEndpointId': 'string',
        'OwnerId': 'string',
        'ShareStatus': 'NOT_SHARED'|'SHARED_WITH_ME'|'SHARED_BY_ME',
        'CreationTime': 'string',
        'ModificationTime': 'string'
    }
}

Response Structure

  • (dict) --

    • ResolverRule (dict) --

      Information about the CreateResolverRule request, including the status of the request.

      • Id (string) --

        The ID that Resolver assigned to the Resolver rule when you created it.

      • CreatorRequestId (string) --

        A unique string that you specified when you created the Resolver rule. CreatorRequestId identifies the request and allows failed requests to be retried without the risk of executing the operation twice.

      • Arn (string) --

        The ARN (Amazon Resource Name) for the Resolver rule specified by Id .

      • DomainName (string) --

        DNS queries for this domain name are forwarded to the IP addresses that are specified in TargetIps . If a query matches multiple Resolver rules (example.com and www.example.com), the query is routed using the Resolver rule that contains the most specific domain name (www.example.com).

      • Status (string) --

        A code that specifies the current status of the Resolver rule.

      • StatusMessage (string) --

        A detailed description of the status of a Resolver rule.

      • RuleType (string) --

        When you want to forward DNS queries for specified domain name to resolvers on your network, specify FORWARD .

        When you have a forwarding rule to forward DNS queries for a domain to your network and you want Resolver to process queries for a subdomain of that domain, specify SYSTEM .

        For example, to forward DNS queries for example.com to resolvers on your network, you create a rule and specify FORWARD for RuleType . To then have Resolver process queries for apex.example.com, you create a rule and specify SYSTEM for RuleType .

        Currently, only Resolver can create rules that have a value of RECURSIVE for RuleType .

      • Name (string) --

        The name for the Resolver rule, which you specified when you created the Resolver rule.

      • TargetIps (list) --

        An array that contains the IP addresses and ports that an outbound endpoint forwards DNS queries to. Typically, these are the IP addresses of DNS resolvers on your network. Specify IPv4 addresses. IPv6 is not supported.

        • (dict) --

          In a CreateResolverRule request, an array of the IPs that you want to forward DNS queries to.

          • Ip (string) --

            One IP address that you want to forward DNS queries to. You can specify only IPv4 addresses.

          • Port (integer) --

            The port at Ip that you want to forward DNS queries to.

      • ResolverEndpointId (string) --

        The ID of the endpoint that the rule is associated with.

      • OwnerId (string) --

        When a rule is shared with another AWS account, the account ID of the account that the rule is shared with.

      • ShareStatus (string) --

        Whether the rules is shared and, if so, whether the current account is sharing the rule with another account, or another account is sharing the rule with the current account.

      • CreationTime (string) --

        The date and time that the Resolver rule was created, in Unix time format and Coordinated Universal Time (UTC).

      • ModificationTime (string) --

        The date and time that the Resolver rule was last updated, in Unix time format and Coordinated Universal Time (UTC).

Exceptions

delete_resolver_endpoint(**kwargs)

Deletes a Resolver endpoint. The effect of deleting a Resolver endpoint depends on whether it's an inbound or an outbound Resolver endpoint:

  • Inbound : DNS queries from your network are no longer routed to the DNS service for the specified VPC.
  • Outbound : DNS queries from a VPC are no longer routed to your network.

See also: AWS API Documentation

Request Syntax

response = client.delete_resolver_endpoint(
    ResolverEndpointId='string'
)
Parameters
ResolverEndpointId (string) --

[REQUIRED]

The ID of the Resolver endpoint that you want to delete.

Return type
dict
Returns
Response Syntax
{
    'ResolverEndpoint': {
        'Id': 'string',
        'CreatorRequestId': 'string',
        'Arn': 'string',
        'Name': 'string',
        'SecurityGroupIds': [
            'string',
        ],
        'Direction': 'INBOUND'|'OUTBOUND',
        'IpAddressCount': 123,
        'HostVPCId': 'string',
        'Status': 'CREATING'|'OPERATIONAL'|'UPDATING'|'AUTO_RECOVERING'|'ACTION_NEEDED'|'DELETING',
        'StatusMessage': 'string',
        'CreationTime': 'string',
        'ModificationTime': 'string'
    }
}

Response Structure

  • (dict) --
    • ResolverEndpoint (dict) --

      Information about the DeleteResolverEndpoint request, including the status of the request.

      • Id (string) --

        The ID of the Resolver endpoint.

      • CreatorRequestId (string) --

        A unique string that identifies the request that created the Resolver endpoint. The CreatorRequestId allows failed requests to be retried without the risk of executing the operation twice.

      • Arn (string) --

        The ARN (Amazon Resource Name) for the Resolver endpoint.

      • Name (string) --

        The name that you assigned to the Resolver endpoint when you submitted a CreateResolverEndpoint request.

      • SecurityGroupIds (list) --

        The ID of one or more security groups that control access to this VPC. The security group must include one or more inbound rules (for inbound endpoints) or outbound rules (for outbound endpoints). Inbound and outbound rules must allow TCP and UDP access. For inbound access, open port 53. For outbound access, open the port that you're using for DNS queries on your network.

        • (string) --
      • Direction (string) --

        Indicates whether the Resolver endpoint allows inbound or outbound DNS queries:

        • INBOUND : allows DNS queries to your VPC from your network
        • OUTBOUND : allows DNS queries from your VPC to your network
      • IpAddressCount (integer) --

        The number of IP addresses that the Resolver endpoint can use for DNS queries.

      • HostVPCId (string) --

        The ID of the VPC that you want to create the Resolver endpoint in.

      • Status (string) --

        A code that specifies the current status of the Resolver endpoint. Valid values include the following:

        • CREATING : Resolver is creating and configuring one or more Amazon VPC network interfaces for this endpoint.
        • OPERATIONAL : The Amazon VPC network interfaces for this endpoint are correctly configured and able to pass inbound or outbound DNS queries between your network and Resolver.
        • UPDATING : Resolver is associating or disassociating one or more network interfaces with this endpoint.
        • AUTO_RECOVERING : Resolver is trying to recover one or more of the network interfaces that are associated with this endpoint. During the recovery process, the endpoint functions with limited capacity because of the limit on the number of DNS queries per IP address (per network interface). For the current limit, see Limits on Route 53 Resolver .
        • ACTION_NEEDED : This endpoint is unhealthy, and Resolver can't automatically recover it. To resolve the problem, we recommend that you check each IP address that you associated with the endpoint. For each IP address that isn't available, add another IP address and then delete the IP address that isn't available. (An endpoint must always include at least two IP addresses.) A status of ACTION_NEEDED can have a variety of causes. Here are two common causes:
          • One or more of the network interfaces that are associated with the endpoint were deleted using Amazon VPC.
          • The network interface couldn't be created for some reason that's outside the control of Resolver.
        • DELETING : Resolver is deleting this endpoint and the associated network interfaces.
      • StatusMessage (string) --

        A detailed description of the status of the Resolver endpoint.

      • CreationTime (string) --

        The date and time that the endpoint was created, in Unix time format and Coordinated Universal Time (UTC).

      • ModificationTime (string) --

        The date and time that the endpoint was last modified, in Unix time format and Coordinated Universal Time (UTC).

Exceptions

delete_resolver_query_log_config(**kwargs)

Deletes a query logging configuration. When you delete a configuration, Resolver stops logging DNS queries for all of the Amazon VPCs that are associated with the configuration. This also applies if the query logging configuration is shared with other AWS accounts, and the other accounts have associated VPCs with the shared configuration.

Before you can delete a query logging configuration, you must first disassociate all VPCs from the configuration. See DisassociateResolverQueryLogConfig .

If you used Resource Access Manager (RAM) to share a query logging configuration with other accounts, you must stop sharing the configuration before you can delete a configuration. The accounts that you shared the configuration with can first disassociate VPCs that they associated with the configuration, but that's not necessary. If you stop sharing the configuration, those VPCs are automatically disassociated from the configuration.

See also: AWS API Documentation

Request Syntax

response = client.delete_resolver_query_log_config(
    ResolverQueryLogConfigId='string'
)
Parameters
ResolverQueryLogConfigId (string) --

[REQUIRED]

The ID of the query logging configuration that you want to delete.

Return type
dict
Returns
Response Syntax
{
    'ResolverQueryLogConfig': {
        '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) --
    • ResolverQueryLogConfig (dict) --

      Information about the query logging configuration that you deleted, including the status of the request.

      • Id (string) --

        The ID for the query logging configuration.

      • OwnerId (string) --

        The AWS 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 AWS accounts, or was shared with the current account by another AWS account. Sharing is configured through AWS Resource Access Manager (AWS 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 executing 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

delete_resolver_rule(**kwargs)

Deletes a Resolver rule. Before you can delete a Resolver rule, you must disassociate it from all the VPCs that you associated the Resolver rule with. For more information, see DisassociateResolverRule .

See also: AWS API Documentation

Request Syntax

response = client.delete_resolver_rule(
    ResolverRuleId='string'
)
Parameters
ResolverRuleId (string) --

[REQUIRED]

The ID of the Resolver rule that you want to delete.

Return type
dict
Returns
Response Syntax
{
    'ResolverRule': {
        'Id': 'string',
        'CreatorRequestId': 'string',
        'Arn': 'string',
        'DomainName': 'string',
        'Status': 'COMPLETE'|'DELETING'|'UPDATING'|'FAILED',
        'StatusMessage': 'string',
        'RuleType': 'FORWARD'|'SYSTEM'|'RECURSIVE',
        'Name': 'string',
        'TargetIps': [
            {
                'Ip': 'string',
                'Port': 123
            },
        ],
        'ResolverEndpointId': 'string',
        'OwnerId': 'string',
        'ShareStatus': 'NOT_SHARED'|'SHARED_WITH_ME'|'SHARED_BY_ME',
        'CreationTime': 'string',
        'ModificationTime': 'string'
    }
}

Response Structure

  • (dict) --
    • ResolverRule (dict) --

      Information about the DeleteResolverRule request, including the status of the request.

      • Id (string) --

        The ID that Resolver assigned to the Resolver rule when you created it.

      • CreatorRequestId (string) --

        A unique string that you specified when you created the Resolver rule. CreatorRequestId identifies the request and allows failed requests to be retried without the risk of executing the operation twice.

      • Arn (string) --

        The ARN (Amazon Resource Name) for the Resolver rule specified by Id .

      • DomainName (string) --

        DNS queries for this domain name are forwarded to the IP addresses that are specified in TargetIps . If a query matches multiple Resolver rules (example.com and www.example.com), the query is routed using the Resolver rule that contains the most specific domain name (www.example.com).

      • Status (string) --

        A code that specifies the current status of the Resolver rule.

      • StatusMessage (string) --

        A detailed description of the status of a Resolver rule.

      • RuleType (string) --

        When you want to forward DNS queries for specified domain name to resolvers on your network, specify FORWARD .

        When you have a forwarding rule to forward DNS queries for a domain to your network and you want Resolver to process queries for a subdomain of that domain, specify SYSTEM .

        For example, to forward DNS queries for example.com to resolvers on your network, you create a rule and specify FORWARD for RuleType . To then have Resolver process queries for apex.example.com, you create a rule and specify SYSTEM for RuleType .

        Currently, only Resolver can create rules that have a value of RECURSIVE for RuleType .

      • Name (string) --

        The name for the Resolver rule, which you specified when you created the Resolver rule.

      • TargetIps (list) --

        An array that contains the IP addresses and ports that an outbound endpoint forwards DNS queries to. Typically, these are the IP addresses of DNS resolvers on your network. Specify IPv4 addresses. IPv6 is not supported.

        • (dict) --

          In a CreateResolverRule request, an array of the IPs that you want to forward DNS queries to.

          • Ip (string) --

            One IP address that you want to forward DNS queries to. You can specify only IPv4 addresses.

          • Port (integer) --

            The port at Ip that you want to forward DNS queries to.

      • ResolverEndpointId (string) --

        The ID of the endpoint that the rule is associated with.

      • OwnerId (string) --

        When a rule is shared with another AWS account, the account ID of the account that the rule is shared with.

      • ShareStatus (string) --

        Whether the rules is shared and, if so, whether the current account is sharing the rule with another account, or another account is sharing the rule with the current account.

      • CreationTime (string) --

        The date and time that the Resolver rule was created, in Unix time format and Coordinated Universal Time (UTC).

      • ModificationTime (string) --

        The date and time that the Resolver rule was last updated, in Unix time format and Coordinated Universal Time (UTC).

Exceptions

disassociate_resolver_endpoint_ip_address(**kwargs)

Removes IP addresses from an inbound or an outbound Resolver endpoint. If you want to remove more than one IP address, submit one DisassociateResolverEndpointIpAddress request for each IP address.

To add an IP address to an endpoint, see AssociateResolverEndpointIpAddress .

See also: AWS API Documentation

Request Syntax

response = client.disassociate_resolver_endpoint_ip_address(
    ResolverEndpointId='string',
    IpAddress={
        'IpId': 'string',
        'SubnetId': 'string',
        'Ip': 'string'
    }
)
Parameters
  • ResolverEndpointId (string) --

    [REQUIRED]

    The ID of the Resolver endpoint that you want to disassociate an IP address from.

  • IpAddress (dict) --

    [REQUIRED]

    The IPv4 address that you want to remove from a Resolver endpoint.

    • IpId (string) --
      Only when removing an IP address from a Resolver endpoint : The ID of the IP address that you want to remove. To get this ID, use GetResolverEndpoint .
    • SubnetId (string) --

      The ID of the subnet that includes the IP address that you want to update. To get this ID, use GetResolverEndpoint .

    • Ip (string) --

      The new IP address.

Return type

dict

Returns

Response Syntax

{
    'ResolverEndpoint': {
        'Id': 'string',
        'CreatorRequestId': 'string',
        'Arn': 'string',
        'Name': 'string',
        'SecurityGroupIds': [
            'string',
        ],
        'Direction': 'INBOUND'|'OUTBOUND',
        'IpAddressCount': 123,
        'HostVPCId': 'string',
        'Status': 'CREATING'|'OPERATIONAL'|'UPDATING'|'AUTO_RECOVERING'|'ACTION_NEEDED'|'DELETING',
        'StatusMessage': 'string',
        'CreationTime': 'string',
        'ModificationTime': 'string'
    }
}

Response Structure

  • (dict) --

    • ResolverEndpoint (dict) --

      The response to an DisassociateResolverEndpointIpAddress request.

      • Id (string) --

        The ID of the Resolver endpoint.

      • CreatorRequestId (string) --

        A unique string that identifies the request that created the Resolver endpoint. The CreatorRequestId allows failed requests to be retried without the risk of executing the operation twice.

      • Arn (string) --

        The ARN (Amazon Resource Name) for the Resolver endpoint.

      • Name (string) --

        The name that you assigned to the Resolver endpoint when you submitted a CreateResolverEndpoint request.

      • SecurityGroupIds (list) --

        The ID of one or more security groups that control access to this VPC. The security group must include one or more inbound rules (for inbound endpoints) or outbound rules (for outbound endpoints). Inbound and outbound rules must allow TCP and UDP access. For inbound access, open port 53. For outbound access, open the port that you're using for DNS queries on your network.

        • (string) --
      • Direction (string) --

        Indicates whether the Resolver endpoint allows inbound or outbound DNS queries:

        • INBOUND : allows DNS queries to your VPC from your network
        • OUTBOUND : allows DNS queries from your VPC to your network
      • IpAddressCount (integer) --

        The number of IP addresses that the Resolver endpoint can use for DNS queries.

      • HostVPCId (string) --

        The ID of the VPC that you want to create the Resolver endpoint in.

      • Status (string) --

        A code that specifies the current status of the Resolver endpoint. Valid values include the following:

        • CREATING : Resolver is creating and configuring one or more Amazon VPC network interfaces for this endpoint.
        • OPERATIONAL : The Amazon VPC network interfaces for this endpoint are correctly configured and able to pass inbound or outbound DNS queries between your network and Resolver.
        • UPDATING : Resolver is associating or disassociating one or more network interfaces with this endpoint.
        • AUTO_RECOVERING : Resolver is trying to recover one or more of the network interfaces that are associated with this endpoint. During the recovery process, the endpoint functions with limited capacity because of the limit on the number of DNS queries per IP address (per network interface). For the current limit, see Limits on Route 53 Resolver .
        • ACTION_NEEDED : This endpoint is unhealthy, and Resolver can't automatically recover it. To resolve the problem, we recommend that you check each IP address that you associated with the endpoint. For each IP address that isn't available, add another IP address and then delete the IP address that isn't available. (An endpoint must always include at least two IP addresses.) A status of ACTION_NEEDED can have a variety of causes. Here are two common causes:
          • One or more of the network interfaces that are associated with the endpoint were deleted using Amazon VPC.
          • The network interface couldn't be created for some reason that's outside the control of Resolver.
        • DELETING : Resolver is deleting this endpoint and the associated network interfaces.
      • StatusMessage (string) --

        A detailed description of the status of the Resolver endpoint.

      • CreationTime (string) --

        The date and time that the endpoint was created, in Unix time format and Coordinated Universal Time (UTC).

      • ModificationTime (string) --

        The date and time that the endpoint was last modified, in Unix time format and Coordinated Universal Time (UTC).

Exceptions

disassociate_resolver_query_log_config(**kwargs)

Disassociates a VPC from a query logging configuration.

Note

Before you can delete a query logging configuration, you must first disassociate all VPCs from the configuration. If you used Resource Access Manager (RAM) to share a query logging configuration with other accounts, VPCs can be disassociated from the configuration in the following ways:

  • The accounts that you shared the configuration with can disassociate VPCs from the configuration.
  • You can stop sharing the configuration.

See also: AWS API Documentation

Request Syntax

response = client.disassociate_resolver_query_log_config(
    ResolverQueryLogConfigId='string',
    ResourceId='string'
)
Parameters
  • ResolverQueryLogConfigId (string) --

    [REQUIRED]

    The ID of the query logging configuration that you want to disassociate a specified VPC from.

  • ResourceId (string) --

    [REQUIRED]

    The ID of the Amazon VPC that you want to disassociate from a specified query logging configuration.

Return type

dict

Returns

Response Syntax

{
    'ResolverQueryLogConfigAssociation': {
        'Id': 'string',
        'ResolverQueryLogConfigId': 'string',
        'ResourceId': 'string',
        'Status': 'CREATING'|'ACTIVE'|'ACTION_NEEDED'|'DELETING'|'FAILED',
        'Error': 'NONE'|'DESTINATION_NOT_FOUND'|'ACCESS_DENIED'|'INTERNAL_SERVICE_ERROR',
        'ErrorMessage': 'string',
        'CreationTime': 'string'
    }
}

Response Structure

  • (dict) --

    • ResolverQueryLogConfigAssociation (dict) --

      A complex type that contains settings for the association that you deleted between an Amazon VPC and a query logging configuration.

      • Id (string) --

        The ID of the query logging association.

      • ResolverQueryLogConfigId (string) --

        The ID of the query logging configuration that a VPC is associated with.

      • ResourceId (string) --

        The ID of the Amazon VPC that is associated with the query logging configuration.

      • Status (string) --

        The status of the specified query logging association. 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.
      • Error (string) --

        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 the value of Status is a value other than FAILED , Error is null.

      • ErrorMessage (string) --

        Contains additional information about the error. If the value or Error is null, the value of ErrorMessage also is null.

      • CreationTime (string) --

        The date and time that the VPC was associated with the query logging configuration, in Unix time format and Coordinated Universal Time (UTC).

Exceptions

disassociate_resolver_rule(**kwargs)

Removes the association between a specified Resolver rule and a specified VPC.

Warning

If you disassociate a Resolver rule from a VPC, Resolver stops forwarding DNS queries for the domain name that you specified in the Resolver rule.

See also: AWS API Documentation

Request Syntax

response = client.disassociate_resolver_rule(
    VPCId='string',
    ResolverRuleId='string'
)
Parameters
  • VPCId (string) --

    [REQUIRED]

    The ID of the VPC that you want to disassociate the Resolver rule from.

  • ResolverRuleId (string) --

    [REQUIRED]

    The ID of the Resolver rule that you want to disassociate from the specified VPC.

Return type

dict

Returns

Response Syntax

{
    'ResolverRuleAssociation': {
        'Id': 'string',
        'ResolverRuleId': 'string',
        'Name': 'string',
        'VPCId': 'string',
        'Status': 'CREATING'|'COMPLETE'|'DELETING'|'FAILED'|'OVERRIDDEN',
        'StatusMessage': 'string'
    }
}

Response Structure

  • (dict) --

    • ResolverRuleAssociation (dict) --

      Information about the DisassociateResolverRule request, including the status of the request.

      • Id (string) --

        The ID of the association between a Resolver rule and a VPC. Resolver assigns this value when you submit an AssociateResolverRule request.

      • ResolverRuleId (string) --

        The ID of the Resolver rule that you associated with the VPC that is specified by VPCId .

      • Name (string) --

        The name of an association between a Resolver rule and a VPC.

      • VPCId (string) --

        The ID of the VPC that you associated the Resolver rule with.

      • Status (string) --

        A code that specifies the current status of the association between a Resolver rule and a VPC.

      • StatusMessage (string) --

        A detailed description of the status of the association between a Resolver rule and a VPC.

Exceptions

generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

Generate a presigned url given a client, its method, and arguments

Parameters
  • ClientMethod (string) -- The client method to presign for
  • Params (dict) -- The parameters normally passed to ClientMethod.
  • ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
  • HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.
Returns

The presigned url

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_resolver_endpoint(**kwargs)

Gets information about a specified Resolver endpoint, such as whether it's an inbound or an outbound Resolver endpoint, and the current status of the endpoint.

See also: AWS API Documentation

Request Syntax

response = client.get_resolver_endpoint(
    ResolverEndpointId='string'
)
Parameters
ResolverEndpointId (string) --

[REQUIRED]

The ID of the Resolver endpoint that you want to get information about.

Return type
dict
Returns
Response Syntax
{
    'ResolverEndpoint': {
        'Id': 'string',
        'CreatorRequestId': 'string',
        'Arn': 'string',
        'Name': 'string',
        'SecurityGroupIds': [
            'string',
        ],
        'Direction': 'INBOUND'|'OUTBOUND',
        'IpAddressCount': 123,
        'HostVPCId': 'string',
        'Status': 'CREATING'|'OPERATIONAL'|'UPDATING'|'AUTO_RECOVERING'|'ACTION_NEEDED'|'DELETING',
        'StatusMessage': 'string',
        'CreationTime': 'string',
        'ModificationTime': 'string'
    }
}

Response Structure

  • (dict) --
    • ResolverEndpoint (dict) --

      Information about the Resolver endpoint that you specified in a GetResolverEndpoint request.

      • Id (string) --

        The ID of the Resolver endpoint.

      • CreatorRequestId (string) --

        A unique string that identifies the request that created the Resolver endpoint. The CreatorRequestId allows failed requests to be retried without the risk of executing the operation twice.

      • Arn (string) --

        The ARN (Amazon Resource Name) for the Resolver endpoint.

      • Name (string) --

        The name that you assigned to the Resolver endpoint when you submitted a CreateResolverEndpoint request.

      • SecurityGroupIds (list) --

        The ID of one or more security groups that control access to this VPC. The security group must include one or more inbound rules (for inbound endpoints) or outbound rules (for outbound endpoints). Inbound and outbound rules must allow TCP and UDP access. For inbound access, open port 53. For outbound access, open the port that you're using for DNS queries on your network.

        • (string) --
      • Direction (string) --

        Indicates whether the Resolver endpoint allows inbound or outbound DNS queries:

        • INBOUND : allows DNS queries to your VPC from your network
        • OUTBOUND : allows DNS queries from your VPC to your network
      • IpAddressCount (integer) --

        The number of IP addresses that the Resolver endpoint can use for DNS queries.

      • HostVPCId (string) --

        The ID of the VPC that you want to create the Resolver endpoint in.

      • Status (string) --

        A code that specifies the current status of the Resolver endpoint. Valid values include the following:

        • CREATING : Resolver is creating and configuring one or more Amazon VPC network interfaces for this endpoint.
        • OPERATIONAL : The Amazon VPC network interfaces for this endpoint are correctly configured and able to pass inbound or outbound DNS queries between your network and Resolver.
        • UPDATING : Resolver is associating or disassociating one or more network interfaces with this endpoint.
        • AUTO_RECOVERING : Resolver is trying to recover one or more of the network interfaces that are associated with this endpoint. During the recovery process, the endpoint functions with limited capacity because of the limit on the number of DNS queries per IP address (per network interface). For the current limit, see Limits on Route 53 Resolver .
        • ACTION_NEEDED : This endpoint is unhealthy, and Resolver can't automatically recover it. To resolve the problem, we recommend that you check each IP address that you associated with the endpoint. For each IP address that isn't available, add another IP address and then delete the IP address that isn't available. (An endpoint must always include at least two IP addresses.) A status of ACTION_NEEDED can have a variety of causes. Here are two common causes:
          • One or more of the network interfaces that are associated with the endpoint were deleted using Amazon VPC.
          • The network interface couldn't be created for some reason that's outside the control of Resolver.
        • DELETING : Resolver is deleting this endpoint and the associated network interfaces.
      • StatusMessage (string) --

        A detailed description of the status of the Resolver endpoint.

      • CreationTime (string) --

        The date and time that the endpoint was created, in Unix time format and Coordinated Universal Time (UTC).

      • ModificationTime (string) --

        The date and time that the endpoint was last modified, in Unix time format and Coordinated Universal Time (UTC).

Exceptions

get_resolver_query_log_config(**kwargs)

Gets information about a specified Resolver query logging configuration, such as the number of VPCs that the configuration is logging queries for and the location that logs are sent to.

See also: AWS API Documentation

Request Syntax

response = client.get_resolver_query_log_config(
    ResolverQueryLogConfigId='string'
)
Parameters
ResolverQueryLogConfigId (string) --

[REQUIRED]

The ID of the Resolver query logging configuration that you want to get information about.

Return type
dict
Returns
Response Syntax
{
    'ResolverQueryLogConfig': {
        '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) --
    • ResolverQueryLogConfig (dict) --

      Information about the Resolver query logging configuration that you specified in a GetQueryLogConfig request.

      • Id (string) --

        The ID for the query logging configuration.

      • OwnerId (string) --

        The AWS 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 AWS accounts, or was shared with the current account by another AWS account. Sharing is configured through AWS Resource Access Manager (AWS 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 executing 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

get_resolver_query_log_config_association(**kwargs)

Gets information about a specified association between a Resolver query logging configuration and an Amazon VPC. When you associate a VPC with a query logging configuration, Resolver logs DNS queries that originate in that VPC.

See also: AWS API Documentation

Request Syntax

response = client.get_resolver_query_log_config_association(
    ResolverQueryLogConfigAssociationId='string'
)
Parameters
ResolverQueryLogConfigAssociationId (string) --

[REQUIRED]

The ID of the Resolver query logging configuration association that you want to get information about.

Return type
dict
Returns
Response Syntax
{
    'ResolverQueryLogConfigAssociation': {
        'Id': 'string',
        'ResolverQueryLogConfigId': 'string',
        'ResourceId': 'string',
        'Status': 'CREATING'|'ACTIVE'|'ACTION_NEEDED'|'DELETING'|'FAILED',
        'Error': 'NONE'|'DESTINATION_NOT_FOUND'|'ACCESS_DENIED'|'INTERNAL_SERVICE_ERROR',
        'ErrorMessage': 'string',
        'CreationTime': 'string'
    }
}

Response Structure

  • (dict) --
    • ResolverQueryLogConfigAssociation (dict) --

      Information about the Resolver query logging configuration association that you specified in a GetQueryLogConfigAssociation request.

      • Id (string) --

        The ID of the query logging association.

      • ResolverQueryLogConfigId (string) --

        The ID of the query logging configuration that a VPC is associated with.

      • ResourceId (string) --

        The ID of the Amazon VPC that is associated with the query logging configuration.

      • Status (string) --

        The status of the specified query logging association. 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.
      • Error (string) --

        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 the value of Status is a value other than FAILED , Error is null.

      • ErrorMessage (string) --

        Contains additional information about the error. If the value or Error is null, the value of ErrorMessage also is null.

      • CreationTime (string) --

        The date and time that the VPC was associated with the query logging configuration, in Unix time format and Coordinated Universal Time (UTC).

Exceptions

get_resolver_query_log_config_policy(**kwargs)

Gets information about a query logging policy. A query logging policy specifies the Resolver query logging operations and resources that you want to allow another AWS account to be able to use.

See also: AWS API Documentation

Request Syntax

response = client.get_resolver_query_log_config_policy(
    Arn='string'
)
Parameters
Arn (string) --

[REQUIRED]

The ARN of the query logging configuration that you want to get the query logging policy for.

Return type
dict
Returns
Response Syntax
{
    'ResolverQueryLogConfigPolicy': 'string'
}

Response Structure

  • (dict) --
    • ResolverQueryLogConfigPolicy (string) --

      Information about the query logging policy for the query logging configuration that you specified in a GetResolverQueryLogConfigPolicy request.

Exceptions

get_resolver_rule(**kwargs)

Gets information about a specified Resolver rule, such as the domain name that the rule forwards DNS queries for and the ID of the outbound Resolver endpoint that the rule is associated with.

See also: AWS API Documentation

Request Syntax

response = client.get_resolver_rule(
    ResolverRuleId='string'
)
Parameters
ResolverRuleId (string) --

[REQUIRED]

The ID of the Resolver rule that you want to get information about.

Return type
dict
Returns
Response Syntax
{
    'ResolverRule': {
        'Id': 'string',
        'CreatorRequestId': 'string',
        'Arn': 'string',
        'DomainName': 'string',
        'Status': 'COMPLETE'|'DELETING'|'UPDATING'|'FAILED',
        'StatusMessage': 'string',
        'RuleType': 'FORWARD'|'SYSTEM'|'RECURSIVE',
        'Name': 'string',
        'TargetIps': [
            {
                'Ip': 'string',
                'Port': 123
            },
        ],
        'ResolverEndpointId': 'string',
        'OwnerId': 'string',
        'ShareStatus': 'NOT_SHARED'|'SHARED_WITH_ME'|'SHARED_BY_ME',
        'CreationTime': 'string',
        'ModificationTime': 'string'
    }
}

Response Structure

  • (dict) --
    • ResolverRule (dict) --

      Information about the Resolver rule that you specified in a GetResolverRule request.

      • Id (string) --

        The ID that Resolver assigned to the Resolver rule when you created it.

      • CreatorRequestId (string) --

        A unique string that you specified when you created the Resolver rule. CreatorRequestId identifies the request and allows failed requests to be retried without the risk of executing the operation twice.

      • Arn (string) --

        The ARN (Amazon Resource Name) for the Resolver rule specified by Id .

      • DomainName (string) --

        DNS queries for this domain name are forwarded to the IP addresses that are specified in TargetIps . If a query matches multiple Resolver rules (example.com and www.example.com), the query is routed using the Resolver rule that contains the most specific domain name (www.example.com).

      • Status (string) --

        A code that specifies the current status of the Resolver rule.

      • StatusMessage (string) --

        A detailed description of the status of a Resolver rule.

      • RuleType (string) --

        When you want to forward DNS queries for specified domain name to resolvers on your network, specify FORWARD .

        When you have a forwarding rule to forward DNS queries for a domain to your network and you want Resolver to process queries for a subdomain of that domain, specify SYSTEM .

        For example, to forward DNS queries for example.com to resolvers on your network, you create a rule and specify FORWARD for RuleType . To then have Resolver process queries for apex.example.com, you create a rule and specify SYSTEM for RuleType .

        Currently, only Resolver can create rules that have a value of RECURSIVE for RuleType .

      • Name (string) --

        The name for the Resolver rule, which you specified when you created the Resolver rule.

      • TargetIps (list) --

        An array that contains the IP addresses and ports that an outbound endpoint forwards DNS queries to. Typically, these are the IP addresses of DNS resolvers on your network. Specify IPv4 addresses. IPv6 is not supported.

        • (dict) --

          In a CreateResolverRule request, an array of the IPs that you want to forward DNS queries to.

          • Ip (string) --

            One IP address that you want to forward DNS queries to. You can specify only IPv4 addresses.

          • Port (integer) --

            The port at Ip that you want to forward DNS queries to.

      • ResolverEndpointId (string) --

        The ID of the endpoint that the rule is associated with.

      • OwnerId (string) --

        When a rule is shared with another AWS account, the account ID of the account that the rule is shared with.

      • ShareStatus (string) --

        Whether the rules is shared and, if so, whether the current account is sharing the rule with another account, or another account is sharing the rule with the current account.

      • CreationTime (string) --

        The date and time that the Resolver rule was created, in Unix time format and Coordinated Universal Time (UTC).

      • ModificationTime (string) --

        The date and time that the Resolver rule was last updated, in Unix time format and Coordinated Universal Time (UTC).

Exceptions

get_resolver_rule_association(**kwargs)

Gets information about an association between a specified Resolver rule and a VPC. You associate a Resolver rule and a VPC using AssociateResolverRule .

See also: AWS API Documentation

Request Syntax

response = client.get_resolver_rule_association(
    ResolverRuleAssociationId='string'
)
Parameters
ResolverRuleAssociationId (string) --

[REQUIRED]

The ID of the Resolver rule association that you want to get information about.

Return type
dict
Returns
Response Syntax
{
    'ResolverRuleAssociation': {
        'Id': 'string',
        'ResolverRuleId': 'string',
        'Name': 'string',
        'VPCId': 'string',
        'Status': 'CREATING'|'COMPLETE'|'DELETING'|'FAILED'|'OVERRIDDEN',
        'StatusMessage': 'string'
    }
}

Response Structure

  • (dict) --
    • ResolverRuleAssociation (dict) --

      Information about the Resolver rule association that you specified in a GetResolverRuleAssociation request.

      • Id (string) --

        The ID of the association between a Resolver rule and a VPC. Resolver assigns this value when you submit an AssociateResolverRule request.

      • ResolverRuleId (string) --

        The ID of the Resolver rule that you associated with the VPC that is specified by VPCId .

      • Name (string) --

        The name of an association between a Resolver rule and a VPC.

      • VPCId (string) --

        The ID of the VPC that you associated the Resolver rule with.

      • Status (string) --

        A code that specifies the current status of the association between a Resolver rule and a VPC.

      • StatusMessage (string) --

        A detailed description of the status of the association between a Resolver rule and a VPC.

Exceptions

get_resolver_rule_policy(**kwargs)

Gets information about a Resolver rule policy. A Resolver rule policy specifies the Resolver operations and resources that you want to allow another AWS account to be able to use.

See also: AWS API Documentation

Request Syntax

response = client.get_resolver_rule_policy(
    Arn='string'
)
Parameters
Arn (string) --

[REQUIRED]

The ID of the Resolver rule policy that you want to get information about.

Return type
dict
Returns
Response Syntax
{
    'ResolverRulePolicy': 'string'
}

Response Structure

  • (dict) --
    • ResolverRulePolicy (string) --

      Information about the Resolver rule policy that you specified in a GetResolverRulePolicy request.

Exceptions

get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
list_resolver_endpoint_ip_addresses(**kwargs)

Gets the IP addresses for a specified Resolver endpoint.

See also: AWS API Documentation

Request Syntax

response = client.list_resolver_endpoint_ip_addresses(
    ResolverEndpointId='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • ResolverEndpointId (string) --

    [REQUIRED]

    The ID of the Resolver endpoint that you want to get IP addresses for.

  • MaxResults (integer) -- The maximum number of IP addresses that you want to return in the response to a ListResolverEndpointIpAddresses request. If you don't specify a value for MaxResults , Resolver returns up to 100 IP addresses.
  • NextToken (string) --

    For the first ListResolverEndpointIpAddresses request, omit this value.

    If the specified Resolver endpoint has more than MaxResults IP addresses, you can submit another ListResolverEndpointIpAddresses request to get the next group of IP addresses. In the next request, specify the value of NextToken from the previous response.

Return type

dict

Returns

Response Syntax

{
    'NextToken': 'string',
    'MaxResults': 123,
    'IpAddresses': [
        {
            'IpId': 'string',
            'SubnetId': 'string',
            'Ip': 'string',
            'Status': 'CREATING'|'FAILED_CREATION'|'ATTACHING'|'ATTACHED'|'REMAP_DETACHING'|'REMAP_ATTACHING'|'DETACHING'|'FAILED_RESOURCE_GONE'|'DELETING'|'DELETE_FAILED_FAS_EXPIRED',
            'StatusMessage': 'string',
            'CreationTime': 'string',
            'ModificationTime': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • NextToken (string) --

      If the specified endpoint has more than MaxResults IP addresses, you can submit another ListResolverEndpointIpAddresses request to get the next group of IP addresses. In the next request, specify the value of NextToken from the previous response.

    • MaxResults (integer) --

      The value that you specified for MaxResults in the request.

    • IpAddresses (list) --

      Information about the IP addresses in your VPC that DNS queries originate from (for outbound endpoints) or that you forward DNS queries to (for inbound endpoints).

      • (dict) --

        In the response to a GetResolverEndpoint request, information about the IP addresses that the Resolver endpoint uses for DNS queries.

        • IpId (string) --

          The ID of one IP address.

        • SubnetId (string) --

          The ID of one subnet.

        • Ip (string) --

          One IP address that the Resolver endpoint uses for DNS queries.

        • Status (string) --

          A status code that gives the current status of the request.

        • StatusMessage (string) --

          A message that provides additional information about the status of the request.

        • CreationTime (string) --

          The date and time that the IP address was created, in Unix time format and Coordinated Universal Time (UTC).

        • ModificationTime (string) --

          The date and time that the IP address was last modified, in Unix time format and Coordinated Universal Time (UTC).

Exceptions

list_resolver_endpoints(**kwargs)

Lists all the Resolver endpoints that were created using the current AWS account.

See also: AWS API Documentation

Request Syntax

response = client.list_resolver_endpoints(
    MaxResults=123,
    NextToken='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ]
)
Parameters
  • MaxResults (integer) -- The maximum number of Resolver endpoints that you want to return in the response to a ListResolverEndpoints request. If you don't specify a value for MaxResults , Resolver returns up to 100 Resolver endpoints.
  • NextToken (string) --

    For the first ListResolverEndpoints request, omit this value.

    If you have more than MaxResults Resolver endpoints, you can submit another ListResolverEndpoints request to get the next group of Resolver endpoints. In the next request, specify the value of NextToken from the previous response.

  • Filters (list) --

    An optional specification to return a subset of Resolver endpoints, such as all inbound Resolver endpoints.

    Note

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

    • (dict) --

      For Resolver list operations (ListResolverEndpoints , ListResolverRules , ListResolverRuleAssociations , ListResolverQueryLogConfigs , and ListResolverQueryLogConfigAssociations ), an optional specification to return a subset of objects.

      To filter objects, such as Resolver endpoints or Resolver rules, you specify Name and Values . For example, to list only inbound Resolver endpoints, specify Direction for Name and specify INBOUND for Values .

      • 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 as CREATOR_REQUEST_ID . Uppercase values for Name 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 specify DIRECTION for Name , specify INBOUND or OUTBOUND for Values .
        • 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 the HostVPCId 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 specify Status for Name , specify one of the following status codes for Values : CREATING , OPERATIONAL , UPDATING , AUTO_RECOVERING , ACTION_NEEDED , or DELETING . For more information, see Status 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 for Values , include a trailing dot (.) after the domain name. For example, if the domain name is example.com, specify the following value. Note the "." after com : 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 for RuleType .

        • Status : The status of the Resolver rule. If you specify Status for Name , specify one of the following status codes for Values : COMPLETE , DELETING , UPDATING , or FAILED .
        • Type : The type of the Resolver rule. If you specify TYPE for Name , specify FORWARD or SYSTEM for Values .
        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 specify Status for Name , specify one of the following status codes for Values : CREATING , COMPLETE , DELETING , or FAILED .
        • 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 AWS 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 configuration
        • Name : The name of the query logging configuration
        • OwnerId : The AWS account ID for the account that created the query logging configuration.
        • ShareStatus : An indication of whether the query logging configuration is shared with other AWS accounts, or was shared with the current account by another AWS account. Valid values include: NOT_SHARED , SHARED_WITH_ME , or SHARED_BY_ME .
        • Status : The status of the query logging configuration. If you specify Status for Name , specify the applicable status code for Values : CREATING , CREATED , DELETING , or FAILED . 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 of Status is FAILED , specify the cause: DESTINATION_NOT_FOUND or ACCESS_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 specify Status for Name , specify the applicable status code for Values : CREATING , CREATED , DELETING , or FAILED . 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, specify Direction for Name and specify INBOUND for Values .

        • (string) --
Return type

dict

Returns

Response Syntax

{
    'NextToken': 'string',
    'MaxResults': 123,
    'ResolverEndpoints': [
        {
            'Id': 'string',
            'CreatorRequestId': 'string',
            'Arn': 'string',
            'Name': 'string',
            'SecurityGroupIds': [
                'string',
            ],
            'Direction': 'INBOUND'|'OUTBOUND',
            'IpAddressCount': 123,
            'HostVPCId': 'string',
            'Status': 'CREATING'|'OPERATIONAL'|'UPDATING'|'AUTO_RECOVERING'|'ACTION_NEEDED'|'DELETING',
            'StatusMessage': 'string',
            'CreationTime': 'string',
            'ModificationTime': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • NextToken (string) --

      If more than MaxResults IP addresses match the specified criteria, you can submit another ListResolverEndpoint request to get the next group of results. In the next request, specify the value of NextToken from the previous response.

    • MaxResults (integer) --

      The value that you specified for MaxResults in the request.

    • ResolverEndpoints (list) --

      The Resolver endpoints that were created by using the current AWS account, and that match the specified filters, if any.

      • (dict) --

        In the response to a CreateResolverEndpoint , DeleteResolverEndpoint , GetResolverEndpoint , ListResolverEndpoints , or UpdateResolverEndpoint request, a complex type that contains settings for an existing inbound or outbound Resolver endpoint.

        • Id (string) --

          The ID of the Resolver endpoint.

        • CreatorRequestId (string) --

          A unique string that identifies the request that created the Resolver endpoint. The CreatorRequestId allows failed requests to be retried without the risk of executing the operation twice.

        • Arn (string) --

          The ARN (Amazon Resource Name) for the Resolver endpoint.

        • Name (string) --

          The name that you assigned to the Resolver endpoint when you submitted a CreateResolverEndpoint request.

        • SecurityGroupIds (list) --

          The ID of one or more security groups that control access to this VPC. The security group must include one or more inbound rules (for inbound endpoints) or outbound rules (for outbound endpoints). Inbound and outbound rules must allow TCP and UDP access. For inbound access, open port 53. For outbound access, open the port that you're using for DNS queries on your network.

          • (string) --
        • Direction (string) --

          Indicates whether the Resolver endpoint allows inbound or outbound DNS queries:

          • INBOUND : allows DNS queries to your VPC from your network
          • OUTBOUND : allows DNS queries from your VPC to your network
        • IpAddressCount (integer) --

          The number of IP addresses that the Resolver endpoint can use for DNS queries.

        • HostVPCId (string) --

          The ID of the VPC that you want to create the Resolver endpoint in.

        • Status (string) --

          A code that specifies the current status of the Resolver endpoint. Valid values include the following:

          • CREATING : Resolver is creating and configuring one or more Amazon VPC network interfaces for this endpoint.
          • OPERATIONAL : The Amazon VPC network interfaces for this endpoint are correctly configured and able to pass inbound or outbound DNS queries between your network and Resolver.
          • UPDATING : Resolver is associating or disassociating one or more network interfaces with this endpoint.
          • AUTO_RECOVERING : Resolver is trying to recover one or more of the network interfaces that are associated with this endpoint. During the recovery process, the endpoint functions with limited capacity because of the limit on the number of DNS queries per IP address (per network interface). For the current limit, see Limits on Route 53 Resolver .
          • ACTION_NEEDED : This endpoint is unhealthy, and Resolver can't automatically recover it. To resolve the problem, we recommend that you check each IP address that you associated with the endpoint. For each IP address that isn't available, add another IP address and then delete the IP address that isn't available. (An endpoint must always include at least two IP addresses.) A status of ACTION_NEEDED can have a variety of causes. Here are two common causes:
            • One or more of the network interfaces that are associated with the endpoint were deleted using Amazon VPC.
            • The network interface couldn't be created for some reason that's outside the control of Resolver.
          • DELETING : Resolver is deleting this endpoint and the associated network interfaces.
        • StatusMessage (string) --

          A detailed description of the status of the Resolver endpoint.

        • CreationTime (string) --

          The date and time that the endpoint was created, in Unix time format and Coordinated Universal Time (UTC).

        • ModificationTime (string) --

          The date and time that the endpoint was last modified, in Unix time format and Coordinated Universal Time (UTC).

Exceptions

list_resolver_query_log_config_associations(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.list_resolver_query_log_config_associations(
    MaxResults=123,
    NextToken='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    SortBy='string',
    SortOrder='ASCENDING'|'DESCENDING'
)
Parameters
  • MaxResults (integer) -- 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.
  • NextToken (string) --

    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.

  • Filters (list) --

    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.

    • (dict) --

      For Resolver list operations (ListResolverEndpoints , ListResolverRules , ListResolverRuleAssociations , ListResolverQueryLogConfigs , and ListResolverQueryLogConfigAssociations ), an optional specification to return a subset of objects.

      To filter objects, such as Resolver endpoints or Resolver rules, you specify Name and Values . For example, to list only inbound Resolver endpoints, specify Direction for Name and specify INBOUND for Values .

      • 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 as CREATOR_REQUEST_ID . Uppercase values for Name 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 specify DIRECTION for Name , specify INBOUND or OUTBOUND for Values .
        • 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 the HostVPCId 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 specify Status for Name , specify one of the following status codes for Values : CREATING , OPERATIONAL , UPDATING , AUTO_RECOVERING , ACTION_NEEDED , or DELETING . For more information, see Status 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 for Values , include a trailing dot (.) after the domain name. For example, if the domain name is example.com, specify the following value. Note the "." after com : 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 for RuleType .

        • Status : The status of the Resolver rule. If you specify Status for Name , specify one of the following status codes for Values : COMPLETE , DELETING , UPDATING , or FAILED .
        • Type : The type of the Resolver rule. If you specify TYPE for Name , specify FORWARD or SYSTEM for Values .
        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 specify Status for Name , specify one of the following status codes for Values : CREATING , COMPLETE , DELETING , or FAILED .
        • 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 AWS 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 configuration
        • Name : The name of the query logging configuration
        • OwnerId : The AWS account ID for the account that created the query logging configuration.
        • ShareStatus : An indication of whether the query logging configuration is shared with other AWS accounts, or was shared with the current account by another AWS account. Valid values include: NOT_SHARED , SHARED_WITH_ME , or SHARED_BY_ME .
        • Status : The status of the query logging configuration. If you specify Status for Name , specify the applicable status code for Values : CREATING , CREATED , DELETING , or FAILED . 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 of Status is FAILED , specify the cause: DESTINATION_NOT_FOUND or ACCESS_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 specify Status for Name , specify the applicable status code for Values : CREATING , CREATED , DELETING , or FAILED . 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, specify Direction for Name and specify INBOUND for Values .

        • (string) --
  • SortBy (string) --

    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.
  • SortOrder (string) --

    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.

Return type

dict

Returns

Response Syntax

{
    'NextToken': 'string',
    'TotalCount': 123,
    'TotalFilteredCount': 123,
    'ResolverQueryLogConfigAssociations': [
        {
            'Id': 'string',
            'ResolverQueryLogConfigId': 'string',
            'ResourceId': 'string',
            'Status': 'CREATING'|'ACTIVE'|'ACTION_NEEDED'|'DELETING'|'FAILED',
            'Error': 'NONE'|'DESTINATION_NOT_FOUND'|'ACCESS_DENIED'|'INTERNAL_SERVICE_ERROR',
            'ErrorMessage': 'string',
            'CreationTime': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • NextToken (string) --

      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.

    • TotalCount (integer) --

      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.

    • TotalFilteredCount (integer) --

      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 .

    • ResolverQueryLogConfigAssociations (list) --

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

      • (dict) --

        In the response to an AssociateResolverQueryLogConfig , DisassociateResolverQueryLogConfig , GetResolverQueryLogConfigAssociation , or ListResolverQueryLogConfigAssociations , request, a complex type that contains settings for a specified association between an Amazon VPC and a query logging configuration.

        • Id (string) --

          The ID of the query logging association.

        • ResolverQueryLogConfigId (string) --

          The ID of the query logging configuration that a VPC is associated with.

        • ResourceId (string) --

          The ID of the Amazon VPC that is associated with the query logging configuration.

        • Status (string) --

          The status of the specified query logging association. 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.
        • Error (string) --

          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 the value of Status is a value other than FAILED , Error is null.

        • ErrorMessage (string) --

          Contains additional information about the error. If the value or Error is null, the value of ErrorMessage also is null.

        • CreationTime (string) --

          The date and time that the VPC was associated with the query logging configuration, in Unix time format and Coordinated Universal Time (UTC).

Exceptions

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 for MaxResults , 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 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.

  • 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 the NextToken parameter, you must use the same values for Filters , if any, as in the previous request.

    • (dict) --

      For Resolver list operations (ListResolverEndpoints , ListResolverRules , ListResolverRuleAssociations , ListResolverQueryLogConfigs , and ListResolverQueryLogConfigAssociations ), an optional specification to return a subset of objects.

      To filter objects, such as Resolver endpoints or Resolver rules, you specify Name and Values . For example, to list only inbound Resolver endpoints, specify Direction for Name and specify INBOUND for Values .

      • 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 as CREATOR_REQUEST_ID . Uppercase values for Name 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 specify DIRECTION for Name , specify INBOUND or OUTBOUND for Values .
        • 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 the HostVPCId 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 specify Status for Name , specify one of the following status codes for Values : CREATING , OPERATIONAL , UPDATING , AUTO_RECOVERING , ACTION_NEEDED , or DELETING . For more information, see Status 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 for Values , include a trailing dot (.) after the domain name. For example, if the domain name is example.com, specify the following value. Note the "." after com : 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 for RuleType .

        • Status : The status of the Resolver rule. If you specify Status for Name , specify one of the following status codes for Values : COMPLETE , DELETING , UPDATING , or FAILED .
        • Type : The type of the Resolver rule. If you specify TYPE for Name , specify FORWARD or SYSTEM for Values .
        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 specify Status for Name , specify one of the following status codes for Values : CREATING , COMPLETE , DELETING , or FAILED .
        • 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 AWS 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 configuration
        • Name : The name of the query logging configuration
        • OwnerId : The AWS account ID for the account that created the query logging configuration.
        • ShareStatus : An indication of whether the query logging configuration is shared with other AWS accounts, or was shared with the current account by another AWS account. Valid values include: NOT_SHARED , SHARED_WITH_ME , or SHARED_BY_ME .
        • Status : The status of the query logging configuration. If you specify Status for Name , specify the applicable status code for Values : CREATING , CREATED , DELETING , or FAILED . 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 of Status is FAILED , specify the cause: DESTINATION_NOT_FOUND or ACCESS_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 specify Status for Name , specify the applicable status code for Values : CREATING , CREATED , DELETING , or FAILED . 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, specify Direction for Name and specify INBOUND for Values .

        • (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 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 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.
  • SortOrder (string) --

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

    Note

    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.

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 another ListResolverQueryLogConfigs request to get the next group of configurations. In the next request, specify the value of NextToken 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, see TotalCount .

    • ResolverQueryLogConfigs (list) --

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

      • (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 AWS 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 AWS accounts, or was shared with the current account by another AWS account. Sharing is configured through AWS Resource Access Manager (AWS 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 executing 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

list_resolver_rule_associations(**kwargs)

Lists the associations that were created between Resolver rules and VPCs using the current AWS account.

See also: AWS API Documentation

Request Syntax

response = client.list_resolver_rule_associations(
    MaxResults=123,
    NextToken='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ]
)
Parameters
  • MaxResults (integer) -- The maximum number of rule associations that you want to return in the response to a ListResolverRuleAssociations request. If you don't specify a value for MaxResults , Resolver returns up to 100 rule associations.
  • NextToken (string) --

    For the first ListResolverRuleAssociation request, omit this value.

    If you have more than MaxResults rule associations, you can submit another ListResolverRuleAssociation request to get the next group of rule associations. In the next request, specify the value of NextToken from the previous response.

  • Filters (list) --

    An optional specification to return a subset of Resolver rules, such as Resolver rules that are associated with the same VPC ID.

    Note

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

    • (dict) --

      For Resolver list operations (ListResolverEndpoints , ListResolverRules , ListResolverRuleAssociations , ListResolverQueryLogConfigs , and ListResolverQueryLogConfigAssociations ), an optional specification to return a subset of objects.

      To filter objects, such as Resolver endpoints or Resolver rules, you specify Name and Values . For example, to list only inbound Resolver endpoints, specify Direction for Name and specify INBOUND for Values .

      • 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 as CREATOR_REQUEST_ID . Uppercase values for Name 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 specify DIRECTION for Name , specify INBOUND or OUTBOUND for Values .
        • 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 the HostVPCId 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 specify Status for Name , specify one of the following status codes for Values : CREATING , OPERATIONAL , UPDATING , AUTO_RECOVERING , ACTION_NEEDED , or DELETING . For more information, see Status 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 for Values , include a trailing dot (.) after the domain name. For example, if the domain name is example.com, specify the following value. Note the "." after com : 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 for RuleType .

        • Status : The status of the Resolver rule. If you specify Status for Name , specify one of the following status codes for Values : COMPLETE , DELETING , UPDATING , or FAILED .
        • Type : The type of the Resolver rule. If you specify TYPE for Name , specify FORWARD or SYSTEM for Values .
        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 specify Status for Name , specify one of the following status codes for Values : CREATING , COMPLETE , DELETING , or FAILED .
        • 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 AWS 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 configuration
        • Name : The name of the query logging configuration
        • OwnerId : The AWS account ID for the account that created the query logging configuration.
        • ShareStatus : An indication of whether the query logging configuration is shared with other AWS accounts, or was shared with the current account by another AWS account. Valid values include: NOT_SHARED , SHARED_WITH_ME , or SHARED_BY_ME .
        • Status : The status of the query logging configuration. If you specify Status for Name , specify the applicable status code for Values : CREATING , CREATED , DELETING , or FAILED . 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 of Status is FAILED , specify the cause: DESTINATION_NOT_FOUND or ACCESS_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 specify Status for Name , specify the applicable status code for Values : CREATING , CREATED , DELETING , or FAILED . 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, specify Direction for Name and specify INBOUND for Values .

        • (string) --
Return type

dict

Returns

Response Syntax

{
    'NextToken': 'string',
    'MaxResults': 123,
    'ResolverRuleAssociations': [
        {
            'Id': 'string',
            'ResolverRuleId': 'string',
            'Name': 'string',
            'VPCId': 'string',
            'Status': 'CREATING'|'COMPLETE'|'DELETING'|'FAILED'|'OVERRIDDEN',
            'StatusMessage': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • NextToken (string) --

      If more than MaxResults rule associations match the specified criteria, you can submit another ListResolverRuleAssociation request to get the next group of results. In the next request, specify the value of NextToken from the previous response.

    • MaxResults (integer) --

      The value that you specified for MaxResults in the request.

    • ResolverRuleAssociations (list) --

      The associations that were created between Resolver rules and VPCs using the current AWS account, and that match the specified filters, if any.

      • (dict) --

        In the response to an AssociateResolverRule , DisassociateResolverRule , or ListResolverRuleAssociations request, provides information about an association between a Resolver rule and a VPC. The association determines which DNS queries that originate in the VPC are forwarded to your network.

        • Id (string) --

          The ID of the association between a Resolver rule and a VPC. Resolver assigns this value when you submit an AssociateResolverRule request.

        • ResolverRuleId (string) --

          The ID of the Resolver rule that you associated with the VPC that is specified by VPCId .

        • Name (string) --

          The name of an association between a Resolver rule and a VPC.

        • VPCId (string) --

          The ID of the VPC that you associated the Resolver rule with.

        • Status (string) --

          A code that specifies the current status of the association between a Resolver rule and a VPC.

        • StatusMessage (string) --

          A detailed description of the status of the association between a Resolver rule and a VPC.

Exceptions

list_resolver_rules(**kwargs)

Lists the Resolver rules that were created using the current AWS account.

See also: AWS API Documentation

Request Syntax

response = client.list_resolver_rules(
    MaxResults=123,
    NextToken='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ]
)
Parameters
  • MaxResults (integer) -- The maximum number of Resolver rules that you want to return in the response to a ListResolverRules request. If you don't specify a value for MaxResults , Resolver returns up to 100 Resolver rules.
  • NextToken (string) --

    For the first ListResolverRules request, omit this value.

    If you have more than MaxResults Resolver rules, you can submit another ListResolverRules request to get the next group of Resolver rules. In the next request, specify the value of NextToken from the previous response.

  • Filters (list) --

    An optional specification to return a subset of Resolver rules, such as all Resolver rules that are associated with the same Resolver endpoint.

    Note

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

    • (dict) --

      For Resolver list operations (ListResolverEndpoints , ListResolverRules , ListResolverRuleAssociations , ListResolverQueryLogConfigs , and ListResolverQueryLogConfigAssociations ), an optional specification to return a subset of objects.

      To filter objects, such as Resolver endpoints or Resolver rules, you specify Name and Values . For example, to list only inbound Resolver endpoints, specify Direction for Name and specify INBOUND for Values .

      • 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 as CREATOR_REQUEST_ID . Uppercase values for Name 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 specify DIRECTION for Name , specify INBOUND or OUTBOUND for Values .
        • 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 the HostVPCId 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 specify Status for Name , specify one of the following status codes for Values : CREATING , OPERATIONAL , UPDATING , AUTO_RECOVERING , ACTION_NEEDED , or DELETING . For more information, see Status 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 for Values , include a trailing dot (.) after the domain name. For example, if the domain name is example.com, specify the following value. Note the "." after com : 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 for RuleType .

        • Status : The status of the Resolver rule. If you specify Status for Name , specify one of the following status codes for Values : COMPLETE , DELETING , UPDATING , or FAILED .
        • Type : The type of the Resolver rule. If you specify TYPE for Name , specify FORWARD or SYSTEM for Values .
        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 specify Status for Name , specify one of the following status codes for Values : CREATING , COMPLETE , DELETING , or FAILED .
        • 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 AWS 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 configuration
        • Name : The name of the query logging configuration
        • OwnerId : The AWS account ID for the account that created the query logging configuration.
        • ShareStatus : An indication of whether the query logging configuration is shared with other AWS accounts, or was shared with the current account by another AWS account. Valid values include: NOT_SHARED , SHARED_WITH_ME , or SHARED_BY_ME .
        • Status : The status of the query logging configuration. If you specify Status for Name , specify the applicable status code for Values : CREATING , CREATED , DELETING , or FAILED . 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 of Status is FAILED , specify the cause: DESTINATION_NOT_FOUND or ACCESS_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 specify Status for Name , specify the applicable status code for Values : CREATING , CREATED , DELETING , or FAILED . 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, specify Direction for Name and specify INBOUND for Values .

        • (string) --
Return type

dict

Returns

Response Syntax

{
    'NextToken': 'string',
    'MaxResults': 123,
    'ResolverRules': [
        {
            'Id': 'string',
            'CreatorRequestId': 'string',
            'Arn': 'string',
            'DomainName': 'string',
            'Status': 'COMPLETE'|'DELETING'|'UPDATING'|'FAILED',
            'StatusMessage': 'string',
            'RuleType': 'FORWARD'|'SYSTEM'|'RECURSIVE',
            'Name': 'string',
            'TargetIps': [
                {
                    'Ip': 'string',
                    'Port': 123
                },
            ],
            'ResolverEndpointId': 'string',
            'OwnerId': 'string',
            'ShareStatus': 'NOT_SHARED'|'SHARED_WITH_ME'|'SHARED_BY_ME',
            'CreationTime': 'string',
            'ModificationTime': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • NextToken (string) --

      If more than MaxResults Resolver rules match the specified criteria, you can submit another ListResolverRules request to get the next group of results. In the next request, specify the value of NextToken from the previous response.

    • MaxResults (integer) --

      The value that you specified for MaxResults in the request.

    • ResolverRules (list) --

      The Resolver rules that were created using the current AWS account and that match the specified filters, if any.

      • (dict) --

        For queries that originate in your VPC, detailed information about a Resolver rule, which specifies how to route DNS queries out of the VPC. The ResolverRule parameter appears in the response to a CreateResolverRule , DeleteResolverRule , GetResolverRule , ListResolverRules , or UpdateResolverRule request.

        • Id (string) --

          The ID that Resolver assigned to the Resolver rule when you created it.

        • CreatorRequestId (string) --

          A unique string that you specified when you created the Resolver rule. CreatorRequestId identifies the request and allows failed requests to be retried without the risk of executing the operation twice.

        • Arn (string) --

          The ARN (Amazon Resource Name) for the Resolver rule specified by Id .

        • DomainName (string) --

          DNS queries for this domain name are forwarded to the IP addresses that are specified in TargetIps . If a query matches multiple Resolver rules (example.com and www.example.com), the query is routed using the Resolver rule that contains the most specific domain name (www.example.com).

        • Status (string) --

          A code that specifies the current status of the Resolver rule.

        • StatusMessage (string) --

          A detailed description of the status of a Resolver rule.

        • RuleType (string) --

          When you want to forward DNS queries for specified domain name to resolvers on your network, specify FORWARD .

          When you have a forwarding rule to forward DNS queries for a domain to your network and you want Resolver to process queries for a subdomain of that domain, specify SYSTEM .

          For example, to forward DNS queries for example.com to resolvers on your network, you create a rule and specify FORWARD for RuleType . To then have Resolver process queries for apex.example.com, you create a rule and specify SYSTEM for RuleType .

          Currently, only Resolver can create rules that have a value of RECURSIVE for RuleType .

        • Name (string) --

          The name for the Resolver rule, which you specified when you created the Resolver rule.

        • TargetIps (list) --

          An array that contains the IP addresses and ports that an outbound endpoint forwards DNS queries to. Typically, these are the IP addresses of DNS resolvers on your network. Specify IPv4 addresses. IPv6 is not supported.

          • (dict) --

            In a CreateResolverRule request, an array of the IPs that you want to forward DNS queries to.

            • Ip (string) --

              One IP address that you want to forward DNS queries to. You can specify only IPv4 addresses.

            • Port (integer) --

              The port at Ip that you want to forward DNS queries to.

        • ResolverEndpointId (string) --

          The ID of the endpoint that the rule is associated with.

        • OwnerId (string) --

          When a rule is shared with another AWS account, the account ID of the account that the rule is shared with.

        • ShareStatus (string) --

          Whether the rules is shared and, if so, whether the current account is sharing the rule with another account, or another account is sharing the rule with the current account.

        • CreationTime (string) --

          The date and time that the Resolver rule was created, in Unix time format and Coordinated Universal Time (UTC).

        • ModificationTime (string) --

          The date and time that the Resolver rule was last updated, in Unix time format and Coordinated Universal Time (UTC).

Exceptions

list_tags_for_resource(**kwargs)

Lists the tags that you associated with the specified resource.

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_resource(
    ResourceArn='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • ResourceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) for the resource that you want to list tags for.

  • MaxResults (integer) -- The maximum number of tags that you want to return in the response to a ListTagsForResource request. If you don't specify a value for MaxResults , Resolver returns up to 100 tags.
  • NextToken (string) --

    For the first ListTagsForResource request, omit this value.

    If you have more than MaxResults tags, you can submit another ListTagsForResource request to get the next group of tags for the resource. In the next request, specify the value of NextToken from the previous response.

Return type

dict

Returns

Response Syntax

{
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Tags (list) --

      The tags that are associated with the resource that you specified in the ListTagsForResource request.

      • (dict) --

        One tag that you want to add to the specified resource. A tag consists of a Key (a name for the tag) and a Value .

        • Key (string) --

          The name for the tag. For example, if you want to associate Resolver resources with the account IDs of your customers for billing purposes, the value of Key might be account-id .

        • Value (string) --

          The value for the tag. For example, if Key is account-id , then Value might be the ID of the customer account that you're creating the resource for.

    • NextToken (string) --

      If more than MaxResults tags match the specified criteria, you can submit another ListTagsForResource request to get the next group of results. In the next request, specify the value of NextToken from the previous response.

Exceptions

put_resolver_query_log_config_policy(**kwargs)

Specifies an AWS account that you want to share a query logging configuration with, the query logging configuration that you want to share, and the operations that you want the account to be able to perform on the configuration.

See also: AWS API Documentation

Request Syntax

response = client.put_resolver_query_log_config_policy(
    Arn='string',
    ResolverQueryLogConfigPolicy='string'
)
Parameters
  • Arn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the account that you want to share rules with.

  • ResolverQueryLogConfigPolicy (string) --

    [REQUIRED]

    An AWS Identity and Access Management policy statement that lists the query logging configurations that you want to share with another AWS account and the operations that you want the account to be able to perform. You can specify the following operations in the Actions section of the statement:

    • route53resolver:AssociateResolverQueryLogConfig
    • route53resolver:DisassociateResolverQueryLogConfig
    • route53resolver:ListResolverQueryLogConfigAssociations
    • route53resolver:ListResolverQueryLogConfigs

    In the Resource section of the statement, you specify the ARNs for the query logging configurations that you want to share with the account that you specified in Arn .

Return type

dict

Returns

Response Syntax

{
    'ReturnValue': True|False
}

Response Structure

  • (dict) --

    The response to a PutResolverQueryLogConfigPolicy request.

    • ReturnValue (boolean) --

      Whether the PutResolverQueryLogConfigPolicy request was successful.

Exceptions

put_resolver_rule_policy(**kwargs)

Specifies an AWS account that you want to share rules with, the Resolver rules that you want to share, and the operations that you want the account to be able to perform on those rules.

See also: AWS API Documentation

Request Syntax

response = client.put_resolver_rule_policy(
    Arn='string',
    ResolverRulePolicy='string'
)
Parameters
  • Arn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the account that you want to share rules with.

  • ResolverRulePolicy (string) --

    [REQUIRED]

    An AWS Identity and Access Management policy statement that lists the rules that you want to share with another AWS account and the operations that you want the account to be able to perform. You can specify the following operations in the Actions section of the statement:

    • route53resolver:GetResolverRule
    • route53resolver:AssociateResolverRule
    • route53resolver:DisassociateResolverRule
    • route53resolver:ListResolverRules
    • route53resolver:ListResolverRuleAssociations

    In the Resource section of the statement, you specify the ARNs for the rules that you want to share with the account that you specified in Arn .

Return type

dict

Returns

Response Syntax

{
    'ReturnValue': True|False
}

Response Structure

  • (dict) --

    The response to a PutResolverRulePolicy request.

    • ReturnValue (boolean) --

      Whether the PutResolverRulePolicy request was successful.

Exceptions

tag_resource(**kwargs)

Adds one or more tags to a specified resource.

See also: AWS API Documentation

Request Syntax

response = client.tag_resource(
    ResourceArn='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • ResourceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) for the resource that you want to add tags to. To get the ARN for a resource, use the applicable Get or List command:

  • Tags (list) --

    [REQUIRED]

    The tags that you want to add to the specified resource.

    • (dict) --

      One tag that you want to add to the specified resource. A tag consists of a Key (a name for the tag) and a Value .

      • Key (string) -- [REQUIRED]

        The name for the tag. For example, if you want to associate Resolver resources with the account IDs of your customers for billing purposes, the value of Key might be account-id .

      • Value (string) -- [REQUIRED]

        The value for the tag. For example, if Key is account-id , then Value might be the ID of the customer account that you're creating the resource for.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

untag_resource(**kwargs)

Removes one or more tags from a specified resource.

See also: AWS API Documentation

Request Syntax

response = client.untag_resource(
    ResourceArn='string',
    TagKeys=[
        'string',
    ]
)
Parameters
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

update_resolver_endpoint(**kwargs)

Updates the name of an inbound or an outbound Resolver endpoint.

See also: AWS API Documentation

Request Syntax

response = client.update_resolver_endpoint(
    ResolverEndpointId='string',
    Name='string'
)
Parameters
  • ResolverEndpointId (string) --

    [REQUIRED]

    The ID of the Resolver endpoint that you want to update.

  • Name (string) -- The name of the Resolver endpoint that you want to update.
Return type

dict

Returns

Response Syntax

{
    'ResolverEndpoint': {
        'Id': 'string',
        'CreatorRequestId': 'string',
        'Arn': 'string',
        'Name': 'string',
        'SecurityGroupIds': [
            'string',
        ],
        'Direction': 'INBOUND'|'OUTBOUND',
        'IpAddressCount': 123,
        'HostVPCId': 'string',
        'Status': 'CREATING'|'OPERATIONAL'|'UPDATING'|'AUTO_RECOVERING'|'ACTION_NEEDED'|'DELETING',
        'StatusMessage': 'string',
        'CreationTime': 'string',
        'ModificationTime': 'string'
    }
}

Response Structure

  • (dict) --

    • ResolverEndpoint (dict) --

      The response to an UpdateResolverEndpoint request.

      • Id (string) --

        The ID of the Resolver endpoint.

      • CreatorRequestId (string) --

        A unique string that identifies the request that created the Resolver endpoint. The CreatorRequestId allows failed requests to be retried without the risk of executing the operation twice.

      • Arn (string) --

        The ARN (Amazon Resource Name) for the Resolver endpoint.

      • Name (string) --

        The name that you assigned to the Resolver endpoint when you submitted a CreateResolverEndpoint request.

      • SecurityGroupIds (list) --

        The ID of one or more security groups that control access to this VPC. The security group must include one or more inbound rules (for inbound endpoints) or outbound rules (for outbound endpoints). Inbound and outbound rules must allow TCP and UDP access. For inbound access, open port 53. For outbound access, open the port that you're using for DNS queries on your network.

        • (string) --
      • Direction (string) --

        Indicates whether the Resolver endpoint allows inbound or outbound DNS queries:

        • INBOUND : allows DNS queries to your VPC from your network
        • OUTBOUND : allows DNS queries from your VPC to your network
      • IpAddressCount (integer) --

        The number of IP addresses that the Resolver endpoint can use for DNS queries.

      • HostVPCId (string) --

        The ID of the VPC that you want to create the Resolver endpoint in.

      • Status (string) --

        A code that specifies the current status of the Resolver endpoint. Valid values include the following:

        • CREATING : Resolver is creating and configuring one or more Amazon VPC network interfaces for this endpoint.
        • OPERATIONAL : The Amazon VPC network interfaces for this endpoint are correctly configured and able to pass inbound or outbound DNS queries between your network and Resolver.
        • UPDATING : Resolver is associating or disassociating one or more network interfaces with this endpoint.
        • AUTO_RECOVERING : Resolver is trying to recover one or more of the network interfaces that are associated with this endpoint. During the recovery process, the endpoint functions with limited capacity because of the limit on the number of DNS queries per IP address (per network interface). For the current limit, see Limits on Route 53 Resolver .
        • ACTION_NEEDED : This endpoint is unhealthy, and Resolver can't automatically recover it. To resolve the problem, we recommend that you check each IP address that you associated with the endpoint. For each IP address that isn't available, add another IP address and then delete the IP address that isn't available. (An endpoint must always include at least two IP addresses.) A status of ACTION_NEEDED can have a variety of causes. Here are two common causes:
          • One or more of the network interfaces that are associated with the endpoint were deleted using Amazon VPC.
          • The network interface couldn't be created for some reason that's outside the control of Resolver.
        • DELETING : Resolver is deleting this endpoint and the associated network interfaces.
      • StatusMessage (string) --

        A detailed description of the status of the Resolver endpoint.

      • CreationTime (string) --

        The date and time that the endpoint was created, in Unix time format and Coordinated Universal Time (UTC).

      • ModificationTime (string) --

        The date and time that the endpoint was last modified, in Unix time format and Coordinated Universal Time (UTC).

Exceptions

update_resolver_rule(**kwargs)

Updates settings for a specified Resolver rule. ResolverRuleId is required, and all other parameters are optional. If you don't specify a parameter, it retains its current value.

See also: AWS API Documentation

Request Syntax

response = client.update_resolver_rule(
    ResolverRuleId='string',
    Config={
        'Name': 'string',
        'TargetIps': [
            {
                'Ip': 'string',
                'Port': 123
            },
        ],
        'ResolverEndpointId': 'string'
    }
)
Parameters
  • ResolverRuleId (string) --

    [REQUIRED]

    The ID of the Resolver rule that you want to update.

  • Config (dict) --

    [REQUIRED]

    The new settings for the Resolver rule.

    • Name (string) --

      The new name for the Resolver rule. The name that you specify appears in the Resolver dashboard in the Route 53 console.

    • TargetIps (list) --

      For DNS queries that originate in your VPC, the new IP addresses that you want to route outbound DNS queries to.

      • (dict) --

        In a CreateResolverRule request, an array of the IPs that you want to forward DNS queries to.

        • Ip (string) -- [REQUIRED]

          One IP address that you want to forward DNS queries to. You can specify only IPv4 addresses.

        • Port (integer) --

          The port at Ip that you want to forward DNS queries to.

    • ResolverEndpointId (string) --

      The ID of the new outbound Resolver endpoint that you want to use to route DNS queries to the IP addresses that you specify in TargetIps .

Return type

dict

Returns

Response Syntax

{
    'ResolverRule': {
        'Id': 'string',
        'CreatorRequestId': 'string',
        'Arn': 'string',
        'DomainName': 'string',
        'Status': 'COMPLETE'|'DELETING'|'UPDATING'|'FAILED',
        'StatusMessage': 'string',
        'RuleType': 'FORWARD'|'SYSTEM'|'RECURSIVE',
        'Name': 'string',
        'TargetIps': [
            {
                'Ip': 'string',
                'Port': 123
            },
        ],
        'ResolverEndpointId': 'string',
        'OwnerId': 'string',
        'ShareStatus': 'NOT_SHARED'|'SHARED_WITH_ME'|'SHARED_BY_ME',
        'CreationTime': 'string',
        'ModificationTime': 'string'
    }
}

Response Structure

  • (dict) --

    • ResolverRule (dict) --

      The response to an UpdateResolverRule request.

      • Id (string) --

        The ID that Resolver assigned to the Resolver rule when you created it.

      • CreatorRequestId (string) --

        A unique string that you specified when you created the Resolver rule. CreatorRequestId identifies the request and allows failed requests to be retried without the risk of executing the operation twice.

      • Arn (string) --

        The ARN (Amazon Resource Name) for the Resolver rule specified by Id .

      • DomainName (string) --

        DNS queries for this domain name are forwarded to the IP addresses that are specified in TargetIps . If a query matches multiple Resolver rules (example.com and www.example.com), the query is routed using the Resolver rule that contains the most specific domain name (www.example.com).

      • Status (string) --

        A code that specifies the current status of the Resolver rule.

      • StatusMessage (string) --

        A detailed description of the status of a Resolver rule.

      • RuleType (string) --

        When you want to forward DNS queries for specified domain name to resolvers on your network, specify FORWARD .

        When you have a forwarding rule to forward DNS queries for a domain to your network and you want Resolver to process queries for a subdomain of that domain, specify SYSTEM .

        For example, to forward DNS queries for example.com to resolvers on your network, you create a rule and specify FORWARD for RuleType . To then have Resolver process queries for apex.example.com, you create a rule and specify SYSTEM for RuleType .

        Currently, only Resolver can create rules that have a value of RECURSIVE for RuleType .

      • Name (string) --

        The name for the Resolver rule, which you specified when you created the Resolver rule.

      • TargetIps (list) --

        An array that contains the IP addresses and ports that an outbound endpoint forwards DNS queries to. Typically, these are the IP addresses of DNS resolvers on your network. Specify IPv4 addresses. IPv6 is not supported.

        • (dict) --

          In a CreateResolverRule request, an array of the IPs that you want to forward DNS queries to.

          • Ip (string) --

            One IP address that you want to forward DNS queries to. You can specify only IPv4 addresses.

          • Port (integer) --

            The port at Ip that you want to forward DNS queries to.

      • ResolverEndpointId (string) --

        The ID of the endpoint that the rule is associated with.

      • OwnerId (string) --

        When a rule is shared with another AWS account, the account ID of the account that the rule is shared with.

      • ShareStatus (string) --

        Whether the rules is shared and, if so, whether the current account is sharing the rule with another account, or another account is sharing the rule with the current account.

      • CreationTime (string) --

        The date and time that the Resolver rule was created, in Unix time format and Coordinated Universal Time (UTC).

      • ModificationTime (string) --

        The date and time that the Resolver rule was last updated, in Unix time format and Coordinated Universal Time (UTC).

Exceptions

Client Exceptions

Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.

The available client exceptions are:

class Route53Resolver.Client.exceptions.AccessDeniedException

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

Example

try:
  ...
except client.exceptions.AccessDeniedException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

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

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class Route53Resolver.Client.exceptions.InternalServiceErrorException

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

Example

try:
  ...
except client.exceptions.InternalServiceErrorException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

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

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class Route53Resolver.Client.exceptions.InvalidNextTokenException

The value that you specified for NextToken in a List request isn't valid.

Example

try:
  ...
except client.exceptions.InvalidNextTokenException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The value that you specified for NextToken in a List request isn't valid.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class Route53Resolver.Client.exceptions.InvalidParameterException

One or more parameters in this request are not valid.

Example

try:
  ...
except client.exceptions.InvalidParameterException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'FieldName': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    One or more parameters in this request are not valid.

    • Message (string) --

    • FieldName (string) --

      For an InvalidParameterException error, the name of the parameter that's invalid.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class Route53Resolver.Client.exceptions.InvalidPolicyDocument

The specified Resolver rule policy is invalid.

Example

try:
  ...
except client.exceptions.InvalidPolicyDocument as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The specified Resolver rule policy is invalid.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class Route53Resolver.Client.exceptions.InvalidRequestException

The request is invalid.

Example

try:
  ...
except client.exceptions.InvalidRequestException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The request is invalid.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class Route53Resolver.Client.exceptions.InvalidTagException

The specified tag is invalid.

Example

try:
  ...
except client.exceptions.InvalidTagException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The specified tag is invalid.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class Route53Resolver.Client.exceptions.LimitExceededException

The request caused one or more limits to be exceeded.

Example

try:
  ...
except client.exceptions.LimitExceededException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'ResourceType': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The request caused one or more limits to be exceeded.

    • Message (string) --

    • ResourceType (string) --

      For a LimitExceededException error, the type of resource that exceeded the current limit.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class Route53Resolver.Client.exceptions.ResourceExistsException

The resource that you tried to create already exists.

Example

try:
  ...
except client.exceptions.ResourceExistsException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'ResourceType': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The resource that you tried to create already exists.

    • Message (string) --

    • ResourceType (string) --

      For a ResourceExistsException error, the type of resource that the error applies to.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class Route53Resolver.Client.exceptions.ResourceInUseException

The resource that you tried to update or delete is currently in use.

Example

try:
  ...
except client.exceptions.ResourceInUseException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'ResourceType': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The resource that you tried to update or delete is currently in use.

    • Message (string) --

    • ResourceType (string) --

      For a ResourceInUseException error, the type of resource that is currently in use.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class Route53Resolver.Client.exceptions.ResourceNotFoundException

The specified resource doesn't exist.

Example

try:
  ...
except client.exceptions.ResourceNotFoundException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'ResourceType': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The specified resource doesn't exist.

    • Message (string) --

    • ResourceType (string) --

      For a ResourceNotFoundException error, the type of resource that doesn't exist.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class Route53Resolver.Client.exceptions.ResourceUnavailableException

The specified resource isn't available.

Example

try:
  ...
except client.exceptions.ResourceUnavailableException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'ResourceType': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The specified resource isn't available.

    • Message (string) --

    • ResourceType (string) --

      For a ResourceUnavailableException error, the type of resource that isn't available.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class Route53Resolver.Client.exceptions.ThrottlingException

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

Example

try:
  ...
except client.exceptions.ThrottlingException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

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

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class Route53Resolver.Client.exceptions.UnknownResourceException

The specified resource doesn't exist.

Example

try:
  ...
except client.exceptions.UnknownResourceException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The specified resource doesn't exist.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.

Paginators

The available paginators are:

class Route53Resolver.Paginator.ListResolverEndpointIpAddresses
paginator = client.get_paginator('list_resolver_endpoint_ip_addresses')
paginate(**kwargs)

Creates an iterator that will paginate through responses from Route53Resolver.Client.list_resolver_endpoint_ip_addresses().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ResolverEndpointId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • ResolverEndpointId (string) --

    [REQUIRED]

    The ID of the Resolver endpoint that you want to get IP addresses for.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'MaxResults': 123,
    'IpAddresses': [
        {
            'IpId': 'string',
            'SubnetId': 'string',
            'Ip': 'string',
            'Status': 'CREATING'|'FAILED_CREATION'|'ATTACHING'|'ATTACHED'|'REMAP_DETACHING'|'REMAP_ATTACHING'|'DETACHING'|'FAILED_RESOURCE_GONE'|'DELETING'|'DELETE_FAILED_FAS_EXPIRED',
            'StatusMessage': 'string',
            'CreationTime': 'string',
            'ModificationTime': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • MaxResults (integer) --

      The value that you specified for MaxResults in the request.

    • IpAddresses (list) --

      Information about the IP addresses in your VPC that DNS queries originate from (for outbound endpoints) or that you forward DNS queries to (for inbound endpoints).

      • (dict) --

        In the response to a GetResolverEndpoint request, information about the IP addresses that the Resolver endpoint uses for DNS queries.

        • IpId (string) --

          The ID of one IP address.

        • SubnetId (string) --

          The ID of one subnet.

        • Ip (string) --

          One IP address that the Resolver endpoint uses for DNS queries.

        • Status (string) --

          A status code that gives the current status of the request.

        • StatusMessage (string) --

          A message that provides additional information about the status of the request.

        • CreationTime (string) --

          The date and time that the IP address was created, in Unix time format and Coordinated Universal Time (UTC).

        • ModificationTime (string) --

          The date and time that the IP address was last modified, in Unix time format and Coordinated Universal Time (UTC).

class Route53Resolver.Paginator.ListResolverEndpoints
paginator = client.get_paginator('list_resolver_endpoints')
paginate(**kwargs)

Creates an iterator that will paginate through responses from Route53Resolver.Client.list_resolver_endpoints().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • Filters (list) --

    An optional specification to return a subset of Resolver endpoints, such as all inbound Resolver endpoints.

    Note

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

    • (dict) --

      For Resolver list operations (ListResolverEndpoints , ListResolverRules , ListResolverRuleAssociations , ListResolverQueryLogConfigs , and ListResolverQueryLogConfigAssociations ), an optional specification to return a subset of objects.

      To filter objects, such as Resolver endpoints or Resolver rules, you specify Name and Values . For example, to list only inbound Resolver endpoints, specify Direction for Name and specify INBOUND for Values .

      • 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 as CREATOR_REQUEST_ID . Uppercase values for Name 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 specify DIRECTION for Name , specify INBOUND or OUTBOUND for Values .
        • 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 the HostVPCId 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 specify Status for Name , specify one of the following status codes for Values : CREATING , OPERATIONAL , UPDATING , AUTO_RECOVERING , ACTION_NEEDED , or DELETING . For more information, see Status 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 for Values , include a trailing dot (.) after the domain name. For example, if the domain name is example.com, specify the following value. Note the "." after com : 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 for RuleType .

        • Status : The status of the Resolver rule. If you specify Status for Name , specify one of the following status codes for Values : COMPLETE , DELETING , UPDATING , or FAILED .
        • Type : The type of the Resolver rule. If you specify TYPE for Name , specify FORWARD or SYSTEM for Values .
        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 specify Status for Name , specify one of the following status codes for Values : CREATING , COMPLETE , DELETING , or FAILED .
        • 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 AWS 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 configuration
        • Name : The name of the query logging configuration
        • OwnerId : The AWS account ID for the account that created the query logging configuration.
        • ShareStatus : An indication of whether the query logging configuration is shared with other AWS accounts, or was shared with the current account by another AWS account. Valid values include: NOT_SHARED , SHARED_WITH_ME , or SHARED_BY_ME .
        • Status : The status of the query logging configuration. If you specify Status for Name , specify the applicable status code for Values : CREATING , CREATED , DELETING , or FAILED . 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 of Status is FAILED , specify the cause: DESTINATION_NOT_FOUND or ACCESS_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 specify Status for Name , specify the applicable status code for Values : CREATING , CREATED , DELETING , or FAILED . 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, specify Direction for Name and specify INBOUND for Values .

        • (string) --
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'MaxResults': 123,
    'ResolverEndpoints': [
        {
            'Id': 'string',
            'CreatorRequestId': 'string',
            'Arn': 'string',
            'Name': 'string',
            'SecurityGroupIds': [
                'string',
            ],
            'Direction': 'INBOUND'|'OUTBOUND',
            'IpAddressCount': 123,
            'HostVPCId': 'string',
            'Status': 'CREATING'|'OPERATIONAL'|'UPDATING'|'AUTO_RECOVERING'|'ACTION_NEEDED'|'DELETING',
            'StatusMessage': 'string',
            'CreationTime': 'string',
            'ModificationTime': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • MaxResults (integer) --

      The value that you specified for MaxResults in the request.

    • ResolverEndpoints (list) --

      The Resolver endpoints that were created by using the current AWS account, and that match the specified filters, if any.

      • (dict) --

        In the response to a CreateResolverEndpoint , DeleteResolverEndpoint , GetResolverEndpoint , ListResolverEndpoints , or UpdateResolverEndpoint request, a complex type that contains settings for an existing inbound or outbound Resolver endpoint.

        • Id (string) --

          The ID of the Resolver endpoint.

        • CreatorRequestId (string) --

          A unique string that identifies the request that created the Resolver endpoint. The CreatorRequestId allows failed requests to be retried without the risk of executing the operation twice.

        • Arn (string) --

          The ARN (Amazon Resource Name) for the Resolver endpoint.

        • Name (string) --

          The name that you assigned to the Resolver endpoint when you submitted a CreateResolverEndpoint request.

        • SecurityGroupIds (list) --

          The ID of one or more security groups that control access to this VPC. The security group must include one or more inbound rules (for inbound endpoints) or outbound rules (for outbound endpoints). Inbound and outbound rules must allow TCP and UDP access. For inbound access, open port 53. For outbound access, open the port that you're using for DNS queries on your network.

          • (string) --
        • Direction (string) --

          Indicates whether the Resolver endpoint allows inbound or outbound DNS queries:

          • INBOUND : allows DNS queries to your VPC from your network
          • OUTBOUND : allows DNS queries from your VPC to your network
        • IpAddressCount (integer) --

          The number of IP addresses that the Resolver endpoint can use for DNS queries.

        • HostVPCId (string) --

          The ID of the VPC that you want to create the Resolver endpoint in.

        • Status (string) --

          A code that specifies the current status of the Resolver endpoint. Valid values include the following:

          • CREATING : Resolver is creating and configuring one or more Amazon VPC network interfaces for this endpoint.
          • OPERATIONAL : The Amazon VPC network interfaces for this endpoint are correctly configured and able to pass inbound or outbound DNS queries between your network and Resolver.
          • UPDATING : Resolver is associating or disassociating one or more network interfaces with this endpoint.
          • AUTO_RECOVERING : Resolver is trying to recover one or more of the network interfaces that are associated with this endpoint. During the recovery process, the endpoint functions with limited capacity because of the limit on the number of DNS queries per IP address (per network interface). For the current limit, see Limits on Route 53 Resolver .
          • ACTION_NEEDED : This endpoint is unhealthy, and Resolver can't automatically recover it. To resolve the problem, we recommend that you check each IP address that you associated with the endpoint. For each IP address that isn't available, add another IP address and then delete the IP address that isn't available. (An endpoint must always include at least two IP addresses.) A status of ACTION_NEEDED can have a variety of causes. Here are two common causes:
            • One or more of the network interfaces that are associated with the endpoint were deleted using Amazon VPC.
            • The network interface couldn't be created for some reason that's outside the control of Resolver.
          • DELETING : Resolver is deleting this endpoint and the associated network interfaces.
        • StatusMessage (string) --

          A detailed description of the status of the Resolver endpoint.

        • CreationTime (string) --

          The date and time that the endpoint was created, in Unix time format and Coordinated Universal Time (UTC).

        • ModificationTime (string) --

          The date and time that the endpoint was last modified, in Unix time format and Coordinated Universal Time (UTC).

class Route53Resolver.Paginator.ListResolverQueryLogConfigAssociations
paginator = client.get_paginator('list_resolver_query_log_config_associations')
paginate(**kwargs)

Creates an iterator that will paginate through responses from Route53Resolver.Client.list_resolver_query_log_config_associations().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    SortBy='string',
    SortOrder='ASCENDING'|'DESCENDING',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • Filters (list) --

    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.

    • (dict) --

      For Resolver list operations (ListResolverEndpoints , ListResolverRules , ListResolverRuleAssociations , ListResolverQueryLogConfigs , and ListResolverQueryLogConfigAssociations ), an optional specification to return a subset of objects.

      To filter objects, such as Resolver endpoints or Resolver rules, you specify Name and Values . For example, to list only inbound Resolver endpoints, specify Direction for Name and specify INBOUND for Values .

      • 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 as CREATOR_REQUEST_ID . Uppercase values for Name 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 specify DIRECTION for Name , specify INBOUND or OUTBOUND for Values .
        • 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 the HostVPCId 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 specify Status for Name , specify one of the following status codes for Values : CREATING , OPERATIONAL , UPDATING , AUTO_RECOVERING , ACTION_NEEDED , or DELETING . For more information, see Status 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 for Values , include a trailing dot (.) after the domain name. For example, if the domain name is example.com, specify the following value. Note the "." after com : 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 for RuleType .

        • Status : The status of the Resolver rule. If you specify Status for Name , specify one of the following status codes for Values : COMPLETE , DELETING , UPDATING , or FAILED .
        • Type : The type of the Resolver rule. If you specify TYPE for Name , specify FORWARD or SYSTEM for Values .
        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 specify Status for Name , specify one of the following status codes for Values : CREATING , COMPLETE , DELETING , or FAILED .
        • 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 AWS 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 configuration
        • Name : The name of the query logging configuration
        • OwnerId : The AWS account ID for the account that created the query logging configuration.
        • ShareStatus : An indication of whether the query logging configuration is shared with other AWS accounts, or was shared with the current account by another AWS account. Valid values include: NOT_SHARED , SHARED_WITH_ME , or SHARED_BY_ME .
        • Status : The status of the query logging configuration. If you specify Status for Name , specify the applicable status code for Values : CREATING , CREATED , DELETING , or FAILED . 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 of Status is FAILED , specify the cause: DESTINATION_NOT_FOUND or ACCESS_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 specify Status for Name , specify the applicable status code for Values : CREATING , CREATED , DELETING , or FAILED . 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, specify Direction for Name and specify INBOUND for Values .

        • (string) --
  • SortBy (string) --

    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.
  • SortOrder (string) --

    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.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'TotalCount': 123,
    'TotalFilteredCount': 123,
    'ResolverQueryLogConfigAssociations': [
        {
            'Id': 'string',
            'ResolverQueryLogConfigId': 'string',
            'ResourceId': 'string',
            'Status': 'CREATING'|'ACTIVE'|'ACTION_NEEDED'|'DELETING'|'FAILED',
            'Error': 'NONE'|'DESTINATION_NOT_FOUND'|'ACCESS_DENIED'|'INTERNAL_SERVICE_ERROR',
            'ErrorMessage': 'string',
            'CreationTime': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • TotalCount (integer) --

      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.

    • TotalFilteredCount (integer) --

      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 .

    • ResolverQueryLogConfigAssociations (list) --

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

      • (dict) --

        In the response to an AssociateResolverQueryLogConfig , DisassociateResolverQueryLogConfig , GetResolverQueryLogConfigAssociation , or ListResolverQueryLogConfigAssociations , request, a complex type that contains settings for a specified association between an Amazon VPC and a query logging configuration.

        • Id (string) --

          The ID of the query logging association.

        • ResolverQueryLogConfigId (string) --

          The ID of the query logging configuration that a VPC is associated with.

        • ResourceId (string) --

          The ID of the Amazon VPC that is associated with the query logging configuration.

        • Status (string) --

          The status of the specified query logging association. 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.
        • Error (string) --

          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 the value of Status is a value other than FAILED , Error is null.

        • ErrorMessage (string) --

          Contains additional information about the error. If the value or Error is null, the value of ErrorMessage also is null.

        • CreationTime (string) --

          The date and time that the VPC was associated with the query logging configuration, in Unix time format and Coordinated Universal Time (UTC).

class Route53Resolver.Paginator.ListResolverQueryLogConfigs
paginator = client.get_paginator('list_resolver_query_log_configs')
paginate(**kwargs)

Creates an iterator that will paginate through responses from Route53Resolver.Client.list_resolver_query_log_configs().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    SortBy='string',
    SortOrder='ASCENDING'|'DESCENDING',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • 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 the NextToken parameter, you must use the same values for Filters , if any, as in the previous request.

    • (dict) --

      For Resolver list operations (ListResolverEndpoints , ListResolverRules , ListResolverRuleAssociations , ListResolverQueryLogConfigs , and ListResolverQueryLogConfigAssociations ), an optional specification to return a subset of objects.

      To filter objects, such as Resolver endpoints or Resolver rules, you specify Name and Values . For example, to list only inbound Resolver endpoints, specify Direction for Name and specify INBOUND for Values .

      • 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 as CREATOR_REQUEST_ID . Uppercase values for Name 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 specify DIRECTION for Name , specify INBOUND or OUTBOUND for Values .
        • 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 the HostVPCId 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 specify Status for Name , specify one of the following status codes for Values : CREATING , OPERATIONAL , UPDATING , AUTO_RECOVERING , ACTION_NEEDED , or DELETING . For more information, see Status 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 for Values , include a trailing dot (.) after the domain name. For example, if the domain name is example.com, specify the following value. Note the "." after com : 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 for RuleType .

        • Status : The status of the Resolver rule. If you specify Status for Name , specify one of the following status codes for Values : COMPLETE , DELETING , UPDATING , or FAILED .
        • Type : The type of the Resolver rule. If you specify TYPE for Name , specify FORWARD or SYSTEM for Values .
        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 specify Status for Name , specify one of the following status codes for Values : CREATING , COMPLETE , DELETING , or FAILED .
        • 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 AWS 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 configuration
        • Name : The name of the query logging configuration
        • OwnerId : The AWS account ID for the account that created the query logging configuration.
        • ShareStatus : An indication of whether the query logging configuration is shared with other AWS accounts, or was shared with the current account by another AWS account. Valid values include: NOT_SHARED , SHARED_WITH_ME , or SHARED_BY_ME .
        • Status : The status of the query logging configuration. If you specify Status for Name , specify the applicable status code for Values : CREATING , CREATED , DELETING , or FAILED . 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 of Status is FAILED , specify the cause: DESTINATION_NOT_FOUND or ACCESS_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 specify Status for Name , specify the applicable status code for Values : CREATING , CREATED , DELETING , or FAILED . 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, specify Direction for Name and specify INBOUND for Values .

        • (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 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 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.
  • SortOrder (string) --

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

    Note

    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.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    '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) --

    • 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, see TotalCount .

    • ResolverQueryLogConfigs (list) --

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

      • (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 AWS 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 AWS accounts, or was shared with the current account by another AWS account. Sharing is configured through AWS Resource Access Manager (AWS 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 executing 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).

class Route53Resolver.Paginator.ListResolverRuleAssociations
paginator = client.get_paginator('list_resolver_rule_associations')
paginate(**kwargs)

Creates an iterator that will paginate through responses from Route53Resolver.Client.list_resolver_rule_associations().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • Filters (list) --

    An optional specification to return a subset of Resolver rules, such as Resolver rules that are associated with the same VPC ID.

    Note

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

    • (dict) --

      For Resolver list operations (ListResolverEndpoints , ListResolverRules , ListResolverRuleAssociations , ListResolverQueryLogConfigs , and ListResolverQueryLogConfigAssociations ), an optional specification to return a subset of objects.

      To filter objects, such as Resolver endpoints or Resolver rules, you specify Name and Values . For example, to list only inbound Resolver endpoints, specify Direction for Name and specify INBOUND for Values .

      • 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 as CREATOR_REQUEST_ID . Uppercase values for Name 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 specify DIRECTION for Name , specify INBOUND or OUTBOUND for Values .
        • 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 the HostVPCId 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 specify Status for Name , specify one of the following status codes for Values : CREATING , OPERATIONAL , UPDATING , AUTO_RECOVERING , ACTION_NEEDED , or DELETING . For more information, see Status 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 for Values , include a trailing dot (.) after the domain name. For example, if the domain name is example.com, specify the following value. Note the "." after com : 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 for RuleType .

        • Status : The status of the Resolver rule. If you specify Status for Name , specify one of the following status codes for Values : COMPLETE , DELETING , UPDATING , or FAILED .
        • Type : The type of the Resolver rule. If you specify TYPE for Name , specify FORWARD or SYSTEM for Values .
        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 specify Status for Name , specify one of the following status codes for Values : CREATING , COMPLETE , DELETING , or FAILED .
        • 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 AWS 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 configuration
        • Name : The name of the query logging configuration
        • OwnerId : The AWS account ID for the account that created the query logging configuration.
        • ShareStatus : An indication of whether the query logging configuration is shared with other AWS accounts, or was shared with the current account by another AWS account. Valid values include: NOT_SHARED , SHARED_WITH_ME , or SHARED_BY_ME .
        • Status : The status of the query logging configuration. If you specify Status for Name , specify the applicable status code for Values : CREATING , CREATED , DELETING , or FAILED . 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 of Status is FAILED , specify the cause: DESTINATION_NOT_FOUND or ACCESS_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 specify Status for Name , specify the applicable status code for Values : CREATING , CREATED , DELETING , or FAILED . 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, specify Direction for Name and specify INBOUND for Values .

        • (string) --
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'MaxResults': 123,
    'ResolverRuleAssociations': [
        {
            'Id': 'string',
            'ResolverRuleId': 'string',
            'Name': 'string',
            'VPCId': 'string',
            'Status': 'CREATING'|'COMPLETE'|'DELETING'|'FAILED'|'OVERRIDDEN',
            'StatusMessage': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • MaxResults (integer) --

      The value that you specified for MaxResults in the request.

    • ResolverRuleAssociations (list) --

      The associations that were created between Resolver rules and VPCs using the current AWS account, and that match the specified filters, if any.

      • (dict) --

        In the response to an AssociateResolverRule , DisassociateResolverRule , or ListResolverRuleAssociations request, provides information about an association between a Resolver rule and a VPC. The association determines which DNS queries that originate in the VPC are forwarded to your network.

        • Id (string) --

          The ID of the association between a Resolver rule and a VPC. Resolver assigns this value when you submit an AssociateResolverRule request.

        • ResolverRuleId (string) --

          The ID of the Resolver rule that you associated with the VPC that is specified by VPCId .

        • Name (string) --

          The name of an association between a Resolver rule and a VPC.

        • VPCId (string) --

          The ID of the VPC that you associated the Resolver rule with.

        • Status (string) --

          A code that specifies the current status of the association between a Resolver rule and a VPC.

        • StatusMessage (string) --

          A detailed description of the status of the association between a Resolver rule and a VPC.

class Route53Resolver.Paginator.ListResolverRules
paginator = client.get_paginator('list_resolver_rules')
paginate(**kwargs)

Creates an iterator that will paginate through responses from Route53Resolver.Client.list_resolver_rules().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • Filters (list) --

    An optional specification to return a subset of Resolver rules, such as all Resolver rules that are associated with the same Resolver endpoint.

    Note

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

    • (dict) --

      For Resolver list operations (ListResolverEndpoints , ListResolverRules , ListResolverRuleAssociations , ListResolverQueryLogConfigs , and ListResolverQueryLogConfigAssociations ), an optional specification to return a subset of objects.

      To filter objects, such as Resolver endpoints or Resolver rules, you specify Name and Values . For example, to list only inbound Resolver endpoints, specify Direction for Name and specify INBOUND for Values .

      • 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 as CREATOR_REQUEST_ID . Uppercase values for Name 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 specify DIRECTION for Name , specify INBOUND or OUTBOUND for Values .
        • 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 the HostVPCId 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 specify Status for Name , specify one of the following status codes for Values : CREATING , OPERATIONAL , UPDATING , AUTO_RECOVERING , ACTION_NEEDED , or DELETING . For more information, see Status 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 for Values , include a trailing dot (.) after the domain name. For example, if the domain name is example.com, specify the following value. Note the "." after com : 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 for RuleType .

        • Status : The status of the Resolver rule. If you specify Status for Name , specify one of the following status codes for Values : COMPLETE , DELETING , UPDATING , or FAILED .
        • Type : The type of the Resolver rule. If you specify TYPE for Name , specify FORWARD or SYSTEM for Values .
        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 specify Status for Name , specify one of the following status codes for Values : CREATING , COMPLETE , DELETING , or FAILED .
        • 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 AWS 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 configuration
        • Name : The name of the query logging configuration
        • OwnerId : The AWS account ID for the account that created the query logging configuration.
        • ShareStatus : An indication of whether the query logging configuration is shared with other AWS accounts, or was shared with the current account by another AWS account. Valid values include: NOT_SHARED , SHARED_WITH_ME , or SHARED_BY_ME .
        • Status : The status of the query logging configuration. If you specify Status for Name , specify the applicable status code for Values : CREATING , CREATED , DELETING , or FAILED . 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 of Status is FAILED , specify the cause: DESTINATION_NOT_FOUND or ACCESS_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 specify Status for Name , specify the applicable status code for Values : CREATING , CREATED , DELETING , or FAILED . 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, specify Direction for Name and specify INBOUND for Values .

        • (string) --
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'MaxResults': 123,
    'ResolverRules': [
        {
            'Id': 'string',
            'CreatorRequestId': 'string',
            'Arn': 'string',
            'DomainName': 'string',
            'Status': 'COMPLETE'|'DELETING'|'UPDATING'|'FAILED',
            'StatusMessage': 'string',
            'RuleType': 'FORWARD'|'SYSTEM'|'RECURSIVE',
            'Name': 'string',
            'TargetIps': [
                {
                    'Ip': 'string',
                    'Port': 123
                },
            ],
            'ResolverEndpointId': 'string',
            'OwnerId': 'string',
            'ShareStatus': 'NOT_SHARED'|'SHARED_WITH_ME'|'SHARED_BY_ME',
            'CreationTime': 'string',
            'ModificationTime': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • MaxResults (integer) --

      The value that you specified for MaxResults in the request.

    • ResolverRules (list) --

      The Resolver rules that were created using the current AWS account and that match the specified filters, if any.

      • (dict) --

        For queries that originate in your VPC, detailed information about a Resolver rule, which specifies how to route DNS queries out of the VPC. The ResolverRule parameter appears in the response to a CreateResolverRule , DeleteResolverRule , GetResolverRule , ListResolverRules , or UpdateResolverRule request.

        • Id (string) --

          The ID that Resolver assigned to the Resolver rule when you created it.

        • CreatorRequestId (string) --

          A unique string that you specified when you created the Resolver rule. CreatorRequestId identifies the request and allows failed requests to be retried without the risk of executing the operation twice.

        • Arn (string) --

          The ARN (Amazon Resource Name) for the Resolver rule specified by Id .

        • DomainName (string) --

          DNS queries for this domain name are forwarded to the IP addresses that are specified in TargetIps . If a query matches multiple Resolver rules (example.com and www.example.com), the query is routed using the Resolver rule that contains the most specific domain name (www.example.com).

        • Status (string) --

          A code that specifies the current status of the Resolver rule.

        • StatusMessage (string) --

          A detailed description of the status of a Resolver rule.

        • RuleType (string) --

          When you want to forward DNS queries for specified domain name to resolvers on your network, specify FORWARD .

          When you have a forwarding rule to forward DNS queries for a domain to your network and you want Resolver to process queries for a subdomain of that domain, specify SYSTEM .

          For example, to forward DNS queries for example.com to resolvers on your network, you create a rule and specify FORWARD for RuleType . To then have Resolver process queries for apex.example.com, you create a rule and specify SYSTEM for RuleType .

          Currently, only Resolver can create rules that have a value of RECURSIVE for RuleType .

        • Name (string) --

          The name for the Resolver rule, which you specified when you created the Resolver rule.

        • TargetIps (list) --

          An array that contains the IP addresses and ports that an outbound endpoint forwards DNS queries to. Typically, these are the IP addresses of DNS resolvers on your network. Specify IPv4 addresses. IPv6 is not supported.

          • (dict) --

            In a CreateResolverRule request, an array of the IPs that you want to forward DNS queries to.

            • Ip (string) --

              One IP address that you want to forward DNS queries to. You can specify only IPv4 addresses.

            • Port (integer) --

              The port at Ip that you want to forward DNS queries to.

        • ResolverEndpointId (string) --

          The ID of the endpoint that the rule is associated with.

        • OwnerId (string) --

          When a rule is shared with another AWS account, the account ID of the account that the rule is shared with.

        • ShareStatus (string) --

          Whether the rules is shared and, if so, whether the current account is sharing the rule with another account, or another account is sharing the rule with the current account.

        • CreationTime (string) --

          The date and time that the Resolver rule was created, in Unix time format and Coordinated Universal Time (UTC).

        • ModificationTime (string) --

          The date and time that the Resolver rule was last updated, in Unix time format and Coordinated Universal Time (UTC).

class Route53Resolver.Paginator.ListTagsForResource
paginator = client.get_paginator('list_tags_for_resource')
paginate(**kwargs)

Creates an iterator that will paginate through responses from Route53Resolver.Client.list_tags_for_resource().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ResourceArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • ResourceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) for the resource that you want to list tags for.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],

}

Response Structure

  • (dict) --

    • Tags (list) --

      The tags that are associated with the resource that you specified in the ListTagsForResource request.

      • (dict) --

        One tag that you want to add to the specified resource. A tag consists of a Key (a name for the tag) and a Value .

        • Key (string) --

          The name for the tag. For example, if you want to associate Resolver resources with the account IDs of your customers for billing purposes, the value of Key might be account-id .

        • Value (string) --

          The value for the tag. For example, if Key is account-id , then Value might be the ID of the customer account that you're creating the resource for.