Skip to content

list_resolver_endpoint_ip_addresses

list_resolver_endpoint_ip_addresses(
    resolver_endpoint_id: ResourceId,
    *,
    config_overrides: Optional[Route53ResolverClientConfig] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[NextToken] = None,
) -> ListResolverEndpointIpAddressesResponse

Gets the IP addresses for a specified Resolver endpoint.

Parameters:

  • resolver_endpoint_id (ResourceId) –

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

  • max_results (Optional[MaxResults], default: None ) –

    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.

  • next_token (Optional[NextToken], default: None ) –

    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.

Raises:

Source code in docs_src/capo_route53resolver/_services/route53_resolver.py
def list_resolver_endpoint_ip_addresses(
    self,
    resolver_endpoint_id: "capo_route53resolver.types.resource_id.ResourceId",
    *,
    config_overrides: Optional[Route53ResolverClientConfig] = None,
    max_results: Optional[
        "capo_route53resolver.types.max_results.MaxResults"
    ] = None,
    next_token: Optional["capo_route53resolver.types.next_token.NextToken"] = None,
) -> "capo_route53resolver.types.list_resolver_endpoint_ip_addresses_response.ListResolverEndpointIpAddressesResponse":
    """<p>Gets the IP addresses for a specified Resolver endpoint.</p>

    Args:
        resolver_endpoint_id: <p>The ID of the Resolver endpoint that you want to get IP addresses for.</p>
        max_results: <p>The maximum number of IP addresses that you want to return in the response to a <code>ListResolverEndpointIpAddresses</code> request. If you don't specify a value for <code>MaxResults</code>, Resolver returns up to 100 IP addresses. </p>
        next_token: <p>For the first <code>ListResolverEndpointIpAddresses</code> request, omit this value.</p> <p>If the specified Resolver endpoint has more than <code>MaxResults</code> IP addresses, you can submit another <code>ListResolverEndpointIpAddresses</code> request to get the next group of IP addresses. In the next request, specify the value of <code>NextToken</code> from the previous response. </p>

    Raises:
        capo_route53resolver.errors.internal_service_error_exception.InternalServiceErrorException: <p>We encountered an unknown error. Try again in a few minutes.</p>
        capo_route53resolver.errors.invalid_next_token_exception.InvalidNextTokenException: <p>The value that you specified for <code>NextToken</code> in a <code>List</code> request isn't valid.</p>
        capo_route53resolver.errors.invalid_parameter_exception.InvalidParameterException: <p>One or more parameters in this request are not valid.</p>
        capo_route53resolver.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource doesn't exist.</p>
        capo_route53resolver.errors.throttling_exception.ThrottlingException: <p>The request was throttled. Try again in a few minutes.</p>
        capo_route53resolver.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_route53resolver.types.list_resolver_endpoint_ip_addresses_request.ListResolverEndpointIpAddressesRequest]",
    ) -> OperationResponse[
        "capo_route53resolver.types.list_resolver_endpoint_ip_addresses_response.ListResolverEndpointIpAddressesResponse"
    ]:
        import capo_route53resolver._operations.route53_resolver.list_resolver_endpoint_ip_addresses

        output, http_response = (
            capo_route53resolver._operations.route53_resolver.list_resolver_endpoint_ip_addresses.list_resolver_endpoint_ip_addresses(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListResolverEndpointIpAddresses")
    )
    input_: capo_route53resolver.types.list_resolver_endpoint_ip_addresses_request.ListResolverEndpointIpAddressesRequest = {
        "resolver_endpoint_id": resolver_endpoint_id
    }
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output