2024/11/25 - AWS Direct Connect - 5 updated api methods
Changes Update DescribeDirectConnectGatewayAssociations API to return associated core network information if a Direct Connect gateway is attached to a Cloud WAN core network.
{'directConnectGatewayAssociation': {'associatedCoreNetwork': {'attachmentId': 'string', 'id': 'string', 'ownerAccount': 'string'}}}
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 Amazon Web Services account that owns the virtual private gateway or transit gateway.
list
Overrides the Amazon VPC prefixes advertised to the Direct Connect gateway.
For information about how to set the prefixes, see Allowed Prefixes in the Direct Connect User Guide.
(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' }, ], 'associatedCoreNetwork': { 'id': 'string', 'ownerAccount': 'string', 'attachmentId': 'string' }, 'virtualGatewayId': 'string', 'virtualGatewayRegion': 'string', 'virtualGatewayOwnerAccount': 'string' } }
Response Structure
(dict) --
directConnectGatewayAssociation (dict) --
Information about an association between a Direct Connect gateway and a virtual gateway or transit gateway.
directConnectGatewayId (string) --
The ID of the Direct Connect gateway.
directConnectGatewayOwnerAccount (string) --
The ID of the Amazon Web Services 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.
updating: The CIDR blocks for the virtual private gateway or transit gateway are currently being updated. This could be new CIDR blocks added or current CIDR blocks removed.
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 Amazon Web Services 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.
associatedCoreNetwork (dict) --
The ID of the Cloud WAN core network associated with the Direct Connect attachment.
id (string) --
The ID of the Cloud WAN core network.
ownerAccount (string) --
The account owner of the Cloud WAN core network.
attachmentId (string) --
the ID of the Direct Connect attachment
virtualGatewayId (string) --
The ID of the virtual private gateway. Applies only to private virtual interfaces.
virtualGatewayRegion (string) --
The Amazon Web Services Region where the virtual private gateway is located.
virtualGatewayOwnerAccount (string) --
The ID of the Amazon Web Services account that owns the virtual private gateway.
{'directConnectGatewayAssociation': {'associatedCoreNetwork': {'attachmentId': 'string', 'id': 'string', 'ownerAccount': 'string'}}}
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
This parameter is required when you create an association to a transit gateway.
For information about how to set the prefixes, see Allowed Prefixes in the Direct Connect User Guide.
(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' }, ], 'associatedCoreNetwork': { 'id': 'string', 'ownerAccount': 'string', 'attachmentId': '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 Amazon Web Services 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.
updating: The CIDR blocks for the virtual private gateway or transit gateway are currently being updated. This could be new CIDR blocks added or current CIDR blocks removed.
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 Amazon Web Services 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.
associatedCoreNetwork (dict) --
The ID of the Cloud WAN core network associated with the Direct Connect attachment.
id (string) --
The ID of the Cloud WAN core network.
ownerAccount (string) --
The account owner of the Cloud WAN core network.
attachmentId (string) --
the ID of the Direct Connect attachment
virtualGatewayId (string) --
The ID of the virtual private gateway. Applies only to private virtual interfaces.
virtualGatewayRegion (string) --
The Amazon Web Services Region where the virtual private gateway is located.
virtualGatewayOwnerAccount (string) --
The ID of the Amazon Web Services account that owns the virtual private gateway.
{'directConnectGatewayAssociation': {'associatedCoreNetwork': {'attachmentId': 'string', 'id': 'string', 'ownerAccount': 'string'}}}
Deletes the association between the specified Direct Connect gateway and virtual private gateway.
We recommend that you specify the associationID to delete the association. Alternatively, if you own virtual gateway and a Direct Connect gateway association, you can specify the virtualGatewayId and directConnectGatewayId to delete an association.
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' }, ], 'associatedCoreNetwork': { 'id': 'string', 'ownerAccount': 'string', 'attachmentId': '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 Amazon Web Services 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.
updating: The CIDR blocks for the virtual private gateway or transit gateway are currently being updated. This could be new CIDR blocks added or current CIDR blocks removed.
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 Amazon Web Services 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.
associatedCoreNetwork (dict) --
The ID of the Cloud WAN core network associated with the Direct Connect attachment.
id (string) --
The ID of the Cloud WAN core network.
ownerAccount (string) --
The account owner of the Cloud WAN core network.
attachmentId (string) --
the ID of the Direct Connect attachment
virtualGatewayId (string) --
The ID of the virtual private gateway. Applies only to private virtual interfaces.
virtualGatewayRegion (string) --
The Amazon Web Services Region where the virtual private gateway is located.
virtualGatewayOwnerAccount (string) --
The ID of the Amazon Web Services account that owns the virtual private gateway.
{'directConnectGatewayAssociations': {'associatedCoreNetwork': {'attachmentId': 'string', 'id': 'string', 'ownerAccount': 'string'}}}
Lists the associations between your Direct Connect gateways and virtual private gateways and transit gateways. You must specify one of the following:
A Direct Connect gateway The response contains all virtual private gateways and transit gateways associated with the Direct Connect gateway.
A virtual private gateway The response contains the Direct Connect gateway.
A transit gateway The response contains the Direct Connect gateway.
A Direct Connect gateway and a virtual private gateway The response contains the association between the Direct Connect gateway and virtual private gateway.
A Direct Connect gateway and a transit gateway The response contains the association between the Direct Connect gateway and transit 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 or transit 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' }, ], 'associatedCoreNetwork': { 'id': 'string', 'ownerAccount': 'string', 'attachmentId': '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 Amazon Web Services 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.
updating: The CIDR blocks for the virtual private gateway or transit gateway are currently being updated. This could be new CIDR blocks added or current CIDR blocks removed.
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 Amazon Web Services 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.
associatedCoreNetwork (dict) --
The ID of the Cloud WAN core network associated with the Direct Connect attachment.
id (string) --
The ID of the Cloud WAN core network.
ownerAccount (string) --
The account owner of the Cloud WAN core network.
attachmentId (string) --
the ID of the Direct Connect attachment
virtualGatewayId (string) --
The ID of the virtual private gateway. Applies only to private virtual interfaces.
virtualGatewayRegion (string) --
The Amazon Web Services Region where the virtual private gateway is located.
virtualGatewayOwnerAccount (string) --
The ID of the Amazon Web Services account that owns the virtual private gateway.
nextToken (string) --
The token to retrieve the next page.
{'directConnectGatewayAssociation': {'associatedCoreNetwork': {'attachmentId': 'string', 'id': 'string', 'ownerAccount': 'string'}}}
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' }, ], 'associatedCoreNetwork': { 'id': 'string', 'ownerAccount': 'string', 'attachmentId': '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 Amazon Web Services 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.
updating: The CIDR blocks for the virtual private gateway or transit gateway are currently being updated. This could be new CIDR blocks added or current CIDR blocks removed.
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 Amazon Web Services 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.
associatedCoreNetwork (dict) --
The ID of the Cloud WAN core network associated with the Direct Connect attachment.
id (string) --
The ID of the Cloud WAN core network.
ownerAccount (string) --
The account owner of the Cloud WAN core network.
attachmentId (string) --
the ID of the Direct Connect attachment
virtualGatewayId (string) --
The ID of the virtual private gateway. Applies only to private virtual interfaces.
virtualGatewayRegion (string) --
The Amazon Web Services Region where the virtual private gateway is located.
virtualGatewayOwnerAccount (string) --
The ID of the Amazon Web Services account that owns the virtual private gateway.