EventBridgeV2 / Client / describe_event_source

describe_event_source

EventBridgeV2.Client.describe_event_source(**kwargs)

Returns the full configuration and lifecycle state of an EventSource.

See also: AWS API Documentation

Request Syntax

response = client.describe_event_source(
    EventSourceArn='string'
)
Parameters:

EventSourceArn (string) –

[REQUIRED]

EventSource ARN: event-sourcev2///. The type segment is set by the service (aws.service for AWS service events, aws.partner for partner events) and is not part of the resource’s name. The id segment is a 25-character identifier generated by the service.

Return type:

dict

Returns:

Response Syntax

{
    'EventSourceArn': 'string',
    'Name': 'string',
    'EventBusArn': 'string',
    'Configuration': {
        'AwsServiceEventsConfiguration': {
            'AwsService': 'string',
            'Pattern': 'string',
            'OnFailureConfiguration': {
                'Arn': 'string'
            }
        },
        'PartnerEventsConfiguration': {
            'PartnerEventSourceArn': 'string',
            'Pattern': 'string',
            'PartnerBusKmsKeyIdentifier': 'string',
            'OnFailureConfiguration': {
                'Arn': 'string'
            }
        }
    },
    'Description': 'string',
    'State': 'CREATING'|'ACTIVE'|'UPDATING'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETING'|'DELETE_FAILED',
    'Revoked': True|False,
    'CreationTime': datetime(2015, 1, 1),
    'LastModifiedTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    • EventSourceArn (string) –

      EventSource ARN: event-sourcev2///. The type segment is set by the service (aws.service for AWS service events, aws.partner for partner events) and is not part of the resource’s name. The id segment is a 25-character identifier generated by the service.

    • Name (string) –

      EventSource name. First character alphanumeric; the rest may add ‘.’, ‘-’, ‘_’. Names may not begin with the reserved “aws.” prefix. The grammar matches the ARN local-name segment in EventSourceArn (event-sourcev2///), mirroring EventBusName, so a name the ARN cannot represent cannot be created.

    • EventBusArn (string) –

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

    • Configuration (dict) –

      Discriminated EventSource configuration. Exactly one variant must be set.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: AwsServiceEventsConfiguration, PartnerEventsConfiguration. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

      • AwsServiceEventsConfiguration (dict) –

        Configuration for forwarding a single AWS service’s events from the account’s default event bus.

        • AwsService (string) –

          A single AWS service source identifier, e.g. “aws.s3”. Wildcards and lists are rejected.

        • Pattern (string) –

          A filter pattern, as a JSON string, that defines which of the service’s events are forwarded to the event bus. Do not include source, account, or region as top-level fields. If no pattern is specified, all events from the service are forwarded.

        • OnFailureConfiguration (dict) –

          The destination for events that could not be forwarded.

          • Arn (string) –

            The ARN of the destination that receives events that could not be delivered. An Amazon SQS queue is the supported destination.

      • PartnerEventsConfiguration (dict) –

        Configuration for forwarding a partner event source’s events through a managed partner event bus.

        • PartnerEventSourceArn (string) –

          ARN of the partner event source to forward. It is a partner-owned resource, so the account segment is empty: arn:aws:events:::event-source/aws.partner/.

        • Pattern (string) –

          A filter pattern, as a JSON string, that defines which of the partner event source’s events are forwarded to the event bus. If no pattern is specified, all events from the partner event source are forwarded.

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

        • OnFailureConfiguration (dict) –

          The destination for events that could not be forwarded, covering both the forwarding target and the managed partner event bus.

          • Arn (string) –

            The ARN of the destination that receives events that could not be delivered. An Amazon SQS queue is the supported destination.

    • Description (string) –

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

    • State (string) –

      Lifecycle state of an EventSource. Revocation is reported by the Revoked flag.

    • Revoked (boolean) –

      True when the bus owner has withdrawn this EventSource. Present only when true, so an absent member means the EventSource is not revoked. Revocation is terminal: it never returns to false. Mutating operations on a revoked EventSource fail with InvalidStateException, except DeleteEventSource, which stays available so a revoked EventSource can still be cleaned up.

    • CreationTime (datetime) –

      The time the EventSource was created.

    • LastModifiedTime (datetime) –

      The time the EventSource was last modified.

Exceptions