VPCLattice / Paginator / ListServiceNetworkVpcAssociations

ListServiceNetworkVpcAssociations

class VPCLattice.Paginator.ListServiceNetworkVpcAssociations

paginator = client.get_paginator('list_service_network_vpc_associations')

paginate(**kwargs)

Creates an iterator that will paginate through responses from VPCLattice.Client.list_service_network_vpc_associations().

See also: AWS API Documentation

Request Syntax

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

Parameters:

• serviceNetworkIdentifier (string) – The ID or ARN of the service network.

• vpcIdentifier (string) – The ID or ARN of the VPC.

• 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

{
    'items': [
        {
            'id': 'string',
            'arn': 'string',
            'status': 'CREATE_IN_PROGRESS'|'ACTIVE'|'UPDATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'CREATE_FAILED'|'DELETE_FAILED'|'UPDATE_FAILED',
            'createdBy': 'string',
            'createdAt': datetime(2015, 1, 1),
            'serviceNetworkId': 'string',
            'serviceNetworkName': 'string',
            'serviceNetworkArn': 'string',
            'privateDnsEnabled': True|False,
            'dnsOptions': {
                'privateDnsPreference': 'VERIFIED_DOMAINS_ONLY'|'ALL_DOMAINS'|'VERIFIED_DOMAINS_AND_SPECIFIED_DOMAINS'|'SPECIFIED_DOMAINS_ONLY',
                'privateDnsSpecifiedDomains': [
                    'string',
                ]
            },
            'vpcId': 'string',
            'lastUpdatedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • items (list) –

    Information about the associations.

    • (dict) –

      Summary information about an association between a service network and a VPC.

      • id (string) –

        The ID of the association.

      • arn (string) –

        The Amazon Resource Name (ARN) of the association.

      • status (string) –

        The status.

      • createdBy (string) –

        The account that created the association.

      • createdAt (datetime) –

        The date and time that the association was created, in ISO-8601 format.

      • serviceNetworkId (string) –

        The ID of the service network.

      • serviceNetworkName (string) –

        The name of the service network.

      • serviceNetworkArn (string) –

        The Amazon Resource Name (ARN) of the service network.

      • privateDnsEnabled (boolean) –

        Indicates if private DNS is enabled for the service network VPC association.

      • dnsOptions (dict) –

        The DNS options for the service network VPC association.

        • privateDnsPreference (string) –

          The preference for which private domains have a private hosted zone created for and associated with the specified VPC. Only supported when private DNS is enabled and when the VPC endpoint type is ServiceNetwork or Resource.

          • ALL_DOMAINS - VPC Lattice provisions private hosted zones for all custom domain names.

          • VERIFIED_DOMAINS_ONLY - VPC Lattice provisions a private hosted zone only if custom domain name has been verified by the provider.

          • VERIFIED_DOMAINS_AND_SPECIFIED_DOMAINS - VPC Lattice provisions private hosted zones for all verified custom domain names and other domain names that the resource consumer specifies. The resource consumer specifies the domain names in the privateDnsSpecifiedDomains parameter.

          • SPECIFIED_DOMAINS_ONLY - VPC Lattice provisions a private hosted zone for domain names specified by the resource consumer. The resource consumer specifies the domain names in the privateDnsSpecifiedDomains parameter.

        • privateDnsSpecifiedDomains (list) –

          Indicates which of the private domains to create private hosted zones for and associate with the specified VPC. Only supported when private DNS is enabled and the private DNS preference is VERIFIED_DOMAINS_AND_SPECIFIED_DOMAINS or SPECIFIED_DOMAINS_ONLY.

          • (string) –

      • vpcId (string) –

        The ID of the VPC.

      • lastUpdatedAt (datetime) –

        The date and time that the association was last updated, in ISO-8601 format.

  • NextToken (string) –

    A token to resume pagination.