Schemas / Client / list_discoverers

list_discoverers#

Schemas.Client.list_discoverers(**kwargs)#

List the discoverers.

See also: AWS API Documentation

Request Syntax

response = client.list_discoverers(
    DiscovererIdPrefix='string',
    Limit=123,
    NextToken='string',
    SourceArnPrefix='string'
)
Parameters:

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

  • Limit (integer) –

  • NextToken (string) – The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.

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

Return type:

dict

Returns:

Response Syntax

{
    'Discoverers': [
        {
            'DiscovererArn': 'string',
            'DiscovererId': 'string',
            'SourceArn': 'string',
            'State': 'STARTED'|'STOPPED',
            'CrossAccount': True|False,
            'Tags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': '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) –

    • NextToken (string) –

      The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.

Exceptions

  • Schemas.Client.exceptions.ServiceUnavailableException

  • Schemas.Client.exceptions.BadRequestException

  • Schemas.Client.exceptions.UnauthorizedException

  • Schemas.Client.exceptions.InternalServerErrorException

  • Schemas.Client.exceptions.ForbiddenException