EC2 / Client / delete_transit_gateway_connect_peer

delete_transit_gateway_connect_peer

EC2.Client.delete_transit_gateway_connect_peer(**kwargs)

Deletes the specified Connect peer.

See also: AWS API Documentation

Request Syntax

response = client.delete_transit_gateway_connect_peer(
    TransitGatewayConnectPeerId='string',
    DryRun=True|False
)

Parameters:

• TransitGatewayConnectPeerId (string) –

  [REQUIRED]

  The ID of the Connect peer.

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

Return type:

dict

Returns:

Response Syntax

{
    'TransitGatewayConnectPeer': {
        'TransitGatewayAttachmentId': 'string',
        'TransitGatewayConnectPeerId': 'string',
        'State': 'pending'|'available'|'deleting'|'deleted',
        'CreationTime': datetime(2015, 1, 1),
        'ConnectPeerConfiguration': {
            'TransitGatewayAddress': 'string',
            'PeerAddress': 'string',
            'InsideCidrBlocks': [
                'string',
            ],
            'Protocol': 'gre',
            'BgpConfigurations': [
                {
                    'TransitGatewayAsn': 123,
                    'PeerAsn': 123,
                    'TransitGatewayAddress': 'string',
                    'PeerAddress': 'string',
                    'BgpStatus': 'up'|'down'
                },
            ]
        },
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

• (dict) –

  • TransitGatewayConnectPeer (dict) –

    Information about the deleted Connect peer.

    • TransitGatewayAttachmentId (string) –

      The ID of the Connect attachment.

    • TransitGatewayConnectPeerId (string) –

      The ID of the Connect peer.

    • State (string) –

      The state of the Connect peer.

    • CreationTime (datetime) –

      The creation time.

    • ConnectPeerConfiguration (dict) –

      The Connect peer details.

      • TransitGatewayAddress (string) –

        The Connect peer IP address on the transit gateway side of the tunnel.

      • PeerAddress (string) –

        The Connect peer IP address on the appliance side of the tunnel.

      • InsideCidrBlocks (list) –

        The range of interior BGP peer IP addresses.

        • (string) –

      • Protocol (string) –

        The tunnel protocol.

      • BgpConfigurations (list) –

        The BGP configuration details.

        • (dict) –

          The BGP configuration information.

          • TransitGatewayAsn (integer) –

            The transit gateway Autonomous System Number (ASN).

          • PeerAsn (integer) –

            The peer Autonomous System Number (ASN).

          • TransitGatewayAddress (string) –

            The interior BGP peer IP address for the transit gateway.

          • PeerAddress (string) –

            The interior BGP peer IP address for the appliance.

          • BgpStatus (string) –

            The BGP status.

    • Tags (list) –

      The tags for the Connect peer.

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