describe_event_source

EventBridge.Client.describe_event_source(**kwargs)

This operation lists details about a partner event source that is shared with your account.

See also: AWS API Documentation

Request Syntax

response = client.describe_event_source(
    Name='string'
)
Parameters
Name (string) --

[REQUIRED]

The name of the partner event source to display the details of.

Return type
dict
Returns
Response Syntax
{
    'Arn': 'string',
    'CreatedBy': 'string',
    'CreationTime': datetime(2015, 1, 1),
    'ExpirationTime': datetime(2015, 1, 1),
    'Name': 'string',
    'State': 'PENDING'|'ACTIVE'|'DELETED'
}

Response Structure

  • (dict) --
    • Arn (string) --

      The ARN of the partner event source.

    • CreatedBy (string) --

      The name of the SaaS partner that created the event source.

    • CreationTime (datetime) --

      The date and time that the event source was created.

    • ExpirationTime (datetime) --

      The date and time that the event source will expire if you do not create a matching event bus.

    • Name (string) --

      The name of the partner event source.

    • State (string) --

      The state of the event source. If it is ACTIVE, you have already created a matching event bus for this event source, and that event bus is active. If it is PENDING, either you haven't yet created a matching event bus, or that event bus is deactivated. If it is DELETED, you have created a matching event bus, but the event source has since been deleted.

Exceptions

  • EventBridge.Client.exceptions.ResourceNotFoundException
  • EventBridge.Client.exceptions.InternalException
  • EventBridge.Client.exceptions.OperationDisabledException