AWS API Changes

2020/09/02 - Amazon Elastic Compute Cloud - 30 updated api methods

Changes This release adds a new transit gateway attachment state and resource type.

AcceptTransitGatewayPeeringAttachment (updated)

Link ¶
Changes (response)

{'TransitGatewayPeeringAttachment': {'State': {'initiatingRequest'}}}

Accepts a transit gateway peering attachment request. The peering attachment must be in the pendingAcceptance state.

See also: AWS API Documentation

Request Syntax

client.accept_transit_gateway_peering_attachment(
    TransitGatewayAttachmentId='string',
    DryRun=True|False
)

type TransitGatewayAttachmentId

string

param TransitGatewayAttachmentId

[REQUIRED]

The ID of the transit gateway attachment.

type DryRun

boolean

param DryRun

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 .

rtype

dict

returns

Response Syntax

{
    'TransitGatewayPeeringAttachment': {
        'TransitGatewayAttachmentId': 'string',
        'RequesterTgwInfo': {
            'TransitGatewayId': 'string',
            'OwnerId': 'string',
            'Region': 'string'
        },
        'AccepterTgwInfo': {
            'TransitGatewayId': 'string',
            'OwnerId': 'string',
            'Region': 'string'
        },
        'Status': {
            'Code': 'string',
            'Message': 'string'
        },
        'State': 'initiating'|'initiatingRequest'|'pendingAcceptance'|'rollingBack'|'pending'|'available'|'modifying'|'deleting'|'deleted'|'failed'|'rejected'|'rejecting'|'failing',
        'CreationTime': datetime(2015, 1, 1),
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

(dict) --
- TransitGatewayPeeringAttachment (dict) --
  
  The transit gateway peering attachment.
  - TransitGatewayAttachmentId (string) --
    
    The ID of the transit gateway peering attachment.
  - RequesterTgwInfo (dict) --
    
    Information about the requester transit gateway.
    - TransitGatewayId (string) --
      
      The ID of the transit gateway.
    - OwnerId (string) --
      
      The AWS account ID of the owner of the transit gateway.
    - Region (string) --
      
      The Region of the transit gateway.
  - AccepterTgwInfo (dict) --
    
    Information about the accepter transit gateway.
    - TransitGatewayId (string) --
      
      The ID of the transit gateway.
    - OwnerId (string) --
      
      The AWS account ID of the owner of the transit gateway.
    - Region (string) --
      
      The Region of the transit gateway.
  - Status (dict) --
    
    The status of the transit gateway peering attachment.
    - Code (string) --
      
      The status code.
    - Message (string) --
      
      The status message, if applicable.
  - State (string) --
    
    The state of the transit gateway peering attachment. Note that the initiating state has been deprecated.
  - CreationTime (datetime) --
    
    The time the transit gateway peering attachment was created.
  - Tags (list) --
    
    The tags for the transit gateway peering 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 255 Unicode characters.

AcceptTransitGatewayVpcAttachment (updated)

Link ¶
Changes (response)

{'TransitGatewayVpcAttachment': {'State': {'initiatingRequest'}}}

Accepts a request to attach a VPC to a transit gateway.

The VPC attachment must be in the pendingAcceptance state. Use DescribeTransitGatewayVpcAttachments to view your pending VPC attachment requests. Use RejectTransitGatewayVpcAttachment to reject a VPC attachment request.

See also: AWS API Documentation

Request Syntax

client.accept_transit_gateway_vpc_attachment(
    TransitGatewayAttachmentId='string',
    DryRun=True|False
)

type TransitGatewayAttachmentId

string

param TransitGatewayAttachmentId

[REQUIRED]

The ID of the attachment.

type DryRun

boolean

param DryRun

rtype

dict

returns

Response Syntax

{
    'TransitGatewayVpcAttachment': {
        'TransitGatewayAttachmentId': 'string',
        'TransitGatewayId': 'string',
        'VpcId': 'string',
        'VpcOwnerId': 'string',
        'State': 'initiating'|'initiatingRequest'|'pendingAcceptance'|'rollingBack'|'pending'|'available'|'modifying'|'deleting'|'deleted'|'failed'|'rejected'|'rejecting'|'failing',
        'SubnetIds': [
            'string',
        ],
        'CreationTime': datetime(2015, 1, 1),
        'Options': {
            'DnsSupport': 'enable'|'disable',
            'Ipv6Support': 'enable'|'disable'
        },
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

(dict) --
- TransitGatewayVpcAttachment (dict) --
  
  The VPC attachment.
  - TransitGatewayAttachmentId (string) --
    
    The ID of the attachment.
  - TransitGatewayId (string) --
    
    The ID of the transit gateway.
  - VpcId (string) --
    
    The ID of the VPC.
  - VpcOwnerId (string) --
    
    The ID of the AWS account that owns the VPC.
  - State (string) --
    
    The state of the VPC attachment. Note that the initiating state has been deprecated.
  - SubnetIds (list) --
    
    The IDs of the subnets.
    - (string) --
  - CreationTime (datetime) --
    
    The creation time.
  - Options (dict) --
    
    The VPC attachment options.
    - DnsSupport (string) --
      
      Indicates whether DNS support is enabled.
    - Ipv6Support (string) --
      
      Indicates whether IPv6 support is disabled.
  - Tags (list) --
    
    The tags for the VPC 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 255 Unicode characters.

AssociateTransitGatewayMulticastDomain (updated)

Link ¶
Changes (response)

{'Associations': {'ResourceType': {'peering'}}}

Associates the specified subnets and transit gateway attachments with the specified transit gateway multicast domain.

The transit gateway attachment must be in the available state before you can add a resource. Use DescribeTransitGatewayAttachments to see the state of the attachment.

See also: AWS API Documentation

Request Syntax

client.associate_transit_gateway_multicast_domain(
    TransitGatewayMulticastDomainId='string',
    TransitGatewayAttachmentId='string',
    SubnetIds=[
        'string',
    ],
    DryRun=True|False
)

type TransitGatewayMulticastDomainId

string

param TransitGatewayMulticastDomainId

The ID of the transit gateway multicast domain.

type TransitGatewayAttachmentId

string

param TransitGatewayAttachmentId

The ID of the transit gateway attachment to associate with the transit gateway multicast domain.

type SubnetIds

list

param SubnetIds

The IDs of the subnets to associate with the transit gateway multicast domain.

(string) --

type DryRun

boolean

param DryRun

rtype

dict

returns

Response Syntax

{
    'Associations': {
        'TransitGatewayMulticastDomainId': 'string',
        'TransitGatewayAttachmentId': 'string',
        'ResourceId': 'string',
        'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'|'peering'|'tgw-peering',
        'Subnets': [
            {
                'SubnetId': 'string',
                'State': 'associating'|'associated'|'disassociating'|'disassociated'
            },
        ]
    }
}

Response Structure

(dict) --
- Associations (dict) --
  
  Information about the transit gateway multicast domain associations.
  - TransitGatewayMulticastDomainId (string) --
    
    The ID of the transit gateway multicast domain.
  - TransitGatewayAttachmentId (string) --
    
    The ID of the transit gateway attachment.
  - ResourceId (string) --
    
    The ID of the resource.
  - ResourceType (string) --
    
    The type of resource, for example a VPC attachment.
  - Subnets (list) --
    
    The subnets associated with the multicast domain.
    - (dict) --
      
      Describes the subnet association with the transit gateway multicast domain.
      - SubnetId (string) --
        
        The ID of the subnet.
      - State (string) --
        
        The state of the subnet association.

AssociateTransitGatewayRouteTable (updated)

Link ¶
Changes (response)

{'Association': {'ResourceType': {'peering'}}}

Associates the specified attachment with the specified transit gateway route table. You can associate only one route table with an attachment.

See also: AWS API Documentation

Request Syntax

client.associate_transit_gateway_route_table(
    TransitGatewayRouteTableId='string',
    TransitGatewayAttachmentId='string',
    DryRun=True|False
)

type TransitGatewayRouteTableId

string

param TransitGatewayRouteTableId

[REQUIRED]

The ID of the transit gateway route table.

type TransitGatewayAttachmentId

string

param TransitGatewayAttachmentId

[REQUIRED]

The ID of the attachment.

type DryRun

boolean

param DryRun

rtype

dict

returns

Response Syntax

{
    'Association': {
        'TransitGatewayRouteTableId': 'string',
        'TransitGatewayAttachmentId': 'string',
        'ResourceId': 'string',
        'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'|'peering'|'tgw-peering',
        'State': 'associating'|'associated'|'disassociating'|'disassociated'
    }
}

Response Structure

(dict) --
- Association (dict) --
  
  The ID of the association.
  - TransitGatewayRouteTableId (string) --
    
    The ID of the transit gateway route table.
  - TransitGatewayAttachmentId (string) --
    
    The ID of the attachment.
  - ResourceId (string) --
    
    The ID of the resource.
  - ResourceType (string) --
    
    The resource type. Note that the tgw-peering resource type has been deprecated.
  - State (string) --
    
    The state of the association.

CreateTransitGatewayPeeringAttachment (updated)

Link ¶
Changes (response)

{'TransitGatewayPeeringAttachment': {'State': {'initiatingRequest'}}}

Requests a transit gateway peering attachment between the specified transit gateway (requester) and a peer transit gateway (accepter). The transit gateways must be in different Regions. The peer transit gateway can be in your account or a different AWS account.

After you create the peering attachment, the owner of the accepter transit gateway must accept the attachment request.

See also: AWS API Documentation

Request Syntax

client.create_transit_gateway_peering_attachment(
    TransitGatewayId='string',
    PeerTransitGatewayId='string',
    PeerAccountId='string',
    PeerRegion='string',
    TagSpecifications=[
        {
            'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    DryRun=True|False
)

type TransitGatewayId

string

param TransitGatewayId

[REQUIRED]

The ID of the transit gateway.

type PeerTransitGatewayId

string

param PeerTransitGatewayId

[REQUIRED]

The ID of the peer transit gateway with which to create the peering attachment.

type PeerAccountId

string

param PeerAccountId

[REQUIRED]

The AWS account ID of the owner of the peer transit gateway.

type PeerRegion

string

param PeerRegion

[REQUIRED]

The Region where the peer transit gateway is located.

type TagSpecifications

list

param TagSpecifications

The tags to apply to the transit gateway peering attachment.

(dict) --

The tags to apply to a resource when the resource is being created.
- ResourceType (string) --
  
  The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | client-vpn-endpoint | customer-gateway | dedicated-host | dhcp-options | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | import-image-task | import-snapshot-task | instance | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | placement-group | prefix-list | natgateway | network-acl | route-table | security-group | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-route-table | volume | vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
  
  To tag a resource after it has been created, see CreateTags.
- Tags (list) --
  
  The tags to apply to the resource.
  - (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 255 Unicode characters.

type DryRun

boolean

param DryRun

rtype

dict

returns

Response Syntax

{
    'TransitGatewayPeeringAttachment': {
        'TransitGatewayAttachmentId': 'string',
        'RequesterTgwInfo': {
            'TransitGatewayId': 'string',
            'OwnerId': 'string',
            'Region': 'string'
        },
        'AccepterTgwInfo': {
            'TransitGatewayId': 'string',
            'OwnerId': 'string',
            'Region': 'string'
        },
        'Status': {
            'Code': 'string',
            'Message': 'string'
        },
        'State': 'initiating'|'initiatingRequest'|'pendingAcceptance'|'rollingBack'|'pending'|'available'|'modifying'|'deleting'|'deleted'|'failed'|'rejected'|'rejecting'|'failing',
        'CreationTime': datetime(2015, 1, 1),
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

(dict) --
- TransitGatewayPeeringAttachment (dict) --
  
  The transit gateway peering attachment.
  - TransitGatewayAttachmentId (string) --
    
    The ID of the transit gateway peering attachment.
  - RequesterTgwInfo (dict) --
    
    Information about the requester transit gateway.
    - TransitGatewayId (string) --
      
      The ID of the transit gateway.
    - OwnerId (string) --
      
      The AWS account ID of the owner of the transit gateway.
    - Region (string) --
      
      The Region of the transit gateway.
  - AccepterTgwInfo (dict) --
    
    Information about the accepter transit gateway.
    - TransitGatewayId (string) --
      
      The ID of the transit gateway.
    - OwnerId (string) --
      
      The AWS account ID of the owner of the transit gateway.
    - Region (string) --
      
      The Region of the transit gateway.
  - Status (dict) --
    
    The status of the transit gateway peering attachment.
    - Code (string) --
      
      The status code.
    - Message (string) --
      
      The status message, if applicable.
  - State (string) --
    
    The state of the transit gateway peering attachment. Note that the initiating state has been deprecated.
  - CreationTime (datetime) --
    
    The time the transit gateway peering attachment was created.
  - Tags (list) --
    
    The tags for the transit gateway peering 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 255 Unicode characters.

CreateTransitGatewayPrefixListReference (updated)

Link ¶
Changes (response)

{'TransitGatewayPrefixListReference': {'TransitGatewayAttachment': {'ResourceType': {'peering'}}}}

Creates a reference (route) to a prefix list in a specified transit gateway route table.

See also: AWS API Documentation

Request Syntax

client.create_transit_gateway_prefix_list_reference(
    TransitGatewayRouteTableId='string',
    PrefixListId='string',
    TransitGatewayAttachmentId='string',
    Blackhole=True|False,
    DryRun=True|False
)

type TransitGatewayRouteTableId

string

param TransitGatewayRouteTableId

[REQUIRED]

The ID of the transit gateway route table.

type PrefixListId

string

param PrefixListId

[REQUIRED]

The ID of the prefix list that is used for destination matches.

type TransitGatewayAttachmentId

string

param TransitGatewayAttachmentId

The ID of the attachment to which traffic is routed.

type Blackhole

boolean

param Blackhole

Indicates whether to drop traffic that matches this route.

type DryRun

boolean

param DryRun

rtype

dict

returns

Response Syntax

{
    'TransitGatewayPrefixListReference': {
        'TransitGatewayRouteTableId': 'string',
        'PrefixListId': 'string',
        'PrefixListOwnerId': 'string',
        'State': 'pending'|'available'|'modifying'|'deleting',
        'Blackhole': True|False,
        'TransitGatewayAttachment': {
            'TransitGatewayAttachmentId': 'string',
            'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'|'peering'|'tgw-peering',
            'ResourceId': 'string'
        }
    }
}

Response Structure

(dict) --
- TransitGatewayPrefixListReference (dict) --
  
  Information about the prefix list reference.
  - TransitGatewayRouteTableId (string) --
    
    The ID of the transit gateway route table.
  - PrefixListId (string) --
    
    The ID of the prefix list.
  - PrefixListOwnerId (string) --
    
    The ID of the prefix list owner.
  - State (string) --
    
    The state of the prefix list reference.
  - Blackhole (boolean) --
    
    Indicates whether traffic that matches this route is dropped.
  - TransitGatewayAttachment (dict) --
    
    Information about the transit gateway attachment.
    - TransitGatewayAttachmentId (string) --
      
      The ID of the attachment.
    - ResourceType (string) --
      
      The resource type. Note that the tgw-peering resource type has been deprecated.
    - ResourceId (string) --
      
      The ID of the resource.

CreateTransitGatewayRoute (updated)

Link ¶
Changes (response)

{'Route': {'TransitGatewayAttachments': {'ResourceType': {'peering'}}}}

Creates a static route for the specified transit gateway route table.

See also: AWS API Documentation

Request Syntax

client.create_transit_gateway_route(
    DestinationCidrBlock='string',
    TransitGatewayRouteTableId='string',
    TransitGatewayAttachmentId='string',
    Blackhole=True|False,
    DryRun=True|False
)

type DestinationCidrBlock

string

param DestinationCidrBlock

[REQUIRED]

The CIDR range used for destination matches. Routing decisions are based on the most specific match.

type TransitGatewayRouteTableId

string

param TransitGatewayRouteTableId

[REQUIRED]

The ID of the transit gateway route table.

type TransitGatewayAttachmentId

string

param TransitGatewayAttachmentId

The ID of the attachment.

type Blackhole

boolean

param Blackhole

Indicates whether to drop traffic that matches this route.

type DryRun

boolean

param DryRun

rtype

dict

returns

Response Syntax

{
    'Route': {
        'DestinationCidrBlock': 'string',
        'PrefixListId': 'string',
        'TransitGatewayAttachments': [
            {
                'ResourceId': 'string',
                'TransitGatewayAttachmentId': 'string',
                'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'|'peering'|'tgw-peering'
            },
        ],
        'Type': 'static'|'propagated',
        'State': 'pending'|'active'|'blackhole'|'deleting'|'deleted'
    }
}

Response Structure

(dict) --
- Route (dict) --
  
  Information about the route.
  - DestinationCidrBlock (string) --
    
    The CIDR block used for destination matches.
  - PrefixListId (string) --
    
    The ID of the prefix list used for destination matches.
  - TransitGatewayAttachments (list) --
    
    The attachments.
    - (dict) --
      
      Describes a route attachment.
      - ResourceId (string) --
        
        The ID of the resource.
      - TransitGatewayAttachmentId (string) --
        
        The ID of the attachment.
      - ResourceType (string) --
        
        The resource type. Note that the tgw-peering resource type has been deprecated.
  - Type (string) --
    
    The route type.
  - State (string) --
    
    The state of the route.

CreateTransitGatewayVpcAttachment (updated)

Link ¶
Changes (response)

{'TransitGatewayVpcAttachment': {'State': {'initiatingRequest'}}}

Attaches the specified VPC to the specified transit gateway.

If you attach a VPC with a CIDR range that overlaps the CIDR range of a VPC that is already attached, the new VPC CIDR range is not propagated to the default propagation route table.

To send VPC traffic to an attached transit gateway, add a route to the VPC route table using CreateRoute.

See also: AWS API Documentation

Request Syntax

client.create_transit_gateway_vpc_attachment(
    TransitGatewayId='string',
    VpcId='string',
    SubnetIds=[
        'string',
    ],
    Options={
        'DnsSupport': 'enable'|'disable',
        'Ipv6Support': 'enable'|'disable'
    },
    TagSpecifications=[
        {
            'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    DryRun=True|False
)

type TransitGatewayId

string

param TransitGatewayId

[REQUIRED]

The ID of the transit gateway.

type VpcId

string

param VpcId

[REQUIRED]

The ID of the VPC.

type SubnetIds

list

param SubnetIds

[REQUIRED]

The IDs of one or more subnets. You can specify only one subnet per Availability Zone. You must specify at least one subnet, but we recommend that you specify two subnets for better availability. The transit gateway uses one IP address from each specified subnet.

(string) --

type Options

dict

param Options

The VPC attachment options.

DnsSupport (string) --

Enable or disable DNS support. The default is enable .
Ipv6Support (string) --

Enable or disable IPv6 support. The default is enable .

type TagSpecifications

list

param TagSpecifications

The tags to apply to the VPC attachment.

(dict) --

The tags to apply to a resource when the resource is being created.
- ResourceType (string) --
  
  The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | client-vpn-endpoint | customer-gateway | dedicated-host | dhcp-options | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | import-image-task | import-snapshot-task | instance | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | placement-group | prefix-list | natgateway | network-acl | route-table | security-group | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-route-table | volume | vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
  
  To tag a resource after it has been created, see CreateTags.
- Tags (list) --
  
  The tags to apply to the resource.
  - (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 255 Unicode characters.

type DryRun

boolean

param DryRun

rtype

dict

returns

Response Syntax

{
    'TransitGatewayVpcAttachment': {
        'TransitGatewayAttachmentId': 'string',
        'TransitGatewayId': 'string',
        'VpcId': 'string',
        'VpcOwnerId': 'string',
        'State': 'initiating'|'initiatingRequest'|'pendingAcceptance'|'rollingBack'|'pending'|'available'|'modifying'|'deleting'|'deleted'|'failed'|'rejected'|'rejecting'|'failing',
        'SubnetIds': [
            'string',
        ],
        'CreationTime': datetime(2015, 1, 1),
        'Options': {
            'DnsSupport': 'enable'|'disable',
            'Ipv6Support': 'enable'|'disable'
        },
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

(dict) --
- TransitGatewayVpcAttachment (dict) --
  
  Information about the VPC attachment.
  - TransitGatewayAttachmentId (string) --
    
    The ID of the attachment.
  - TransitGatewayId (string) --
    
    The ID of the transit gateway.
  - VpcId (string) --
    
    The ID of the VPC.
  - VpcOwnerId (string) --
    
    The ID of the AWS account that owns the VPC.
  - State (string) --
    
    The state of the VPC attachment. Note that the initiating state has been deprecated.
  - SubnetIds (list) --
    
    The IDs of the subnets.
    - (string) --
  - CreationTime (datetime) --
    
    The creation time.
  - Options (dict) --
    
    The VPC attachment options.
    - DnsSupport (string) --
      
      Indicates whether DNS support is enabled.
    - Ipv6Support (string) --
      
      Indicates whether IPv6 support is disabled.
  - Tags (list) --
    
    The tags for the VPC 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 255 Unicode characters.

DeleteTransitGatewayPeeringAttachment (updated)

Link ¶
Changes (response)

{'TransitGatewayPeeringAttachment': {'State': {'initiatingRequest'}}}

Deletes a transit gateway peering attachment.

See also: AWS API Documentation

Request Syntax

client.delete_transit_gateway_peering_attachment(
    TransitGatewayAttachmentId='string',
    DryRun=True|False
)

type TransitGatewayAttachmentId

string

param TransitGatewayAttachmentId

[REQUIRED]

The ID of the transit gateway peering attachment.

type DryRun

boolean

param DryRun

rtype

dict

returns

Response Syntax

{
    'TransitGatewayPeeringAttachment': {
        'TransitGatewayAttachmentId': 'string',
        'RequesterTgwInfo': {
            'TransitGatewayId': 'string',
            'OwnerId': 'string',
            'Region': 'string'
        },
        'AccepterTgwInfo': {
            'TransitGatewayId': 'string',
            'OwnerId': 'string',
            'Region': 'string'
        },
        'Status': {
            'Code': 'string',
            'Message': 'string'
        },
        'State': 'initiating'|'initiatingRequest'|'pendingAcceptance'|'rollingBack'|'pending'|'available'|'modifying'|'deleting'|'deleted'|'failed'|'rejected'|'rejecting'|'failing',
        'CreationTime': datetime(2015, 1, 1),
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

(dict) --
- TransitGatewayPeeringAttachment (dict) --
  
  The transit gateway peering attachment.
  - TransitGatewayAttachmentId (string) --
    
    The ID of the transit gateway peering attachment.
  - RequesterTgwInfo (dict) --
    
    Information about the requester transit gateway.
    - TransitGatewayId (string) --
      
      The ID of the transit gateway.
    - OwnerId (string) --
      
      The AWS account ID of the owner of the transit gateway.
    - Region (string) --
      
      The Region of the transit gateway.
  - AccepterTgwInfo (dict) --
    
    Information about the accepter transit gateway.
    - TransitGatewayId (string) --
      
      The ID of the transit gateway.
    - OwnerId (string) --
      
      The AWS account ID of the owner of the transit gateway.
    - Region (string) --
      
      The Region of the transit gateway.
  - Status (dict) --
    
    The status of the transit gateway peering attachment.
    - Code (string) --
      
      The status code.
    - Message (string) --
      
      The status message, if applicable.
  - State (string) --
    
    The state of the transit gateway peering attachment. Note that the initiating state has been deprecated.
  - CreationTime (datetime) --
    
    The time the transit gateway peering attachment was created.
  - Tags (list) --
    
    The tags for the transit gateway peering 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 255 Unicode characters.

DeleteTransitGatewayPrefixListReference (updated)

Link ¶
Changes (response)

{'TransitGatewayPrefixListReference': {'TransitGatewayAttachment': {'ResourceType': {'peering'}}}}

Deletes a reference (route) to a prefix list in a specified transit gateway route table.

See also: AWS API Documentation

Request Syntax

client.delete_transit_gateway_prefix_list_reference(
    TransitGatewayRouteTableId='string',
    PrefixListId='string',
    DryRun=True|False
)

type TransitGatewayRouteTableId

string

param TransitGatewayRouteTableId

[REQUIRED]

The ID of the route table.

type PrefixListId

string

param PrefixListId

[REQUIRED]

The ID of the prefix list.

type DryRun

boolean

param DryRun

rtype

dict

returns

Response Syntax

{
    'TransitGatewayPrefixListReference': {
        'TransitGatewayRouteTableId': 'string',
        'PrefixListId': 'string',
        'PrefixListOwnerId': 'string',
        'State': 'pending'|'available'|'modifying'|'deleting',
        'Blackhole': True|False,
        'TransitGatewayAttachment': {
            'TransitGatewayAttachmentId': 'string',
            'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'|'peering'|'tgw-peering',
            'ResourceId': 'string'
        }
    }
}

Response Structure

(dict) --
- TransitGatewayPrefixListReference (dict) --
  
  Information about the deleted prefix list reference.
  - TransitGatewayRouteTableId (string) --
    
    The ID of the transit gateway route table.
  - PrefixListId (string) --
    
    The ID of the prefix list.
  - PrefixListOwnerId (string) --
    
    The ID of the prefix list owner.
  - State (string) --
    
    The state of the prefix list reference.
  - Blackhole (boolean) --
    
    Indicates whether traffic that matches this route is dropped.
  - TransitGatewayAttachment (dict) --
    
    Information about the transit gateway attachment.
    - TransitGatewayAttachmentId (string) --
      
      The ID of the attachment.
    - ResourceType (string) --
      
      The resource type. Note that the tgw-peering resource type has been deprecated.
    - ResourceId (string) --
      
      The ID of the resource.

DeleteTransitGatewayRoute (updated)

Link ¶
Changes (response)

{'Route': {'TransitGatewayAttachments': {'ResourceType': {'peering'}}}}

Deletes the specified route from the specified transit gateway route table.

See also: AWS API Documentation

Request Syntax

client.delete_transit_gateway_route(
    TransitGatewayRouteTableId='string',
    DestinationCidrBlock='string',
    DryRun=True|False
)

type TransitGatewayRouteTableId

string

param TransitGatewayRouteTableId

[REQUIRED]

The ID of the transit gateway route table.

type DestinationCidrBlock

string

param DestinationCidrBlock

[REQUIRED]

The CIDR range for the route. This must match the CIDR for the route exactly.

type DryRun

boolean

param DryRun

rtype

dict

returns

Response Syntax

{
    'Route': {
        'DestinationCidrBlock': 'string',
        'PrefixListId': 'string',
        'TransitGatewayAttachments': [
            {
                'ResourceId': 'string',
                'TransitGatewayAttachmentId': 'string',
                'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'|'peering'|'tgw-peering'
            },
        ],
        'Type': 'static'|'propagated',
        'State': 'pending'|'active'|'blackhole'|'deleting'|'deleted'
    }
}

Response Structure

(dict) --
- Route (dict) --
  
  Information about the route.
  - DestinationCidrBlock (string) --
    
    The CIDR block used for destination matches.
  - PrefixListId (string) --
    
    The ID of the prefix list used for destination matches.
  - TransitGatewayAttachments (list) --
    
    The attachments.
    - (dict) --
      
      Describes a route attachment.
      - ResourceId (string) --
        
        The ID of the resource.
      - TransitGatewayAttachmentId (string) --
        
        The ID of the attachment.
      - ResourceType (string) --
        
        The resource type. Note that the tgw-peering resource type has been deprecated.
  - Type (string) --
    
    The route type.
  - State (string) --
    
    The state of the route.

DeleteTransitGatewayVpcAttachment (updated)

Link ¶
Changes (response)

{'TransitGatewayVpcAttachment': {'State': {'initiatingRequest'}}}

Deletes the specified VPC attachment.

See also: AWS API Documentation

Request Syntax

client.delete_transit_gateway_vpc_attachment(
    TransitGatewayAttachmentId='string',
    DryRun=True|False
)

type TransitGatewayAttachmentId

string

param TransitGatewayAttachmentId

[REQUIRED]

The ID of the attachment.

type DryRun

boolean

param DryRun

rtype

dict

returns

Response Syntax

{
    'TransitGatewayVpcAttachment': {
        'TransitGatewayAttachmentId': 'string',
        'TransitGatewayId': 'string',
        'VpcId': 'string',
        'VpcOwnerId': 'string',
        'State': 'initiating'|'initiatingRequest'|'pendingAcceptance'|'rollingBack'|'pending'|'available'|'modifying'|'deleting'|'deleted'|'failed'|'rejected'|'rejecting'|'failing',
        'SubnetIds': [
            'string',
        ],
        'CreationTime': datetime(2015, 1, 1),
        'Options': {
            'DnsSupport': 'enable'|'disable',
            'Ipv6Support': 'enable'|'disable'
        },
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

(dict) --
- TransitGatewayVpcAttachment (dict) --
  
  Information about the deleted VPC attachment.
  - TransitGatewayAttachmentId (string) --
    
    The ID of the attachment.
  - TransitGatewayId (string) --
    
    The ID of the transit gateway.
  - VpcId (string) --
    
    The ID of the VPC.
  - VpcOwnerId (string) --
    
    The ID of the AWS account that owns the VPC.
  - State (string) --
    
    The state of the VPC attachment. Note that the initiating state has been deprecated.
  - SubnetIds (list) --
    
    The IDs of the subnets.
    - (string) --
  - CreationTime (datetime) --
    
    The creation time.
  - Options (dict) --
    
    The VPC attachment options.
    - DnsSupport (string) --
      
      Indicates whether DNS support is enabled.
    - Ipv6Support (string) --
      
      Indicates whether IPv6 support is disabled.
  - Tags (list) --
    
    The tags for the VPC 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 255 Unicode characters.

DescribeTransitGatewayAttachments (updated)

Link ¶
Changes (response)

{'TransitGatewayAttachments': {'ResourceType': {'peering'},
                               'State': {'initiatingRequest'}}}

Describes one or more attachments between resources and transit gateways. By default, all attachments are described. Alternatively, you can filter the results by attachment ID, attachment state, resource ID, or resource owner.

See also: AWS API Documentation

Request Syntax

client.describe_transit_gateway_attachments(
    TransitGatewayAttachmentIds=[
        'string',
    ],
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NextToken='string',
    DryRun=True|False
)

type TransitGatewayAttachmentIds

list

param TransitGatewayAttachmentIds

The IDs of the attachments.

(string) --

type Filters

list

param Filters

One or more filters. The possible values are:

association.state - The state of the association ( associating | associated | disassociating ).
association.transit-gateway-route-table-id - The ID of the route table for the transit gateway.
resource-id - The ID of the resource.
resource-owner-id - The ID of the AWS account that owns the resource.
resource-type - The resource type. Valid values are vpc | vpn | direct-connect-gateway | peering .
state - The state of the attachment. Valid values are available | deleted | deleting | failed | failing | initiatingRequest | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting .
transit-gateway-attachment-id - The ID of the attachment.
transit-gateway-id - The ID of the transit gateway.
transit-gateway-owner-id - The ID of the AWS account that owns the transit gateway.

(dict) --

A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. The filters supported by a describe operation are documented with the describe operation. For example:
- DescribeAvailabilityZones
- DescribeImages
- DescribeInstances
- DescribeKeyPairs
- DescribeSecurityGroups
- DescribeSnapshots
- DescribeSubnets
- DescribeTags
- DescribeVolumes
- DescribeVpcs
- Name (string) --
  
  The name of the filter. Filter names are case-sensitive.
- Values (list) --
  
  The filter values. Filter values are case-sensitive.
  - (string) --

type MaxResults

integer

param MaxResults

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

type NextToken

string

param NextToken

The token for the next page of results.

type DryRun

boolean

param DryRun

rtype

dict

returns

Response Syntax

{
    'TransitGatewayAttachments': [
        {
            'TransitGatewayAttachmentId': 'string',
            'TransitGatewayId': 'string',
            'TransitGatewayOwnerId': 'string',
            'ResourceOwnerId': 'string',
            'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'|'peering'|'tgw-peering',
            'ResourceId': 'string',
            'State': 'initiating'|'initiatingRequest'|'pendingAcceptance'|'rollingBack'|'pending'|'available'|'modifying'|'deleting'|'deleted'|'failed'|'rejected'|'rejecting'|'failing',
            'Association': {
                'TransitGatewayRouteTableId': 'string',
                'State': 'associating'|'associated'|'disassociating'|'disassociated'
            },
            'CreationTime': datetime(2015, 1, 1),
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- TransitGatewayAttachments (list) --
  
  Information about the attachments.
  - (dict) --
    
    Describes an attachment between a resource and a transit gateway.
    - TransitGatewayAttachmentId (string) --
      
      The ID of the attachment.
    - TransitGatewayId (string) --
      
      The ID of the transit gateway.
    - TransitGatewayOwnerId (string) --
      
      The ID of the AWS account that owns the transit gateway.
    - ResourceOwnerId (string) --
      
      The ID of the AWS account that owns the resource.
    - ResourceType (string) --
      
      The resource type. Note that the tgw-peering resource type has been deprecated.
    - ResourceId (string) --
      
      The ID of the resource.
    - State (string) --
      
      The attachment state. Note that the initiating state has been deprecated.
    - Association (dict) --
      
      The association.
      - TransitGatewayRouteTableId (string) --
        
        The ID of the route table for the transit gateway.
      - State (string) --
        
        The state of the association.
    - CreationTime (datetime) --
      
      The creation time.
    - 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 255 Unicode characters.
- NextToken (string) --
  
  The token to use to retrieve the next page of results. This value is null when there are no more results to return.

DescribeTransitGatewayPeeringAttachments (updated)

Link ¶
Changes (response)

{'TransitGatewayPeeringAttachments': {'State': {'initiatingRequest'}}}

Describes your transit gateway peering attachments.

See also: AWS API Documentation

Request Syntax

client.describe_transit_gateway_peering_attachments(
    TransitGatewayAttachmentIds=[
        'string',
    ],
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NextToken='string',
    DryRun=True|False
)

type TransitGatewayAttachmentIds

list

param TransitGatewayAttachmentIds

One or more IDs of the transit gateway peering attachments.

(string) --

type Filters

list

param Filters

One or more filters. The possible values are:

transit-gateway-attachment-id - The ID of the transit gateway attachment.
local-owner-id - The ID of your AWS account.
remote-owner-id - The ID of the AWS account in the remote Region that owns the transit gateway.
state - The state of the peering attachment. Valid values are available | deleted | deleting | failed | failing | initiatingRequest | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting ).
transit-gateway-id - The ID of the transit gateway.

(dict) --

A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. The filters supported by a describe operation are documented with the describe operation. For example:
- DescribeAvailabilityZones
- DescribeImages
- DescribeInstances
- DescribeKeyPairs
- DescribeSecurityGroups
- DescribeSnapshots
- DescribeSubnets
- DescribeTags
- DescribeVolumes
- DescribeVpcs
- Name (string) --
  
  The name of the filter. Filter names are case-sensitive.
- Values (list) --
  
  The filter values. Filter values are case-sensitive.
  - (string) --

type MaxResults

integer

param MaxResults

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

type NextToken

string

param NextToken

The token for the next page of results.

type DryRun

boolean

param DryRun

rtype

dict

returns

Response Syntax

{
    'TransitGatewayPeeringAttachments': [
        {
            'TransitGatewayAttachmentId': 'string',
            'RequesterTgwInfo': {
                'TransitGatewayId': 'string',
                'OwnerId': 'string',
                'Region': 'string'
            },
            'AccepterTgwInfo': {
                'TransitGatewayId': 'string',
                'OwnerId': 'string',
                'Region': 'string'
            },
            'Status': {
                'Code': 'string',
                'Message': 'string'
            },
            'State': 'initiating'|'initiatingRequest'|'pendingAcceptance'|'rollingBack'|'pending'|'available'|'modifying'|'deleting'|'deleted'|'failed'|'rejected'|'rejecting'|'failing',
            'CreationTime': datetime(2015, 1, 1),
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- TransitGatewayPeeringAttachments (list) --
  
  The transit gateway peering attachments.
  - (dict) --
    
    Describes the transit gateway peering attachment.
    - TransitGatewayAttachmentId (string) --
      
      The ID of the transit gateway peering attachment.
    - RequesterTgwInfo (dict) --
      
      Information about the requester transit gateway.
      - TransitGatewayId (string) --
        
        The ID of the transit gateway.
      - OwnerId (string) --
        
        The AWS account ID of the owner of the transit gateway.
      - Region (string) --
        
        The Region of the transit gateway.
    - AccepterTgwInfo (dict) --
      
      Information about the accepter transit gateway.
      - TransitGatewayId (string) --
        
        The ID of the transit gateway.
      - OwnerId (string) --
        
        The AWS account ID of the owner of the transit gateway.
      - Region (string) --
        
        The Region of the transit gateway.
    - Status (dict) --
      
      The status of the transit gateway peering attachment.
      - Code (string) --
        
        The status code.
      - Message (string) --
        
        The status message, if applicable.
    - State (string) --
      
      The state of the transit gateway peering attachment. Note that the initiating state has been deprecated.
    - CreationTime (datetime) --
      
      The time the transit gateway peering attachment was created.
    - Tags (list) --
      
      The tags for the transit gateway peering 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 255 Unicode characters.
- NextToken (string) --
  
  The token to use to retrieve the next page of results. This value is null when there are no more results to return.

DescribeTransitGatewayVpcAttachments (updated)

Link ¶
Changes (response)

{'TransitGatewayVpcAttachments': {'State': {'initiatingRequest'}}}

Describes one or more VPC attachments. By default, all VPC attachments are described. Alternatively, you can filter the results.

See also: AWS API Documentation

Request Syntax

client.describe_transit_gateway_vpc_attachments(
    TransitGatewayAttachmentIds=[
        'string',
    ],
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NextToken='string',
    DryRun=True|False
)

type TransitGatewayAttachmentIds

list

param TransitGatewayAttachmentIds

The IDs of the attachments.

(string) --

type Filters

list

param Filters

One or more filters. The possible values are:

state - The state of the attachment. Valid values are available | deleted | deleting | failed | failing | initiatingRequest | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting .
transit-gateway-attachment-id - The ID of the attachment.
transit-gateway-id - The ID of the transit gateway.
vpc-id - The ID of the VPC.

(dict) --

A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. The filters supported by a describe operation are documented with the describe operation. For example:
- DescribeAvailabilityZones
- DescribeImages
- DescribeInstances
- DescribeKeyPairs
- DescribeSecurityGroups
- DescribeSnapshots
- DescribeSubnets
- DescribeTags
- DescribeVolumes
- DescribeVpcs
- Name (string) --
  
  The name of the filter. Filter names are case-sensitive.
- Values (list) --
  
  The filter values. Filter values are case-sensitive.
  - (string) --

type MaxResults

integer

param MaxResults

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

type NextToken

string

param NextToken

The token for the next page of results.

type DryRun

boolean

param DryRun

rtype

dict

returns

Response Syntax

{
    'TransitGatewayVpcAttachments': [
        {
            'TransitGatewayAttachmentId': 'string',
            'TransitGatewayId': 'string',
            'VpcId': 'string',
            'VpcOwnerId': 'string',
            'State': 'initiating'|'initiatingRequest'|'pendingAcceptance'|'rollingBack'|'pending'|'available'|'modifying'|'deleting'|'deleted'|'failed'|'rejected'|'rejecting'|'failing',
            'SubnetIds': [
                'string',
            ],
            'CreationTime': datetime(2015, 1, 1),
            'Options': {
                'DnsSupport': 'enable'|'disable',
                'Ipv6Support': 'enable'|'disable'
            },
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- TransitGatewayVpcAttachments (list) --
  
  Information about the VPC attachments.
  - (dict) --
    
    Describes a VPC attachment.
    - TransitGatewayAttachmentId (string) --
      
      The ID of the attachment.
    - TransitGatewayId (string) --
      
      The ID of the transit gateway.
    - VpcId (string) --
      
      The ID of the VPC.
    - VpcOwnerId (string) --
      
      The ID of the AWS account that owns the VPC.
    - State (string) --
      
      The state of the VPC attachment. Note that the initiating state has been deprecated.
    - SubnetIds (list) --
      
      The IDs of the subnets.
      - (string) --
    - CreationTime (datetime) --
      
      The creation time.
    - Options (dict) --
      
      The VPC attachment options.
      - DnsSupport (string) --
        
        Indicates whether DNS support is enabled.
      - Ipv6Support (string) --
        
        Indicates whether IPv6 support is disabled.
    - Tags (list) --
      
      The tags for the VPC 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 255 Unicode characters.
- NextToken (string) --
  
  The token to use to retrieve the next page of results. This value is null when there are no more results to return.

DisableTransitGatewayRouteTablePropagation (updated)

Link ¶
Changes (response)

{'Propagation': {'ResourceType': {'peering'}}}

Disables the specified resource attachment from propagating routes to the specified propagation route table.

See also: AWS API Documentation

Request Syntax

client.disable_transit_gateway_route_table_propagation(
    TransitGatewayRouteTableId='string',
    TransitGatewayAttachmentId='string',
    DryRun=True|False
)

type TransitGatewayRouteTableId

string

param TransitGatewayRouteTableId

[REQUIRED]

The ID of the propagation route table.

type TransitGatewayAttachmentId

string

param TransitGatewayAttachmentId

[REQUIRED]

The ID of the attachment.

type DryRun

boolean

param DryRun

rtype

dict

returns

Response Syntax

{
    'Propagation': {
        'TransitGatewayAttachmentId': 'string',
        'ResourceId': 'string',
        'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'|'peering'|'tgw-peering',
        'TransitGatewayRouteTableId': 'string',
        'State': 'enabling'|'enabled'|'disabling'|'disabled'
    }
}

Response Structure

(dict) --
- Propagation (dict) --
  
  Information about route propagation.
  - TransitGatewayAttachmentId (string) --
    
    The ID of the attachment.
  - ResourceId (string) --
    
    The ID of the resource.
  - ResourceType (string) --
    
    The resource type. Note that the tgw-peering resource type has been deprecated.
  - TransitGatewayRouteTableId (string) --
    
    The ID of the transit gateway route table.
  - State (string) --
    
    The state.

DisassociateTransitGatewayMulticastDomain (updated)

Link ¶
Changes (response)

{'Associations': {'ResourceType': {'peering'}}}

Disassociates the specified subnets from the transit gateway multicast domain.

See also: AWS API Documentation

Request Syntax

client.disassociate_transit_gateway_multicast_domain(
    TransitGatewayMulticastDomainId='string',
    TransitGatewayAttachmentId='string',
    SubnetIds=[
        'string',
    ],
    DryRun=True|False
)

type TransitGatewayMulticastDomainId

string

param TransitGatewayMulticastDomainId

The ID of the transit gateway multicast domain.

type TransitGatewayAttachmentId

string

param TransitGatewayAttachmentId

The ID of the attachment.

type SubnetIds

list

param SubnetIds

The IDs of the subnets;

(string) --

type DryRun

boolean

param DryRun

rtype

dict

returns

Response Syntax

{
    'Associations': {
        'TransitGatewayMulticastDomainId': 'string',
        'TransitGatewayAttachmentId': 'string',
        'ResourceId': 'string',
        'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'|'peering'|'tgw-peering',
        'Subnets': [
            {
                'SubnetId': 'string',
                'State': 'associating'|'associated'|'disassociating'|'disassociated'
            },
        ]
    }
}

Response Structure

(dict) --
- Associations (dict) --
  
  Information about the association.
  - TransitGatewayMulticastDomainId (string) --
    
    The ID of the transit gateway multicast domain.
  - TransitGatewayAttachmentId (string) --
    
    The ID of the transit gateway attachment.
  - ResourceId (string) --
    
    The ID of the resource.
  - ResourceType (string) --
    
    The type of resource, for example a VPC attachment.
  - Subnets (list) --
    
    The subnets associated with the multicast domain.
    - (dict) --
      
      Describes the subnet association with the transit gateway multicast domain.
      - SubnetId (string) --
        
        The ID of the subnet.
      - State (string) --
        
        The state of the subnet association.

DisassociateTransitGatewayRouteTable (updated)

Link ¶
Changes (response)

{'Association': {'ResourceType': {'peering'}}}

Disassociates a resource attachment from a transit gateway route table.

See also: AWS API Documentation

Request Syntax

client.disassociate_transit_gateway_route_table(
    TransitGatewayRouteTableId='string',
    TransitGatewayAttachmentId='string',
    DryRun=True|False
)

type TransitGatewayRouteTableId

string

param TransitGatewayRouteTableId

[REQUIRED]

The ID of the transit gateway route table.

type TransitGatewayAttachmentId

string

param TransitGatewayAttachmentId

[REQUIRED]

The ID of the attachment.

type DryRun

boolean

param DryRun

rtype

dict

returns

Response Syntax

{
    'Association': {
        'TransitGatewayRouteTableId': 'string',
        'TransitGatewayAttachmentId': 'string',
        'ResourceId': 'string',
        'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'|'peering'|'tgw-peering',
        'State': 'associating'|'associated'|'disassociating'|'disassociated'
    }
}

Response Structure

(dict) --
- Association (dict) --
  
  Information about the association.
  - TransitGatewayRouteTableId (string) --
    
    The ID of the transit gateway route table.
  - TransitGatewayAttachmentId (string) --
    
    The ID of the attachment.
  - ResourceId (string) --
    
    The ID of the resource.
  - ResourceType (string) --
    
    The resource type. Note that the tgw-peering resource type has been deprecated.
  - State (string) --
    
    The state of the association.

EnableTransitGatewayRouteTablePropagation (updated)

Link ¶
Changes (response)

{'Propagation': {'ResourceType': {'peering'}}}

Enables the specified attachment to propagate routes to the specified propagation route table.

See also: AWS API Documentation

Request Syntax

client.enable_transit_gateway_route_table_propagation(
    TransitGatewayRouteTableId='string',
    TransitGatewayAttachmentId='string',
    DryRun=True|False
)

type TransitGatewayRouteTableId

string

param TransitGatewayRouteTableId

[REQUIRED]

The ID of the propagation route table.

type TransitGatewayAttachmentId

string

param TransitGatewayAttachmentId

[REQUIRED]

The ID of the attachment.

type DryRun

boolean

param DryRun

rtype

dict

returns

Response Syntax

{
    'Propagation': {
        'TransitGatewayAttachmentId': 'string',
        'ResourceId': 'string',
        'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'|'peering'|'tgw-peering',
        'TransitGatewayRouteTableId': 'string',
        'State': 'enabling'|'enabled'|'disabling'|'disabled'
    }
}

Response Structure

(dict) --
- Propagation (dict) --
  
  Information about route propagation.
  - TransitGatewayAttachmentId (string) --
    
    The ID of the attachment.
  - ResourceId (string) --
    
    The ID of the resource.
  - ResourceType (string) --
    
    The resource type. Note that the tgw-peering resource type has been deprecated.
  - TransitGatewayRouteTableId (string) --
    
    The ID of the transit gateway route table.
  - State (string) --
    
    The state.

GetTransitGatewayMulticastDomainAssociations (updated)

Link ¶
Changes (response)

{'MulticastDomainAssociations': {'ResourceType': {'peering'}}}

Gets information about the associations for the transit gateway multicast domain.

See also: AWS API Documentation

Request Syntax

client.get_transit_gateway_multicast_domain_associations(
    TransitGatewayMulticastDomainId='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NextToken='string',
    DryRun=True|False
)

type TransitGatewayMulticastDomainId

string

param TransitGatewayMulticastDomainId

The ID of the transit gateway multicast domain.

type Filters

list

param Filters

One or more filters. The possible values are:

resource-id - The ID of the resource.
resource-type - The type of resource. The valid value is: vpc .
state - The state of the subnet association. Valid values are associated | associating | disassociated | disassociating .
subnet-id - The ID of the subnet.
transit-gateway-attachment-id - The id of the transit gateway attachment.

(dict) --

A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. The filters supported by a describe operation are documented with the describe operation. For example:
- DescribeAvailabilityZones
- DescribeImages
- DescribeInstances
- DescribeKeyPairs
- DescribeSecurityGroups
- DescribeSnapshots
- DescribeSubnets
- DescribeTags
- DescribeVolumes
- DescribeVpcs
- Name (string) --
  
  The name of the filter. Filter names are case-sensitive.
- Values (list) --
  
  The filter values. Filter values are case-sensitive.
  - (string) --

type MaxResults

integer

param MaxResults

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

type NextToken

string

param NextToken

The token for the next page of results.

type DryRun

boolean

param DryRun

rtype

dict

returns

Response Syntax

{
    'MulticastDomainAssociations': [
        {
            'TransitGatewayAttachmentId': 'string',
            'ResourceId': 'string',
            'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'|'peering'|'tgw-peering',
            'Subnet': {
                'SubnetId': 'string',
                'State': 'associating'|'associated'|'disassociating'|'disassociated'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- MulticastDomainAssociations (list) --
  
  Information about the multicast domain associations.
  - (dict) --
    
    Describes the resources associated with the transit gateway multicast domain.
    - TransitGatewayAttachmentId (string) --
      
      The ID of the transit gateway attachment.
    - ResourceId (string) --
      
      The ID of the resource.
    - ResourceType (string) --
      
      The type of resource, for example a VPC attachment.
    - Subnet (dict) --
      
      The subnet associated with the transit gateway multicast domain.
      - SubnetId (string) --
        
        The ID of the subnet.
      - State (string) --
        
        The state of the subnet association.
- NextToken (string) --
  
  The token to use to retrieve the next page of results. This value is null when there are no more results to return.

GetTransitGatewayPrefixListReferences (updated)

Link ¶
Changes (response)

{'TransitGatewayPrefixListReferences': {'TransitGatewayAttachment': {'ResourceType': {'peering'}}}}

Gets information about the prefix list references in a specified transit gateway route table.

See also: AWS API Documentation

Request Syntax

client.get_transit_gateway_prefix_list_references(
    TransitGatewayRouteTableId='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NextToken='string',
    DryRun=True|False
)

type TransitGatewayRouteTableId

string

param TransitGatewayRouteTableId

[REQUIRED]

The ID of the transit gateway route table.

type Filters

list

param Filters

One or more filters. The possible values are:

attachment.resource-id - The ID of the resource for the attachment.
attachment.resource-type - The type of resource for the attachment. Valid values are vpc | vpn | direct-connect-gateway | peering .
attachment.transit-gateway-attachment-id - The ID of the attachment.
is-blackhole - Whether traffic matching the route is blocked ( true | false ).
prefix-list-id - The ID of the prefix list.
prefix-list-owner-id - The ID of the owner of the prefix list.
state - The state of the prefix list reference ( pending | available | modifying | deleting ).

(dict) --

A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. The filters supported by a describe operation are documented with the describe operation. For example:
- DescribeAvailabilityZones
- DescribeImages
- DescribeInstances
- DescribeKeyPairs
- DescribeSecurityGroups
- DescribeSnapshots
- DescribeSubnets
- DescribeTags
- DescribeVolumes
- DescribeVpcs
- Name (string) --
  
  The name of the filter. Filter names are case-sensitive.
- Values (list) --
  
  The filter values. Filter values are case-sensitive.
  - (string) --

type MaxResults

integer

param MaxResults

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

type NextToken

string

param NextToken

The token for the next page of results.

type DryRun

boolean

param DryRun

rtype

dict

returns

Response Syntax

{
    'TransitGatewayPrefixListReferences': [
        {
            'TransitGatewayRouteTableId': 'string',
            'PrefixListId': 'string',
            'PrefixListOwnerId': 'string',
            'State': 'pending'|'available'|'modifying'|'deleting',
            'Blackhole': True|False,
            'TransitGatewayAttachment': {
                'TransitGatewayAttachmentId': 'string',
                'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'|'peering'|'tgw-peering',
                'ResourceId': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- TransitGatewayPrefixListReferences (list) --
  
  Information about the prefix list references.
  - (dict) --
    
    Describes a prefix list reference.
    - TransitGatewayRouteTableId (string) --
      
      The ID of the transit gateway route table.
    - PrefixListId (string) --
      
      The ID of the prefix list.
    - PrefixListOwnerId (string) --
      
      The ID of the prefix list owner.
    - State (string) --
      
      The state of the prefix list reference.
    - Blackhole (boolean) --
      
      Indicates whether traffic that matches this route is dropped.
    - TransitGatewayAttachment (dict) --
      
      Information about the transit gateway attachment.
      - TransitGatewayAttachmentId (string) --
        
        The ID of the attachment.
      - ResourceType (string) --
        
        The resource type. Note that the tgw-peering resource type has been deprecated.
      - ResourceId (string) --
        
        The ID of the resource.
- NextToken (string) --
  
  The token to use to retrieve the next page of results. This value is null when there are no more results to return.

GetTransitGatewayRouteTableAssociations (updated)

Link ¶
Changes (response)

{'Associations': {'ResourceType': {'peering'}}}

Gets information about the associations for the specified transit gateway route table.

See also: AWS API Documentation

Request Syntax

client.get_transit_gateway_route_table_associations(
    TransitGatewayRouteTableId='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NextToken='string',
    DryRun=True|False
)

type TransitGatewayRouteTableId

string

param TransitGatewayRouteTableId

[REQUIRED]

The ID of the transit gateway route table.

type Filters

list

param Filters

One or more filters. The possible values are:

resource-id - The ID of the resource.
resource-type - The resource type. Valid values are vpc | vpn | direct-connect-gateway | peering .
transit-gateway-attachment-id - The ID of the attachment.

(dict) --

A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. The filters supported by a describe operation are documented with the describe operation. For example:
- DescribeAvailabilityZones
- DescribeImages
- DescribeInstances
- DescribeKeyPairs
- DescribeSecurityGroups
- DescribeSnapshots
- DescribeSubnets
- DescribeTags
- DescribeVolumes
- DescribeVpcs
- Name (string) --
  
  The name of the filter. Filter names are case-sensitive.
- Values (list) --
  
  The filter values. Filter values are case-sensitive.
  - (string) --

type MaxResults

integer

param MaxResults

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

type NextToken

string

param NextToken

The token for the next page of results.

type DryRun

boolean

param DryRun

rtype

dict

returns

Response Syntax

{
    'Associations': [
        {
            'TransitGatewayAttachmentId': 'string',
            'ResourceId': 'string',
            'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'|'peering'|'tgw-peering',
            'State': 'associating'|'associated'|'disassociating'|'disassociated'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- Associations (list) --
  
  Information about the associations.
  - (dict) --
    
    Describes an association between a route table and a resource attachment.
    - TransitGatewayAttachmentId (string) --
      
      The ID of the attachment.
    - ResourceId (string) --
      
      The ID of the resource.
    - ResourceType (string) --
      
      The resource type. Note that the tgw-peering resource type has been deprecated.
    - State (string) --
      
      The state of the association.
- NextToken (string) --
  
  The token to use to retrieve the next page of results. This value is null when there are no more results to return.

GetTransitGatewayRouteTablePropagations (updated)

Link ¶
Changes (response)

{'TransitGatewayRouteTablePropagations': {'ResourceType': {'peering'}}}

Gets information about the route table propagations for the specified transit gateway route table.

See also: AWS API Documentation

Request Syntax

client.get_transit_gateway_route_table_propagations(
    TransitGatewayRouteTableId='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NextToken='string',
    DryRun=True|False
)

type TransitGatewayRouteTableId

string

param TransitGatewayRouteTableId

[REQUIRED]

The ID of the transit gateway route table.

type Filters

list

param Filters

One or more filters. The possible values are:

resource-id - The ID of the resource.
resource-type - The resource type. Valid values are vpc | vpn | direct-connect-gateway | peering .
transit-gateway-attachment-id - The ID of the attachment.

(dict) --

A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. The filters supported by a describe operation are documented with the describe operation. For example:
- DescribeAvailabilityZones
- DescribeImages
- DescribeInstances
- DescribeKeyPairs
- DescribeSecurityGroups
- DescribeSnapshots
- DescribeSubnets
- DescribeTags
- DescribeVolumes
- DescribeVpcs
- Name (string) --
  
  The name of the filter. Filter names are case-sensitive.
- Values (list) --
  
  The filter values. Filter values are case-sensitive.
  - (string) --

type MaxResults

integer

param MaxResults

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

type NextToken

string

param NextToken

The token for the next page of results.

type DryRun

boolean

param DryRun

rtype

dict

returns

Response Syntax

{
    'TransitGatewayRouteTablePropagations': [
        {
            'TransitGatewayAttachmentId': 'string',
            'ResourceId': 'string',
            'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'|'peering'|'tgw-peering',
            'State': 'enabling'|'enabled'|'disabling'|'disabled'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- TransitGatewayRouteTablePropagations (list) --
  
  Information about the route table propagations.
  - (dict) --
    
    Describes a route table propagation.
    - TransitGatewayAttachmentId (string) --
      
      The ID of the attachment.
    - ResourceId (string) --
      
      The ID of the resource.
    - ResourceType (string) --
      
      The type of resource. Note that the tgw-peering resource type has been deprecated.
    - State (string) --
      
      The state of the resource.
- NextToken (string) --
  
  The token to use to retrieve the next page of results. This value is null when there are no more results to return.

ModifyTransitGatewayPrefixListReference (updated)

Link ¶
Changes (response)

{'TransitGatewayPrefixListReference': {'TransitGatewayAttachment': {'ResourceType': {'peering'}}}}

Modifies a reference (route) to a prefix list in a specified transit gateway route table.

See also: AWS API Documentation

Request Syntax

client.modify_transit_gateway_prefix_list_reference(
    TransitGatewayRouteTableId='string',
    PrefixListId='string',
    TransitGatewayAttachmentId='string',
    Blackhole=True|False,
    DryRun=True|False
)

type TransitGatewayRouteTableId

string

param TransitGatewayRouteTableId

[REQUIRED]

The ID of the transit gateway route table.

type PrefixListId

string

param PrefixListId

[REQUIRED]

The ID of the prefix list.

type TransitGatewayAttachmentId

string

param TransitGatewayAttachmentId

The ID of the attachment to which traffic is routed.

type Blackhole

boolean

param Blackhole

Indicates whether to drop traffic that matches this route.

type DryRun

boolean

param DryRun

rtype

dict

returns

Response Syntax

{
    'TransitGatewayPrefixListReference': {
        'TransitGatewayRouteTableId': 'string',
        'PrefixListId': 'string',
        'PrefixListOwnerId': 'string',
        'State': 'pending'|'available'|'modifying'|'deleting',
        'Blackhole': True|False,
        'TransitGatewayAttachment': {
            'TransitGatewayAttachmentId': 'string',
            'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'|'peering'|'tgw-peering',
            'ResourceId': 'string'
        }
    }
}

Response Structure

(dict) --
- TransitGatewayPrefixListReference (dict) --
  
  Information about the prefix list reference.
  - TransitGatewayRouteTableId (string) --
    
    The ID of the transit gateway route table.
  - PrefixListId (string) --
    
    The ID of the prefix list.
  - PrefixListOwnerId (string) --
    
    The ID of the prefix list owner.
  - State (string) --
    
    The state of the prefix list reference.
  - Blackhole (boolean) --
    
    Indicates whether traffic that matches this route is dropped.
  - TransitGatewayAttachment (dict) --
    
    Information about the transit gateway attachment.
    - TransitGatewayAttachmentId (string) --
      
      The ID of the attachment.
    - ResourceType (string) --
      
      The resource type. Note that the tgw-peering resource type has been deprecated.
    - ResourceId (string) --
      
      The ID of the resource.

ModifyTransitGatewayVpcAttachment (updated)

Link ¶
Changes (response)

{'TransitGatewayVpcAttachment': {'State': {'initiatingRequest'}}}

Modifies the specified VPC attachment.

See also: AWS API Documentation

Request Syntax

client.modify_transit_gateway_vpc_attachment(
    TransitGatewayAttachmentId='string',
    AddSubnetIds=[
        'string',
    ],
    RemoveSubnetIds=[
        'string',
    ],
    Options={
        'DnsSupport': 'enable'|'disable',
        'Ipv6Support': 'enable'|'disable'
    },
    DryRun=True|False
)

type TransitGatewayAttachmentId

string

param TransitGatewayAttachmentId

[REQUIRED]

The ID of the attachment.

type AddSubnetIds

list

param AddSubnetIds

The IDs of one or more subnets to add. You can specify at most one subnet per Availability Zone.

(string) --

type RemoveSubnetIds

list

param RemoveSubnetIds

The IDs of one or more subnets to remove.

(string) --

type Options

dict

param Options

The new VPC attachment options.

Note

You cannot modify the IPv6 options.

DnsSupport (string) --

Enable or disable DNS support. The default is enable .
Ipv6Support (string) --

Enable or disable IPv6 support. The default is enable .

type DryRun

boolean

param DryRun

rtype

dict

returns

Response Syntax

{
    'TransitGatewayVpcAttachment': {
        'TransitGatewayAttachmentId': 'string',
        'TransitGatewayId': 'string',
        'VpcId': 'string',
        'VpcOwnerId': 'string',
        'State': 'initiating'|'initiatingRequest'|'pendingAcceptance'|'rollingBack'|'pending'|'available'|'modifying'|'deleting'|'deleted'|'failed'|'rejected'|'rejecting'|'failing',
        'SubnetIds': [
            'string',
        ],
        'CreationTime': datetime(2015, 1, 1),
        'Options': {
            'DnsSupport': 'enable'|'disable',
            'Ipv6Support': 'enable'|'disable'
        },
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

(dict) --
- TransitGatewayVpcAttachment (dict) --
  
  Information about the modified attachment.
  - TransitGatewayAttachmentId (string) --
    
    The ID of the attachment.
  - TransitGatewayId (string) --
    
    The ID of the transit gateway.
  - VpcId (string) --
    
    The ID of the VPC.
  - VpcOwnerId (string) --
    
    The ID of the AWS account that owns the VPC.
  - State (string) --
    
    The state of the VPC attachment. Note that the initiating state has been deprecated.
  - SubnetIds (list) --
    
    The IDs of the subnets.
    - (string) --
  - CreationTime (datetime) --
    
    The creation time.
  - Options (dict) --
    
    The VPC attachment options.
    - DnsSupport (string) --
      
      Indicates whether DNS support is enabled.
    - Ipv6Support (string) --
      
      Indicates whether IPv6 support is disabled.
  - Tags (list) --
    
    The tags for the VPC 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 255 Unicode characters.

RejectTransitGatewayPeeringAttachment (updated)

Link ¶
Changes (response)

{'TransitGatewayPeeringAttachment': {'State': {'initiatingRequest'}}}

Rejects a transit gateway peering attachment request.

See also: AWS API Documentation

Request Syntax

client.reject_transit_gateway_peering_attachment(
    TransitGatewayAttachmentId='string',
    DryRun=True|False
)

type TransitGatewayAttachmentId

string

param TransitGatewayAttachmentId

[REQUIRED]

The ID of the transit gateway peering attachment.

type DryRun

boolean

param DryRun

rtype

dict

returns

Response Syntax

{
    'TransitGatewayPeeringAttachment': {
        'TransitGatewayAttachmentId': 'string',
        'RequesterTgwInfo': {
            'TransitGatewayId': 'string',
            'OwnerId': 'string',
            'Region': 'string'
        },
        'AccepterTgwInfo': {
            'TransitGatewayId': 'string',
            'OwnerId': 'string',
            'Region': 'string'
        },
        'Status': {
            'Code': 'string',
            'Message': 'string'
        },
        'State': 'initiating'|'initiatingRequest'|'pendingAcceptance'|'rollingBack'|'pending'|'available'|'modifying'|'deleting'|'deleted'|'failed'|'rejected'|'rejecting'|'failing',
        'CreationTime': datetime(2015, 1, 1),
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

(dict) --
- TransitGatewayPeeringAttachment (dict) --
  
  The transit gateway peering attachment.
  - TransitGatewayAttachmentId (string) --
    
    The ID of the transit gateway peering attachment.
  - RequesterTgwInfo (dict) --
    
    Information about the requester transit gateway.
    - TransitGatewayId (string) --
      
      The ID of the transit gateway.
    - OwnerId (string) --
      
      The AWS account ID of the owner of the transit gateway.
    - Region (string) --
      
      The Region of the transit gateway.
  - AccepterTgwInfo (dict) --
    
    Information about the accepter transit gateway.
    - TransitGatewayId (string) --
      
      The ID of the transit gateway.
    - OwnerId (string) --
      
      The AWS account ID of the owner of the transit gateway.
    - Region (string) --
      
      The Region of the transit gateway.
  - Status (dict) --
    
    The status of the transit gateway peering attachment.
    - Code (string) --
      
      The status code.
    - Message (string) --
      
      The status message, if applicable.
  - State (string) --
    
    The state of the transit gateway peering attachment. Note that the initiating state has been deprecated.
  - CreationTime (datetime) --
    
    The time the transit gateway peering attachment was created.
  - Tags (list) --
    
    The tags for the transit gateway peering 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 255 Unicode characters.

RejectTransitGatewayVpcAttachment (updated)

Link ¶
Changes (response)

{'TransitGatewayVpcAttachment': {'State': {'initiatingRequest'}}}

Rejects a request to attach a VPC to a transit gateway.

The VPC attachment must be in the pendingAcceptance state. Use DescribeTransitGatewayVpcAttachments to view your pending VPC attachment requests. Use AcceptTransitGatewayVpcAttachment to accept a VPC attachment request.

See also: AWS API Documentation

Request Syntax

client.reject_transit_gateway_vpc_attachment(
    TransitGatewayAttachmentId='string',
    DryRun=True|False
)

type TransitGatewayAttachmentId

string

param TransitGatewayAttachmentId

[REQUIRED]

The ID of the attachment.

type DryRun

boolean

param DryRun

rtype

dict

returns

Response Syntax

{
    'TransitGatewayVpcAttachment': {
        'TransitGatewayAttachmentId': 'string',
        'TransitGatewayId': 'string',
        'VpcId': 'string',
        'VpcOwnerId': 'string',
        'State': 'initiating'|'initiatingRequest'|'pendingAcceptance'|'rollingBack'|'pending'|'available'|'modifying'|'deleting'|'deleted'|'failed'|'rejected'|'rejecting'|'failing',
        'SubnetIds': [
            'string',
        ],
        'CreationTime': datetime(2015, 1, 1),
        'Options': {
            'DnsSupport': 'enable'|'disable',
            'Ipv6Support': 'enable'|'disable'
        },
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

(dict) --
- TransitGatewayVpcAttachment (dict) --
  
  Information about the attachment.
  - TransitGatewayAttachmentId (string) --
    
    The ID of the attachment.
  - TransitGatewayId (string) --
    
    The ID of the transit gateway.
  - VpcId (string) --
    
    The ID of the VPC.
  - VpcOwnerId (string) --
    
    The ID of the AWS account that owns the VPC.
  - State (string) --
    
    The state of the VPC attachment. Note that the initiating state has been deprecated.
  - SubnetIds (list) --
    
    The IDs of the subnets.
    - (string) --
  - CreationTime (datetime) --
    
    The creation time.
  - Options (dict) --
    
    The VPC attachment options.
    - DnsSupport (string) --
      
      Indicates whether DNS support is enabled.
    - Ipv6Support (string) --
      
      Indicates whether IPv6 support is disabled.
  - Tags (list) --
    
    The tags for the VPC 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 255 Unicode characters.

ReplaceTransitGatewayRoute (updated)

Link ¶
Changes (response)

{'Route': {'TransitGatewayAttachments': {'ResourceType': {'peering'}}}}

Replaces the specified route in the specified transit gateway route table.

See also: AWS API Documentation

Request Syntax

client.replace_transit_gateway_route(
    DestinationCidrBlock='string',
    TransitGatewayRouteTableId='string',
    TransitGatewayAttachmentId='string',
    Blackhole=True|False,
    DryRun=True|False
)

type DestinationCidrBlock

string

param DestinationCidrBlock

[REQUIRED]

The CIDR range used for the destination match. Routing decisions are based on the most specific match.

type TransitGatewayRouteTableId

string

param TransitGatewayRouteTableId

[REQUIRED]

The ID of the route table.

type TransitGatewayAttachmentId

string

param TransitGatewayAttachmentId

The ID of the attachment.

type Blackhole

boolean

param Blackhole

Indicates whether traffic matching this route is to be dropped.

type DryRun

boolean

param DryRun

rtype

dict

returns

Response Syntax

{
    'Route': {
        'DestinationCidrBlock': 'string',
        'PrefixListId': 'string',
        'TransitGatewayAttachments': [
            {
                'ResourceId': 'string',
                'TransitGatewayAttachmentId': 'string',
                'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'|'peering'|'tgw-peering'
            },
        ],
        'Type': 'static'|'propagated',
        'State': 'pending'|'active'|'blackhole'|'deleting'|'deleted'
    }
}

Response Structure

(dict) --
- Route (dict) --
  
  Information about the modified route.
  - DestinationCidrBlock (string) --
    
    The CIDR block used for destination matches.
  - PrefixListId (string) --
    
    The ID of the prefix list used for destination matches.
  - TransitGatewayAttachments (list) --
    
    The attachments.
    - (dict) --
      
      Describes a route attachment.
      - ResourceId (string) --
        
        The ID of the resource.
      - TransitGatewayAttachmentId (string) --
        
        The ID of the attachment.
      - ResourceType (string) --
        
        The resource type. Note that the tgw-peering resource type has been deprecated.
  - Type (string) --
    
    The route type.
  - State (string) --
    
    The state of the route.

SearchTransitGatewayMulticastGroups (updated)

Link ¶
Changes (response)

{'MulticastGroups': {'ResourceType': {'peering'}}}

Searches one or more transit gateway multicast groups and returns the group membership information.

See also: AWS API Documentation

Request Syntax

client.search_transit_gateway_multicast_groups(
    TransitGatewayMulticastDomainId='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NextToken='string',
    DryRun=True|False
)

type TransitGatewayMulticastDomainId

string

param TransitGatewayMulticastDomainId

The ID of the transit gateway multicast domain.

type Filters

list

param Filters

One or more filters. The possible values are:

group-ip-address - The IP address of the transit gateway multicast group.
is-group-member - The resource is a group member. Valid values are true | false .
is-group-source - The resource is a group source. Valid values are true | false .
member-type - The member type. Valid values are igmp | static .
resource-id - The ID of the resource.
resource-type - The type of resource. Valid values are vpc | vpn | direct-connect-gateway | tgw-peering .
source-type - The source type. Valid values are igmp | static .
state - The state of the subnet association. Valid values are associated | associated | disassociated | disassociating .
subnet-id - The ID of the subnet.
transit-gateway-attachment-id - The id of the transit gateway attachment.

(dict) --

A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. The filters supported by a describe operation are documented with the describe operation. For example:
- DescribeAvailabilityZones
- DescribeImages
- DescribeInstances
- DescribeKeyPairs
- DescribeSecurityGroups
- DescribeSnapshots
- DescribeSubnets
- DescribeTags
- DescribeVolumes
- DescribeVpcs
- Name (string) --
  
  The name of the filter. Filter names are case-sensitive.
- Values (list) --
  
  The filter values. Filter values are case-sensitive.
  - (string) --

type MaxResults

integer

param MaxResults

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

type NextToken

string

param NextToken

The token for the next page of results.

type DryRun

boolean

param DryRun

rtype

dict

returns

Response Syntax

{
    'MulticastGroups': [
        {
            'GroupIpAddress': 'string',
            'TransitGatewayAttachmentId': 'string',
            'SubnetId': 'string',
            'ResourceId': 'string',
            'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'|'peering'|'tgw-peering',
            'NetworkInterfaceId': 'string',
            'GroupMember': True|False,
            'GroupSource': True|False,
            'MemberType': 'static'|'igmp',
            'SourceType': 'static'|'igmp'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- MulticastGroups (list) --
  
  Information about the transit gateway multicast group.
  - (dict) --
    
    Describes the transit gateway multicast group resources.
    - GroupIpAddress (string) --
      
      The IP address assigned to the transit gateway multicast group.
    - TransitGatewayAttachmentId (string) --
      
      The ID of the transit gateway attachment.
    - SubnetId (string) --
      
      The ID of the subnet.
    - ResourceId (string) --
      
      The ID of the resource.
    - ResourceType (string) --
      
      The type of resource, for example a VPC attachment.
    - NetworkInterfaceId (string) --
      
      The ID of the transit gateway attachment.
    - GroupMember (boolean) --
      
      Indicates that the resource is a transit gateway multicast group member.
    - GroupSource (boolean) --
      
      Indicates that the resource is a transit gateway multicast group member.
    - MemberType (string) --
      
      The member type (for example, static ).
    - SourceType (string) --
      
      The source type.
- NextToken (string) --
  
  The token to use to retrieve the next page of results. This value is null when there are no more results to return.

SearchTransitGatewayRoutes (updated)

Link ¶
Changes (response)

{'Routes': {'TransitGatewayAttachments': {'ResourceType': {'peering'}}}}

Searches for routes in the specified transit gateway route table.

See also: AWS API Documentation

Request Syntax

client.search_transit_gateway_routes(
    TransitGatewayRouteTableId='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    DryRun=True|False
)

type TransitGatewayRouteTableId

string

param TransitGatewayRouteTableId

[REQUIRED]

The ID of the transit gateway route table.

type Filters

list

param Filters

[REQUIRED]

One or more filters. The possible values are:

attachment.transit-gateway-attachment-id - The id of the transit gateway attachment.
attachment.resource-id - The resource id of the transit gateway attachment.
attachment.resource-type - The attachment resource type. Valid values are vpc | vpn | direct-connect-gateway | peering .
prefix-list-id - The ID of the prefix list.
route-search.exact-match - The exact match of the specified filter.
route-search.longest-prefix-match - The longest prefix that matches the route.
route-search.subnet-of-match - The routes with a subnet that match the specified CIDR filter.
route-search.supernet-of-match - The routes with a CIDR that encompass the CIDR filter. For example, if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify supernet-of-match as 10.0.1.0/30, then the result returns 10.0.1.0/29.
state - The state of the route ( active | blackhole ).
type - The type of route ( propagated | static ).

(dict) --

A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. The filters supported by a describe operation are documented with the describe operation. For example:
- DescribeAvailabilityZones
- DescribeImages
- DescribeInstances
- DescribeKeyPairs
- DescribeSecurityGroups
- DescribeSnapshots
- DescribeSubnets
- DescribeTags
- DescribeVolumes
- DescribeVpcs
- Name (string) --
  
  The name of the filter. Filter names are case-sensitive.
- Values (list) --
  
  The filter values. Filter values are case-sensitive.
  - (string) --

type MaxResults

integer

param MaxResults

The maximum number of routes to return.

type DryRun

boolean

param DryRun

rtype

dict

returns

Response Syntax

{
    'Routes': [
        {
            'DestinationCidrBlock': 'string',
            'PrefixListId': 'string',
            'TransitGatewayAttachments': [
                {
                    'ResourceId': 'string',
                    'TransitGatewayAttachmentId': 'string',
                    'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'|'peering'|'tgw-peering'
                },
            ],
            'Type': 'static'|'propagated',
            'State': 'pending'|'active'|'blackhole'|'deleting'|'deleted'
        },
    ],
    'AdditionalRoutesAvailable': True|False
}

Response Structure

(dict) --
- Routes (list) --
  
  Information about the routes.
  - (dict) --
    
    Describes a route for a transit gateway route table.
    - DestinationCidrBlock (string) --
      
      The CIDR block used for destination matches.
    - PrefixListId (string) --
      
      The ID of the prefix list used for destination matches.
    - TransitGatewayAttachments (list) --
      
      The attachments.
      - (dict) --
        
        Describes a route attachment.
        
        ResourceId (string) --
        
        The ID of the resource.
        
        TransitGatewayAttachmentId (string) --
        
        The ID of the attachment.
        
        ResourceType (string) --
        
        The resource type. Note that the tgw-peering resource type has been deprecated.
    - Type (string) --
      
      The route type.
    - State (string) --
      
      The state of the route.
- AdditionalRoutesAvailable (boolean) --
  
  Indicates whether there are additional routes available.