EventBridge / Client / list_partner_event_sources

list_partner_event_sources#

EventBridge.Client.list_partner_event_sources(**kwargs)#

An SaaS partner can use this operation to list all the partner event source names that they have created. This operation is not used by Amazon Web Services customers.

See also: AWS API Documentation

Request Syntax

response = client.list_partner_event_sources(
    NamePrefix='string',
    NextToken='string',
    Limit=123
)
Parameters:

  • NamePrefix (string) –

    [REQUIRED]

    If you specify this, the results are limited to only those partner event sources that start with the string you specify.

  • NextToken (string) – The token returned by a previous call to this operation. Specifying this retrieves the next set of results.

  • Limit (integer) – pecifying 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.

Return type:

dict

Returns:

Response Syntax

{
    'PartnerEventSources': [
        {
            'Arn': 'string',
            'Name': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • PartnerEventSources (list) –

      The list of partner event sources returned by the operation.

      • (dict) –

        A partner event source is created by an SaaS partner. If a customer creates a partner event bus that matches this event source, that Amazon Web Services account can receive events from the partner’s applications or services.

        • Arn (string) –

          The ARN of the partner event source.

        • Name (string) –

          The name of the partner event source.

    • NextToken (string) –

      A token you can use in a subsequent operation to retrieve the next set of results.

Exceptions

  • EventBridge.Client.exceptions.InternalException

  • EventBridge.Client.exceptions.OperationDisabledException