Skip to content

list_resolver_endpoints async

list_resolver_endpoints(
    *,
    config_overrides: Optional[AsyncRoute53ResolverClientConfig] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[NextToken] = None,
    filters: Optional[Filters] = None,
) -> ListResolverEndpointsResponse

Lists all the Resolver endpoints that were created using the current Amazon Web Services account.

Parameters:

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

    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.

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

    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 (Optional[Filters], default: None ) –

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

    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.

Raises:

Source code in docs_src/capo_route53resolver/_services/async_route53_resolver.py
async def list_resolver_endpoints(
    self,
    *,
    config_overrides: Optional[AsyncRoute53ResolverClientConfig] = None,
    max_results: Optional[
        "capo_route53resolver.types.max_results.MaxResults"
    ] = None,
    next_token: Optional["capo_route53resolver.types.next_token.NextToken"] = None,
    filters: Optional["capo_route53resolver.types.filters.Filters"] = None,
) -> "capo_route53resolver.types.list_resolver_endpoints_response.ListResolverEndpointsResponse":
    """<p>Lists all the Resolver endpoints that were created using the current Amazon Web Services account.</p>

    Args:
        max_results: <p>The maximum number of Resolver endpoints that you want to return in the response to a <code>ListResolverEndpoints</code> request. If you don't specify a value for <code>MaxResults</code>, Resolver returns up to 100 Resolver endpoints. </p>
        next_token: <p>For the first <code>ListResolverEndpoints</code> request, omit this value.</p> <p>If you have more than <code>MaxResults</code> Resolver endpoints, you can submit another <code>ListResolverEndpoints</code> request to get the next group of Resolver endpoints. In the next request, specify the value of <code>NextToken</code> from the previous response. </p>
        filters: <p>An optional specification to return a subset of Resolver endpoints, such as all inbound Resolver endpoints.</p> <note> <p>If you submit a second or subsequent <code>ListResolverEndpoints</code> request and specify the <code>NextToken</code> parameter, you must use the same values for <code>Filters</code>, if any, as in the previous request.</p> </note>

    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.invalid_request_exception.InvalidRequestException: <p>The request is invalid.</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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_route53resolver.types.list_resolver_endpoints_request.ListResolverEndpointsRequest]",
    ) -> AsyncOperationResponse[
        "capo_route53resolver.types.list_resolver_endpoints_response.ListResolverEndpointsResponse"
    ]:
        import capo_route53resolver._operations.route53_resolver.list_resolver_endpoints

        (
            output,
            http_response,
        ) = await capo_route53resolver._operations.route53_resolver.list_resolver_endpoints.async_list_resolver_endpoints(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListResolverEndpoints")
    )
    input_: capo_route53resolver.types.list_resolver_endpoints_request.ListResolverEndpointsRequest = {}
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    if filters is not None:
        input_["filters"] = filters

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output