list_worker_configurations

KafkaConnect.Client.list_worker_configurations(**kwargs)

Returns a list of all of the worker configurations in this account and Region.

See also: AWS API Documentation

Request Syntax

response = client.list_worker_configurations(
    maxResults=123,
    nextToken='string'
)

Parameters

• maxResults (integer) -- The maximum number of worker configurations to list in one response.
• nextToken (string) -- If the response of a ListWorkerConfigurations operation is truncated, it will include a NextToken. Send this NextToken in a subsequent request to continue listing from where the previous operation left off.

Return type

dict

Returns

Response Syntax

{
    'nextToken': 'string',
    'workerConfigurations': [
        {
            'creationTime': datetime(2015, 1, 1),
            'description': 'string',
            'latestRevision': {
                'creationTime': datetime(2015, 1, 1),
                'description': 'string',
                'revision': 123
            },
            'name': 'string',
            'workerConfigurationArn': 'string'
        },
    ]
}

Response Structure

• (dict) --

  • nextToken (string) --

    If the response of a ListWorkerConfigurations operation is truncated, it will include a NextToken. Send this NextToken in a subsequent request to continue listing from where the previous operation left off.

  • workerConfigurations (list) --

    An array of worker configuration descriptions.

    • (dict) --

      The summary of a worker configuration.

      • creationTime (datetime) --

        The time that a worker configuration was created.

      • description (string) --

        The description of a worker configuration.

      • latestRevision (dict) --

        The latest revision of a worker configuration.

        • creationTime (datetime) --

          The time that a worker configuration revision was created.

        • description (string) --

          The description of a worker configuration revision.

        • revision (integer) --

          The revision of a worker configuration.

      • name (string) --

        The name of the worker configuration.

      • workerConfigurationArn (string) --

        The Amazon Resource Name (ARN) of the worker configuration.

Exceptions

• KafkaConnect.Client.exceptions.NotFoundException
• KafkaConnect.Client.exceptions.BadRequestException
• KafkaConnect.Client.exceptions.ForbiddenException
• KafkaConnect.Client.exceptions.ServiceUnavailableException
• KafkaConnect.Client.exceptions.TooManyRequestsException
• KafkaConnect.Client.exceptions.UnauthorizedException
• KafkaConnect.Client.exceptions.InternalServerErrorException