NetworkManager / Client / delete_peering

delete_peering#

NetworkManager.Client.delete_peering(**kwargs)#

Deletes an existing peering connection.

See also: AWS API Documentation

Request Syntax

response = client.delete_peering(
    PeeringId='string'
)
Parameters:

PeeringId (string) –

[REQUIRED]

The ID of the peering connection to delete.

Return type:

dict

Returns:

Response Syntax

{
    'Peering': {
        'CoreNetworkId': 'string',
        'CoreNetworkArn': 'string',
        'PeeringId': 'string',
        'OwnerAccountId': 'string',
        'PeeringType': 'TRANSIT_GATEWAY',
        'State': 'CREATING'|'FAILED'|'AVAILABLE'|'DELETING',
        'EdgeLocation': 'string',
        'ResourceArn': 'string',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'CreatedAt': datetime(2015, 1, 1),
        'LastModificationErrors': [
            {
                'Code': 'TRANSIT_GATEWAY_NOT_FOUND'|'TRANSIT_GATEWAY_PEERS_LIMIT_EXCEEDED'|'MISSING_PERMISSIONS'|'INTERNAL_ERROR'|'EDGE_LOCATION_PEER_DUPLICATE'|'INVALID_TRANSIT_GATEWAY_STATE',
                'Message': 'string',
                'ResourceArn': 'string',
                'RequestId': 'string',
                'MissingPermissionsContext': {
                    'MissingPermission': 'string'
                }
            },
        ]
    }
}

Response Structure

  • (dict) –

    • Peering (dict) –

      Information about a deleted peering connection.

      • CoreNetworkId (string) –

        The ID of the core network for the peering request.

      • CoreNetworkArn (string) –

        The ARN of a core network.

      • PeeringId (string) –

        The ID of the peering attachment.

      • OwnerAccountId (string) –

        The ID of the account owner.

      • PeeringType (string) –

        The type of peering. This will be TRANSIT_GATEWAY.

      • State (string) –

        The current state of the peering connection.

      • EdgeLocation (string) –

        The edge location for the peer.

      • ResourceArn (string) –

        The resource ARN of the peer.

      • Tags (list) –

        The list of key-value tags associated with the peering.

        • (dict) –

          Describes a tag.

          • Key (string) –

            The tag key.

            Constraints: Maximum length of 128 characters.

          • Value (string) –

            The tag value.

            Constraints: Maximum length of 256 characters.

      • CreatedAt (datetime) –

        The timestamp when the attachment peer was created.

      • LastModificationErrors (list) –

        Describes the error associated with the Connect peer request.

        • (dict) –

          Describes an error associated with a peering request.

          • Code (string) –

            The error code for the peering request.

          • Message (string) –

            The message associated with the error code.

          • ResourceArn (string) –

            The ARN of the requested peering resource.

          • RequestId (string) –

            The ID of the Peering request.

          • MissingPermissionsContext (dict) –

            Provides additional information about missing permissions for the peering error.

            • MissingPermission (string) –

              The missing permissions.

Exceptions