EC2 / Client / delete_transit_gateway

delete_transit_gateway

EC2.Client.delete_transit_gateway(**kwargs)

Deletes the specified transit gateway.

See also: AWS API Documentation

Request Syntax

response = client.delete_transit_gateway(
    TransitGatewayId='string',
    DryRun=True|False
)

Parameters:

• TransitGatewayId (string) –

  [REQUIRED]

  The ID of the transit gateway.

• 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

{
    'TransitGateway': {
        'TransitGatewayId': 'string',
        'TransitGatewayArn': 'string',
        'State': 'pending'|'available'|'modifying'|'deleting'|'deleted',
        'OwnerId': 'string',
        'Description': 'string',
        'CreationTime': datetime(2015, 1, 1),
        'Options': {
            'AmazonSideAsn': 123,
            'TransitGatewayCidrBlocks': [
                'string',
            ],
            'AutoAcceptSharedAttachments': 'enable'|'disable',
            'DefaultRouteTableAssociation': 'enable'|'disable',
            'AssociationDefaultRouteTableId': 'string',
            'DefaultRouteTablePropagation': 'enable'|'disable',
            'PropagationDefaultRouteTableId': 'string',
            'VpnEcmpSupport': 'enable'|'disable',
            'DnsSupport': 'enable'|'disable',
            'SecurityGroupReferencingSupport': 'enable'|'disable',
            'MulticastSupport': 'enable'|'disable'
        },
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

• (dict) –

  • TransitGateway (dict) –

    Information about the deleted transit gateway.

    • TransitGatewayId (string) –

      The ID of the transit gateway.

    • TransitGatewayArn (string) –

      The Amazon Resource Name (ARN) of the transit gateway.

    • State (string) –

      The state of the transit gateway.

    • OwnerId (string) –

      The ID of the Amazon Web Services account that owns the transit gateway.

    • Description (string) –

      The description of the transit gateway.

    • CreationTime (datetime) –

      The creation time.

    • Options (dict) –

      The transit gateway options.

      • AmazonSideAsn (integer) –

        A private Autonomous System Number (ASN) for the Amazon side of a BGP session. The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs.

      • TransitGatewayCidrBlocks (list) –

        The transit gateway CIDR blocks.

        • (string) –

      • AutoAcceptSharedAttachments (string) –

        Indicates whether attachment requests are automatically accepted.

      • DefaultRouteTableAssociation (string) –

        Indicates whether resource attachments are automatically associated with the default association route table.

      • AssociationDefaultRouteTableId (string) –

        The ID of the default association route table.

      • DefaultRouteTablePropagation (string) –

        Indicates whether resource attachments automatically propagate routes to the default propagation route table.

      • PropagationDefaultRouteTableId (string) –

        The ID of the default propagation route table.

      • VpnEcmpSupport (string) –

        Indicates whether Equal Cost Multipath Protocol support is enabled.

      • DnsSupport (string) –

        Indicates whether DNS support is enabled.

      • SecurityGroupReferencingSupport (string) –

        Note

        This parameter is in preview and may not be available for your account.

        Enables you to reference a security group across VPCs attached to a transit gateway. Use this option to simplify security group management and control of instance-to-instance traffic across VPCs that are connected by transit gateway. You can also use this option to migrate from VPC peering (which was the only option that supported security group referencing) to transit gateways (which now also support security group referencing). This option is disabled by default and there are no additional costs to use this feature.

      • MulticastSupport (string) –

        Indicates whether multicast is enabled on the transit gateway

    • Tags (list) –

      The tags for the transit gateway.

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