Displays details about an event bus in your account. This can include the external Amazon Web Services accounts that are permitted to write events to your default event bus, and the associated policy. For custom event buses and partner event buses, it displays the name, ARN, policy, state, and creation time.
To enable your account to receive events from other accounts on its default event bus, use PutPermission.
For more information about partner event buses, see CreateEventBus.
Parameters:
-
name
(Optional[EventBusNameOrArn], default:
None
)
–
The name or ARN of the event bus to show details for. If you omit this, the default event bus is displayed.
Raises:
Source code in docs_src/capo_eventbridge/_services/async_event_bridge.py
| async def describe_event_bus(
self,
*,
config_overrides: Optional[AsyncEventBridgeClientConfig] = None,
name: Optional[
"capo_eventbridge.types.event_bus_name_or_arn.EventBusNameOrArn"
] = None,
) -> "capo_eventbridge.types.describe_event_bus_response.DescribeEventBusResponse":
"""<p>Displays details about an event bus in your account. This can include the external Amazon Web Services accounts that are permitted to write events to your default event bus, and the associated policy. For custom event buses and partner event buses, it displays the name, ARN, policy, state, and creation time.</p> <p> To enable your account to receive events from other accounts on its default event bus, use <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutPermission.html">PutPermission</a>.</p> <p>For more information about partner event buses, see <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_CreateEventBus.html">CreateEventBus</a>.</p>
Args:
name: <p>The name or ARN of the event bus to show details for. If you omit this, the default event bus is displayed.</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_event_bus_request.DescribeEventBusRequest]",
) -> AsyncOperationResponse[
"capo_eventbridge.types.describe_event_bus_response.DescribeEventBusResponse"
]:
import capo_eventbridge._operations.aws_events.describe_event_bus
(
output,
http_response,
) = await capo_eventbridge._operations.aws_events.describe_event_bus.async_describe_event_bus(
req.options, req.input
)
return AsyncOperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DescribeEventBus")
)
input_: capo_eventbridge.types.describe_event_bus_request.DescribeEventBusRequest = {}
if name is not None:
input_["name"] = name
response = await aexecute_pipeline(
AsyncOperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
await response.response.aclose()
return response.output
|