EC2 / Client / delete_transit_gateway_connect

delete_transit_gateway_connect#

EC2.Client.delete_transit_gateway_connect(**kwargs)#

Deletes the specified Connect attachment. You must first delete any Connect peers for the attachment.

See also: AWS API Documentation

Request Syntax

response = client.delete_transit_gateway_connect(
    TransitGatewayAttachmentId='string',
    DryRun=True|False
)
Parameters:
  • TransitGatewayAttachmentId (string) –

    [REQUIRED]

    The ID of the Connect attachment.

  • 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

{
    'TransitGatewayConnect': {
        'TransitGatewayAttachmentId': 'string',
        'TransportTransitGatewayAttachmentId': 'string',
        'TransitGatewayId': 'string',
        'State': 'initiating'|'initiatingRequest'|'pendingAcceptance'|'rollingBack'|'pending'|'available'|'modifying'|'deleting'|'deleted'|'failed'|'rejected'|'rejecting'|'failing',
        'CreationTime': datetime(2015, 1, 1),
        'Options': {
            'Protocol': 'gre'
        },
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) –

    • TransitGatewayConnect (dict) –

      Information about the deleted Connect attachment.

      • TransitGatewayAttachmentId (string) –

        The ID of the Connect attachment.

      • TransportTransitGatewayAttachmentId (string) –

        The ID of the attachment from which the Connect attachment was created.

      • TransitGatewayId (string) –

        The ID of the transit gateway.

      • State (string) –

        The state of the attachment.

      • CreationTime (datetime) –

        The creation time.

      • Options (dict) –

        The Connect attachment options.

        • Protocol (string) –

          The tunnel protocol.

      • Tags (list) –

        The tags for the attachment.

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