describe_endpoint `async` ¶

describe_endpoint(
    name: EndpointName,
    *,
    config_overrides: Optional[AsyncEventBridgeClientConfig] = None,
    home_region: Optional[HomeRegion] = None,
) -> DescribeEndpointResponse

Get the information about an existing global endpoint. 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 (EndpointName) –

The name of the endpoint you want to get information about. For example, "Name":"us-east-2-custom_bus_A-endpoint".
home_region (Optional[HomeRegion], default: None ) –

The primary Region of the endpoint you want to get information about. For example "HomeRegion": "us-east-1".

Raises:

InternalException –

This exception occurs due to unexpected causes.
ResourceNotFoundException –

An entity that you specified does not exist.
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 describe_endpoint(
    self,
    name: "capo_eventbridge.types.endpoint_name.EndpointName",
    *,
    config_overrides: Optional[AsyncEventBridgeClientConfig] = None,
    home_region: Optional["capo_eventbridge.types.home_region.HomeRegion"] = None,
) -> "capo_eventbridge.types.describe_endpoint_response.DescribeEndpointResponse":
    """<p>Get the information about an existing global endpoint. 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: <p>The name of the endpoint you want to get information about. For example, <code>"Name":"us-east-2-custom_bus_A-endpoint"</code>.</p>
        home_region: <p>The primary Region of the endpoint you want to get information about. For example <code>"HomeRegion": "us-east-1"</code>.</p>

    Raises:
        capo_eventbridge.errors.internal_exception.InternalException: <p>This exception occurs due to unexpected causes.</p>
        capo_eventbridge.errors.resource_not_found_exception.ResourceNotFoundException: <p>An entity that you specified does not exist.</p>
        capo_eventbridge.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_eventbridge.types.describe_endpoint_request.DescribeEndpointRequest]",
    ) -> AsyncOperationResponse[
        "capo_eventbridge.types.describe_endpoint_response.DescribeEndpointResponse"
    ]:
        import capo_eventbridge._operations.aws_events.describe_endpoint

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeEndpoint")
    )
    input_: capo_eventbridge.types.describe_endpoint_request.DescribeEndpointRequest = {
        "name": name
    }
    if home_region is not None:
        input_["home_region"] = home_region

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

describe_endpoint async ¶

describe_endpoint `async` ¶