Skip to content

list_managed_endpoints async

list_managed_endpoints(
    virtual_cluster_id: ResourceIdString,
    *,
    config_overrides: Optional[AsyncEMRcontainersClientConfig] = None,
    created_before: Optional[Date] = None,
    created_after: Optional[Date] = None,
    types: Optional[EndpointTypes] = None,
    states: Optional[EndpointStates] = None,
    max_results: Optional[JavaInteger] = None,
    next_token: Optional[NextToken] = None,
) -> ListManagedEndpointsResponse

Lists managed endpoints based on a set of parameters. A managed endpoint is a gateway that connects Amazon EMR Studio to Amazon EMR on EKS so that Amazon EMR Studio can communicate with your virtual cluster.

Parameters:

  • virtual_cluster_id (ResourceIdString) –

    The ID of the virtual cluster.

  • created_before (Optional[Date], default: None ) –

    The date and time before which the endpoints are created.

  • created_after (Optional[Date], default: None ) –

    The date and time after which the endpoints are created.

  • types (Optional[EndpointTypes], default: None ) –

    The types of the managed endpoints.

  • states (Optional[EndpointStates], default: None ) –

    The states of the managed endpoints.

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

    The maximum number of managed endpoints that can be listed.

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

    The token for the next set of managed endpoints to return.

Raises:

Source code in docs_src/capo_emr_containers/_services/async_em_rcontainers.py
async def list_managed_endpoints(
    self,
    virtual_cluster_id: "capo_emr_containers.types.resource_id_string.ResourceIdString",
    *,
    config_overrides: Optional[AsyncEMRcontainersClientConfig] = None,
    created_before: Optional["capo_emr_containers.types.date.Date"] = None,
    created_after: Optional["capo_emr_containers.types.date.Date"] = None,
    types: Optional[
        "capo_emr_containers.types.endpoint_types.EndpointTypes"
    ] = None,
    states: Optional[
        "capo_emr_containers.types.endpoint_states.EndpointStates"
    ] = None,
    max_results: Optional[
        "capo_emr_containers.types.java_integer.JavaInteger"
    ] = None,
    next_token: Optional["capo_emr_containers.types.next_token.NextToken"] = None,
) -> "capo_emr_containers.types.list_managed_endpoints_response.ListManagedEndpointsResponse":
    """<p>Lists managed endpoints based on a set of parameters. A managed endpoint is a gateway that connects Amazon EMR Studio to Amazon EMR on EKS so that Amazon EMR Studio can communicate with your virtual cluster.</p>

    Args:
        virtual_cluster_id: <p>The ID of the virtual cluster.</p>
        created_before: <p>The date and time before which the endpoints are created.</p>
        created_after: <p> The date and time after which the endpoints are created.</p>
        types: <p>The types of the managed endpoints.</p>
        states: <p>The states of the managed endpoints.</p>
        max_results: <p>The maximum number of managed endpoints that can be listed.</p>
        next_token: <p> The token for the next set of managed endpoints to return. </p>

    Raises:
        capo_emr_containers.errors.internal_server_exception.InternalServerException: <p>This is an internal server exception.</p>
        capo_emr_containers.errors.validation_exception.ValidationException: <p>There are invalid parameters in the client request.</p>
        capo_emr_containers.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_emr_containers.types.list_managed_endpoints_request.ListManagedEndpointsRequest]",
    ) -> AsyncOperationResponse[
        "capo_emr_containers.types.list_managed_endpoints_response.ListManagedEndpointsResponse"
    ]:
        import capo_emr_containers._operations.aws_chicago_web_service.list_managed_endpoints

        (
            output,
            http_response,
        ) = await capo_emr_containers._operations.aws_chicago_web_service.list_managed_endpoints.async_list_managed_endpoints(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_emr_containers.types.list_managed_endpoints_response.ListManagedEndpointsResponse",
    ) -> dict[str, Any]:
        import capo_emr_containers.types.list_managed_endpoints_response

        return capo_emr_containers.types.list_managed_endpoints_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("ListManagedEndpoints", redact_output=_redact_output),
    )
    input_: capo_emr_containers.types.list_managed_endpoints_request.ListManagedEndpointsRequest = {
        "virtual_cluster_id": virtual_cluster_id
    }
    if created_before is not None:
        input_["created_before"] = created_before
    if created_after is not None:
        input_["created_after"] = created_after
    if types is not None:
        input_["types"] = types
    if states is not None:
        input_["states"] = states
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

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