EC2 / Client / delete_route_server_endpoint

delete_route_server_endpoint#

EC2.Client.delete_route_server_endpoint(**kwargs)#

Deletes the specified route server endpoint.

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.

See also: AWS API Documentation

Request Syntax

response = client.delete_route_server_endpoint(
    RouteServerEndpointId='string',
    DryRun=True|False
)
Parameters:

  • RouteServerEndpointId (string) –

    [REQUIRED]

    The ID of the route server endpoint to delete.

  • 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

{
    'RouteServerEndpoint': {
        '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'
            },
        ]
    }
}

Response Structure

  • (dict) –

    • RouteServerEndpoint (dict) –

      Information about the deleted route server endpoint.

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