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',
    'Description': 'string',
    'KmsKeyIdentifier': 'string',
    'DeadLetterConfig': {
        'Arn': 'string'
    },
    'Policy': 'string',
    'CreationTime': datetime(2015, 1, 1),
    'LastModifiedTime': datetime(2015, 1, 1)
}

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.

    • Description (string) –

      The event bus description.

    • KmsKeyIdentifier (string) –

      The identifier of the KMS customer managed key for EventBridge to use to encrypt events on this event bus, if one has been specified.

      For more information, see Data encryption in EventBridge in the Amazon EventBridge User Guide.

    • DeadLetterConfig (dict) –

      Configuration details of the Amazon SQS queue for EventBridge to use as a dead-letter queue (DLQ).

      For more information, see Using dead-letter queues to process undelivered events in the EventBridge User Guide.

      • Arn (string) –

        The ARN of the SQS queue specified as the target for the dead-letter queue.

    • Policy (string) –

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

    • CreationTime (datetime) –

      The time the event bus was created.

    • LastModifiedTime (datetime) –

      The time the event bus was last modified.

Exceptions

  • EventBridge.Client.exceptions.ResourceNotFoundException

  • EventBridge.Client.exceptions.InternalException