Schemas / Paginator / ListDiscoverers

ListDiscoverers

class Schemas.Paginator.ListDiscoverers

paginator = client.get_paginator('list_discoverers')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Schemas.Client.list_discoverers().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    DiscovererIdPrefix='string',
    SourceArnPrefix='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• DiscovererIdPrefix (string) – Specifying this limits the results to only those discoverer IDs that start with the specified prefix.

• SourceArnPrefix (string) – Specifying this limits the results to only those ARNs that start with the specified prefix.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'Discoverers': [
        {
            'DiscovererArn': 'string',
            'DiscovererId': 'string',
            'SourceArn': 'string',
            'State': 'STARTED'|'STOPPED',
            'CrossAccount': True|False,
            'Tags': {
                'string': 'string'
            }
        },
    ],

}

Response Structure

• (dict) –

  200 response

  • Discoverers (list) –

    An array of DiscovererSummary information.

    • (dict) –

      • DiscovererArn (string) –

        The ARN of the discoverer.

      • DiscovererId (string) –

        The ID of the discoverer.

      • SourceArn (string) –

        The ARN of the event bus.

      • State (string) –

        The state of the discoverer.

      • CrossAccount (boolean) –

        The Status if the discoverer will discover schemas from events sent from another account.

      • Tags (dict) –

        Tags associated with the resource.

        • (string) –

          • (string) –