2019/04/30 - AWS Direct Connect - 3 new9 updated api methods
Changes Update directconnect client to latest version
Accepts ownership of a transit virtual interface created by another AWS account.
After the owner of the transit virtual interface makes this call, the specified transit virtual interface is created and made available to handle traffic.
See also: AWS API Documentation
Request Syntax
client.confirm_transit_virtual_interface(
virtualInterfaceId='string',
directConnectGatewayId='string'
)
string
[REQUIRED]
The ID of the virtual interface.
string
[REQUIRED]
The ID of the Direct Connect gateway.
dict
Response Syntax
{
'virtualInterfaceState': 'confirming'|'verifying'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected'|'unknown'
}
Response Structure
(dict) --
virtualInterfaceState (string) --
The state of the virtual interface. The following are the possible values:
confirming: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.
verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.
pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.
available: A virtual interface that is able to forward traffic.
down: A virtual interface that is BGP down.
deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.
deleted: A virtual interface that cannot forward traffic.
rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the Confirming state is deleted by the virtual interface owner, the virtual interface enters the Rejected state.
unknown: The state of the virtual interface is not available.
Provisions a transit virtual interface to be owned by the specified AWS account. Use this type of interface to connect a transit gateway to your Direct Connect gateway.
The owner of a connection provisions a transit virtual interface to be owned by the specified AWS account.
After you create a transit virtual interface, it must be confirmed by the owner using ConfirmTransitVirtualInterface. Until this step has been completed, the transit virtual interface is in the requested state and is not available to handle traffic.
See also: AWS API Documentation
Request Syntax
client.allocate_transit_virtual_interface(
connectionId='string',
ownerAccount='string',
newTransitVirtualInterfaceAllocation={
'virtualInterfaceName': 'string',
'vlan': 123,
'asn': 123,
'mtu': 123,
'authKey': 'string',
'amazonAddress': 'string',
'customerAddress': 'string',
'addressFamily': 'ipv4'|'ipv6'
}
)
string
[REQUIRED]
The ID of the connection on which the transit virtual interface is provisioned.
string
[REQUIRED]
The ID of the AWS account that owns the transit virtual interface.
dict
[REQUIRED]
Information about the transit virtual interface.
virtualInterfaceName (string) --
The name of the virtual interface assigned by the customer network.
vlan (integer) --
The ID of the VLAN.
asn (integer) --
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
mtu (integer) --
The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.
authKey (string) --
The authentication key for BGP configuration.
amazonAddress (string) --
The IP address assigned to the Amazon interface.
customerAddress (string) --
The IP address assigned to the customer interface.
addressFamily (string) --
The address family for the BGP peer.
dict
Response Syntax
{
'virtualInterface': {
'ownerAccount': 'string',
'virtualInterfaceId': 'string',
'location': 'string',
'connectionId': 'string',
'virtualInterfaceType': 'string',
'virtualInterfaceName': 'string',
'vlan': 123,
'asn': 123,
'amazonSideAsn': 123,
'authKey': 'string',
'amazonAddress': 'string',
'customerAddress': 'string',
'addressFamily': 'ipv4'|'ipv6',
'virtualInterfaceState': 'confirming'|'verifying'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected'|'unknown',
'customerRouterConfig': 'string',
'mtu': 123,
'jumboFrameCapable': True|False,
'virtualGatewayId': 'string',
'directConnectGatewayId': 'string',
'routeFilterPrefixes': [
{
'cidr': 'string'
},
],
'bgpPeers': [
{
'bgpPeerId': 'string',
'asn': 123,
'authKey': 'string',
'addressFamily': 'ipv4'|'ipv6',
'amazonAddress': 'string',
'customerAddress': 'string',
'bgpPeerState': 'verifying'|'pending'|'available'|'deleting'|'deleted',
'bgpStatus': 'up'|'down'|'unknown',
'awsDeviceV2': 'string'
},
],
'region': 'string',
'awsDeviceV2': 'string'
}
}
Response Structure
(dict) --
virtualInterface (dict) --
Information about a virtual interface.
ownerAccount (string) --
The ID of the AWS account that owns the virtual interface.
virtualInterfaceId (string) --
The ID of the virtual interface.
location (string) --
The location of the connection.
connectionId (string) --
The ID of the connection.
virtualInterfaceType (string) --
The type of virtual interface. The possible values are private and public.
virtualInterfaceName (string) --
The name of the virtual interface assigned by the customer network.
vlan (integer) --
The ID of the VLAN.
asn (integer) --
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
amazonSideAsn (integer) --
The autonomous system number (ASN) for the Amazon side of the connection.
authKey (string) --
The authentication key for BGP configuration.
amazonAddress (string) --
The IP address assigned to the Amazon interface.
customerAddress (string) --
The IP address assigned to the customer interface.
addressFamily (string) --
The address family for the BGP peer.
virtualInterfaceState (string) --
The state of the virtual interface. The following are the possible values:
confirming: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.
verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.
pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.
available: A virtual interface that is able to forward traffic.
down: A virtual interface that is BGP down.
deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.
deleted: A virtual interface that cannot forward traffic.
rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the Confirming state is deleted by the virtual interface owner, the virtual interface enters the Rejected state.
unknown: The state of the virtual interface is not available.
customerRouterConfig (string) --
The customer router configuration.
mtu (integer) --
The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames (9001 MTU) are supported.
virtualGatewayId (string) --
The ID of the virtual private gateway. Applies only to private virtual interfaces.
directConnectGatewayId (string) --
The ID of the Direct Connect gateway.
routeFilterPrefixes (list) --
The routes to be advertised to the AWS network in this Region. Applies to public virtual interfaces.
(dict) --
Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
cidr (string) --
The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.
bgpPeers (list) --
The BGP peers configured on this virtual interface.
(dict) --
Information about a BGP peer.
bgpPeerId (string) --
The ID of the BGP peer.
asn (integer) --
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
authKey (string) --
The authentication key for BGP configuration.
addressFamily (string) --
The address family for the BGP peer.
amazonAddress (string) --
The IP address assigned to the Amazon interface.
customerAddress (string) --
The IP address assigned to the customer interface.
bgpPeerState (string) --
The state of the BGP peer. The following are the possible values:
verifying: The BGP peering addresses or ASN require validation before the BGP peer can be created. This state applies only to public virtual interfaces.
pending: The BGP peer is created, and remains in this state until it is ready to be established.
available: The BGP peer is ready to be established.
deleting: The BGP peer is being deleted.
deleted: The BGP peer is deleted and cannot be established.
bgpStatus (string) --
The status of the BGP peer. The following are the possible values:
up: The BGP peer is established. This state does not indicate the state of the routing function. Ensure that you are receiving routes over the BGP session.
down: The BGP peer is down.
unknown: The BGP peer status is not available.
awsDeviceV2 (string) --
The Direct Connect endpoint on which the BGP peer terminates.
region (string) --
The AWS Region where the virtual interface is located.
awsDeviceV2 (string) --
The Direct Connect endpoint on which the virtual interface terminates.
Creates a transit virtual interface. A transit virtual interface is a VLAN that transports traffic from a Direct Connect gateway to one or more transit gateways. A transit virtual interface enables the connection of multiple VPCs attached to a transit gateway to a Direct Connect gateway.
See also: AWS API Documentation
Request Syntax
client.create_transit_virtual_interface(
connectionId='string',
newTransitVirtualInterface={
'virtualInterfaceName': 'string',
'vlan': 123,
'asn': 123,
'mtu': 123,
'authKey': 'string',
'amazonAddress': 'string',
'customerAddress': 'string',
'addressFamily': 'ipv4'|'ipv6',
'directConnectGatewayId': 'string'
}
)
string
[REQUIRED]
The ID of the connection.
dict
[REQUIRED]
Information about the transit virtual interface.
virtualInterfaceName (string) --
The name of the virtual interface assigned by the customer network.
vlan (integer) --
The ID of the VLAN.
asn (integer) --
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
mtu (integer) --
The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.
authKey (string) --
The authentication key for BGP configuration.
amazonAddress (string) --
The IP address assigned to the Amazon interface.
customerAddress (string) --
The IP address assigned to the customer interface.
addressFamily (string) --
The address family for the BGP peer.
directConnectGatewayId (string) --
The ID of the Direct Connect gateway.
dict
Response Syntax
{
'virtualInterface': {
'ownerAccount': 'string',
'virtualInterfaceId': 'string',
'location': 'string',
'connectionId': 'string',
'virtualInterfaceType': 'string',
'virtualInterfaceName': 'string',
'vlan': 123,
'asn': 123,
'amazonSideAsn': 123,
'authKey': 'string',
'amazonAddress': 'string',
'customerAddress': 'string',
'addressFamily': 'ipv4'|'ipv6',
'virtualInterfaceState': 'confirming'|'verifying'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected'|'unknown',
'customerRouterConfig': 'string',
'mtu': 123,
'jumboFrameCapable': True|False,
'virtualGatewayId': 'string',
'directConnectGatewayId': 'string',
'routeFilterPrefixes': [
{
'cidr': 'string'
},
],
'bgpPeers': [
{
'bgpPeerId': 'string',
'asn': 123,
'authKey': 'string',
'addressFamily': 'ipv4'|'ipv6',
'amazonAddress': 'string',
'customerAddress': 'string',
'bgpPeerState': 'verifying'|'pending'|'available'|'deleting'|'deleted',
'bgpStatus': 'up'|'down'|'unknown',
'awsDeviceV2': 'string'
},
],
'region': 'string',
'awsDeviceV2': 'string'
}
}
Response Structure
(dict) --
virtualInterface (dict) --
Information about a virtual interface.
ownerAccount (string) --
The ID of the AWS account that owns the virtual interface.
virtualInterfaceId (string) --
The ID of the virtual interface.
location (string) --
The location of the connection.
connectionId (string) --
The ID of the connection.
virtualInterfaceType (string) --
The type of virtual interface. The possible values are private and public.
virtualInterfaceName (string) --
The name of the virtual interface assigned by the customer network.
vlan (integer) --
The ID of the VLAN.
asn (integer) --
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
amazonSideAsn (integer) --
The autonomous system number (ASN) for the Amazon side of the connection.
authKey (string) --
The authentication key for BGP configuration.
amazonAddress (string) --
The IP address assigned to the Amazon interface.
customerAddress (string) --
The IP address assigned to the customer interface.
addressFamily (string) --
The address family for the BGP peer.
virtualInterfaceState (string) --
The state of the virtual interface. The following are the possible values:
confirming: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.
verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.
pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.
available: A virtual interface that is able to forward traffic.
down: A virtual interface that is BGP down.
deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.
deleted: A virtual interface that cannot forward traffic.
rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the Confirming state is deleted by the virtual interface owner, the virtual interface enters the Rejected state.
unknown: The state of the virtual interface is not available.
customerRouterConfig (string) --
The customer router configuration.
mtu (integer) --
The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames (9001 MTU) are supported.
virtualGatewayId (string) --
The ID of the virtual private gateway. Applies only to private virtual interfaces.
directConnectGatewayId (string) --
The ID of the Direct Connect gateway.
routeFilterPrefixes (list) --
The routes to be advertised to the AWS network in this Region. Applies to public virtual interfaces.
(dict) --
Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
cidr (string) --
The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.
bgpPeers (list) --
The BGP peers configured on this virtual interface.
(dict) --
Information about a BGP peer.
bgpPeerId (string) --
The ID of the BGP peer.
asn (integer) --
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
authKey (string) --
The authentication key for BGP configuration.
addressFamily (string) --
The address family for the BGP peer.
amazonAddress (string) --
The IP address assigned to the Amazon interface.
customerAddress (string) --
The IP address assigned to the customer interface.
bgpPeerState (string) --
The state of the BGP peer. The following are the possible values:
verifying: The BGP peering addresses or ASN require validation before the BGP peer can be created. This state applies only to public virtual interfaces.
pending: The BGP peer is created, and remains in this state until it is ready to be established.
available: The BGP peer is ready to be established.
deleting: The BGP peer is being deleted.
deleted: The BGP peer is deleted and cannot be established.
bgpStatus (string) --
The status of the BGP peer. The following are the possible values:
up: The BGP peer is established. This state does not indicate the state of the routing function. Ensure that you are receiving routes over the BGP session.
down: The BGP peer is down.
unknown: The BGP peer status is not available.
awsDeviceV2 (string) --
The Direct Connect endpoint on which the BGP peer terminates.
region (string) --
The AWS Region where the virtual interface is located.
awsDeviceV2 (string) --
The Direct Connect endpoint on which the virtual interface terminates.
{'directConnectGatewayAssociation': {'associatedGateway': {'type': {'transitGateway'}}}}
Accepts a proposal request to attach a virtual private gateway or transit gateway to a Direct Connect gateway.
See also: AWS API Documentation
Request Syntax
client.accept_direct_connect_gateway_association_proposal(
directConnectGatewayId='string',
proposalId='string',
associatedGatewayOwnerAccount='string',
overrideAllowedPrefixesToDirectConnectGateway=[
{
'cidr': 'string'
},
]
)
string
[REQUIRED]
The ID of the Direct Connect gateway.
string
[REQUIRED]
The ID of the request proposal.
string
[REQUIRED]
The ID of the AWS account that owns the virtual private gateway or transit gateway.
list
Overrides the existing Amazon VPC prefixes advertised to the Direct Connect gateway.
(dict) --
Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
cidr (string) --
The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.
dict
Response Syntax
{
'directConnectGatewayAssociation': {
'directConnectGatewayId': 'string',
'directConnectGatewayOwnerAccount': 'string',
'associationState': 'associating'|'associated'|'disassociating'|'disassociated'|'updating',
'stateChangeError': 'string',
'associatedGateway': {
'id': 'string',
'type': 'virtualPrivateGateway'|'transitGateway',
'ownerAccount': 'string',
'region': 'string'
},
'associationId': 'string',
'allowedPrefixesToDirectConnectGateway': [
{
'cidr': 'string'
},
],
'virtualGatewayId': 'string',
'virtualGatewayRegion': 'string',
'virtualGatewayOwnerAccount': 'string'
}
}
Response Structure
(dict) --
directConnectGatewayAssociation (dict) --
Information about an association between a Direct Connect gateway and a virtual private gateway or transit gateway.
directConnectGatewayId (string) --
The ID of the Direct Connect gateway.
directConnectGatewayOwnerAccount (string) --
The ID of the AWS account that owns the associated gateway.
associationState (string) --
The state of the association. The following are the possible values:
associating: The initial state after calling CreateDirectConnectGatewayAssociation.
associated: The Direct Connect gateway and virtual private gateway or transit gateway are successfully associated and ready to pass traffic.
disassociating: The initial state after calling DeleteDirectConnectGatewayAssociation.
disassociated: The virtual private gateway or transit gateway is disassociated from the Direct Connect gateway. Traffic flow between the Direct Connect gateway and virtual private gateway or transit gateway is stopped.
stateChangeError (string) --
The error message if the state of an object failed to advance.
associatedGateway (dict) --
Information about the associated gateway.
id (string) --
The ID of the associated gateway.
type (string) --
The type of associated gateway.
ownerAccount (string) --
The ID of the AWS account that owns the associated virtual private gateway or transit gateway.
region (string) --
The Region where the associated gateway is located.
associationId (string) --
The ID of the Direct Connect gateway association.
allowedPrefixesToDirectConnectGateway (list) --
The Amazon VPC prefixes to advertise to the Direct Connect gateway.
(dict) --
Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
cidr (string) --
The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.
virtualGatewayId (string) --
The ID of the virtual private gateway. Applies only to private virtual interfaces.
virtualGatewayRegion (string) --
The AWS Region where the virtual private gateway is located.
virtualGatewayOwnerAccount (string) --
The ID of the AWS account that owns the virtual private gateway.
{'directConnectGatewayAssociation': {'associatedGateway': {'type': {'transitGateway'}}}}
Creates an association between a Direct Connect gateway and a virtual private gateway. The virtual private gateway must be attached to a VPC and must not be associated with another Direct Connect gateway.
See also: AWS API Documentation
Request Syntax
client.create_direct_connect_gateway_association(
directConnectGatewayId='string',
gatewayId='string',
addAllowedPrefixesToDirectConnectGateway=[
{
'cidr': 'string'
},
],
virtualGatewayId='string'
)
string
[REQUIRED]
The ID of the Direct Connect gateway.
string
The ID of the virtual private gateway or transit gateway.
list
The Amazon VPC prefixes to advertise to the Direct Connect gateway
(dict) --
Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
cidr (string) --
The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.
string
The ID of the virtual private gateway.
dict
Response Syntax
{
'directConnectGatewayAssociation': {
'directConnectGatewayId': 'string',
'directConnectGatewayOwnerAccount': 'string',
'associationState': 'associating'|'associated'|'disassociating'|'disassociated'|'updating',
'stateChangeError': 'string',
'associatedGateway': {
'id': 'string',
'type': 'virtualPrivateGateway'|'transitGateway',
'ownerAccount': 'string',
'region': 'string'
},
'associationId': 'string',
'allowedPrefixesToDirectConnectGateway': [
{
'cidr': 'string'
},
],
'virtualGatewayId': 'string',
'virtualGatewayRegion': 'string',
'virtualGatewayOwnerAccount': 'string'
}
}
Response Structure
(dict) --
directConnectGatewayAssociation (dict) --
The association to be created.
directConnectGatewayId (string) --
The ID of the Direct Connect gateway.
directConnectGatewayOwnerAccount (string) --
The ID of the AWS account that owns the associated gateway.
associationState (string) --
The state of the association. The following are the possible values:
associating: The initial state after calling CreateDirectConnectGatewayAssociation.
associated: The Direct Connect gateway and virtual private gateway or transit gateway are successfully associated and ready to pass traffic.
disassociating: The initial state after calling DeleteDirectConnectGatewayAssociation.
disassociated: The virtual private gateway or transit gateway is disassociated from the Direct Connect gateway. Traffic flow between the Direct Connect gateway and virtual private gateway or transit gateway is stopped.
stateChangeError (string) --
The error message if the state of an object failed to advance.
associatedGateway (dict) --
Information about the associated gateway.
id (string) --
The ID of the associated gateway.
type (string) --
The type of associated gateway.
ownerAccount (string) --
The ID of the AWS account that owns the associated virtual private gateway or transit gateway.
region (string) --
The Region where the associated gateway is located.
associationId (string) --
The ID of the Direct Connect gateway association.
allowedPrefixesToDirectConnectGateway (list) --
The Amazon VPC prefixes to advertise to the Direct Connect gateway.
(dict) --
Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
cidr (string) --
The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.
virtualGatewayId (string) --
The ID of the virtual private gateway. Applies only to private virtual interfaces.
virtualGatewayRegion (string) --
The AWS Region where the virtual private gateway is located.
virtualGatewayOwnerAccount (string) --
The ID of the AWS account that owns the virtual private gateway.
{'directConnectGatewayAssociationProposal': {'associatedGateway': {'type': {'transitGateway'}}}}
Creates a proposal to associate the specified virtual private gateway or transit gateway with the specified Direct Connect gateway.
You can only associate a Direct Connect gateway and virtual private gateway or transit gateway when the account that owns the Direct Connect gateway and the account that owns the virtual private gateway or transit gateway have the same AWS Payer ID.
See also: AWS API Documentation
Request Syntax
client.create_direct_connect_gateway_association_proposal(
directConnectGatewayId='string',
directConnectGatewayOwnerAccount='string',
gatewayId='string',
addAllowedPrefixesToDirectConnectGateway=[
{
'cidr': 'string'
},
],
removeAllowedPrefixesToDirectConnectGateway=[
{
'cidr': 'string'
},
]
)
string
[REQUIRED]
The ID of the Direct Connect gateway.
string
[REQUIRED]
The ID of the AWS account that owns the Direct Connect gateway.
string
[REQUIRED]
The ID of the virtual private gateway or transit gateway.
list
The Amazon VPC prefixes to advertise to the Direct Connect gateway.
(dict) --
Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
cidr (string) --
The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.
list
The Amazon VPC prefixes to no longer advertise to the Direct Connect gateway.
(dict) --
Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
cidr (string) --
The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.
dict
Response Syntax
{
'directConnectGatewayAssociationProposal': {
'proposalId': 'string',
'directConnectGatewayId': 'string',
'directConnectGatewayOwnerAccount': 'string',
'proposalState': 'requested'|'accepted'|'deleted',
'associatedGateway': {
'id': 'string',
'type': 'virtualPrivateGateway'|'transitGateway',
'ownerAccount': 'string',
'region': 'string'
},
'existingAllowedPrefixesToDirectConnectGateway': [
{
'cidr': 'string'
},
],
'requestedAllowedPrefixesToDirectConnectGateway': [
{
'cidr': 'string'
},
]
}
}
Response Structure
(dict) --
directConnectGatewayAssociationProposal (dict) --
Information about the Direct Connect gateway proposal.
proposalId (string) --
The ID of the association proposal.
directConnectGatewayId (string) --
The ID of the Direct Connect gateway.
directConnectGatewayOwnerAccount (string) --
The ID of the AWS account that owns the Direct Connect gateway.
proposalState (string) --
The state of the proposal. The following are possible values:
accepted: The proposal has been accepted. The Direct Connect gateway association is available to use in this state.
deleted: The proposal has been deleted by the owner that made the proposal. The Direct Connect gateway association cannot be used in this state.
requested: The proposal has been requested. The Direct Connect gateway association cannot be used in this state.
associatedGateway (dict) --
Information about the associated gateway.
id (string) --
The ID of the associated gateway.
type (string) --
The type of associated gateway.
ownerAccount (string) --
The ID of the AWS account that owns the associated virtual private gateway or transit gateway.
region (string) --
The Region where the associated gateway is located.
existingAllowedPrefixesToDirectConnectGateway (list) --
The existing Amazon VPC prefixes advertised to the Direct Connect gateway.
(dict) --
Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
cidr (string) --
The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.
requestedAllowedPrefixesToDirectConnectGateway (list) --
The Amazon VPC prefixes to advertise to the Direct Connect gateway.
(dict) --
Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
cidr (string) --
The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.
{'directConnectGatewayAssociation': {'associatedGateway': {'type': {'transitGateway'}}}}
Deletes the association between the specified Direct Connect gateway and virtual private gateway.
See also: AWS API Documentation
Request Syntax
client.delete_direct_connect_gateway_association(
associationId='string',
directConnectGatewayId='string',
virtualGatewayId='string'
)
string
The ID of the Direct Connect gateway association.
string
The ID of the Direct Connect gateway.
string
The ID of the virtual private gateway.
dict
Response Syntax
{
'directConnectGatewayAssociation': {
'directConnectGatewayId': 'string',
'directConnectGatewayOwnerAccount': 'string',
'associationState': 'associating'|'associated'|'disassociating'|'disassociated'|'updating',
'stateChangeError': 'string',
'associatedGateway': {
'id': 'string',
'type': 'virtualPrivateGateway'|'transitGateway',
'ownerAccount': 'string',
'region': 'string'
},
'associationId': 'string',
'allowedPrefixesToDirectConnectGateway': [
{
'cidr': 'string'
},
],
'virtualGatewayId': 'string',
'virtualGatewayRegion': 'string',
'virtualGatewayOwnerAccount': 'string'
}
}
Response Structure
(dict) --
directConnectGatewayAssociation (dict) --
Information about the deleted association.
directConnectGatewayId (string) --
The ID of the Direct Connect gateway.
directConnectGatewayOwnerAccount (string) --
The ID of the AWS account that owns the associated gateway.
associationState (string) --
The state of the association. The following are the possible values:
associating: The initial state after calling CreateDirectConnectGatewayAssociation.
associated: The Direct Connect gateway and virtual private gateway or transit gateway are successfully associated and ready to pass traffic.
disassociating: The initial state after calling DeleteDirectConnectGatewayAssociation.
disassociated: The virtual private gateway or transit gateway is disassociated from the Direct Connect gateway. Traffic flow between the Direct Connect gateway and virtual private gateway or transit gateway is stopped.
stateChangeError (string) --
The error message if the state of an object failed to advance.
associatedGateway (dict) --
Information about the associated gateway.
id (string) --
The ID of the associated gateway.
type (string) --
The type of associated gateway.
ownerAccount (string) --
The ID of the AWS account that owns the associated virtual private gateway or transit gateway.
region (string) --
The Region where the associated gateway is located.
associationId (string) --
The ID of the Direct Connect gateway association.
allowedPrefixesToDirectConnectGateway (list) --
The Amazon VPC prefixes to advertise to the Direct Connect gateway.
(dict) --
Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
cidr (string) --
The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.
virtualGatewayId (string) --
The ID of the virtual private gateway. Applies only to private virtual interfaces.
virtualGatewayRegion (string) --
The AWS Region where the virtual private gateway is located.
virtualGatewayOwnerAccount (string) --
The ID of the AWS account that owns the virtual private gateway.
{'directConnectGatewayAssociationProposal': {'associatedGateway': {'type': {'transitGateway'}}}}
Deletes the association proposal request between the specified Direct Connect gateway and virtual private gateway or transit gateway.
See also: AWS API Documentation
Request Syntax
client.delete_direct_connect_gateway_association_proposal(
proposalId='string'
)
string
[REQUIRED]
The ID of the proposal.
dict
Response Syntax
{
'directConnectGatewayAssociationProposal': {
'proposalId': 'string',
'directConnectGatewayId': 'string',
'directConnectGatewayOwnerAccount': 'string',
'proposalState': 'requested'|'accepted'|'deleted',
'associatedGateway': {
'id': 'string',
'type': 'virtualPrivateGateway'|'transitGateway',
'ownerAccount': 'string',
'region': 'string'
},
'existingAllowedPrefixesToDirectConnectGateway': [
{
'cidr': 'string'
},
],
'requestedAllowedPrefixesToDirectConnectGateway': [
{
'cidr': 'string'
},
]
}
}
Response Structure
(dict) --
directConnectGatewayAssociationProposal (dict) --
The ID of the associated gateway.
proposalId (string) --
The ID of the association proposal.
directConnectGatewayId (string) --
The ID of the Direct Connect gateway.
directConnectGatewayOwnerAccount (string) --
The ID of the AWS account that owns the Direct Connect gateway.
proposalState (string) --
The state of the proposal. The following are possible values:
accepted: The proposal has been accepted. The Direct Connect gateway association is available to use in this state.
deleted: The proposal has been deleted by the owner that made the proposal. The Direct Connect gateway association cannot be used in this state.
requested: The proposal has been requested. The Direct Connect gateway association cannot be used in this state.
associatedGateway (dict) --
Information about the associated gateway.
id (string) --
The ID of the associated gateway.
type (string) --
The type of associated gateway.
ownerAccount (string) --
The ID of the AWS account that owns the associated virtual private gateway or transit gateway.
region (string) --
The Region where the associated gateway is located.
existingAllowedPrefixesToDirectConnectGateway (list) --
The existing Amazon VPC prefixes advertised to the Direct Connect gateway.
(dict) --
Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
cidr (string) --
The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.
requestedAllowedPrefixesToDirectConnectGateway (list) --
The Amazon VPC prefixes to advertise to the Direct Connect gateway.
(dict) --
Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
cidr (string) --
The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.
{'directConnectGatewayAssociationProposals': {'associatedGateway': {'type': {'transitGateway'}}}}
Describes one or more association proposals for connection between a virtual private gateway or transit gateway and a Direct Connect gateway.
See also: AWS API Documentation
Request Syntax
client.describe_direct_connect_gateway_association_proposals(
directConnectGatewayId='string',
proposalId='string',
associatedGatewayId='string',
maxResults=123,
nextToken='string'
)
string
The ID of the Direct Connect gateway.
string
The ID of the proposal.
string
The ID of the associated gateway.
integer
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
If MaxResults is given a value larger than 100, only 100 results are returned.
string
The token for the next page of results.
dict
Response Syntax
{
'directConnectGatewayAssociationProposals': [
{
'proposalId': 'string',
'directConnectGatewayId': 'string',
'directConnectGatewayOwnerAccount': 'string',
'proposalState': 'requested'|'accepted'|'deleted',
'associatedGateway': {
'id': 'string',
'type': 'virtualPrivateGateway'|'transitGateway',
'ownerAccount': 'string',
'region': 'string'
},
'existingAllowedPrefixesToDirectConnectGateway': [
{
'cidr': 'string'
},
],
'requestedAllowedPrefixesToDirectConnectGateway': [
{
'cidr': 'string'
},
]
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
directConnectGatewayAssociationProposals (list) --
Describes the Direct Connect gateway association proposals.
(dict) --
Information about the proposal request to attach a virtual private gateway to a Direct Connect gateway.
proposalId (string) --
The ID of the association proposal.
directConnectGatewayId (string) --
The ID of the Direct Connect gateway.
directConnectGatewayOwnerAccount (string) --
The ID of the AWS account that owns the Direct Connect gateway.
proposalState (string) --
The state of the proposal. The following are possible values:
accepted: The proposal has been accepted. The Direct Connect gateway association is available to use in this state.
deleted: The proposal has been deleted by the owner that made the proposal. The Direct Connect gateway association cannot be used in this state.
requested: The proposal has been requested. The Direct Connect gateway association cannot be used in this state.
associatedGateway (dict) --
Information about the associated gateway.
id (string) --
The ID of the associated gateway.
type (string) --
The type of associated gateway.
ownerAccount (string) --
The ID of the AWS account that owns the associated virtual private gateway or transit gateway.
region (string) --
The Region where the associated gateway is located.
existingAllowedPrefixesToDirectConnectGateway (list) --
The existing Amazon VPC prefixes advertised to the Direct Connect gateway.
(dict) --
Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
cidr (string) --
The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.
requestedAllowedPrefixesToDirectConnectGateway (list) --
The Amazon VPC prefixes to advertise to the Direct Connect gateway.
(dict) --
Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
cidr (string) --
The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.
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.
{'directConnectGatewayAssociations': {'associatedGateway': {'type': {'transitGateway'}}}}
Lists the associations between your Direct Connect gateways and virtual private gateways. You must specify a Direct Connect gateway, a virtual private gateway, or both. If you specify a Direct Connect gateway, the response contains all virtual private gateways associated with the Direct Connect gateway. If you specify a virtual private gateway, the response contains all Direct Connect gateways associated with the virtual private gateway. If you specify both, the response contains the association between the Direct Connect gateway and the virtual private gateway.
See also: AWS API Documentation
Request Syntax
client.describe_direct_connect_gateway_associations(
associationId='string',
associatedGatewayId='string',
directConnectGatewayId='string',
maxResults=123,
nextToken='string',
virtualGatewayId='string'
)
string
The ID of the Direct Connect gateway association.
string
The ID of the associated gateway.
string
The ID of the Direct Connect gateway.
integer
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
If MaxResults is given a value larger than 100, only 100 results are returned.
string
The token provided in the previous call to retrieve the next page.
string
The ID of the virtual private gateway.
dict
Response Syntax
{
'directConnectGatewayAssociations': [
{
'directConnectGatewayId': 'string',
'directConnectGatewayOwnerAccount': 'string',
'associationState': 'associating'|'associated'|'disassociating'|'disassociated'|'updating',
'stateChangeError': 'string',
'associatedGateway': {
'id': 'string',
'type': 'virtualPrivateGateway'|'transitGateway',
'ownerAccount': 'string',
'region': 'string'
},
'associationId': 'string',
'allowedPrefixesToDirectConnectGateway': [
{
'cidr': 'string'
},
],
'virtualGatewayId': 'string',
'virtualGatewayRegion': 'string',
'virtualGatewayOwnerAccount': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
directConnectGatewayAssociations (list) --
Information about the associations.
(dict) --
Information about an association between a Direct Connect gateway and a virtual private gateway or transit gateway.
directConnectGatewayId (string) --
The ID of the Direct Connect gateway.
directConnectGatewayOwnerAccount (string) --
The ID of the AWS account that owns the associated gateway.
associationState (string) --
The state of the association. The following are the possible values:
associating: The initial state after calling CreateDirectConnectGatewayAssociation.
associated: The Direct Connect gateway and virtual private gateway or transit gateway are successfully associated and ready to pass traffic.
disassociating: The initial state after calling DeleteDirectConnectGatewayAssociation.
disassociated: The virtual private gateway or transit gateway is disassociated from the Direct Connect gateway. Traffic flow between the Direct Connect gateway and virtual private gateway or transit gateway is stopped.
stateChangeError (string) --
The error message if the state of an object failed to advance.
associatedGateway (dict) --
Information about the associated gateway.
id (string) --
The ID of the associated gateway.
type (string) --
The type of associated gateway.
ownerAccount (string) --
The ID of the AWS account that owns the associated virtual private gateway or transit gateway.
region (string) --
The Region where the associated gateway is located.
associationId (string) --
The ID of the Direct Connect gateway association.
allowedPrefixesToDirectConnectGateway (list) --
The Amazon VPC prefixes to advertise to the Direct Connect gateway.
(dict) --
Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
cidr (string) --
The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.
virtualGatewayId (string) --
The ID of the virtual private gateway. Applies only to private virtual interfaces.
virtualGatewayRegion (string) --
The AWS Region where the virtual private gateway is located.
virtualGatewayOwnerAccount (string) --
The ID of the AWS account that owns the virtual private gateway.
nextToken (string) --
The token to retrieve the next page.
{'directConnectGatewayAttachments': {'attachmentType': 'TransitVirtualInterface '
'| '
'PrivateVirtualInterface'}}
Lists the attachments between your Direct Connect gateways and virtual interfaces. You must specify a Direct Connect gateway, a virtual interface, or both. If you specify a Direct Connect gateway, the response contains all virtual interfaces attached to the Direct Connect gateway. If you specify a virtual interface, the response contains all Direct Connect gateways attached to the virtual interface. If you specify both, the response contains the attachment between the Direct Connect gateway and the virtual interface.
See also: AWS API Documentation
Request Syntax
client.describe_direct_connect_gateway_attachments(
directConnectGatewayId='string',
virtualInterfaceId='string',
maxResults=123,
nextToken='string'
)
string
The ID of the Direct Connect gateway.
string
The ID of the virtual interface.
integer
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
If MaxResults is given a value larger than 100, only 100 results are returned.
string
The token provided in the previous call to retrieve the next page.
dict
Response Syntax
{
'directConnectGatewayAttachments': [
{
'directConnectGatewayId': 'string',
'virtualInterfaceId': 'string',
'virtualInterfaceRegion': 'string',
'virtualInterfaceOwnerAccount': 'string',
'attachmentState': 'attaching'|'attached'|'detaching'|'detached',
'attachmentType': 'TransitVirtualInterface'|'PrivateVirtualInterface',
'stateChangeError': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
directConnectGatewayAttachments (list) --
The attachments.
(dict) --
Information about an attachment between a Direct Connect gateway and a virtual interface.
directConnectGatewayId (string) --
The ID of the Direct Connect gateway.
virtualInterfaceId (string) --
The ID of the virtual interface.
virtualInterfaceRegion (string) --
The AWS Region where the virtual interface is located.
virtualInterfaceOwnerAccount (string) --
The ID of the AWS account that owns the virtual interface.
attachmentState (string) --
The state of the attachment. The following are the possible values:
attaching: The initial state after a virtual interface is created using the Direct Connect gateway.
attached: The Direct Connect gateway and virtual interface are attached and ready to pass traffic.
detaching: The initial state after calling DeleteVirtualInterface.
detached: The virtual interface is detached from the Direct Connect gateway. Traffic flow between the Direct Connect gateway and virtual interface is stopped.
attachmentType (string) --
The type of attachment.
stateChangeError (string) --
The error message if the state of an object failed to advance.
nextToken (string) --
The token to retrieve the next page.
{'directConnectGatewayAssociation': {'associatedGateway': {'type': {'transitGateway'}}}}
Updates the specified attributes of the Direct Connect gateway association.
Add or remove prefixes from the association.
See also: AWS API Documentation
Request Syntax
client.update_direct_connect_gateway_association(
associationId='string',
addAllowedPrefixesToDirectConnectGateway=[
{
'cidr': 'string'
},
],
removeAllowedPrefixesToDirectConnectGateway=[
{
'cidr': 'string'
},
]
)
string
The ID of the Direct Connect gateway association.
list
The Amazon VPC prefixes to advertise to the Direct Connect gateway.
(dict) --
Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
cidr (string) --
The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.
list
The Amazon VPC prefixes to no longer advertise to the Direct Connect gateway.
(dict) --
Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
cidr (string) --
The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.
dict
Response Syntax
{
'directConnectGatewayAssociation': {
'directConnectGatewayId': 'string',
'directConnectGatewayOwnerAccount': 'string',
'associationState': 'associating'|'associated'|'disassociating'|'disassociated'|'updating',
'stateChangeError': 'string',
'associatedGateway': {
'id': 'string',
'type': 'virtualPrivateGateway'|'transitGateway',
'ownerAccount': 'string',
'region': 'string'
},
'associationId': 'string',
'allowedPrefixesToDirectConnectGateway': [
{
'cidr': 'string'
},
],
'virtualGatewayId': 'string',
'virtualGatewayRegion': 'string',
'virtualGatewayOwnerAccount': 'string'
}
}
Response Structure
(dict) --
directConnectGatewayAssociation (dict) --
Information about an association between a Direct Connect gateway and a virtual private gateway or transit gateway.
directConnectGatewayId (string) --
The ID of the Direct Connect gateway.
directConnectGatewayOwnerAccount (string) --
The ID of the AWS account that owns the associated gateway.
associationState (string) --
The state of the association. The following are the possible values:
associating: The initial state after calling CreateDirectConnectGatewayAssociation.
associated: The Direct Connect gateway and virtual private gateway or transit gateway are successfully associated and ready to pass traffic.
disassociating: The initial state after calling DeleteDirectConnectGatewayAssociation.
disassociated: The virtual private gateway or transit gateway is disassociated from the Direct Connect gateway. Traffic flow between the Direct Connect gateway and virtual private gateway or transit gateway is stopped.
stateChangeError (string) --
The error message if the state of an object failed to advance.
associatedGateway (dict) --
Information about the associated gateway.
id (string) --
The ID of the associated gateway.
type (string) --
The type of associated gateway.
ownerAccount (string) --
The ID of the AWS account that owns the associated virtual private gateway or transit gateway.
region (string) --
The Region where the associated gateway is located.
associationId (string) --
The ID of the Direct Connect gateway association.
allowedPrefixesToDirectConnectGateway (list) --
The Amazon VPC prefixes to advertise to the Direct Connect gateway.
(dict) --
Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
cidr (string) --
The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.
virtualGatewayId (string) --
The ID of the virtual private gateway. Applies only to private virtual interfaces.
virtualGatewayRegion (string) --
The AWS Region where the virtual private gateway is located.
virtualGatewayOwnerAccount (string) --
The ID of the AWS account that owns the virtual private gateway.