EC2 / Client / describe_route_server_endpoints

describe_route_server_endpoints

EC2.Client.describe_route_server_endpoints(**kwargs)

Describes one or more route server endpoints.

A route server endpoint is an Amazon Web Services-managed component inside a subnet that facilitates BGP (Border Gateway Protocol) connections between your route server and your BGP peers. Create two endpoints per subnet for redundancy.

For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.

See also: AWS API Documentation

Request Syntax

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

Parameters:

• RouteServerEndpointIds (list) –

  The IDs of the route server endpoints to describe.

  • (string) –

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

• MaxResults (integer) – The maximum number of results to return with a single call.

• Filters (list) –

  One or more filters to apply to the describe request.

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

• DryRun (boolean) – A check for 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.

Return type:

dict

Returns:

Response Syntax

{
    'RouteServerEndpoints': [
        {
            'RouteServerId': 'string',
            'RouteServerEndpointId': 'string',
            'VpcId': 'string',
            'SubnetId': 'string',
            'EniId': 'string',
            'EniAddress': 'string',
            'State': 'pending'|'available'|'deleting'|'deleted'|'failing'|'failed'|'delete-failed',
            'FailureReason': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • RouteServerEndpoints (list) –

    Information about the described route server endpoints.

    • (dict) –

      Describes a route server endpoint and its properties.

      A route server endpoint is an Amazon Web Services-managed component inside a subnet that facilitates BGP (Border Gateway Protocol) connections between your route server and your BGP peers. Create two endpoints per subnet for redundancy.

      • RouteServerId (string) –

        The ID of the route server associated with this endpoint.

      • RouteServerEndpointId (string) –

        The unique identifier of the route server endpoint.

      • VpcId (string) –

        The ID of the VPC containing the endpoint.

      • SubnetId (string) –

        The ID of the subnet to place the route server endpoint into.

      • EniId (string) –

        The ID of the Elastic network interface for the endpoint.

      • EniAddress (string) –

        The IP address of the Elastic network interface for the endpoint.

      • State (string) –

        The current state of the route server endpoint.

      • FailureReason (string) –

        The reason for any failure in endpoint creation or operation.

      • Tags (list) –

        Any tags assigned to the route server 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.

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