Skip to content

Type definitions#

Index > Interconnect > Type definitions

Auto-generated documentation for Interconnect type annotations stubs module mypy-boto3-interconnect.

AttachPointTypeDef#

# AttachPointTypeDef TypedDict usage example

from mypy_boto3_interconnect.type_defs import AttachPointTypeDef


def get_value() -> AttachPointTypeDef:
    return {
        "directConnectGateway": ...,
    }


# AttachPointTypeDef definition

class AttachPointTypeDef(TypedDict):
    directConnectGateway: NotRequired[str],
    arn: NotRequired[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef TypedDict usage example

from mypy_boto3_interconnect.type_defs import ResponseMetadataTypeDef


def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
    }


# ResponseMetadataTypeDef definition

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

AttachPointDescriptorTypeDef#

# AttachPointDescriptorTypeDef TypedDict usage example

from mypy_boto3_interconnect.type_defs import AttachPointDescriptorTypeDef


def get_value() -> AttachPointDescriptorTypeDef:
    return {
        "type": ...,
    }


# AttachPointDescriptorTypeDef definition

class AttachPointDescriptorTypeDef(TypedDict):
    type: AttachPointTypeType,  # (1)
    identifier: str,
    name: str,
  1. See AttachPointTypeType

BandwidthsTypeDef#

# BandwidthsTypeDef TypedDict usage example

from mypy_boto3_interconnect.type_defs import BandwidthsTypeDef


def get_value() -> BandwidthsTypeDef:
    return {
        "available": ...,
    }


# BandwidthsTypeDef definition

class BandwidthsTypeDef(TypedDict):
    available: NotRequired[list[str]],
    supported: NotRequired[list[str]],

ProviderTypeDef#

# ProviderTypeDef TypedDict usage example

from mypy_boto3_interconnect.type_defs import ProviderTypeDef


def get_value() -> ProviderTypeDef:
    return {
        "cloudServiceProvider": ...,
    }


# ProviderTypeDef definition

class ProviderTypeDef(TypedDict):
    cloudServiceProvider: NotRequired[str],
    lastMileProvider: NotRequired[str],

RemoteAccountIdentifierTypeDef#

# RemoteAccountIdentifierTypeDef TypedDict usage example

from mypy_boto3_interconnect.type_defs import RemoteAccountIdentifierTypeDef


def get_value() -> RemoteAccountIdentifierTypeDef:
    return {
        "identifier": ...,
    }


# RemoteAccountIdentifierTypeDef definition

class RemoteAccountIdentifierTypeDef(TypedDict):
    identifier: NotRequired[str],

DeleteConnectionRequestTypeDef#

# DeleteConnectionRequestTypeDef TypedDict usage example

from mypy_boto3_interconnect.type_defs import DeleteConnectionRequestTypeDef


def get_value() -> DeleteConnectionRequestTypeDef:
    return {
        "identifier": ...,
    }


# DeleteConnectionRequestTypeDef definition

class DeleteConnectionRequestTypeDef(TypedDict):
    identifier: str,
    clientToken: NotRequired[str],

DescribeConnectionProposalRequestTypeDef#

# DescribeConnectionProposalRequestTypeDef TypedDict usage example

from mypy_boto3_interconnect.type_defs import DescribeConnectionProposalRequestTypeDef


def get_value() -> DescribeConnectionProposalRequestTypeDef:
    return {
        "activationKey": ...,
    }


# DescribeConnectionProposalRequestTypeDef definition

class DescribeConnectionProposalRequestTypeDef(TypedDict):
    activationKey: str,

GetConnectionRequestTypeDef#

# GetConnectionRequestTypeDef TypedDict usage example

from mypy_boto3_interconnect.type_defs import GetConnectionRequestTypeDef


def get_value() -> GetConnectionRequestTypeDef:
    return {
        "identifier": ...,
    }


# GetConnectionRequestTypeDef definition

class GetConnectionRequestTypeDef(TypedDict):
    identifier: str,

WaiterConfigTypeDef#

# WaiterConfigTypeDef TypedDict usage example

from mypy_boto3_interconnect.type_defs import WaiterConfigTypeDef


def get_value() -> WaiterConfigTypeDef:
    return {
        "Delay": ...,
    }


