Kafka / Client / describe_vpc_connection

describe_vpc_connection

Kafka.Client.describe_vpc_connection(**kwargs)

Returns a description of this MSK VPC connection.

See also: AWS API Documentation

Request Syntax

response = client.describe_vpc_connection(
    Arn='string'
)
Parameters:

Arn (string) –

[REQUIRED]

The Amazon Resource Name (ARN) that uniquely identifies a MSK VPC connection.

Return type:

dict

Returns:

Response Syntax

{
    'VpcConnectionArn': 'string',
    'TargetClusterArn': 'string',
    'State': 'CREATING'|'AVAILABLE'|'INACTIVE'|'DEACTIVATING'|'DELETING'|'FAILED'|'REJECTED'|'REJECTING',
    'Authentication': 'string',
    'VpcId': 'string',
    'Subnets': [
        'string',
    ],
    'SecurityGroups': [
        'string',
    ],
    'CreationTime': datetime(2015, 1, 1),
    'Tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) –

    200 response

    • VpcConnectionArn (string) –

      The Amazon Resource Name (ARN) that uniquely identifies a MSK VPC connection.

    • TargetClusterArn (string) –

      The Amazon Resource Name (ARN) that uniquely identifies an MSK cluster.

    • State (string) –

      The state of VPC connection.

    • Authentication (string) –

      The authentication type of VPC connection.

    • VpcId (string) –

      The VPC Id for the VPC connection.

    • Subnets (list) –

      The list of subnets for the VPC connection.

      • (string) –

    • SecurityGroups (list) –

      The list of security groups for the VPC connection.

      • (string) –

    • CreationTime (datetime) –

      The creation time of the VPC connection.

    • Tags (dict) –

      A map of tags for the VPC connection.

      • (string) –

        • (string) –

Exceptions