EC2 / Client / describe_vpc_endpoints

describe_vpc_endpoints

EC2.Client.describe_vpc_endpoints(**kwargs)

Describes your VPC endpoints. The default is to describe all your VPC endpoints. Alternatively, you can specify specific VPC endpoint IDs or filter the results to include only the VPC endpoints that match specific criteria.

See also: AWS API Documentation

Request Syntax

response = client.describe_vpc_endpoints(
    DryRun=True|False,
    VpcEndpointIds=[
        'string',
    ],
    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.

• VpcEndpointIds (list) –

  The IDs of the VPC endpoints.

  • (string) –

• Filters (list) –

  The filters.

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

  • service-name - The name of the service.

  • service-region - The Region of the service.

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

  • vpc-id - The ID of the VPC in which the endpoint resides.

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

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

  • vpc-endpoint-type - The type of VPC endpoint ( Interface | Gateway | GatewayLoadBalancer).

  • (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 items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

  Constraint: If the value is greater than 1,000, we return only 1,000 items.

• NextToken (string) – The token for the next set of items to return. (You received this token from a prior call.)

Return type:

dict

Returns:

Response Syntax

{
    'VpcEndpoints': [
        {
            'VpcEndpointId': 'string',
            'VpcEndpointType': 'Interface'|'Gateway'|'GatewayLoadBalancer'|'Resource'|'ServiceNetwork',
            'VpcId': 'string',
            'ServiceName': 'string',
            'State': 'PendingAcceptance'|'Pending'|'Available'|'Deleting'|'Deleted'|'Rejected'|'Failed'|'Expired'|'Partial',
            'PolicyDocument': 'string',
            'RouteTableIds': [
                'string',
            ],
            'SubnetIds': [
                'string',
            ],
            'Groups': [
                {
                    'GroupId': 'string',
                    'GroupName': 'string'
                },
            ],
            'IpAddressType': 'ipv4'|'dualstack'|'ipv6',
            'DnsOptions': {
                'DnsRecordIpType': 'ipv4'|'dualstack'|'ipv6'|'service-defined',
                'PrivateDnsOnlyForInboundResolverEndpoint': True|False
            },
            'PrivateDnsEnabled': True|False,
            'RequesterManaged': True|False,
            'NetworkInterfaceIds': [
                'string',
            ],
            'DnsEntries': [
                {
                    'DnsName': 'string',
                    'HostedZoneId': 'string'
                },
            ],
            'CreationTimestamp': datetime(2015, 1, 1),
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'OwnerId': 'string',
            'LastError': {
                'Message': 'string',
                'Code': 'string'
            },
            'Ipv4Prefixes': [
                {
                    'SubnetId': 'string',
                    'IpPrefixes': [
                        'string',
                    ]
                },
            ],
            'Ipv6Prefixes': [
                {
                    'SubnetId': 'string',
                    'IpPrefixes': [
                        'string',
                    ]
                },
            ],
            'FailureReason': 'string',
            'ServiceNetworkArn': 'string',
            'ResourceConfigurationArn': 'string',
            'ServiceRegion': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • VpcEndpoints (list) –

    Information about the VPC endpoints.

    • (dict) –

      Describes a VPC endpoint.

      • VpcEndpointId (string) –

        The ID of the endpoint.

      • VpcEndpointType (string) –

        The type of endpoint.

      • VpcId (string) –

        The ID of the VPC to which the endpoint is associated.

      • ServiceName (string) –

        The name of the service to which the endpoint is associated.

      • State (string) –

        The state of the endpoint.

      • PolicyDocument (string) –

        The policy document associated with the endpoint, if applicable.

      • RouteTableIds (list) –

        (Gateway endpoint) The IDs of the route tables associated with the endpoint.

        • (string) –

      • SubnetIds (list) –

        (Interface endpoint) The subnets for the endpoint.

        • (string) –

      • Groups (list) –

        (Interface endpoint) Information about the security groups that are associated with the network interface.

        • (dict) –

          Describes a security group.

          • GroupId (string) –

            The ID of the security group.

          • GroupName (string) –

            The name of the security group.

      • IpAddressType (string) –

        The IP address type for the endpoint.

      • DnsOptions (dict) –

        The DNS options for the endpoint.

        • DnsRecordIpType (string) –

          The DNS records created for the endpoint.

        • PrivateDnsOnlyForInboundResolverEndpoint (boolean) –

          Indicates whether to enable private DNS only for inbound endpoints.

      • PrivateDnsEnabled (boolean) –

        (Interface endpoint) Indicates whether the VPC is associated with a private hosted zone.

      • RequesterManaged (boolean) –

        Indicates whether the endpoint is being managed by its service.

      • NetworkInterfaceIds (list) –

        (Interface endpoint) The network interfaces for the endpoint.

        • (string) –

      • DnsEntries (list) –

        (Interface endpoint) The DNS entries for the endpoint.

        • (dict) –

          Describes a DNS entry.

          • DnsName (string) –

            The DNS name.

          • HostedZoneId (string) –

            The ID of the private hosted zone.

      • CreationTimestamp (datetime) –

        The date and time that the endpoint was created.

      • Tags (list) –

        The tags assigned to the endpoint.

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

      • OwnerId (string) –

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

      • LastError (dict) –

        The last error that occurred for endpoint.

        • Message (string) –

          The error message for the VPC endpoint error.

        • Code (string) –

          The error code for the VPC endpoint error.

      • Ipv4Prefixes (list) –

        Array of IPv4 prefixes.

        • (dict) –

          Prefixes of the subnet IP.

          • SubnetId (string) –

            ID of the subnet.

          • IpPrefixes (list) –

            Array of SubnetIpPrefixes objects.

            • (string) –

      • Ipv6Prefixes (list) –

        Array of IPv6 prefixes.

        • (dict) –

          Prefixes of the subnet IP.

          • SubnetId (string) –

            ID of the subnet.

          • IpPrefixes (list) –

            Array of SubnetIpPrefixes objects.

            • (string) –

      • FailureReason (string) –

        Reason for the failure.

      • ServiceNetworkArn (string) –

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

      • ResourceConfigurationArn (string) –

        The Amazon Resource Name (ARN) of the resource configuration.

      • ServiceRegion (string) –

        The Region where the service is hosted.

  • NextToken (string) –

    The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.