# WaiterConfigTypeDef definition

class WaiterConfigTypeDef(TypedDict):
    Delay: NotRequired[int],
    MaxAttempts: NotRequired[int],

GetEnvironmentRequestTypeDef#

# GetEnvironmentRequestTypeDef TypedDict usage example

from mypy_boto3_interconnect.type_defs import GetEnvironmentRequestTypeDef


def get_value() -> GetEnvironmentRequestTypeDef:
    return {
        "id": ...,
    }


# GetEnvironmentRequestTypeDef definition

class GetEnvironmentRequestTypeDef(TypedDict):
    id: str,

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef TypedDict usage example

from mypy_boto3_interconnect.type_defs import PaginatorConfigTypeDef


def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }


# PaginatorConfigTypeDef definition

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

ListAttachPointsRequestTypeDef#

# ListAttachPointsRequestTypeDef TypedDict usage example

from mypy_boto3_interconnect.type_defs import ListAttachPointsRequestTypeDef


def get_value() -> ListAttachPointsRequestTypeDef:
    return {
        "environmentId": ...,
    }


# ListAttachPointsRequestTypeDef definition

class ListAttachPointsRequestTypeDef(TypedDict):
    environmentId: str,
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListTagsForResourceRequestTypeDef#

# ListTagsForResourceRequestTypeDef TypedDict usage example

from mypy_boto3_interconnect.type_defs import ListTagsForResourceRequestTypeDef


def get_value() -> ListTagsForResourceRequestTypeDef:
    return {
        "arn": ...,
    }


# ListTagsForResourceRequestTypeDef definition

class ListTagsForResourceRequestTypeDef(TypedDict):
    arn: str,

TagResourceRequestTypeDef#

# TagResourceRequestTypeDef TypedDict usage example

from mypy_boto3_interconnect.type_defs import TagResourceRequestTypeDef


def get_value() -> TagResourceRequestTypeDef:
    return {
        "arn": ...,
    }


# TagResourceRequestTypeDef definition

class TagResourceRequestTypeDef(TypedDict):
    arn: str,
    tags: Mapping[str, str],

UntagResourceRequestTypeDef#

# UntagResourceRequestTypeDef TypedDict usage example

from mypy_boto3_interconnect.type_defs import UntagResourceRequestTypeDef


def get_value() -> UntagResourceRequestTypeDef:
    return {
        "arn": ...,
    }


# UntagResourceRequestTypeDef definition

class UntagResourceRequestTypeDef(TypedDict):
    arn: str,
    tagKeys: Sequence[str],

UpdateConnectionRequestTypeDef#

# UpdateConnectionRequestTypeDef TypedDict usage example

from mypy_boto3_interconnect.type_defs import UpdateConnectionRequestTypeDef


def get_value() -> UpdateConnectionRequestTypeDef:
    return {
        "identifier": ...,
    }


# UpdateConnectionRequestTypeDef definition

class UpdateConnectionRequestTypeDef(TypedDict):
    identifier: str,
    description: NotRequired[str],
    bandwidth: NotRequired[str],
    clientToken: NotRequired[str],

AcceptConnectionProposalRequestTypeDef#

# AcceptConnectionProposalRequestTypeDef TypedDict usage example

from mypy_boto3_interconnect.type_defs import AcceptConnectionProposalRequestTypeDef


def get_value() -> AcceptConnectionProposalRequestTypeDef:
    return {
        "attachPoint": ...,
    }


# AcceptConnectionProposalRequestTypeDef definition

class AcceptConnectionProposalRequestTypeDef(TypedDict):
    attachPoint: AttachPointTypeDef,  # (1)
    activationKey: str,
    description: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],
    clientToken: NotRequired[str],
  1. See AttachPointTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef TypedDict usage example

from mypy_boto3_interconnect.type_defs import ListTagsForResourceResponseTypeDef


def get_value() -> ListTagsForResourceResponseTypeDef:
    return {
        "tags": ...,
    }


# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    tags: dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListAttachPointsResponseTypeDef#

# ListAttachPointsResponseTypeDef TypedDict usage example

from mypy_boto3_interconnect.type_defs import ListAttachPointsResponseTypeDef


def get_value() -> ListAttachPointsResponseTypeDef:
    return {
        "attachPoints": ...,
    }


