VPCLattice / Client / get_service_network_vpc_association

get_service_network_vpc_association

VPCLattice.Client.get_service_network_vpc_association(**kwargs)

Retrieves information about the specified association between a service network and a VPC.

See also: AWS API Documentation

Request Syntax

response = client.get_service_network_vpc_association(
    serviceNetworkVpcAssociationIdentifier='string'
)
Parameters:

serviceNetworkVpcAssociationIdentifier (string) –

[REQUIRED]

The ID or ARN of the association.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • id (string) –

      The ID of the association.

    • status (string) –

      The status of the association.

    • arn (string) –

      The Amazon Resource Name (ARN) of the association.

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

    • vpcId (string) –

      The ID of the VPC.

    • securityGroupIds (list) –

      The IDs of the security groups.

      • (string) –

    • privateDnsEnabled (boolean) –

      Indicates if private DNS is enabled in the VPC association.

    • failureMessage (string) –

      The failure message.

    • failureCode (string) –

      The failure code.

    • lastUpdatedAt (datetime) –

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

    • dnsOptions (dict) –

      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) –

Exceptions