Skip to content

Type definitions#

Index > DirectConnect > Type definitions

Auto-generated documentation for DirectConnect type annotations stubs module mypy-boto3-directconnect.

RouteFilterPrefixTypeDef#

# RouteFilterPrefixTypeDef definition

class RouteFilterPrefixTypeDef(TypedDict):
    cidr: NotRequired[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

AllocateConnectionOnInterconnectRequestRequestTypeDef#

# AllocateConnectionOnInterconnectRequestRequestTypeDef definition

class AllocateConnectionOnInterconnectRequestRequestTypeDef(TypedDict):
    bandwidth: str,
    connectionName: str,
    ownerAccount: str,
    interconnectId: str,
    vlan: int,

TagTypeDef#

# TagTypeDef definition

class TagTypeDef(TypedDict):
    key: str,
    value: NotRequired[str],

AssociateConnectionWithLagRequestRequestTypeDef#

# AssociateConnectionWithLagRequestRequestTypeDef definition

class AssociateConnectionWithLagRequestRequestTypeDef(TypedDict):
    connectionId: str,
    lagId: str,

AssociateHostedConnectionRequestRequestTypeDef#

# AssociateHostedConnectionRequestRequestTypeDef definition

class AssociateHostedConnectionRequestRequestTypeDef(TypedDict):
    connectionId: str,
    parentConnectionId: str,

AssociateMacSecKeyRequestRequestTypeDef#

# AssociateMacSecKeyRequestRequestTypeDef definition

class AssociateMacSecKeyRequestRequestTypeDef(TypedDict):
    connectionId: str,
    secretARN: NotRequired[str],
    ckn: NotRequired[str],
    cak: NotRequired[str],

MacSecKeyTypeDef#

# MacSecKeyTypeDef definition

class MacSecKeyTypeDef(TypedDict):
    secretARN: NotRequired[str],
    ckn: NotRequired[str],
    state: NotRequired[str],
    startOn: NotRequired[str],

AssociateVirtualInterfaceRequestRequestTypeDef#

# AssociateVirtualInterfaceRequestRequestTypeDef definition

class AssociateVirtualInterfaceRequestRequestTypeDef(TypedDict):
    virtualInterfaceId: str,
    connectionId: str,

AssociatedGatewayTypeDef#

# AssociatedGatewayTypeDef definition

class AssociatedGatewayTypeDef(TypedDict):
    id: NotRequired[str],
    type: NotRequired[GatewayTypeType],  # (1)
    ownerAccount: NotRequired[str],
    region: NotRequired[str],
  1. See GatewayTypeType

BGPPeerTypeDef#

# BGPPeerTypeDef definition

class BGPPeerTypeDef(TypedDict):
    bgpPeerId: NotRequired[str],
    asn: NotRequired[int],
    authKey: NotRequired[str],
    addressFamily: NotRequired[AddressFamilyType],  # (1)
    amazonAddress: NotRequired[str],
    customerAddress: NotRequired[str],
    bgpPeerState: NotRequired[BGPPeerStateType],  # (2)
    bgpStatus: NotRequired[BGPStatusType],  # (3)
    awsDeviceV2: NotRequired[str],
    awsLogicalDeviceId: NotRequired[str],
  1. See AddressFamilyType
  2. See BGPPeerStateType
  3. See BGPStatusType

ConfirmConnectionRequestRequestTypeDef#

# ConfirmConnectionRequestRequestTypeDef definition

class ConfirmConnectionRequestRequestTypeDef(TypedDict):
    connectionId: str,

ConfirmCustomerAgreementRequestRequestTypeDef#

# ConfirmCustomerAgreementRequestRequestTypeDef definition

class ConfirmCustomerAgreementRequestRequestTypeDef(TypedDict):
    agreementName: NotRequired[str],

ConfirmPrivateVirtualInterfaceRequestRequestTypeDef#

# ConfirmPrivateVirtualInterfaceRequestRequestTypeDef definition

class ConfirmPrivateVirtualInterfaceRequestRequestTypeDef(TypedDict):
    virtualInterfaceId: str,
    virtualGatewayId: NotRequired[str],
    directConnectGatewayId: NotRequired[str],

ConfirmPublicVirtualInterfaceRequestRequestTypeDef#

# ConfirmPublicVirtualInterfaceRequestRequestTypeDef definition

class ConfirmPublicVirtualInterfaceRequestRequestTypeDef(TypedDict):
    virtualInterfaceId: str,

ConfirmTransitVirtualInterfaceRequestRequestTypeDef#

# ConfirmTransitVirtualInterfaceRequestRequestTypeDef definition

class ConfirmTransitVirtualInterfaceRequestRequestTypeDef(TypedDict):
    virtualInterfaceId: str,
    directConnectGatewayId: str,

NewBGPPeerTypeDef#

# NewBGPPeerTypeDef definition

class NewBGPPeerTypeDef(TypedDict):
    asn: NotRequired[int],
    authKey: NotRequired[str],
    addressFamily: NotRequired[AddressFamilyType],  # (1)
    amazonAddress: NotRequired[str],
    customerAddress: NotRequired[str],
  1. See AddressFamilyType

CreateDirectConnectGatewayRequestRequestTypeDef#

# CreateDirectConnectGatewayRequestRequestTypeDef definition

class CreateDirectConnectGatewayRequestRequestTypeDef(TypedDict):
    directConnectGatewayName: str,
    amazonSideAsn: NotRequired[int],

DirectConnectGatewayTypeDef#

# DirectConnectGatewayTypeDef definition

class DirectConnectGatewayTypeDef(TypedDict):
    directConnectGatewayId: NotRequired[str],
    directConnectGatewayName: NotRequired[str],
    amazonSideAsn: NotRequired[int],
    ownerAccount: NotRequired[str],
    directConnectGatewayState: NotRequired[DirectConnectGatewayStateType],  # (1)
    stateChangeError: NotRequired[str],
  1. See DirectConnectGatewayStateType

CustomerAgreementTypeDef#

# CustomerAgreementTypeDef definition

class CustomerAgreementTypeDef(TypedDict):
    agreementName: NotRequired[str],
    status: NotRequired[str],

DeleteBGPPeerRequestRequestTypeDef#

# DeleteBGPPeerRequestRequestTypeDef definition

class DeleteBGPPeerRequestRequestTypeDef(TypedDict):
    virtualInterfaceId: NotRequired[str],
    asn: NotRequired[int],
    customerAddress: NotRequired[str],
    bgpPeerId: NotRequired[str],

DeleteConnectionRequestRequestTypeDef#

# DeleteConnectionRequestRequestTypeDef definition

class DeleteConnectionRequestRequestTypeDef(TypedDict):
    connectionId: str,

DeleteDirectConnectGatewayAssociationProposalRequestRequestTypeDef#

# DeleteDirectConnectGatewayAssociationProposalRequestRequestTypeDef definition

class DeleteDirectConnectGatewayAssociationProposalRequestRequestTypeDef(TypedDict):
    proposalId: str,

DeleteDirectConnectGatewayAssociationRequestRequestTypeDef#

# DeleteDirectConnectGatewayAssociationRequestRequestTypeDef definition

class DeleteDirectConnectGatewayAssociationRequestRequestTypeDef(TypedDict):
    associationId: NotRequired[str],
    directConnectGatewayId: NotRequired[str],
    virtualGatewayId: NotRequired[str],

DeleteDirectConnectGatewayRequestRequestTypeDef#

# DeleteDirectConnectGatewayRequestRequestTypeDef definition

class DeleteDirectConnectGatewayRequestRequestTypeDef(TypedDict):
    directConnectGatewayId: str,

DeleteInterconnectRequestRequestTypeDef#

# DeleteInterconnectRequestRequestTypeDef definition

class DeleteInterconnectRequestRequestTypeDef(TypedDict):
    interconnectId: str,

DeleteLagRequestRequestTypeDef#

# DeleteLagRequestRequestTypeDef definition

class DeleteLagRequestRequestTypeDef(TypedDict):
    lagId: str,

DeleteVirtualInterfaceRequestRequestTypeDef#

# DeleteVirtualInterfaceRequestRequestTypeDef definition

class DeleteVirtualInterfaceRequestRequestTypeDef(TypedDict):
    virtualInterfaceId: str,

DescribeConnectionLoaRequestRequestTypeDef#

# DescribeConnectionLoaRequestRequestTypeDef definition

class DescribeConnectionLoaRequestRequestTypeDef(TypedDict):
    connectionId: str,
    providerName: NotRequired[str],
    loaContentType: NotRequired[LoaContentTypeType],  # (1)
  1. See LoaContentTypeType

LoaTypeDef#

# LoaTypeDef definition

class LoaTypeDef(TypedDict):
    loaContent: NotRequired[bytes],
    loaContentType: NotRequired[LoaContentTypeType],  # (1)
  1. See LoaContentTypeType

DescribeConnectionsOnInterconnectRequestRequestTypeDef#

# DescribeConnectionsOnInterconnectRequestRequestTypeDef definition

class DescribeConnectionsOnInterconnectRequestRequestTypeDef(TypedDict):
    interconnectId: str,

DescribeConnectionsRequestRequestTypeDef#

# DescribeConnectionsRequestRequestTypeDef definition

class DescribeConnectionsRequestRequestTypeDef(TypedDict):
    connectionId: NotRequired[str],

DescribeDirectConnectGatewayAssociationProposalsRequestRequestTypeDef#

# DescribeDirectConnectGatewayAssociationProposalsRequestRequestTypeDef definition

class DescribeDirectConnectGatewayAssociationProposalsRequestRequestTypeDef(TypedDict):
    directConnectGatewayId: NotRequired[str],
    proposalId: NotRequired[str],
    associatedGatewayId: NotRequired[str],
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

DescribeDirectConnectGatewayAssociationsRequestRequestTypeDef#

# DescribeDirectConnectGatewayAssociationsRequestRequestTypeDef definition

class DescribeDirectConnectGatewayAssociationsRequestRequestTypeDef(TypedDict):
    associationId: NotRequired[str],
    associatedGatewayId: NotRequired[str],
    directConnectGatewayId: NotRequired[str],
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
    virtualGatewayId: NotRequired[str],

DescribeDirectConnectGatewayAttachmentsRequestRequestTypeDef#

# DescribeDirectConnectGatewayAttachmentsRequestRequestTypeDef definition

class DescribeDirectConnectGatewayAttachmentsRequestRequestTypeDef(TypedDict):
    directConnectGatewayId: NotRequired[str],
    virtualInterfaceId: NotRequired[str],
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

DirectConnectGatewayAttachmentTypeDef#

# DirectConnectGatewayAttachmentTypeDef definition

class DirectConnectGatewayAttachmentTypeDef(TypedDict):
    directConnectGatewayId: NotRequired[str],
    virtualInterfaceId: NotRequired[str],
    virtualInterfaceRegion: NotRequired[str],
    virtualInterfaceOwnerAccount: NotRequired[str],
    attachmentState: NotRequired[DirectConnectGatewayAttachmentStateType],  # (1)
    attachmentType: NotRequired[DirectConnectGatewayAttachmentTypeType],  # (2)
    stateChangeError: NotRequired[str],
  1. See DirectConnectGatewayAttachmentStateType
  2. See DirectConnectGatewayAttachmentTypeType

DescribeDirectConnectGatewaysRequestRequestTypeDef#

# DescribeDirectConnectGatewaysRequestRequestTypeDef definition

class DescribeDirectConnectGatewaysRequestRequestTypeDef(TypedDict):
    directConnectGatewayId: NotRequired[str],
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

DescribeHostedConnectionsRequestRequestTypeDef#

# DescribeHostedConnectionsRequestRequestTypeDef definition

class DescribeHostedConnectionsRequestRequestTypeDef(TypedDict):
    connectionId: str,

DescribeInterconnectLoaRequestRequestTypeDef#

# DescribeInterconnectLoaRequestRequestTypeDef definition

class DescribeInterconnectLoaRequestRequestTypeDef(TypedDict):
    interconnectId: str,
    providerName: NotRequired[str],
    loaContentType: NotRequired[LoaContentTypeType],  # (1)
  1. See LoaContentTypeType

DescribeInterconnectsRequestRequestTypeDef#

# DescribeInterconnectsRequestRequestTypeDef definition

class DescribeInterconnectsRequestRequestTypeDef(TypedDict):
    interconnectId: NotRequired[str],

DescribeLagsRequestRequestTypeDef#

# DescribeLagsRequestRequestTypeDef definition

class DescribeLagsRequestRequestTypeDef(TypedDict):
    lagId: NotRequired[str],

DescribeLoaRequestRequestTypeDef#

# DescribeLoaRequestRequestTypeDef definition

class DescribeLoaRequestRequestTypeDef(TypedDict):
    connectionId: str,
    providerName: NotRequired[str],
    loaContentType: NotRequired[LoaContentTypeType],  # (1)
  1. See LoaContentTypeType

DescribeRouterConfigurationRequestRequestTypeDef#

# DescribeRouterConfigurationRequestRequestTypeDef definition

class DescribeRouterConfigurationRequestRequestTypeDef(TypedDict):
    virtualInterfaceId: str,
    routerTypeIdentifier: NotRequired[str],

RouterTypeTypeDef#

# RouterTypeTypeDef definition

class RouterTypeTypeDef(TypedDict):
    vendor: NotRequired[str],
    platform: NotRequired[str],
    software: NotRequired[str],
    xsltTemplateName: NotRequired[str],
    xsltTemplateNameForMacSec: NotRequired[str],
    routerTypeIdentifier: NotRequired[str],

DescribeTagsRequestRequestTypeDef#

# DescribeTagsRequestRequestTypeDef definition

class DescribeTagsRequest