KafkaConnect / Client / describe_worker_configuration

describe_worker_configuration#

KafkaConnect.Client.describe_worker_configuration(**kwargs)#

Returns information about a worker configuration.

Request Syntax

response = client.describe_worker_configuration(
    workerConfigurationArn='string'
)

Parameters:

workerConfigurationArn (string) –

[REQUIRED]

The Amazon Resource Name (ARN) of the worker configuration that you want to get information about.

Return type:

dict

Returns:

Response Syntax

{
    'creationTime': datetime(2015, 1, 1),
    'description': 'string',
    'latestRevision': {
        'creationTime': datetime(2015, 1, 1),
        'description': 'string',
        'propertiesFileContent': 'string',
        'revision': 123
    },
    'name': 'string',
    'workerConfigurationArn': 'string',
    'workerConfigurationState': 'ACTIVE'|'DELETING'
}

Response Structure

(dict) –
- creationTime (datetime) –
  
  The time that the worker configuration was created.
- description (string) –
  
  The description of the worker configuration.
- latestRevision (dict) –
  
  The latest revision of the custom configuration.
  - creationTime (datetime) –
    
    The time that the worker configuration was created.
  - description (string) –
    
    The description of the worker configuration revision.
  - propertiesFileContent (string) –
    
    Base64 encoded contents of the connect-distributed.properties file.
  - revision (integer) –
    
    The description of a revision of the worker configuration.
- name (string) –
  
  The name of the worker configuration.
- workerConfigurationArn (string) –
  
  The Amazon Resource Name (ARN) of the custom configuration.
- workerConfigurationState (string) –
  
  The state 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