# ListAttachPointsResponseTypeDef definition

class ListAttachPointsResponseTypeDef(TypedDict):
    attachPoints: list[AttachPointDescriptorTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See list[AttachPointDescriptorTypeDef]
  2. See ResponseMetadataTypeDef

ConnectionSummaryTypeDef#

# ConnectionSummaryTypeDef TypedDict usage example

from mypy_boto3_interconnect.type_defs import ConnectionSummaryTypeDef


def get_value() -> ConnectionSummaryTypeDef:
    return {
        "id": ...,
    }


# ConnectionSummaryTypeDef definition

class ConnectionSummaryTypeDef(TypedDict):
    id: str,
    arn: str,
    description: str,
    bandwidth: str,
    attachPoint: AttachPointTypeDef,  # (1)
    environmentId: str,
    provider: ProviderTypeDef,  # (2)
    location: str,
    type: str,
    state: ConnectionStateType,  # (3)
    sharedId: str,
    billingTier: NotRequired[int],
  1. See AttachPointTypeDef
  2. See ProviderTypeDef
  3. See ConnectionStateType

ConnectionTypeDef#

# ConnectionTypeDef TypedDict usage example

from mypy_boto3_interconnect.type_defs import ConnectionTypeDef


def get_value() -> ConnectionTypeDef:
    return {
        "id": ...,
    }


# ConnectionTypeDef definition

class ConnectionTypeDef(TypedDict):
    id: str,
    arn: str,
    description: str,
    bandwidth: str,
    attachPoint: AttachPointTypeDef,  # (1)
    environmentId: str,
    provider: ProviderTypeDef,  # (2)
    location: str,
    type: str,
    state: ConnectionStateType,  # (3)
    sharedId: str,
    ownerAccount: str,
    activationKey: str,
    billingTier: NotRequired[int],
    tags: NotRequired[dict[str, str]],
  1. See AttachPointTypeDef
  2. See ProviderTypeDef
  3. See ConnectionStateType

DescribeConnectionProposalResponseTypeDef#

# DescribeConnectionProposalResponseTypeDef TypedDict usage example

from mypy_boto3_interconnect.type_defs import DescribeConnectionProposalResponseTypeDef


def get_value() -> DescribeConnectionProposalResponseTypeDef:
    return {
        "bandwidth": ...,
    }


# DescribeConnectionProposalResponseTypeDef definition

class DescribeConnectionProposalResponseTypeDef(TypedDict):
    bandwidth: str,
    environmentId: str,
    provider: ProviderTypeDef,  # (1)
    location: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ProviderTypeDef
  2. See ResponseMetadataTypeDef

EnvironmentTypeDef#

# EnvironmentTypeDef TypedDict usage example

from mypy_boto3_interconnect.type_defs import EnvironmentTypeDef


def get_value() -> EnvironmentTypeDef:
    return {
        "provider": ...,
    }


# EnvironmentTypeDef definition

class EnvironmentTypeDef(TypedDict):
    provider: ProviderTypeDef,  # (1)
    location: str,
    environmentId: str,
    state: EnvironmentStateType,  # (2)
    bandwidths: BandwidthsTypeDef,  # (3)
    type: str,
    activationPageUrl: NotRequired[str],
    remoteIdentifierType: NotRequired[RemoteAccountIdentifierTypeType],  # (4)
  1. See ProviderTypeDef
  2. See EnvironmentStateType
  3. See BandwidthsTypeDef
  4. See RemoteAccountIdentifierTypeType

ListConnectionsRequestTypeDef#

# ListConnectionsRequestTypeDef TypedDict usage example

from mypy_boto3_interconnect.type_defs import ListConnectionsRequestTypeDef


def get_value() -> ListConnectionsRequestTypeDef:
    return {
        "maxResults": ...,
    }


# ListConnectionsRequestTypeDef definition

class ListConnectionsRequestTypeDef(TypedDict):
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
    state: NotRequired[ConnectionStateType],  # (1)
    environmentId: NotRequired[str],
    provider: NotRequired[ProviderTypeDef],  # (2)
    attachPoint: NotRequired[AttachPointTypeDef],  # (3)
  1. See ConnectionStateType
  2. See ProviderTypeDef
  3. See AttachPointTypeDef

ListEnvironmentsRequestTypeDef#

# ListEnvironmentsRequestTypeDef TypedDict usage example

from mypy_boto3_interconnect.type_defs import ListEnvironmentsRequestTypeDef


def get_value() -> ListEnvironmentsRequestTypeDef:
    return {
        "maxResults": ...,
    }


# ListEnvironmentsRequestTypeDef definition

class ListEnvironmentsRequestTypeDef(TypedDict):
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
    provider: NotRequired[ProviderTypeDef],  # (1)
    location: NotRequired[str],
  1. See ProviderTypeDef

CreateConnectionRequestTypeDef#

# CreateConnectionRequestTypeDef TypedDict usage example

from mypy_boto3_interconnect.type_defs import CreateConnectionRequestTypeDef


def get_value() -> CreateConnectionRequestTypeDef:
    return {
        "bandwidth": ...,
    }


# CreateConnectionRequestTypeDef definition

class CreateConnectionRequestTypeDef(TypedDict):
    bandwidth: str,
    attachPoint: AttachPointTypeDef,  # (1)
    environmentId: str,
    description: NotRequired[str],
    remoteAccount: NotRequired[RemoteAccountIdentifierTypeDef],  # (2)
    tags: NotRequired[Mapping[str, str]],
    clientToken: NotRequired[str],
  1. See AttachPointTypeDef
  2. See RemoteAccountIdentifierTypeDef

GetConnectionRequestWaitExtraTypeDef#

# GetConnectionRequestWaitExtraTypeDef TypedDict usage example

from mypy_boto3_interconnect.type_defs import GetConnectionRequestWaitExtraTypeDef


def get_value() -> GetConnectionRequestWaitExtraTypeDef:
    return {
        "identifier": ...,
    }


# GetConnectionRequestWaitExtraTypeDef definition

class GetConnectionRequestWaitExtraTypeDef(TypedDict):
    identifier: str,
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (1)
  1. See WaiterConfigTypeDef

GetConnectionRequestWaitTypeDef#

# GetConnectionRequestWaitTypeDef TypedDict usage example

from mypy_boto3_interconnect.type_defs import GetConnectionRequestWaitTypeDef


def get_value() -> GetConnectionRequestWaitTypeDef:
    return {
        "identifier": ...,
    }


# GetConnectionRequestWaitTypeDef definition

class GetConnectionRequestWaitTypeDef(TypedDict):
    identifier: str,
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (1)
  1. See WaiterConfigTypeDef

ListAttachPointsRequestPaginateTypeDef#

# ListAttachPointsRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_interconnect.type_defs import ListAttachPointsRequestPaginateTypeDef


def get_value() -> ListAttachPointsRequestPaginateTypeDef:
    return {
        "environmentId": ...,
    }


# ListAttachPointsRequestPaginateTypeDef definition

class ListAttachPointsRequestPaginateTypeDef(TypedDict):
    environmentId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListConnectionsRequestPaginateTypeDef#

# ListConnectionsRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_interconnect.type_defs import ListConnectionsRequestPaginateTypeDef


def get_value() -> ListConnectionsRequestPaginateTypeDef:
    return {
        "state": ...,
    }


# ListConnectionsRequestPaginateTypeDef definition

class ListConnectionsRequestPaginateTypeDef(TypedDict):
    state: NotRequired[ConnectionStateType],  # (1)
    environmentId: NotRequired[str],
    provider: NotRequired[ProviderTypeDef],  # (2)
    attachPoint: NotRequired[AttachPointTypeDef],  # (3)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (4)
  1. See ConnectionStateType
  2. See ProviderTypeDef
  3. See AttachPointTypeDef
  4. See PaginatorConfigTypeDef

ListEnvironmentsRequestPaginateTypeDef#

# ListEnvironmentsRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_interconnect.type_defs import ListEnvironmentsRequestPaginateTypeDef


def get_value() -> ListEnvironmentsRequestPaginateTypeDef:
    return {
        "provider": ...,
    }


# ListEnvironmentsRequestPaginateTypeDef definition

class ListEnvironmentsRequestPaginateTypeDef(TypedDict):
    provider: NotRequired[ProviderTypeDef],  # (1)
    location: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See ProviderTypeDef
  2. See PaginatorConfigTypeDef

ListConnectionsResponseTypeDef#

# ListConnectionsResponseTypeDef TypedDict usage example

from mypy_boto3_interconnect.type_defs import ListConnectionsResponseTypeDef


def get_value() -> ListConnectionsResponseTypeDef:
    return {
        "connections": ...,
    }


# ListConnectionsResponseTypeDef definition

class ListConnectionsResponseTypeDef(TypedDict):
    connections: list[ConnectionSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See list[ConnectionSummaryTypeDef]
  2. See ResponseMetadataTypeDef

AcceptConnectionProposalResponseTypeDef#

# AcceptConnectionProposalResponseTypeDef TypedDict usage example

from mypy_boto3_interconnect.type_defs import AcceptConnectionProposalResponseTypeDef


def get_value() -> AcceptConnectionProposalResponseTypeDef:
    return {
        "connection": ...,
    }


# AcceptConnectionProposalResponseTypeDef definition

class AcceptConnectionProposalResponseTypeDef(TypedDict):
    connection: ConnectionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ConnectionTypeDef
  2. See ResponseMetadataTypeDef

CreateConnectionResponseTypeDef#

# CreateConnectionResponseTypeDef TypedDict usage example

from mypy_boto3_interconnect.type_defs import CreateConnectionResponseTypeDef


def get_value() -> CreateConnectionResponseTypeDef:
    return {
        "connection": ...,
    }


# CreateConnectionResponseTypeDef definition

class CreateConnectionResponseTypeDef(TypedDict):
    connection: ConnectionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ConnectionTypeDef
  2. See ResponseMetadataTypeDef

DeleteConnectionResponseTypeDef#

# DeleteConnectionResponseTypeDef TypedDict usage example

from mypy_boto3_interconnect.type_defs import DeleteConnectionResponseTypeDef


def get_value() -> DeleteConnectionResponseTypeDef:
    return {
        "connection": ...,
    }


# DeleteConnectionResponseTypeDef definition

class DeleteConnectionResponseTypeDef(TypedDict):
    connection: ConnectionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ConnectionTypeDef
  2. See ResponseMetadataTypeDef

GetConnectionResponseTypeDef#

# GetConnectionResponseTypeDef TypedDict usage example

from mypy_boto3_interconnect.type_defs import GetConnectionResponseTypeDef


def get_value() -> GetConnectionResponseTypeDef:
    return {
        "connection": ...,
    }


# GetConnectionResponseTypeDef definition

class GetConnectionResponseTypeDef(TypedDict):
    connection: ConnectionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ConnectionTypeDef
  2. See ResponseMetadataTypeDef

UpdateConnectionResponseTypeDef#

# UpdateConnectionResponseTypeDef TypedDict usage example

from mypy_boto3_interconnect.type_defs import UpdateConnectionResponseTypeDef


def get_value() -> UpdateConnectionResponseTypeDef:
    return {
        "connection": ...,
    }


# UpdateConnectionResponseTypeDef definition

class UpdateConnectionResponseTypeDef(TypedDict):
    connection: ConnectionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ConnectionTypeDef
  2. See ResponseMetadataTypeDef

GetEnvironmentResponseTypeDef#

# GetEnvironmentResponseTypeDef TypedDict usage example

from mypy_boto3_interconnect.type_defs import GetEnvironmentResponseTypeDef


def get_value() -> GetEnvironmentResponseTypeDef:
    return {
        "environment": ...,
    }


# GetEnvironmentResponseTypeDef definition

class GetEnvironmentResponseTypeDef(TypedDict):
    environment: EnvironmentTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See EnvironmentTypeDef
  2. See ResponseMetadataTypeDef

ListEnvironmentsResponseTypeDef#

# ListEnvironmentsResponseTypeDef TypedDict usage example

from mypy_boto3_interconnect.type_defs import ListEnvironmentsResponseTypeDef


def get_value() -> ListEnvironmentsResponseTypeDef:
    return {
        "environments": ...,
    }


# ListEnvironmentsResponseTypeDef definition

class ListEnvironmentsResponseTypeDef(TypedDict):
    environments: list[EnvironmentTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See list[EnvironmentTypeDef]
  2. See ResponseMetadataTypeDef