EventBridgeV2 / Client / list_subscribers

list_subscribers

EventBridgeV2.Client.list_subscribers(**kwargs)

Lists subscribers as summaries. By default the list spans the subscribers the caller account owns across all buses; set EventBusArn to scope it to one bus. Use DescribeSubscriber to retrieve full configuration.

See also: AWS API Documentation

Request Syntax

response = client.list_subscribers(
    EventBusArn='string',
    NamePrefix='string',
    NextToken='string',
    MaxResults=123
)
Parameters:

  • EventBusArn (string) – The Amazon Resource Name (ARN) that uniquely identifies an event bus.

  • NamePrefix (string) – Name of a subscriber. The first character must be alphanumeric; the remaining characters may also include ‘.’, ‘-’, and ‘_’.

  • NextToken (string) – Opaque pagination token returned by a List operation. Pass it back in the next request to retrieve the next page of results.

  • MaxResults (integer) – Maximum number of results to return in one page of a List operation.

Return type:

dict

Returns:

Response Syntax

{
    'Subscribers': [
        {
            'SubscriberArn': 'string',
            'Name': 'string',
            'EventBusArn': 'string',
            'TargetArn': 'string',
            'Type': 'FIFO'|'UNORDERED',
            'Revoked': True|False,
            'State': 'RUNNING'|'STOPPED',
            'CreationTime': datetime(2015, 1, 1),
            'LastModifiedTime': datetime(2015, 1, 1),
            'SubscriberAccountId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Subscribers (list) –

      List of subscriber summaries.

      • (dict) –

        Summary of a subscriber, as returned by ListSubscribers.

        • SubscriberArn (string) –

          The Amazon Resource Name (ARN) that uniquely identifies a subscriber.

        • Name (string) –

          Name of a subscriber. The first character must be alphanumeric; the remaining characters may also include ‘.’, ‘-’, and ‘_’.

        • EventBusArn (string) –

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

        • TargetArn (string) –

          ARN of the target a subscriber invokes. The resource grammar is service-neutral because target services use different separators and the USI form omits region and account.

        • Type (string) –

          Delivery ordering mode of a subscriber: FIFO delivers events in order within an event group; UNORDERED delivers without an ordering guarantee.

        • Revoked (boolean) –

          True when the bus owner has revoked this subscriber. Present only when true, so a bus owner listing subscribers sees at a glance which ones they revoked. See DescribeSubscriberResponse$Revoked.

        • State (string) –

          Customer-controlled run state of a subscriber, set on create or update. Distinct from the bus lifecycle vocabulary, where ACTIVE means “provisioned and healthy”. Delivery requires State RUNNING on a subscriber that is not revoked.

        • CreationTime (datetime) –

          The time the subscriber was created.

        • LastModifiedTime (datetime) –

          The time the subscriber was last modified.

        • SubscriberAccountId (string) –

          AWS Account Id.

    • NextToken (string) –

      Opaque pagination token returned by a List operation. Pass it back in the next request to retrieve the next page of results.

Exceptions