list_endpoints `async` ¶

list_endpoints(
    *,
    config_overrides: Optional[AsyncEventBridgeClientConfig] = None,
    name_prefix: Optional[EndpointName] = None,
    home_region: Optional[HomeRegion] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[LimitMax100] = None,
) -> ListEndpointsResponse

List the global endpoints associated with this account. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide .

Parameters:

name_prefix (Optional[EndpointName], default: None ) –

A value that will return a subset of the endpoints associated with this account. For example, "NamePrefix": "ABC" will return all endpoints with "ABC" in the name.
home_region (Optional[HomeRegion], default: None ) –

The primary Region of the endpoints associated with this account. For example "HomeRegion": "us-east-1".
next_token (Optional[NextToken], default: None ) –

The token returned by a previous call, which you can use to retrieve the next set of results.

The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.

Using an expired pagination token results in an HTTP 400 InvalidToken error.
max_results (Optional[LimitMax100], default: None ) –

The maximum number of results returned by the call.

Raises:

InternalException –

This exception occurs due to unexpected causes.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_eventbridge/_services/async_event_bridge.py

async def list_endpoints(
    self,
    *,
    config_overrides: Optional[AsyncEventBridgeClientConfig] = None,
    name_prefix: Optional[
        "capo_eventbridge.types.endpoint_name.EndpointName"
    ] = None,
    home_region: Optional["capo_eventbridge.types.home_region.HomeRegion"] = None,
    next_token: Optional["capo_eventbridge.types.next_token.NextToken"] = None,
    max_results: Optional["capo_eventbridge.types.limit_max100.LimitMax100"] = None,
) -> "capo_eventbridge.types.list_endpoints_response.ListEndpointsResponse":
    """<p>List the global endpoints associated with this account. For more information about global endpoints, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-global-endpoints.html">Making applications Regional-fault tolerant with global endpoints and event replication</a> in the <i> <i>Amazon EventBridge User Guide</i> </i>.</p>

    Args:
        name_prefix: <p>A value that will return a subset of the endpoints associated with this account. For example, <code>"NamePrefix": "ABC"</code> will return all endpoints with "ABC" in the name.</p>
        home_region: <p>The primary Region of the endpoints associated with this account. For example <code>"HomeRegion": "us-east-1"</code>.</p>
        next_token: <p>The token returned by a previous call, which you can use to retrieve the next set of results.</p> <p>The value of <code>nextToken</code> is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.</p> <p> Using an expired pagination token results in an <code>HTTP 400 InvalidToken</code> error.</p>
        max_results: <p>The maximum number of results returned by the call.</p>

    Raises:
        capo_eventbridge.errors.internal_exception.InternalException: <p>This exception occurs due to unexpected causes.</p>
        capo_eventbridge.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_eventbridge.types.list_endpoints_request.ListEndpointsRequest]",
    ) -> AsyncOperationResponse[
        "capo_eventbridge.types.list_endpoints_response.ListEndpointsResponse"
    ]:
        import capo_eventbridge._operations.aws_events.list_endpoints

        (
            output,
            http_response,
        ) = await capo_eventbridge._operations.aws_events.list_endpoints.async_list_endpoints(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListEndpoints")
    )
    input_: capo_eventbridge.types.list_endpoints_request.ListEndpointsRequest = {}
    if name_prefix is not None:
        input_["name_prefix"] = name_prefix
    if home_region is not None:
        input_["home_region"] = home_region
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

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

list_endpoints async ¶

list_endpoints `async` ¶