EventBridge / Client / describe_event_bus

describe_event_bus

EventBridge.Client.describe_event_bus(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.describe_event_bus(
    Name='string'
)

Parameters:

Name (string) – The name or ARN of the event bus to show details for. If you omit this, the default event bus is displayed.

Return type:

dict

Returns:

Response Syntax

{
    'Name': 'string',
    'Arn': 'string',
    'Policy': 'string'
}

Response Structure

• (dict) –

  • Name (string) –

    The name of the event bus. Currently, this is always default.

  • Arn (string) –

    The Amazon Resource Name (ARN) of the account permitted to write events to the current account.

  • Policy (string) –

    The policy that enables the external account to send events to your account.

Exceptions

• EventBridge.Client.exceptions.ResourceNotFoundException

• EventBridge.Client.exceptions.InternalException