EventBridgeV2 / Client / describe_event_bus

describe_event_bus

EventBridgeV2.Client.describe_event_bus(**kwargs)

Returns the full configuration and lifecycle state of an event bus.

See also: AWS API Documentation

Request Syntax

response = client.describe_event_bus(
    EventBusArn='string'
)
Parameters:

EventBusArn (string) –

[REQUIRED]

The Amazon Resource Name (ARN) that uniquely identifies an event bus.

Return type:

dict

Returns:

Response Syntax

{
    'EventBusArn': 'string',
    'Name': 'string',
    'Description': 'string',
    'EncryptionConfiguration': {
        'KmsKeyIdentifier': 'string'
    },
    'StorageConfiguration': {
        'RetentionPeriodInDays': 123,
        'RetentionWindowStartTime': datetime(2015, 1, 1)
    },
    'CreationTime': datetime(2015, 1, 1),
    'LastModifiedTime': datetime(2015, 1, 1),
    'State': 'CREATING'|'CREATE_FAILED'|'UPDATING'|'UPDATE_FAILED'|'DELETING'|'ACTIVE'|'DELETE_FAILED',
    'StateReason': 'string'
}

Response Structure

  • (dict) –

    • EventBusArn (string) –

      The Amazon Resource Name (ARN) that uniquely identifies an event bus.

    • Name (string) –

      Name of an event bus. The first character must be alphanumeric; the remaining characters may also include ‘.’, ‘-’, and ‘_’. The grammar matches the name segment of EventBusArn (event-busv2//), so every valid name can be represented in the bus’s ARN. The same type is used everywhere a bus name appears.

    • Description (string) –

      Free-text description. Used by every resource type that has one: event buses, subscribers, and event sources.

    • EncryptionConfiguration (dict) –

      Encryption configuration for an event bus.

      • KmsKeyIdentifier (string) –

        Identifier of the AWS KMS customer managed key used to encrypt events: a key ID, key ARN, alias name, or alias ARN. When absent, events are encrypted with an AWS owned key.

    • StorageConfiguration (dict) –

      Event storage configuration of an event bus, as returned on reads.

      • RetentionPeriodInDays (integer) –

        Number of days events are retained on the event bus.

      • RetentionWindowStartTime (datetime) –

        The earliest point in time from which stored events are available. Events older than this have expired from retention.

    • CreationTime (datetime) –

      The time the event bus was created.

    • LastModifiedTime (datetime) –

      The time the event bus was last modified.

    • State (string) –

      Lifecycle state of an event bus.

      • CREATING: Bus creation is in progress.

      • CREATE_FAILED: Bus creation failed; see StateReason. The bus cannot be recovered or recreated in place: delete it with DeleteEventBus, then create a new bus.

      • ACTIVE: Bus is fully operational and can accept events.

      • UPDATING: Bus update is in progress.

      • UPDATE_FAILED: Bus update failed; the bus remains operational with its previous configuration.

      • DELETING: Bus deletion is actively in progress.

      • DELETE_FAILED: Bus deletion failed; see StateReason. Retry DeleteEventBus after removing subscribers and event sources.

    • StateReason (string) –

      Human-readable explanation of why an event bus is in its current State. Omitted when the bus is in a normal operational state (ACTIVE). It stands in for the error response an asynchronous failure cannot return, so it applies only to resources with an asynchronous lifecycle: event buses. EventSources and subscribers are provisioned synchronously and report failures directly on the request.

Exceptions