EC2 / Client / describe_vpc_endpoint_connections

describe_vpc_endpoint_connections

EC2.Client.describe_vpc_endpoint_connections(**kwargs)

Describes the VPC endpoint connections to your VPC endpoint services, including any endpoints that are pending your acceptance.

See also: AWS API Documentation

Request Syntax

response = client.describe_vpc_endpoint_connections(
    DryRun=True|False,
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NextToken='string'
)

Parameters:

• DryRun (boolean) – Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

• Filters (list) –

  The filters.

  • ip-address-type - The IP address type ( ipv4 | ipv6).

  • service-id - The ID of the service.

  • vpc-endpoint-owner - The ID of the Amazon Web Services account ID that owns the endpoint.

  • vpc-endpoint-region - The Region of the endpoint or cross-region to find endpoints for other Regions.

  • vpc-endpoint-state - The state of the endpoint ( pendingAcceptance | pending | available | deleting | deleted | rejected | failed).

  • vpc-endpoint-id - The ID of the endpoint.

  • (dict) –

    A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

    If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.

    For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.

    • Name (string) –

      The name of the filter. Filter names are case-sensitive.

    • Values (list) –

      The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

      • (string) –

• MaxResults (integer) – The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1,000; if MaxResults is given a value larger than 1,000, only 1,000 results are returned.

• NextToken (string) – The token to retrieve the next page of results.

Return type:

dict

Returns:

Response Syntax

{
    'VpcEndpointConnections': [
        {
            'ServiceId': 'string',
            'VpcEndpointId': 'string',
            'VpcEndpointOwner': 'string',
            'VpcEndpointState': 'PendingAcceptance'|'Pending'|'Available'|'Deleting'|'Deleted'|'Rejected'|'Failed'|'Expired'|'Partial',
            'CreationTimestamp': datetime(2015, 1, 1),
            'DnsEntries': [
                {
                    'DnsName': 'string',
                    'HostedZoneId': 'string'
                },
            ],
            'NetworkLoadBalancerArns': [
                'string',
            ],
            'GatewayLoadBalancerArns': [
                'string',
            ],
            'IpAddressType': 'ipv4'|'dualstack'|'ipv6',
            'VpcEndpointConnectionId': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'VpcEndpointRegion': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • VpcEndpointConnections (list) –

    Information about the VPC endpoint connections.

    • (dict) –

      Describes a VPC endpoint connection to a service.

      • ServiceId (string) –

        The ID of the service to which the endpoint is connected.

      • VpcEndpointId (string) –

        The ID of the VPC endpoint.

      • VpcEndpointOwner (string) –

        The ID of the Amazon Web Services account that owns the VPC endpoint.

      • VpcEndpointState (string) –

        The state of the VPC endpoint.

      • CreationTimestamp (datetime) –

        The date and time that the VPC endpoint was created.

      • DnsEntries (list) –

        The DNS entries for the VPC endpoint.

        • (dict) –

          Describes a DNS entry.

          • DnsName (string) –

            The DNS name.

          • HostedZoneId (string) –

            The ID of the private hosted zone.

      • NetworkLoadBalancerArns (list) –

        The Amazon Resource Names (ARNs) of the network load balancers for the service.

        • (string) –

      • GatewayLoadBalancerArns (list) –

        The Amazon Resource Names (ARNs) of the Gateway Load Balancers for the service.

        • (string) –

      • IpAddressType (string) –

        The IP address type for the endpoint.

      • VpcEndpointConnectionId (string) –

        The ID of the VPC endpoint connection.

      • Tags (list) –

        The tags.

        • (dict) –

          Describes a tag.

          • Key (string) –

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.

          • Value (string) –

            The value of the tag.

            Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

      • VpcEndpointRegion (string) –

        The Region of the endpoint.

  • NextToken (string) –

    The token to use to retrieve the next page of results. This value is null when there are no more results to return.