SecurityAgent / Paginator / ListPrivateConnections

ListPrivateConnections

class SecurityAgent.Paginator.ListPrivateConnections

paginator = client.get_paginator('list_private_connections')

paginate(**kwargs)

Creates an iterator that will paginate through responses from SecurityAgent.Client.list_private_connections().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

PaginationConfig (dict) –

A dictionary that provides parameters to control pagination.

• MaxItems (integer) –

  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

• PageSize (integer) –

  The size of each page.

• StartingToken (string) –

  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'privateConnections': [
        {
            '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'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • privateConnections (list) –

    The list of private connections.

    • (dict) –

      Summarizes a private connection.

      • 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.

  • NextToken (string) –

    A token to resume pagination.