Amazon EventBridge

{'ManagedBy': 'string'}

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

client.describe_event_bus(
    Name='string'
)

type Name:

string

param Name:

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

rtype:

dict

returns:

Response Syntax

{
    'Name': 'string',
    'Arn': 'string',
    'Description': 'string',
    'KmsKeyIdentifier': 'string',
    'DeadLetterConfig': {
        'Arn': 'string'
    },
    'Policy': 'string',
    'LogConfig': {
        'IncludeDetail': 'NONE'|'FULL',
        'Level': 'OFF'|'ERROR'|'INFO'|'TRACE'
    },
    'CreationTime': datetime(2015, 1, 1),
    'LastModifiedTime': datetime(2015, 1, 1),
    'ManagedBy': '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.

  • 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.

  • LogConfig (dict) --

    The logging configuration settings for the event bus.

    For more information, see Configuring logs for event buses in the EventBridge User Guide.

    • IncludeDetail (string) --

      Whether EventBridge include detailed event information in the records it generates. Detailed data can be useful for troubleshooting and debugging. This information includes details of the event itself, as well as target details.

      For more information, see Including detail data in event bus logs in the EventBridge User Guide.

    • Level (string) --

      The level of logging detail to include. This applies to all log destinations for the event bus.

      For more information, see Specifying event bus log level in the EventBridge User Guide.

  • CreationTime (datetime) --

    The time the event bus was created.

  • LastModifiedTime (datetime) --

    The time the event bus was last modified.

  • ManagedBy (string) --

    If the event bus was created on behalf of your account by an Amazon Web Services service, this field displays the principal name of the service that created the event bus.

{'EventBuses': {'ManagedBy': 'string'}}

Lists all the event buses in your account, including the default event bus, custom event buses, and partner event buses.

See also: AWS API Documentation

Request Syntax

client.list_event_buses(
    NamePrefix='string',
    NextToken='string',
    Limit=123
)

type NamePrefix:

string

param NamePrefix:

Specifying this limits the results to only those event buses with names that start with the specified prefix.

type NextToken:

string

param NextToken:

The token returned by a previous call, which you can use to retrieve the next set of results.

The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.

Using an expired pagination token results in an HTTP 400 InvalidToken error.

type Limit:

integer

param Limit:

Specifying this limits the number of results returned by this operation. The operation also returns a NextToken which you can use in a subsequent operation to retrieve the next set of results.

rtype:

dict

returns:

Response Syntax

{
    'EventBuses': [
        {
            'Name': 'string',
            'Arn': 'string',
            'Description': 'string',
            'Policy': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'LastModifiedTime': datetime(2015, 1, 1),
            'ManagedBy': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • EventBuses (list) --

    This list of event buses.

    • (dict) --

      An event bus receives events from a source, uses rules to evaluate them, applies any configured input transformation, and routes them to the appropriate target(s). Your account's default event bus receives events from Amazon Web Services services. A custom event bus can receive events from your custom applications and services. A partner event bus receives events from an event source created by an SaaS partner. These events come from the partners services or applications.

      • Name (string) --

        The name of the event bus.

      • Arn (string) --

        The ARN of the event bus.

      • Description (string) --

        The event bus description.

      • Policy (string) --

        The permissions policy of the event bus, describing which other Amazon Web Services accounts can write events to this event bus.

      • CreationTime (datetime) --

        The time the event bus was created.

      • LastModifiedTime (datetime) --

        The time the event bus was last modified.

      • ManagedBy (string) --

        If the event bus was created on behalf of your account by an Amazon Web Services service, this field displays the principal name of the service that created the event bus.

  • NextToken (string) --

    A token indicating there are more results available. If there are no more results, no token is included in the response.

    The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.

    Using an expired pagination token results in an HTTP 400 InvalidToken error.