DirectConnectClient
Index > DirectConnect > DirectConnectClient
Auto-generated documentation for DirectConnect type annotations stubs module mypy-boto3-directconnect.
DirectConnectClient
Type annotations and code completion for boto3.client("directconnect")
.
boto3 documentation
from boto3.session import Session
from mypy_boto3_directconnect.client import DirectConnectClient
def get_directconnect_client() -> DirectConnectClient:
return Session().client("directconnect")
Exceptions
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("directconnect").exceptions
structure.
client = boto3.client("directconnect")
try:
do_something(client)
except (
client.ClientError,
client.DirectConnectClientException,
client.DirectConnectServerException,
client.DuplicateTagKeysException,
client.TooManyTagsException,
) as e:
print(e)
from mypy_boto3_directconnect.client import Exceptions
def handle_error(exc: Exceptions.ClientError) -> None:
...
Methods
accept_direct_connect_gateway_association_proposal
Accepts a proposal request to attach a virtual private gateway or transit gateway to a Direct Connect gateway.
Type annotations and code completion for boto3.client("directconnect").accept_direct_connect_gateway_association_proposal
method.
boto3 documentation
def accept_direct_connect_gateway_association_proposal(
self,
*,
directConnectGatewayId: str,
proposalId: str,
associatedGatewayOwnerAccount: str,
overrideAllowedPrefixesToDirectConnectGateway: Sequence[RouteFilterPrefixTypeDef] = ..., # (1)
) -> AcceptDirectConnectGatewayAssociationProposalResultTypeDef: # (2)
...
kwargs: AcceptDirectConnectGatewayAssociationProposalRequestRequestTypeDef = { # (1)
"directConnectGatewayId": ...,
"proposalId": ...,
"associatedGatewayOwnerAccount": ...,
}
parent.accept_direct_connect_gateway_association_proposal(**kwargs)
allocate_connection_on_interconnect
Deprecated.
Type annotations and code completion for boto3.client("directconnect").allocate_connection_on_interconnect
method.
boto3 documentation
def allocate_connection_on_interconnect(
self,
*,
bandwidth: str,
connectionName: str,
ownerAccount: str,
interconnectId: str,
vlan: int,
) -> ConnectionResponseMetadataTypeDef: # (1)
...
kwargs: AllocateConnectionOnInterconnectRequestRequestTypeDef = { # (1)
"bandwidth": ...,
"connectionName": ...,
"ownerAccount": ...,
"interconnectId": ...,
"vlan": ...,
}
parent.allocate_connection_on_interconnect(**kwargs)
allocate_hosted_connection
Creates a hosted connection on the specified interconnect or a link aggregation group (LAG) of interconnects.
Type annotations and code completion for boto3.client("directconnect").allocate_hosted_connection
method.
boto3 documentation
def allocate_hosted_connection(
self,
*,
connectionId: str,
ownerAccount: str,
bandwidth: str,
connectionName: str,
vlan: int,
tags: Sequence[TagTypeDef] = ..., # (1)
) -> ConnectionResponseMetadataTypeDef: # (2)
...
kwargs: AllocateHostedConnectionRequestRequestTypeDef = { # (1)
"connectionId": ...,
"ownerAccount": ...,
"bandwidth": ...,
"connectionName": ...,
"vlan": ...,
}
parent.allocate_hosted_connection(**kwargs)
allocate_private_virtual_interface
Provisions a private virtual interface to be owned by the specified Amazon Web Services account.
Type annotations and code completion for boto3.client("directconnect").allocate_private_virtual_interface
method.
boto3 documentation
def allocate_private_virtual_interface(
self,
*,
connectionId: str,
ownerAccount: str,
newPrivateVirtualInterfaceAllocation: NewPrivateVirtualInterfaceAllocationTypeDef, # (1)
) -> VirtualInterfaceResponseMetadataTypeDef: # (2)
...
kwargs: AllocatePrivateVirtualInterfaceRequestRequestTypeDef = { # (1)
"connectionId": ...,
"ownerAccount": ...,
"newPrivateVirtualInterfaceAllocation": ...,
}
parent.allocate_private_virtual_interface(**kwargs)
allocate_public_virtual_interface
Provisions a public virtual interface to be owned by the specified Amazon Web Services account.
Type annotations and code completion for boto3.client("directconnect").allocate_public_virtual_interface
method.
boto3 documentation
def allocate_public_virtual_interface(
self,
*,
connectionId: str,
ownerAccount: str,
newPublicVirtualInterfaceAllocation: NewPublicVirtualInterfaceAllocationTypeDef, # (1)
) -> VirtualInterfaceResponseMetadataTypeDef: # (2)
...
kwargs: AllocatePublicVirtualInterfaceRequestRequestTypeDef = { # (1)
"connectionId": ...,
"ownerAccount": ...,
"newPublicVirtualInterfaceAllocation": ...,
}
parent.allocate_public_virtual_interface(**kwargs)
allocate_transit_virtual_interface
Provisions a transit virtual interface to be owned by the specified Amazon Web Services account.
Type annotations and code completion for boto3.client("directconnect").allocate_transit_virtual_interface
method.
boto3 documentation
def allocate_transit_virtual_interface(
self,
*,
connectionId: str,
ownerAccount: str,
newTransitVirtualInterfaceAllocation: NewTransitVirtualInterfaceAllocationTypeDef, # (1)
) -> AllocateTransitVirtualInterfaceResultTypeDef: # (2)
...
kwargs: AllocateTransitVirtualInterfaceRequestRequestTypeDef = { # (1)
"connectionId": ...,
"ownerAccount": ...,
"newTransitVirtualInterfaceAllocation": ...,
}
parent.allocate_transit_virtual_interface(**kwargs)
associate_connection_with_lag
Associates an existing connection with a link aggregation group (LAG).
Type annotations and code completion for boto3.client("directconnect").associate_connection_with_lag
method.
boto3 documentation
def associate_connection_with_lag(
self,
*,
connectionId: str,
lagId: str,
) -> ConnectionResponseMetadataTypeDef: # (1)
...
kwargs: AssociateConnectionWithLagRequestRequestTypeDef = { # (1)
"connectionId": ...,
"lagId": ...,
}
parent.associate_connection_with_lag(**kwargs)
associate_hosted_connection
Associates a hosted connection and its virtual interfaces with a link aggregation group (LAG) or interconnect.
Type annotations and code completion for boto3.client("directconnect").associate_hosted_connection
method.
boto3 documentation
def associate_hosted_connection(
self,
*,
connectionId: str,
parentConnectionId: str,
) -> ConnectionResponseMetadataTypeDef: # (1)
...
kwargs: AssociateHostedConnectionRequestRequestTypeDef = { # (1)
"connectionId": ...,
"parentConnectionId": ...,
}
parent.associate_hosted_connection(**kwargs)
associate_mac_sec_key
Associates a MAC Security (MACsec) Connection Key Name (CKN)/ Connectivity Association Key (CAK) pair with an Direct Connect dedicated connection.
Type annotations and code completion for boto3.client("directconnect").associate_mac_sec_key
method.
boto3 documentation
def associate_mac_sec_key(
self,
*,
connectionId: str,
secretARN: str = ...,
ckn: str = ...,
cak: str = ...,
) -> AssociateMacSecKeyResponseTypeDef: # (1)
...
kwargs: AssociateMacSecKeyRequestRequestTypeDef = { # (1)
"connectionId": ...,
}
parent.associate_mac_sec_key(**kwargs)
associate_virtual_interface
Associates a virtual interface with a specified link aggregation group (LAG) or connection.
Type annotations and code completion for boto3.client("directconnect").associate_virtual_interface
method.
boto3 documentation
def associate_virtual_interface(
self,
*,
virtualInterfaceId: str,
connectionId: str,
) -> VirtualInterfaceResponseMetadataTypeDef: # (1)
...
kwargs: AssociateVirtualInterfaceRequestRequestTypeDef = { # (1)
"virtualInterfaceId": ...,
"connectionId": ...,
}
parent.associate_virtual_interface(**kwargs)
can_paginate
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("directconnect").can_paginate
method.
boto3 documentation
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("directconnect").close
method.
boto3 documentation
confirm_connection
Confirms the creation of the specified hosted connection on an interconnect.
Type annotations and code completion for boto3.client("directconnect").confirm_connection
method.
boto3 documentation
def confirm_connection(
self,
*,
connectionId: str,
) -> ConfirmConnectionResponseTypeDef: # (1)
...
kwargs: ConfirmConnectionRequestRequestTypeDef = { # (1)
"connectionId": ...,
}
parent.confirm_connection(**kwargs)
confirm_customer_agreement
The confirmation of the terms of agreement when creating the connection/link aggregation group (LAG).
Type annotations and code completion for boto3.client("directconnect").confirm_customer_agreement
method.
boto3 documentation
def confirm_customer_agreement(
self,
*,
agreementName: str = ...,
) -> ConfirmCustomerAgreementResponseTypeDef: # (1)
...
kwargs: ConfirmCustomerAgreementRequestRequestTypeDef = { # (1)
"agreementName": ...,
}
parent.confirm_customer_agreement(**kwargs)
confirm_private_virtual_interface
Accepts ownership of a private virtual interface created by another Amazon Web Services account.
Type annotations and code completion for boto3.client("directconnect").confirm_private_virtual_interface
method.
boto3 documentation
def confirm_private_virtual_interface(
self,
*,
virtualInterfaceId: str,
virtualGatewayId: str = ...,
directConnectGatewayId: str = ...,
) -> ConfirmPrivateVirtualInterfaceResponseTypeDef: # (1)
...
kwargs: ConfirmPrivateVirtualInterfaceRequestRequestTypeDef = { # (1)
"virtualInterfaceId": ...,
}
parent.confirm_private_virtual_interface(**kwargs)
confirm_public_virtual_interface
Accepts ownership of a public virtual interface created by another Amazon Web Services account.
Type annotations and code completion for boto3.client("directconnect").confirm_public_virtual_interface
method.
boto3 documentation
def confirm_public_virtual_interface(
self,
*,
virtualInterfaceId: str,
) -> ConfirmPublicVirtualInterfaceResponseTypeDef: # (1)
...
kwargs: ConfirmPublicVirtualInterfaceRequestRequestTypeDef = { # (1)
"virtualInterfaceId": ...,
}
parent.confirm_public_virtual_interface(**kwargs)
confirm_transit_virtual_interface
Accepts ownership of a transit virtual interface created by another Amazon Web Services account.
Type annotations and code completion for boto3.client("directconnect").confirm_transit_virtual_interface
method.
boto3 documentation
def confirm_transit_virtual_interface(
self,
*,
virtualInterfaceId: str,
directConnectGatewayId: str,
) -> ConfirmTransitVirtualInterfaceResponseTypeDef: # (1)
...
kwargs: ConfirmTransitVirtualInterfaceRequestRequestTypeDef = { # (1)
"virtualInterfaceId": ...,
"directConnectGatewayId": ...,
}
parent.confirm_transit_virtual_interface(**kwargs)
create_bgp_peer
Creates a BGP peer on the specified virtual interface.
Type annotations and code completion for boto3.client("directconnect").create_bgp_peer
method.
boto3 documentation
def create_bgp_peer(
self,
*,
virtualInterfaceId: str = ...,
newBGPPeer: NewBGPPeerTypeDef = ..., # (1)
) -> CreateBGPPeerResponseTypeDef: # (2)
...
kwargs: CreateBGPPeerRequestRequestTypeDef = { # (1)
"virtualInterfaceId": ...,
}
parent.create_bgp_peer(**kwargs)
create_connection
Creates a connection between a customer network and a specific Direct Connect location.
Type annotations and code completion for boto3.client("directconnect").create_connection
method.
boto3 documentation
def create_connection(
self,
*,
location: str,
bandwidth: str,
connectionName: str,
lagId: str = ...,
tags: Sequence[TagTypeDef] = ..., # (1)
providerName: str = ...,
requestMACSec: bool = ...,
) -> ConnectionResponseMetadataTypeDef: # (2)
...
kwargs: CreateConnectionRequestRequestTypeDef = { # (1)
"location": ...,
"bandwidth": ...,
"connectionName": ...,
}
parent.create_connection(**kwargs)
create_direct_connect_gateway
Creates a Direct Connect gateway, which is an intermediate object that enables you to connect a set of virtual interfaces and virtual private gateways.
Type annotations and code completion for boto3.client("directconnect").create_direct_connect_gateway
method.
boto3 documentation
def create_direct_connect_gateway(
self,
*,
directConnectGatewayName: str,
amazonSideAsn: int = ...,
) -> CreateDirectConnectGatewayResultTypeDef: # (1)
...
kwargs: CreateDirectConnectGatewayRequestRequestTypeDef = { # (1)
"directConnectGatewayName": ...,
}
parent.create_direct_connect_gateway(**kwargs)
create_direct_connect_gateway_association
Creates an association between a Direct Connect gateway and a virtual private gateway.
Type annotations and code completion for boto3.client("directconnect").create_direct_connect_gateway_association
method.
boto3 documentation
def create_direct_connect_gateway_association(
self,
*,
directConnectGatewayId: str,
gatewayId: str = ...,
addAllowedPrefixesToDirectConnectGateway: Sequence[RouteFilterPrefixTypeDef] = ..., # (1)
virtualGatewayId: str = ...,
) -> CreateDirectConnectGatewayAssociationResultTypeDef: # (2)
...
kwargs: CreateDirectConnectGatewayAssociationRequestRequestTypeDef = { # (1)
"directConnectGatewayId": ...,
}
parent.create_direct_connect_gateway_association(**kwargs)
create_direct_connect_gateway_association_proposal
Creates a proposal to associate the specified virtual private gateway or transit gateway with the specified Direct Connect gateway.
Type annotations and code completion for boto3.client("directconnect").create_direct_connect_gateway_association_proposal
method.
boto3 documentation
def create_direct_connect_gateway_association_proposal(
self,
*,
directConnectGatewayId: str,
directConnectGatewayOwnerAccount: str,
gatewayId: str,
addAllowedPrefixesToDirectConnectGateway: Sequence[RouteFilterPrefixTypeDef] = ..., # (1)
removeAllowedPrefixesToDirectConnectGateway: Sequence[RouteFilterPrefixTypeDef] = ..., # (1)
) -> CreateDirectConnectGatewayAssociationProposalResultTypeDef: # (3)
...
- See RouteFilterPrefixTypeDef
- See RouteFilterPrefixTypeDef
- See CreateDirectConnectGatewayAssociationProposalResultTypeDef
kwargs: CreateDirectConnectGatewayAssociationProposalRequestRequestTypeDef = { # (1)
"directConnectGatewayId": ...,
"directConnectGatewayOwnerAccount": ...,
"gatewayId": ...,
}
parent.create_direct_connect_gateway_association_proposal(**kwargs)
create_interconnect
Creates an interconnect between an Direct Connect Partner's network and a specific Direct Connect location.
Type annotations and code completion for boto3.client("directconnect").create_interconnect
method.
boto3 documentation
def create_interconnect(
self,
*,
interconnectName: str,
bandwidth: str,
location: str,
lagId: str = ...,
tags: Sequence[TagTypeDef] = ..., # (1)
providerName: str = ...,
) -> InterconnectResponseMetadataTypeDef: # (2)
...
kwargs: CreateInterconnectRequestRequestTypeDef = { # (1)
"interconnectName": ...,
"bandwidth": ...,
"location": ...,
}
parent.create_interconnect(**kwargs)
create_lag
Creates a link aggregation group (LAG) with the specified number of bundled physical dedicated connections between the customer network and a specific Direct Connect location.
Type annotations and code completion for boto3.client("directconnect").create_lag
method.
boto3 documentation
def create_lag(
self,
*,
numberOfConnections: int,
location: str,
connectionsBandwidth: str,
lagName: str,
connectionId: str = ...,
tags: Sequence[TagTypeDef] = ..., # (1)
childConnectionTags: Sequence[TagTypeDef] = ..., # (1)
providerName: str = ...,
requestMACSec: bool = ...,
) -> LagResponseMetadataTypeDef: # (3)
...
- See TagTypeDef
- See TagTypeDef
- See LagResponseMetadataTypeDef
kwargs: CreateLagRequestRequestTypeDef = { # (1)
"numberOfConnections": ...,
"location": ...,
"connectionsBandwidth": ...,
"lagName": ...,
}
parent.create_lag(**kwargs)
create_private_virtual_interface
Creates a private virtual interface.
Type annotations and code completion for boto3.client("directconnect").create_private_virtual_interface
method.
boto3 documentation
def create_private_virtual_interface(
self,
*,
connectionId: str,
newPrivateVirtualInterface: NewPrivateVirtualInterfaceTypeDef, # (1)
) -> VirtualInterfaceResponseMetadataTypeDef: # (2)
...
kwargs: CreatePrivateVirtualInterfaceRequestRequestTypeDef = { # (1)
"connectionId": ...,
"newPrivateVirtualInterface": ...,
}
parent.create_private_virtual_interface(**kwargs)
create_public_virtual_interface
Creates a public virtual interface.
Type annotations and code completion for boto3.client("directconnect").create_public_virtual_interface
method.
boto3 documentation
def create_public_virtual_interface(
self,
*,
connectionId: str,
newPublicVirtualInterface: NewPublicVirtualInterfaceTypeDef, # (1)
) -> VirtualInterfaceResponseMetadataTypeDef: # (2)
...
kwargs: CreatePublicVirtualInterfaceRequestRequestTypeDef = { # (1)
"connectionId": ...,
"newPublicVirtualInterface": ...,
}
parent.create_public_virtual_interface(**kwargs)
create_transit_virtual_interface
Creates a transit virtual interface.
Type annotations and code completion for boto3.client("directconnect").create_transit_virtual_interface
method.
boto3 documentation
def create_transit_virtual_interface(
self,
*,
connectionId: str,
newTransitVirtualInterface: NewTransitVirtualInterfaceTypeDef, # (1)
) -> CreateTransitVirtualInterfaceResultTypeDef: # (2)
...
kwargs: CreateTransitVirtualInterfaceRequestRequestTypeDef = { # (1)
"connectionId": ...,
"newTransitVirtualInterface": ...,
}
parent.create_transit_virtual_interface(**kwargs)
delete_bgp_peer
Deletes the specified BGP peer on the specified virtual interface with the specified customer address and ASN.
Type annotations and code completion for boto3.client("directconnect").delete_bgp_peer
method.
boto3 documentation
def delete_bgp_peer(
self,
*,
virtualInterfaceId: str = ...,
asn: int = ...,
customerAddress: str = ...,
bgpPeerId: str = ...,
) -> DeleteBGPPeerResponseTypeDef: # (1)
...
kwargs: DeleteBGPPeerRequestRequestTypeDef = { # (1)
"virtualInterfaceId": ...,
}
parent.delete_bgp_peer(**kwargs)
delete_connection
Deletes the specified connection.
Type annotations and code completion for boto3.client("directconnect").delete_connection
method.
boto3 documentation
def delete_connection(
self,
*,
connectionId: str,
) -> ConnectionResponseMetadataTypeDef: # (1)
...
kwargs: DeleteConnectionRequestRequestTypeDef = { # (1)
"connectionId": ...,
}
parent.delete_connection(**kwargs)
delete_direct_connect_gateway
Deletes the specified Direct Connect gateway.
Type annotations and code completion for boto3.client("directconnect").delete_direct_connect_gateway
method.
boto3 documentation
def delete_direct_connect_gateway(
self,
*,
directConnectGatewayId: str,
) -> DeleteDirectConnectGatewayResultTypeDef: # (1)
...
kwargs: DeleteDirectConnectGatewayRequestRequestTypeDef = { # (1)
"directConnectGatewayId": ...,
}
parent.delete_direct_connect_gateway(**kwargs)
delete_direct_connect_gateway_association
Deletes the association between the specified Direct Connect gateway and virtual private gateway.
Type annotations and code completion for boto3.client("directconnect").delete_direct_connect_gateway_association
method.
boto3 documentation
def delete_direct_connect_gateway_association(
self,
*,
associationId: str = ...,
directConnectGatewayId: str = ...,
virtualGatewayId: str = ...,
) -> DeleteDirectConnectGatewayAssociationResultTypeDef: # (1)
...
kwargs: DeleteDirectConnectGatewayAssociationRequestRequestTypeDef = { # (1)
"associationId": ...,
}
parent.delete_direct_connect_gateway_association(**kwargs)
delete_direct_connect_gateway_association_proposal
Deletes the association proposal request between the specified Direct Connect gateway and virtual private gateway or transit gateway.
Type annotations and code completion for boto3.client("directconnect").delete_direct_connect_gateway_association_proposal
method.
boto3 documentation
def delete_direct_connect_gateway_association_proposal(
self,
*,
proposalId: str,
) -> DeleteDirectConnectGatewayAssociationProposalResultTypeDef: # (1)
...
kwargs: DeleteDirectConnectGatewayAssociationProposalRequestRequestTypeDef = { # (1)
"proposalId": ...,
}
parent.delete_direct_connect_gateway_association_proposal(**kwargs)
delete_interconnect
Deletes the specified interconnect.
Type annotations and code completion for boto3.client("directconnect").delete_interconnect
method.
boto3 documentation
def delete_interconnect(
self,
*,
interconnectId: str,
) -> DeleteInterconnectResponseTypeDef: # (1)
...
kwargs: DeleteInterconnectRequestRequestTypeDef = { # (1)
"interconnectId": ...,
}
parent.delete_interconnect(**kwargs)
delete_lag
Deletes the specified link aggregation group (LAG).
Type annotations and code completion for boto3.client("directconnect").delete_lag
method.
boto3 documentation
kwargs: DeleteLagRequestRequestTypeDef = { # (1)
"lagId": ...,
}
parent.delete_lag(**kwargs)
delete_virtual_interface
Deletes a virtual interface.
Type annotations and code completion for boto3.client("directconnect").delete_virtual_interface
method.
boto3 documentation
def delete_virtual_interface(
self,
*,
virtualInterfaceId: str,
) -> DeleteVirtualInterfaceResponseTypeDef: # (1)
...
kwargs: DeleteVirtualInterfaceRequestRequestTypeDef = { # (1)
"virtualInterfaceId": ...,
}
parent.delete_virtual_interface(**kwargs)
describe_connection_loa
Deprecated.
Type annotations and code completion for boto3.client("directconnect").describe_connection_loa
method.
boto3 documentation
def describe_connection_loa(
self,
*,
connectionId: str,
providerName: str = ...,
loaContentType: LoaContentTypeType = ..., # (1)
) -> DescribeConnectionLoaResponseTypeDef: # (2)
...
kwargs: DescribeConnectionLoaRequestRequestTypeDef = { # (1)
"connectionId": ...,
}
parent.describe_connection_loa(**kwargs)
describe_connections
Displays the specified connection or all connections in this Region.
Type annotations and code completion for boto3.client("directconnect").describe_connections
method.
boto3 documentation
def describe_connections(
self,
*,
connectionId: str = ...,
) -> ConnectionsTypeDef: # (1)
...
kwargs: DescribeConnectionsRequestRequestTypeDef = { # (1)
"connectionId": ...,
}
parent.describe_connections(**kwargs)
describe_connections_on_interconnect
Deprecated.
Type annotations and code completion for boto3.client("directconnect").describe_connections_on_interconnect
method.
boto3 documentation
def describe_connections_on_interconnect(
self,
*,
interconnectId: str,
) -> ConnectionsTypeDef: # (1)
...
kwargs: DescribeConnectionsOnInterconnectRequestRequestTypeDef = { # (1)
"interconnectId": ...,
}
parent.describe_connections_on_interconnect(**kwargs)
describe_customer_metadata
Get and view a list of customer agreements, along with their signed status and whether the customer is an NNIPartner, NNIPartnerV2, or a nonPartner.
Type annotations and code completion for boto3.client("directconnect").describe_customer_metadata
method.
boto3 documentation
def describe_customer_metadata(
self,
) -> DescribeCustomerMetadataResponseTypeDef: # (1)
...
describe_direct_connect_gateway_association_proposals
Describes one or more association proposals for connection between a virtual private gateway or transit gateway and a Direct Connect gateway.
Type annotations and code completion for boto3.client("directconnect").describe_direct_connect_gateway_association_proposals
method.
boto3 documentation
def describe_direct_connect_gateway_association_proposals(
self,
*,
directConnectGatewayId: str = ...,
proposalId: str = ...,
associatedGatewayId: str = ...,
maxResults: int = ...,
nextToken: str = ...,
) -> DescribeDirectConnectGatewayAssociationProposalsResultTypeDef: # (1)
...
kwargs: DescribeDirectConnectGatewayAssociationProposalsRequestRequestTypeDef = { # (1)
"directConnectGatewayId": ...,
}
parent.describe_direct_connect_gateway_association_proposals(**kwargs)
describe_direct_connect_gateway_associations
Lists the associations between your Direct Connect gateways and virtual private gateways and transit gateways.
Type annotations and code completion for boto3.client("directconnect").describe_direct_connect_gateway_associations
method.
boto3 documentation
def describe_direct_connect_gateway_associations(
self,
*,
associationId: str = ...,
associatedGatewayId: str = ...,
directConnectGatewayId: str = ...,
maxResults: int = ...,
nextToken: str = ...,
virtualGatewayId: str = ...,
) -> DescribeDirectConnectGatewayAssociationsResultTypeDef: # (1)
...
kwargs: DescribeDirectConnectGatewayAssociationsRequestRequestTypeDef = { # (1)
"associationId": ...,
}
parent.describe_direct_connect_gateway_associations(**kwargs)
describe_direct_connect_gateway_attachments
Lists the attachments between your Direct Connect gateways and virtual interfaces.
Type annotations and code completion for boto3.client("directconnect").describe_direct_connect_gateway_attachments
method.
boto3 documentation
def describe_direct_connect_gateway_attachments(
self,
*,
directConnectGatewayId: str = ...,
virtualInterfaceId: str = ...,
maxResults: int = ...,
nextToken: str = ...,
) -> DescribeDirectConnectGatewayAttachmentsResultTypeDef: # (1)
...
kwargs: DescribeDirectConnectGatewayAttachmentsRequestRequestTypeDef = { # (1)
"directConnectGatewayId": ...,
}
parent.describe_direct_connect_gateway_attachments(**kwargs)
describe_direct_connect_gateways
Lists all your Direct Connect gateways or only the specified Direct Connect gateway.
Type annotations and code completion for boto3.client("directconnect").describe_direct_connect_gateways
method.
boto3 documentation
def describe_direct_connect_gateways(
self,
*,
directConnectGatewayId: str = ...,
maxResults: int = ...,
nextToken: str = ...,
) -> DescribeDirectConnectGatewaysResultTypeDef: # (1)
...
kwargs: DescribeDirectConnectGatewaysRequestRequestTypeDef = { # (1)
"directConnectGatewayId": ...,
}
parent.describe_direct_connect_gateways(**kwargs)
describe_hosted_connections
Lists the hosted connections that have been provisioned on the specified interconnect or link aggregation group (LAG).
Type annotations and code completion for boto3.client("directconnect").describe_hosted_connections
method.
boto3 documentation
def describe_hosted_connections(
self,
*,
connectionId: str,
) -> ConnectionsTypeDef: # (1)
...
kwargs: DescribeHostedConnectionsRequestRequestTypeDef = { # (1)
"connectionId": ...,
}
parent.describe_hosted_connections(**kwargs)
describe_interconnect_loa
Deprecated.
Type annotations and code completion for boto3.client("directconnect").describe_interconnect_loa
method.
boto3 documentation
def describe_interconnect_loa(
self,
*,
interconnectId: str,
providerName: str = ...,
loaContentType: LoaContentTypeType = ..., # (1)
) -> DescribeInterconnectLoaResponseTypeDef: # (2)
...
kwargs: DescribeInterconnectLoaRequestRequestTypeDef = { # (1)
"interconnectId": ...,
}
parent.describe_interconnect_loa(**kwargs)
describe_interconnects
Lists the interconnects owned by the Amazon Web Services account or only the specified interconnect.
Type annotations and code completion for boto3.client("directconnect").describe_interconnects
method.
boto3 documentation
def describe_interconnects(
self,
*,
interconnectId: str = ...,
) -> InterconnectsTypeDef: # (1)
...
kwargs: DescribeInterconnectsRequestRequestTypeDef = { # (1)
"interconnectId": ...,
}
parent.describe_interconnects(**kwargs)
describe_lags
Describes all your link aggregation groups (LAG) or the specified LAG.
Type annotations and code completion for boto3.client("directconnect").describe_lags
method.
boto3 documentation
- See LagsTypeDef
kwargs: DescribeLagsRequestRequestTypeDef = { # (1)
"lagId": ...,
}
parent.describe_lags(**kwargs)
describe_loa
Gets the LOA-CFA for a connection, interconnect, or link aggregation group (LAG).
Type annotations and code completion for boto3.client("directconnect").describe_loa
method.
boto3 documentation
def describe_loa(
self,
*,
connectionId: str,
providerName: str = ...,
loaContentType: LoaContentTypeType = ..., # (1)
) -> LoaResponseMetadataTypeDef: # (2)
...
kwargs: DescribeLoaRequestRequestTypeDef = { # (1)
"connectionId": ...,
}
parent.describe_loa(**kwargs)
describe_locations
Lists the Direct Connect locations in the current Amazon Web Services Region.
Type annotations and code completion for boto3.client("directconnect").describe_locations
method.
boto3 documentation
- See LocationsTypeDef
describe_router_configuration
Details about the router.
Type annotations and code completion for boto3.client("directconnect").describe_router_configuration
method.
boto3 documentation
def describe_router_configuration(
self,
*,
virtualInterfaceId: str,
routerTypeIdentifier: str = ...,
) -> DescribeRouterConfigurationResponseTypeDef: # (1)
...
kwargs: DescribeRouterConfigurationRequestRequestTypeDef = { # (1)
"virtualInterfaceId": ...,
}
parent.describe_router_configuration(**kwargs)
describe_tags
Describes the tags associated with the specified Direct Connect resources.
Type annotations and code completion for boto3.client("directconnect").describe_tags
method.
boto3 documentation
def describe_tags(
self,
*,
resourceArns: Sequence[str],
) -> DescribeTagsResponseTypeDef: # (1)
...
kwargs: DescribeTagsRequestRequestTypeDef = { # (1)
"resourceArns": ...,
}
parent.describe_tags(**kwargs)
describe_virtual_gateways
Lists the virtual private gateways owned by the Amazon Web Services account.
Type annotations and code completion for boto3.client("directconnect").describe_virtual_gateways
method.
boto3 documentation
describe_virtual_interfaces
Displays all virtual interfaces for an Amazon Web Services account.
Type annotations and code completion for boto3.client("directconnect").describe_virtual_interfaces
method.
boto3 documentation
def describe_virtual_interfaces(
self,
*,
connectionId: str = ...,
virtualInterfaceId: str = ...,
) -> VirtualInterfacesTypeDef: # (1)
...
kwargs: DescribeVirtualInterfacesRequestRequestTypeDef = { # (1)
"connectionId": ...,
}
parent.describe_virtual_interfaces(**kwargs)
disassociate_connection_from_lag
Disassociates a connection from a link aggregation group (LAG).
Type annotations and code completion for boto3.client("directconnect").disassociate_connection_from_lag
method.
boto3 documentation
def disassociate_connection_from_lag(
self,
*,
connectionId: str,
lagId: str,
) -> ConnectionResponseMetadataTypeDef: # (1)
...
kwargs: DisassociateConnectionFromLagRequestRequestTypeDef = { # (1)
"connectionId": ...,
"lagId": ...,
}
parent.disassociate_connection_from_lag(**kwargs)
disassociate_mac_sec_key
Removes the association between a MAC Security (MACsec) security key and an Direct Connect dedicated connection.
Type annotations and code completion for boto3.client("directconnect").disassociate_mac_sec_key
method.
boto3 documentation
def disassociate_mac_sec_key(
self,
*,
connectionId: str,
secretARN: str,
) -> DisassociateMacSecKeyResponseTypeDef: # (1)
...
kwargs: DisassociateMacSecKeyRequestRequestTypeDef = { # (1)
"connectionId": ...,
"secretARN": ...,
}
parent.disassociate_mac_sec_key(**kwargs)
generate_presigned_url
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("directconnect").generate_presigned_url
method.
boto3 documentation
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
list_virtual_interface_test_history
Lists the virtual interface failover test history.
Type annotations and code completion for boto3.client("directconnect").list_virtual_interface_test_history
method.
boto3 documentation
def list_virtual_interface_test_history(
self,
*,
testId: str = ...,
virtualInterfaceId: str = ...,
bgpPeers: Sequence[str] = ...,
status: str = ...,
maxResults: int = ...,
nextToken: str = ...,
) -> ListVirtualInterfaceTestHistoryResponseTypeDef: # (1)
...
kwargs: ListVirtualInterfaceTestHistoryRequestRequestTypeDef = { # (1)
"testId": ...,
}
parent.list_virtual_interface_test_history(**kwargs)
start_bgp_failover_test
Starts the virtual interface failover test that verifies your configuration meets your resiliency requirements by placing the BGP peering session in the DOWN state.
Type annotations and code completion for boto3.client("directconnect").start_bgp_failover_test
method.
boto3 documentation
def start_bgp_failover_test(
self,
*,
virtualInterfaceId: str,
bgpPeers: Sequence[str] = ...,
testDurationInMinutes: int = ...,
) -> StartBgpFailoverTestResponseTypeDef: # (1)
...
kwargs: StartBgpFailoverTestRequestRequestTypeDef = { # (1)
"virtualInterfaceId": ...,
}
parent.start_bgp_failover_test(**kwargs)
stop_bgp_failover_test
Stops the virtual interface failover test.
Type annotations and code completion for boto3.client("directconnect").stop_bgp_failover_test
method.
boto3 documentation
def stop_bgp_failover_test(
self,
*,
virtualInterfaceId: str,
) -> StopBgpFailoverTestResponseTypeDef: # (1)
...
kwargs: StopBgpFailoverTestRequestRequestTypeDef = { # (1)
"virtualInterfaceId": ...,
}
parent.stop_bgp_failover_test(**kwargs)
tag_resource
Adds the specified tags to the specified Direct Connect resource.
Type annotations and code completion for boto3.client("directconnect").tag_resource
method.
boto3 documentation
def tag_resource(
self,
*,
resourceArn: str,
tags: Sequence[TagTypeDef], # (1)
) -> Dict[str, Any]:
...
- See TagTypeDef
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
"tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource
Removes one or more tags from the specified Direct Connect resource.
Type annotations and code completion for boto3.client("directconnect").untag_resource
method.
boto3 documentation
def untag_resource(
self,
*,
resourceArn: str,
tagKeys: Sequence[str],
) -> Dict[str, Any]:
...
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
"tagKeys": ...,
}
parent.untag_resource(**kwargs)
update_connection
Updates the Direct Connect dedicated connection configuration.
Type annotations and code completion for boto3.client("directconnect").update_connection
method.
boto3 documentation
def update_connection(
self,
*,
connectionId: str,
connectionName: str = ...,
encryptionMode: str = ...,
) -> ConnectionResponseMetadataTypeDef: # (1)
...
kwargs: UpdateConnectionRequestRequestTypeDef = { # (1)
"connectionId": ...,
}
parent.update_connection(**kwargs)
update_direct_connect_gateway
Updates the name of a current Direct Connect gateway.
Type annotations and code completion for boto3.client("directconnect").update_direct_connect_gateway
method.
boto3 documentation
def update_direct_connect_gateway(
self,
*,
directConnectGatewayId: str,
newDirectConnectGatewayName: str,
) -> UpdateDirectConnectGatewayResponseTypeDef: # (1)
...
kwargs: UpdateDirectConnectGatewayRequestRequestTypeDef = { # (1)
"directConnectGatewayId": ...,
"newDirectConnectGatewayName": ...,
}
parent.update_direct_connect_gateway(**kwargs)
update_direct_connect_gateway_association
Updates the specified attributes of the Direct Connect gateway association.
Type annotations and code completion for boto3.client("directconnect").update_direct_connect_gateway_association
method.
boto3 documentation
def update_direct_connect_gateway_association(
self,
*,
associationId: str = ...,
addAllowedPrefixesToDirectConnectGateway: Sequence[RouteFilterPrefixTypeDef] = ..., # (1)
removeAllowedPrefixesToDirectConnectGateway: Sequence[RouteFilterPrefixTypeDef] = ..., # (1)
) -> UpdateDirectConnectGatewayAssociationResultTypeDef: # (3)
...
- See RouteFilterPrefixTypeDef
- See RouteFilterPrefixTypeDef
- See UpdateDirectConnectGatewayAssociationResultTypeDef
kwargs: UpdateDirectConnectGatewayAssociationRequestRequestTypeDef = { # (1)
"associationId": ...,
}
parent.update_direct_connect_gateway_association(**kwargs)
update_lag
Updates the attributes of the specified link aggregation group (LAG).
Type annotations and code completion for boto3.client("directconnect").update_lag
method.
boto3 documentation
def update_lag(
self,
*,
lagId: str,
lagName: str = ...,
minimumLinks: int = ...,
encryptionMode: str = ...,
) -> LagResponseMetadataTypeDef: # (1)
...
kwargs: UpdateLagRequestRequestTypeDef = { # (1)
"lagId": ...,
}
parent.update_lag(**kwargs)
update_virtual_interface_attributes
Updates the specified attributes of the specified virtual private interface.
Type annotations and code completion for boto3.client("directconnect").update_virtual_interface_attributes
method.
boto3 documentation
def update_virtual_interface_attributes(
self,
*,
virtualInterfaceId: str,
mtu: int = ...,
enableSiteLink: bool = ...,
virtualInterfaceName: str = ...,
) -> VirtualInterfaceResponseMetadataTypeDef: # (1)
...
kwargs: UpdateVirtualInterfaceAttributesRequestRequestTypeDef = { # (1)
"virtualInterfaceId": ...,
}
parent.update_virtual_interface_attributes(**kwargs)
get_paginator
Type annotations and code completion for boto3.client("directconnect").get_paginator
method with overloads.
client.get_paginator("describe_direct_connect_gateway_associations")
-> DescribeDirectConnectGatewayAssociationsPaginatorclient.get_paginator("describe_direct_connect_gateway_attachments")
-> DescribeDirectConnectGatewayAttachmentsPaginatorclient.get_paginator("describe_direct_connect_gateways")
-> DescribeDirectConnectGatewaysPaginator