SecurityAgent / Client / describe_private_connection

describe_private_connection

SecurityAgent.Client.describe_private_connection(**kwargs)

Retrieves the details of a private connection.

See also: AWS API Documentation

Request Syntax

response = client.describe_private_connection(
    privateConnectionName='string'
)
Parameters:

privateConnectionName (string) –

[REQUIRED]

The name of the private connection to describe.

Return type:

dict

Returns:

Response Syntax

{
    'name': 'string',
    'type': 'SERVICE_MANAGED'|'SELF_MANAGED',
    'status': 'ACTIVE'|'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED',
    'resourceGatewayId': 'string',
    'hostAddress': 'string',
    'vpcId': 'string',
    'resourceConfigurationId': 'string',
    'certificateExpiryTime': datetime(2015, 1, 1),
    'dnsResolution': 'PUBLIC'|'IN_VPC',
    'failureMessage': 'string',
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) –

    • name (string) –

      The name of the private connection.

    • type (string) –

      The type of the private connection, indicating whether it is service-managed or self-managed.

    • status (string) –

      The current status of the private connection.

    • resourceGatewayId (string) –

      The identifier or ARN of the VPC Lattice resource gateway.

    • hostAddress (string) –

      The IP address or DNS name of the target resource.

    • vpcId (string) –

      The identifier of the VPC the resource gateway is created in.

    • resourceConfigurationId (string) –

      The identifier or ARN of the VPC Lattice resource configuration.

    • certificateExpiryTime (datetime) –

      The date and time the connection’s certificate expires, in UTC format.

    • dnsResolution (string) –

      The DNS resolution mode for the resource gateway.

    • failureMessage (string) –

      A message describing why the private connection entered a failed state, if applicable.

    • tags (dict) –

      The tags attached to the private connection.

      • (string) –

        Key for a resource tag.

        • (string) –

          Value for a resource tag.

Exceptions