Skip to content

Type definitions#

Index > Private5G > Type definitions

Auto-generated documentation for Private5G type annotations stubs module mypy-boto3-privatenetworks.

SitePlanUnionTypeDef#

# SitePlanUnionTypeDef Union usage example

from mypy_boto3_privatenetworks.type_defs import SitePlanUnionTypeDef


def get_value() -> SitePlanUnionTypeDef:
    return ...


# SitePlanUnionTypeDef definition

SitePlanUnionTypeDef = Union[
    SitePlanTypeDef,  # (1)
    SitePlanOutputTypeDef,  # (2)
]
  1. See SitePlanTypeDef
  2. See SitePlanOutputTypeDef

AcknowledgeOrderReceiptRequestTypeDef#

# AcknowledgeOrderReceiptRequestTypeDef TypedDict usage example

from mypy_boto3_privatenetworks.type_defs import AcknowledgeOrderReceiptRequestTypeDef


def get_value() -> AcknowledgeOrderReceiptRequestTypeDef:
    return {
        "orderArn": ...,
    }


# AcknowledgeOrderReceiptRequestTypeDef definition

class AcknowledgeOrderReceiptRequestTypeDef(TypedDict):
    orderArn: str,

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef TypedDict usage example

from mypy_boto3_privatenetworks.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],

ActivateDeviceIdentifierRequestTypeDef#

# ActivateDeviceIdentifierRequestTypeDef TypedDict usage example

from mypy_boto3_privatenetworks.type_defs import ActivateDeviceIdentifierRequestTypeDef


def get_value() -> ActivateDeviceIdentifierRequestTypeDef:
    return {
        "deviceIdentifierArn": ...,
    }


# ActivateDeviceIdentifierRequestTypeDef definition

class ActivateDeviceIdentifierRequestTypeDef(TypedDict):
    deviceIdentifierArn: str,
    clientToken: NotRequired[str],

DeviceIdentifierTypeDef#

# DeviceIdentifierTypeDef TypedDict usage example

from mypy_boto3_privatenetworks.type_defs import DeviceIdentifierTypeDef


def get_value() -> DeviceIdentifierTypeDef:
    return {
        "createdAt": ...,
    }


# DeviceIdentifierTypeDef definition

class DeviceIdentifierTypeDef(TypedDict):
    createdAt: NotRequired[datetime.datetime],
    deviceIdentifierArn: NotRequired[str],
    iccid: NotRequired[str],
    imsi: NotRequired[str],
    networkArn: NotRequired[str],
    orderArn: NotRequired[str],
    status: NotRequired[DeviceIdentifierStatusType],  # (1)
    trafficGroupArn: NotRequired[str],
    vendor: NotRequired[str],
  1. See DeviceIdentifierStatusType

AddressTypeDef#

# AddressTypeDef TypedDict usage example

from mypy_boto3_privatenetworks.type_defs import AddressTypeDef


def get_value() -> AddressTypeDef:
    return {
        "city": ...,
    }


# AddressTypeDef definition

class AddressTypeDef(TypedDict):
    city: str,
    country: str,
    name: str,
    postalCode: str,
    stateOrProvince: str,
    street1: str,
    company: NotRequired[str],
    emailAddress: NotRequired[str],
    phoneNumber: NotRequired[str],
    street2: NotRequired[str],
    street3: NotRequired[str],

CommitmentConfigurationTypeDef#

# CommitmentConfigurationTypeDef TypedDict usage example

from mypy_boto3_privatenetworks.type_defs import CommitmentConfigurationTypeDef


def get_value() -> CommitmentConfigurationTypeDef:
    return {
        "automaticRenewal": ...,
    }


# CommitmentConfigurationTypeDef definition

class CommitmentConfigurationTypeDef(TypedDict):
    automaticRenewal: bool,
    commitmentLength: CommitmentLengthType,  # (1)
  1. See CommitmentLengthType

PositionTypeDef#

# PositionTypeDef TypedDict usage example

from mypy_boto3_privatenetworks.type_defs import PositionTypeDef


def get_value() -> PositionTypeDef:
    return {
        "elevation": ...,
    }


# PositionTypeDef definition

class PositionTypeDef(TypedDict):
    elevation: NotRequired[float],
    elevationReference: NotRequired[ElevationReferenceType],  # (1)
    elevationUnit: NotRequired[ElevationUnitType],  # (2)
    latitude: NotRequired[float],
    longitude: NotRequired[float],
  1. See ElevationReferenceType
  2. See ElevationUnitType

CreateNetworkRequestTypeDef#

# CreateNetworkRequestTypeDef TypedDict usage example

from mypy_boto3_privatenetworks.type_defs import CreateNetworkRequestTypeDef


def get_value() -> CreateNetworkRequestTypeDef:
    return {
        "networkName": ...,
    }


# CreateNetworkRequestTypeDef definition

class CreateNetworkRequestTypeDef(TypedDict):
    networkName: str,
    clientToken: NotRequired[str],
    description: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],

NetworkTypeDef#

# NetworkTypeDef TypedDict usage example

from mypy_boto3_privatenetworks.type_defs import NetworkTypeDef


def get_value() -> NetworkTypeDef:
    return {
        "createdAt": ...,
    }


# NetworkTypeDef definition

class NetworkTypeDef(TypedDict):
    networkArn: str,
    networkName: str,
    status: NetworkStatusType,  # (1)
    createdAt: NotRequired[datetime.datetime],
    description: NotRequired[str],
    statusReason: NotRequired[str],
  1. See NetworkStatusType

DeactivateDeviceIdentifierRequestTypeDef#

# DeactivateDeviceIdentifierRequestTypeDef TypedDict usage example

from mypy_boto3_privatenetworks.type_defs import DeactivateDeviceIdentifierRequestTypeDef


def get_value() -> DeactivateDeviceIdentifierRequestTypeDef:
    return {
        "deviceIdentifierArn": ...,
    }


# DeactivateDeviceIdentifierRequestTypeDef definition

class DeactivateDeviceIdentifierRequestTypeDef(TypedDict):
    deviceIdentifierArn: str,
    clientToken: NotRequired[str],

DeleteNetworkRequestTypeDef#

# DeleteNetworkRequestTypeDef TypedDict usage example

from mypy_boto3_privatenetworks.type_defs import DeleteNetworkRequestTypeDef


def get_value() -> DeleteNetworkRequestTypeDef:
    return {
        "networkArn": ...,
    }


# DeleteNetworkRequestTypeDef definition

class DeleteNetworkRequestTypeDef(TypedDict):
    networkArn: str,
    clientToken: NotRequired[str],

DeleteNetworkSiteRequestTypeDef#

# DeleteNetworkSiteRequestTypeDef TypedDict usage example

from mypy_boto3_privatenetworks.type_defs import DeleteNetworkSiteRequestTypeDef


def get_value() -> DeleteNetworkSiteRequestTypeDef:
    return {
        "networkSiteArn": ...,
    }


# DeleteNetworkSiteRequestTypeDef definition

class DeleteNetworkSiteRequestTypeDef(TypedDict):
    networkSiteArn: str,
    clientToken: NotRequired[str],

GetDeviceIdentifierRequestTypeDef#

# GetDeviceIdentifierRequestTypeDef TypedDict usage example

from mypy_boto3_privatenetworks.type_defs import GetDeviceIdentifierRequestTypeDef


def get_value() -> GetDeviceIdentifierRequestTypeDef:
    return {
        "deviceIdentifierArn": ...,
    }


# GetDeviceIdentifierRequestTypeDef definition

class GetDeviceIdentifierRequestTypeDef(TypedDict):
    deviceIdentifierArn: str,

GetNetworkRequestTypeDef#

# GetNetworkRequestTypeDef TypedDict usage example

from mypy_boto3_privatenetworks.type_defs import GetNetworkRequestTypeDef


def get_value() -> GetNetworkRequestTypeDef:
    return {
        "networkArn": ...,
    }


# GetNetworkRequestTypeDef definition

class GetNetworkRequestTypeDef(TypedDict):
    networkArn: str,

GetNetworkResourceRequestTypeDef#

# GetNetworkResourceRequestTypeDef TypedDict usage example

from mypy_boto3_privatenetworks.type_defs import GetNetworkResourceRequestTypeDef


def get_value() -> GetNetworkResourceRequestTypeDef:
    return {
        "networkResourceArn": ...,
    }


# GetNetworkResourceRequestTypeDef definition

class GetNetworkResourceRequestTypeDef(TypedDict):
    networkResourceArn: str,

GetNetworkSiteRequestTypeDef#

# GetNetworkSiteRequestTypeDef TypedDict usage example

from mypy_boto3_privatenetworks.type_defs import GetNetworkSiteRequestTypeDef


def get_value() -> GetNetworkSiteRequestTypeDef:
    return {
        "networkSiteArn": ...,
    }


# GetNetworkSiteRequestTypeDef definition

class GetNetworkSiteRequestTypeDef(TypedDict):
    networkSiteArn: str,

GetOrderRequestTypeDef#

# GetOrderRequestTypeDef TypedDict usage example

from mypy_boto3_privatenetworks.type_defs import GetOrderRequestTypeDef


def get_value() -> GetOrderRequestTypeDef:
    return {
        "orderArn": ...,
    }


# GetOrderRequestTypeDef definition

class GetOrderRequestTypeDef(TypedDict):
    orderArn: str,

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef TypedDict usage example

from mypy_boto3_privatenetworks.type_defs import PaginatorConfigTypeDef


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


# PaginatorConfigTypeDef definition

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

ListDeviceIdentifiersRequestTypeDef#

# ListDeviceIdentifiersRequestTypeDef TypedDict usage example

from mypy_boto3_privatenetworks.type_defs import ListDeviceIdentifiersRequestTypeDef


def get_value() -> ListDeviceIdentifiersRequestTypeDef:
    return {
        "networkArn": ...,
    }


# ListDeviceIdentifiersRequestTypeDef definition

class ListDeviceIdentifiersRequestTypeDef(TypedDict):
    networkArn: str,
    filters: NotRequired[Mapping[DeviceIdentifierFilterKeysType, Sequence[str]]],  # (1)
    maxResults: NotRequired[int],
    startToken: NotRequired[str],
  1. See Mapping[DeviceIdentifierFilterKeysType, Sequence[str]]

ListNetworkResourcesRequestTypeDef#

# ListNetworkResourcesRequestTypeDef TypedDict usage example

from mypy_boto3_privatenetworks.type_defs import ListNetworkResourcesRequestTypeDef


def get_value() -> ListNetworkResourcesRequestTypeDef:
    return {
        "networkArn": ...,
    }


# ListNetworkResourcesRequestTypeDef definition

class ListNetworkResourcesRequestTypeDef(TypedDict):
    networkArn: str,
    filters: NotRequired[Mapping[NetworkResourceFilterKeysType, Sequence[str]]],  # (1)
    maxResults: NotRequired[int],
    startToken: NotRequired[str],
  1. See Mapping[NetworkResourceFilterKeysType, Sequence[str]]

ListNetworkSitesRequestTypeDef#

# ListNetworkSitesRequestTypeDef TypedDict usage example

from mypy_boto3_privatenetworks.type_defs import ListNetworkSitesRequestTypeDef


def get_value() -> ListNetworkSitesRequestTypeDef:
    return {
        "networkArn": ...,
    }


# ListNetworkSitesRequestTypeDef definition

class ListNetworkSitesRequestTypeDef(TypedDict):
    networkArn: str,
    filters: NotRequired[Mapping[NetworkSiteFilterKeysType, Sequence[str]]],  # (1)
    maxResults: NotRequired[int],
    startToken: NotRequired[str],
  1. See Mapping[Literal['STATUS'], Sequence[str]]

ListNetworksRequestTypeDef#

# ListNetworksRequestTypeDef TypedDict usage example

from mypy_boto3_privatenetworks.type_defs import ListNetworksRequestTypeDef


def get_value() -> ListNetworksRequestTypeDef:
    return {
        "filters": ...,
    }


# ListNetworksRequestTypeDef definition

class ListNetworksRequestTypeDef(TypedDict):
    filters: NotRequired[Mapping[NetworkFilterKeysType, Sequence[str]]],  # (1)
    maxResults: NotRequired[int],
    startToken: NotRequired[str],
  1. See Mapping[Literal['STATUS'], Sequence[str]]

ListOrdersRequestTypeDef#

# ListOrdersRequestTypeDef TypedDict usage example

from mypy_boto3_privatenetworks.type_defs import ListOrdersRequestTypeDef


def get_value() -> ListOrdersRequestTypeDef:
    return {
        "networkArn": ...,
    }


# ListOrdersRequestTypeDef definition

class ListOrdersRequestTypeDef(TypedDict):
    networkArn: str,
    filters: NotRequired[Mapping[OrderFilterKeysType, Sequence[str]]],  # (1)
    maxResults: NotRequired[int],
    startToken: NotRequired[str],
  1. See Mapping[OrderFilterKeysType, Sequence[str]]

ListTagsForResourceRequestTypeDef#

# ListTagsForResourceRequestTypeDef TypedDict usage example

from mypy_boto3_privatenetworks.type_defs import ListTagsForResourceRequestTypeDef


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


# ListTagsForResourceRequestTypeDef definition

class ListTagsForResourceRequestTypeDef(TypedDict):
    resourceArn: str,

NameValuePairTypeDef#

# NameValuePairTypeDef TypedDict usage example

from mypy_boto3_privatenetworks.type_defs import NameValuePairTypeDef


def get_value() -> NameValuePairTypeDef:
    return {
        "name": ...,
    }


# NameValuePairTypeDef definition

class NameValuePairTypeDef(TypedDict):
    name: str,
    value: NotRequired[str],

TrackingInformationTypeDef#

# TrackingInformationTypeDef TypedDict usage example

from mypy_boto3_privatenetworks.type_defs import TrackingInformationTypeDef


def get_value() -> TrackingInformationTypeDef:
    return {
        "trackingNumber": ...,
    }


# TrackingInformationTypeDef definition

class TrackingInformationTypeDef(TypedDict):
    trackingNumber: NotRequired[str],

TagResourceRequestTypeDef#

# TagResourceRequestTypeDef TypedDict usage example

from mypy_boto3_privatenetworks.type_defs import TagResourceRequestTypeDef


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


# TagResourceRequestTypeDef definition

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

UntagResourceRequestTypeDef#

# UntagResourceRequestTypeDef TypedDict usage example

from mypy_boto3_privatenetworks.type_defs import UntagResourceRequestTypeDef


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


# UntagResourceRequestTypeDef definition

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

UpdateNetworkSiteRequestTypeDef#

# UpdateNetworkSiteRequestTypeDef TypedDict usage example

from mypy_boto3_privatenetworks.type_defs import UpdateNetworkSiteRequestTypeDef


def get_value() -> UpdateNetworkSiteRequestTypeDef:
    return {
        "networkSiteArn": ...,
    }


# UpdateNetworkSiteRequestTypeDef definition

class UpdateNetworkSiteRequestTypeDef(TypedDict):
    networkSiteArn: str,
    clientToken: NotRequired[str],
    description: NotRequired[str],

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef TypedDict usage example

from mypy_boto3_privatenetworks.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

PingResponseTypeDef#

# PingResponseTypeDef TypedDict usage example

from mypy_boto3_privatenetworks.type_defs import PingResponseTypeDef


def get_value() -> PingResponseTypeDef:
    return {
        "status": ...,
    }


# PingResponseTypeDef definition

class PingResponseTypeDef(TypedDict):
    status: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ActivateDeviceIdentifierResponseTypeDef#

# ActivateDeviceIdentifierResponseTypeDef TypedDict usage example

from mypy_boto3_privatenetworks.type_defs import ActivateDeviceIdentifierResponseTypeDef


def get_value() -> ActivateDeviceIdentifierResponseTypeDef:
    return {
        "deviceIdentifier": ...,
    }


# ActivateDeviceIdentifierResponseTypeDef definition

class ActivateDeviceIdentifierResponseTypeDef(TypedDict):
    deviceIdentifier: DeviceIdentifierTypeDef,  # (1)
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DeviceIdentifierTypeDef
  2. See ResponseMetadataTypeDef

DeactivateDeviceIdentifierResponseTypeDef#

# DeactivateDeviceIdentifierResponseTypeDef TypedDict usage example

from mypy_boto3_privatenetworks.type_defs import DeactivateDeviceIdentifierResponseTypeDef


def get_value() -> DeactivateDeviceIdentifierResponseTypeDef:
    return {
        "deviceIdentifier": ...,
    }


# DeactivateDeviceIdentifierResponseTypeDef definition

class DeactivateDeviceIdentifierResponseTypeDef(TypedDict):
    deviceIdentifier: DeviceIdentifierTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DeviceIdentifierTypeDef
  2. See ResponseMetadataTypeDef

GetDeviceIdentifierResponseTypeDef#

# GetDeviceIdentifierResponseTypeDef TypedDict usage example

from mypy_boto3_privatenetworks.type_defs import GetDeviceIdentifierResponseTypeDef


def get_value() -> GetDeviceIdentifierResponseTypeDef:
    return {
        "deviceIdentifier": ...,
    }


# GetDeviceIdentifierResponseTypeDef definition

class GetDeviceIdentifierResponseTypeDef(TypedDict):
    deviceIdentifier: DeviceIdentifierTypeDef,  # (1)
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DeviceIdentifierTypeDef
  2. See ResponseMetadataTypeDef

ListDeviceIdentifiersResponseTypeDef#

# ListDeviceIdentifiersResponseTypeDef TypedDict usage example

from mypy_boto3_privatenetworks.type_defs import ListDeviceIdentifiersResponseTypeDef


def get_value() -> ListDeviceIdentifiersResponseTypeDef:
    return {
        "deviceIdentifiers": ...,
    }


# ListDeviceIdentifiersResponseTypeDef definition

class ListDeviceIdentifiersResponseTypeDef(TypedDict):
    deviceIdentifiers: List[DeviceIdentifierTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See List[DeviceIdentifierTypeDef]
  2. See ResponseMetadataTypeDef

ReturnInformationTypeDef#

# ReturnInformationTypeDef TypedDict usage example

from mypy_boto3_privatenetworks.type_defs import ReturnInformationTypeDef


def get_value() -> ReturnInformationTypeDef:
    return {
        "replacementOrderArn": ...,
    }


# ReturnInformationTypeDef definition

class ReturnInformationTypeDef(TypedDict):
    replacementOrderArn: NotRequired[str],
    returnReason: NotRequired[str],
    shippingAddress: NotRequired[AddressTypeDef],  # (1)
    shippingLabel: NotRequired[str],
  1. See AddressTypeDef

ActivateNetworkSiteRequestTypeDef#

# ActivateNetworkSiteRequestTypeDef TypedDict usage example

from mypy_boto3_privatenetworks.type_defs import ActivateNetworkSiteRequestTypeDef


def get_value() -> ActivateNetworkSiteRequestTypeDef:
    return {
        "networkSiteArn": ...,
    }


# ActivateNetworkSiteRequestTypeDef definition

class ActivateNetworkSiteRequestTypeDef(TypedDict):
    networkSiteArn: str,
    shippingAddress: AddressTypeDef,  # (1)
    clientToken: NotRequired[str],
    commitmentConfiguration: NotRequired[CommitmentConfigurationTypeDef],  # (2)
  1. See AddressTypeDef
  2. See CommitmentConfigurationTypeDef

CommitmentInformationTypeDef#

# CommitmentInformationTypeDef TypedDict usage example

from mypy_boto3_privatenetworks.type_defs import CommitmentInformationTypeDef


def get_value() -> CommitmentInformationTypeDef:
    return {
        "commitmentConfiguration": ...,
    }


# CommitmentInformationTypeDef definition

class CommitmentInformationTypeDef(TypedDict):
    commitmentConfiguration: CommitmentConfigurationTypeDef,  # (1)
    expiresOn: NotRequired[datetime.datetime],
    startAt: NotRequired[datetime.datetime],
  1. See CommitmentConfigurationTypeDef

OrderedResourceDefinitionTypeDef#

# OrderedResourceDefinitionTypeDef TypedDict usage example

from mypy_boto3_privatenetworks.type_defs import OrderedResourceDefinitionTypeDef


def get_value() -> OrderedResourceDefinitionTypeDef:
    return {
        "commitmentConfiguration": ...,
    }


# OrderedResourceDefinitionTypeDef definition

class OrderedResourceDefinitionTypeDef(TypedDict):
    count: int,
    type: NetworkResourceDefinitionTypeType,  # (2)
    commitmentConfiguration: NotRequired[CommitmentConfigurationTypeDef],  # (1)
  1. See CommitmentConfigurationTypeDef
  2. See NetworkResourceDefinitionTypeType

StartNetworkResourceUpdateRequestTypeDef#

# StartNetworkResourceUpdateRequestTypeDef TypedDict usage example

from mypy_boto3_privatenetworks.type_defs import StartNetworkResourceUpdateRequestTypeDef


def get_value() -> StartNetworkResourceUpdateRequestTypeDef:
    return {
        "networkResourceArn": ...,
    }


# StartNetworkResourceUpdateRequestTypeDef definition

class StartNetworkResourceUpdateRequestTypeDef(TypedDict):
    networkResourceArn: str,
    updateType: UpdateTypeType,  # (1)
    commitmentConfiguration: NotRequired[CommitmentConfigurationTypeDef],  # (2)
    returnReason: NotRequired[str],
    shippingAddress: NotRequired[AddressTypeDef],  # (3)
  1. See UpdateTypeType
  2. See CommitmentConfigurationTypeDef
  3. See AddressTypeDef

ConfigureAccessPointRequestTypeDef#

# ConfigureAccessPointRequestTypeDef TypedDict usage example

from mypy_boto3_privatenetworks.type_defs import ConfigureAccessPointRequestTypeDef


def get_value() -> ConfigureAccessPointRequestTypeDef:
    return {
        "accessPointArn": ...,
    }


# ConfigureAccessPointRequestTypeDef definition

class ConfigureAccessPointRequestTypeDef(TypedDict):
    accessPointArn: str,
    cpiSecretKey: NotRequired[str],
    cpiUserId: NotRequired[str],
    cpiUserPassword: NotRequired[str],
    cpiUsername: NotRequired[str],
    position: NotRequired[PositionTypeDef],  # (1)
  1. See PositionTypeDef

CreateNetworkResponseTypeDef#

# CreateNetworkResponseTypeDef TypedDict usage example

from mypy_boto3_privatenetworks.type_defs import CreateNetworkResponseTypeDef


def get_value() -> CreateNetworkResponseTypeDef:
    return {
        "network": ...,
    }


# CreateNetworkResponseTypeDef definition

class CreateNetworkResponseTypeDef(TypedDict):
    network: NetworkTypeDef,  # (1)
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See NetworkTypeDef
  2. See ResponseMetadataTypeDef

DeleteNetworkResponseTypeDef#

# DeleteNetworkResponseTypeDef TypedDict usage example

from mypy_boto3_privatenetworks.type_defs import DeleteNetworkResponseTypeDef


def get_value() -> DeleteNetworkResponseTypeDef:
    return {
        "network": ...,
    }


# DeleteNetworkResponseTypeDef definition

class DeleteNetworkResponseTypeDef(TypedDict):
    network: NetworkTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See NetworkTypeDef
  2. See ResponseMetadataTypeDef

GetNetworkResponseTypeDef#

# GetNetworkResponseTypeDef TypedDict usage example

from mypy_boto3_privatenetworks.type_defs import GetNetworkResponseTypeDef


def get_value() -> GetNetworkResponseTypeDef:
    return {
        "network": ...,
    }


# GetNetworkResponseTypeDef definition

class GetNetworkResponseTypeDef(TypedDict):
    network: NetworkTypeDef,  # (1)
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See NetworkTypeDef
  2. See ResponseMetadataTypeDef

ListNetworksResponseTypeDef#

# ListNetworksResponseTypeDef TypedDict usage example

from mypy_boto3_privatenetworks.type_defs import ListNetworksResponseTypeDef


def get_value() -> ListNetworksResponseTypeDef:
    return {
        "networks": ...,
    }


# ListNetworksResponseTypeDef definition

class ListNetworksResponseTypeDef(TypedDict):
    networks: List[NetworkTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See List[NetworkTypeDef]
  2. See ResponseMetadataTypeDef

ListDeviceIdentifiersRequestPaginateTypeDef#

# ListDeviceIdentifiersRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_privatenetworks.type_defs import ListDeviceIdentifiersRequestPaginateTypeDef


def get_value() -> ListDeviceIdentifiersRequestPaginateTypeDef:
    return {
        "networkArn": ...,
    }


# ListDeviceIdentifiersRequestPaginateTypeDef definition

class ListDeviceIdentifiersRequestPaginateTypeDef(TypedDict):
    networkArn: str,
    filters: NotRequired[Mapping[DeviceIdentifierFilterKeysType, Sequence[str]]],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See Mapping[DeviceIdentifierFilterKeysType, Sequence[str]]
  2. See PaginatorConfigTypeDef

ListNetworkResourcesRequestPaginateTypeDef#

# ListNetworkResourcesRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_privatenetworks.type_defs import ListNetworkResourcesRequestPaginateTypeDef


def get_value() -> ListNetworkResourcesRequestPaginateTypeDef:
    return {
        "networkArn": ...,
    }


# ListNetworkResourcesRequestPaginateTypeDef definition

class ListNetworkResourcesRequestPaginateTypeDef(TypedDict):
    networkArn: str,
    filters: NotRequired[Mapping[NetworkResourceFilterKeysType, Sequence[str]]],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See Mapping[NetworkResourceFilterKeysType, Sequence[str]]
  2. See PaginatorConfigTypeDef

ListNetworkSitesRequestPaginateTypeDef#

# ListNetworkSitesRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_privatenetworks.type_defs import ListNetworkSitesRequestPaginateTypeDef


def get_value() -> ListNetworkSitesRequestPaginateTypeDef:
    return {
        "networkArn": ...,
    }


# ListNetworkSitesRequestPaginateTypeDef definition

class ListNetworkSitesRequestPaginateTypeDef(TypedDict):
    networkArn: str,
    filters: NotRequired[Mapping[NetworkSiteFilterKeysType, Sequence[str]]],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See Mapping[Literal['STATUS'], Sequence[str]]
  2. See PaginatorConfigTypeDef

ListNetworksRequestPaginateTypeDef#

# ListNetworksRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_privatenetworks.type_defs import ListNetworksRequestPaginateTypeDef


def get_value() -> ListNetworksRequestPaginateTypeDef:
    return {
        "filters": ...,
    }


# ListNetworksRequestPaginateTypeDef definition

class ListNetworksRequestPaginateTypeDef(TypedDict):
    filters: NotRequired[Mapping[NetworkFilterKeysType, Sequence[str]]],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See Mapping[Literal['STATUS'], Sequence[str]]
  2. See PaginatorConfigTypeDef

ListOrdersRequestPaginateTypeDef#

# ListOrdersRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_privatenetworks.type_defs import ListOrdersRequestPaginateTypeDef


def get_value() -> ListOrdersRequestPaginateTypeDef:
    return {
        "networkArn": ...,
    }


# ListOrdersRequestPaginateTypeDef definition

class ListOrdersRequestPaginateTypeDef(TypedDict):
    networkArn: str,
    filters: NotRequired[Mapping[OrderFilterKeysType, Sequence[str]]],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See Mapping[OrderFilterKeysType, Sequence[str]]
  2. See PaginatorConfigTypeDef

NetworkResourceDefinitionOutputTypeDef#

# NetworkResourceDefinitionOutputTypeDef TypedDict usage example

from mypy_boto3_privatenetworks.type_defs import NetworkResourceDefinitionOutputTypeDef


def get_value() -> NetworkResourceDefinitionOutputTypeDef:
    return {
        "count": ...,
    }


# NetworkResourceDefinitionOutputTypeDef definition

class NetworkResourceDefinitionOutputTypeDef(TypedDict):
    count: int,
    type: NetworkResourceDefinitionTypeType,  # (2)
    options: NotRequired[List[NameValuePairTypeDef]],  # (1)
  1. See List[NameValuePairTypeDef]
  2. See NetworkResourceDefinitionTypeType

NetworkResourceDefinitionTypeDef#

# NetworkResourceDefinitionTypeDef TypedDict usage example

from mypy_boto3_privatenetworks.type_defs import NetworkResourceDefinitionTypeDef


def get_value() -> NetworkResourceDefinitionTypeDef:
    return {
        "count": ...,
    }


# NetworkResourceDefinitionTypeDef definition

class NetworkResourceDefinitionTypeDef(TypedDict):
    count: int,
    type: NetworkResourceDefinitionTypeType,  # (2)
    options: NotRequired[Sequence[NameValuePairTypeDef]],  # (1)
  1. See Sequence[NameValuePairTypeDef]
  2. See NetworkResourceDefinitionTypeType

NetworkResourceTypeDef#

# NetworkResourceTypeDef TypedDict usage example

from mypy_boto3_privatenetworks.type_defs import NetworkResourceTypeDef


def get_value() -> NetworkResourceTypeDef:
    return {
        "attributes": ...,
    }


# NetworkResourceTypeDef definition

class NetworkResourceTypeDef(TypedDict):
    attributes: NotRequired[List[NameValuePairTypeDef]],  # (1)
    commitmentInformation: NotRequired[CommitmentInformationTypeDef],  # (2)
    createdAt: NotRequired[datetime.datetime],
    description: NotRequired[str],
    health: NotRequired[HealthStatusType],  # (3)
    model: NotRequired[str],
    networkArn: NotRequired[str],
    networkResourceArn: NotRequired[str],
    networkSiteArn: NotRequired[str],
    orderArn: NotRequired[str],
    position: NotRequired[PositionTypeDef],  # (4)
    returnInformation: NotRequired[ReturnInformationTypeDef],  # (5)
    serialNumber: NotRequired[str],
    status: NotRequired[NetworkResourceStatusType],  # (6)
    statusReason: NotRequired[str],
    type: NotRequired[NetworkResourceTypeType],  # (7)
    vendor: NotRequired[str],
  1. See List[NameValuePairTypeDef]
  2. See CommitmentInformationTypeDef
  3. See HealthStatusType
  4. See PositionTypeDef
  5. See ReturnInformationTypeDef
  6. See NetworkResourceStatusType
  7. See NetworkResourceTypeType

OrderTypeDef#

# OrderTypeDef TypedDict usage example

from mypy_boto3_privatenetworks.type_defs import OrderTypeDef


def get_value() -> OrderTypeDef:
    return {
        "acknowledgmentStatus": ...,
    }


# OrderTypeDef definition

class OrderTypeDef(TypedDict):
    acknowledgmentStatus: NotRequired[AcknowledgmentStatusType],  # (1)
    createdAt: NotRequired[datetime.datetime],
    networkArn: NotRequired[str],
    networkSiteArn: NotRequired[str],
    orderArn: NotRequired[str],
    orderedResources: NotRequired[List[OrderedResourceDefinitionTypeDef]],  # (2)
    shippingAddress: NotRequired[AddressTypeDef],  # (3)
    trackingInformation: NotRequired[List[TrackingInformationTypeDef]],  # (4)
  1. See AcknowledgmentStatusType
  2. See List[OrderedResourceDefinitionTypeDef]
  3. See AddressTypeDef
  4. See List[TrackingInformationTypeDef]

SitePlanOutputTypeDef#

# SitePlanOutputTypeDef TypedDict usage example

from mypy_boto3_privatenetworks.type_defs import SitePlanOutputTypeDef


def get_value() -> SitePlanOutputTypeDef:
    return {
        "options": ...,
    }


# SitePlanOutputTypeDef definition

class SitePlanOutputTypeDef(TypedDict):
    options: NotRequired[List[NameValuePairTypeDef]],  # (1)
    resourceDefinitions: NotRequired[List[NetworkResourceDefinitionOutputTypeDef]],  # (2)
  1. See List[NameValuePairTypeDef]
  2. See List[NetworkResourceDefinitionOutputTypeDef]

SitePlanTypeDef#

# SitePlanTypeDef TypedDict usage example

from mypy_boto3_privatenetworks.type_defs import SitePlanTypeDef


def get_value() -> SitePlanTypeDef:
    return {
        "options": ...,
    }


# SitePlanTypeDef definition

class SitePlanTypeDef(TypedDict):
    options: NotRequired[Sequence[NameValuePairTypeDef]],  # (1)
    resourceDefinitions: NotRequired[Sequence[NetworkResourceDefinitionTypeDef]],  # (2)
  1. See Sequence[NameValuePairTypeDef]
  2. See Sequence[NetworkResourceDefinitionTypeDef]

ConfigureAccessPointResponseTypeDef#

# ConfigureAccessPointResponseTypeDef TypedDict usage example

from mypy_boto3_privatenetworks.type_defs import ConfigureAccessPointResponseTypeDef


def get_value() -> ConfigureAccessPointResponseTypeDef:
    return {
        "accessPoint": ...,
    }


# ConfigureAccessPointResponseTypeDef definition

class ConfigureAccessPointResponseTypeDef(TypedDict):
    accessPoint: NetworkResourceTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See NetworkResourceTypeDef
  2. See ResponseMetadataTypeDef

GetNetworkResourceResponseTypeDef#

# GetNetworkResourceResponseTypeDef TypedDict usage example

from mypy_boto3_privatenetworks.type_defs import GetNetworkResourceResponseTypeDef


def get_value() -> GetNetworkResourceResponseTypeDef:
    return {
        "networkResource": ...,
    }


# GetNetworkResourceResponseTypeDef definition

class GetNetworkResourceResponseTypeDef(TypedDict):
    networkResource: NetworkResourceTypeDef,  # (1)
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See NetworkResourceTypeDef
  2. See ResponseMetadataTypeDef

ListNetworkResourcesResponseTypeDef#

# ListNetworkResourcesResponseTypeDef TypedDict usage example

from mypy_boto3_privatenetworks.type_defs import ListNetworkResourcesResponseTypeDef


def get_value() -> ListNetworkResourcesResponseTypeDef:
    return {
        "networkResources": ...,
    }


# ListNetworkResourcesResponseTypeDef definition

class ListNetworkResourcesResponseTypeDef(TypedDict):
    networkResources: List[NetworkResourceTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See List[NetworkResourceTypeDef]
  2. See ResponseMetadataTypeDef

StartNetworkResourceUpdateResponseTypeDef#

# StartNetworkResourceUpdateResponseTypeDef TypedDict usage example

from mypy_boto3_privatenetworks.type_defs import StartNetworkResourceUpdateResponseTypeDef


def get_value() -> StartNetworkResourceUpdateResponseTypeDef:
    return {
        "networkResource": ...,
    }


# StartNetworkResourceUpdateResponseTypeDef definition

class StartNetworkResourceUpdateResponseTypeDef(TypedDict):
    networkResource: NetworkResourceTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See NetworkResourceTypeDef
  2. See ResponseMetadataTypeDef

AcknowledgeOrderReceiptResponseTypeDef#

# AcknowledgeOrderReceiptResponseTypeDef TypedDict usage example

from mypy_boto3_privatenetworks.type_defs import AcknowledgeOrderReceiptResponseTypeDef


def get_value() -> AcknowledgeOrderReceiptResponseTypeDef:
    return {
        "order": ...,
    }


# AcknowledgeOrderReceiptResponseTypeDef definition

class AcknowledgeOrderReceiptResponseTypeDef(TypedDict):
    order: OrderTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See OrderTypeDef
  2. See ResponseMetadataTypeDef

GetOrderResponseTypeDef#

# GetOrderResponseTypeDef TypedDict usage example

from mypy_boto3_privatenetworks.type_defs import GetOrderResponseTypeDef


def get_value() -> GetOrderResponseTypeDef:
    return {
        "order": ...,
    }


# GetOrderResponseTypeDef definition

class GetOrderResponseTypeDef(TypedDict):
    order: OrderTypeDef,  # (1)
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See OrderTypeDef
  2. See ResponseMetadataTypeDef

ListOrdersResponseTypeDef#

# ListOrdersResponseTypeDef TypedDict usage example

from mypy_boto3_privatenetworks.type_defs import ListOrdersResponseTypeDef


def get_value() -> ListOrdersResponseTypeDef:
    return {
        "nextToken": ...,
    }


# ListOrdersResponseTypeDef definition

class ListOrdersResponseTypeDef(TypedDict):
    orders: List[OrderTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See List[OrderTypeDef]
  2. See ResponseMetadataTypeDef

NetworkSiteTypeDef#

# NetworkSiteTypeDef TypedDict usage example

from mypy_boto3_privatenetworks.type_defs import NetworkSiteTypeDef


def get_value() -> NetworkSiteTypeDef:
    return {
        "availabilityZone": ...,
    }


# NetworkSiteTypeDef definition

class NetworkSiteTypeDef(TypedDict):
    networkArn: str,
    networkSiteArn: str,
    networkSiteName: str,
    status: NetworkSiteStatusType,  # (3)
    availabilityZone: NotRequired[str],
    availabilityZoneId: NotRequired[str],
    createdAt: NotRequired[datetime.datetime],
    currentPlan: NotRequired[SitePlanOutputTypeDef],  # (1)
    description: NotRequired[str],
    pendingPlan: NotRequired[SitePlanOutputTypeDef],  # (1)
    statusReason: NotRequired[str],
  1. See SitePlanOutputTypeDef
  2. See SitePlanOutputTypeDef
  3. See NetworkSiteStatusType

ActivateNetworkSiteResponseTypeDef#

# ActivateNetworkSiteResponseTypeDef TypedDict usage example

from mypy_boto3_privatenetworks.type_defs import ActivateNetworkSiteResponseTypeDef


def get_value() -> ActivateNetworkSiteResponseTypeDef:
    return {
        "networkSite": ...,
    }


# ActivateNetworkSiteResponseTypeDef definition

class ActivateNetworkSiteResponseTypeDef(TypedDict):
    networkSite: NetworkSiteTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See NetworkSiteTypeDef
  2. See ResponseMetadataTypeDef

CreateNetworkSiteResponseTypeDef#

# CreateNetworkSiteResponseTypeDef TypedDict usage example

from mypy_boto3_privatenetworks.type_defs import CreateNetworkSiteResponseTypeDef


def get_value() -> CreateNetworkSiteResponseTypeDef:
    return {
        "networkSite": ...,
    }


# CreateNetworkSiteResponseTypeDef definition

class CreateNetworkSiteResponseTypeDef(TypedDict):
    networkSite: NetworkSiteTypeDef,  # (1)
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See NetworkSiteTypeDef
  2. See ResponseMetadataTypeDef

DeleteNetworkSiteResponseTypeDef#

# DeleteNetworkSiteResponseTypeDef TypedDict usage example

from mypy_boto3_privatenetworks.type_defs import DeleteNetworkSiteResponseTypeDef


def get_value() -> DeleteNetworkSiteResponseTypeDef:
    return {
        "networkSite": ...,
    }


# DeleteNetworkSiteResponseTypeDef definition

class DeleteNetworkSiteResponseTypeDef(TypedDict):
    networkSite: NetworkSiteTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See NetworkSiteTypeDef
  2. See ResponseMetadataTypeDef

GetNetworkSiteResponseTypeDef#

# GetNetworkSiteResponseTypeDef TypedDict usage example

from mypy_boto3_privatenetworks.type_defs import GetNetworkSiteResponseTypeDef


def get_value() -> GetNetworkSiteResponseTypeDef:
    return {
        "networkSite": ...,
    }


# GetNetworkSiteResponseTypeDef definition

class GetNetworkSiteResponseTypeDef(TypedDict):
    networkSite: NetworkSiteTypeDef,  # (1)
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See NetworkSiteTypeDef
  2. See ResponseMetadataTypeDef

ListNetworkSitesResponseTypeDef#

# ListNetworkSitesResponseTypeDef TypedDict usage example

from mypy_boto3_privatenetworks.type_defs import ListNetworkSitesResponseTypeDef


def get_value() -> ListNetworkSitesResponseTypeDef:
    return {
        "networkSites": ...,
    }


# ListNetworkSitesResponseTypeDef definition

class ListNetworkSitesResponseTypeDef(TypedDict):
    networkSites: List[NetworkSiteTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See List[NetworkSiteTypeDef]
  2. See ResponseMetadataTypeDef

UpdateNetworkSiteResponseTypeDef#

# UpdateNetworkSiteResponseTypeDef TypedDict usage example

from mypy_boto3_privatenetworks.type_defs import UpdateNetworkSiteResponseTypeDef


def get_value() -> UpdateNetworkSiteResponseTypeDef:
    return {
        "networkSite": ...,
    }


# UpdateNetworkSiteResponseTypeDef definition

class UpdateNetworkSiteResponseTypeDef(TypedDict):
    networkSite: NetworkSiteTypeDef,  # (1)
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See NetworkSiteTypeDef
  2. See ResponseMetadataTypeDef

CreateNetworkSiteRequestTypeDef#

# CreateNetworkSiteRequestTypeDef TypedDict usage example

from mypy_boto3_privatenetworks.type_defs import CreateNetworkSiteRequestTypeDef


def get_value() -> CreateNetworkSiteRequestTypeDef:
    return {
        "networkArn": ...,
    }


# CreateNetworkSiteRequestTypeDef definition

class CreateNetworkSiteRequestTypeDef(TypedDict):
    networkArn: str,
    networkSiteName: str,
    availabilityZone: NotRequired[str],
    availabilityZoneId: NotRequired[str],
    clientToken: NotRequired[str],
    description: NotRequired[str],
    pendingPlan: NotRequired[SitePlanUnionTypeDef],  # (1)
    tags: NotRequired[Mapping[str, str]],
  1. See SitePlanUnionTypeDef

UpdateNetworkSitePlanRequestTypeDef#

# UpdateNetworkSitePlanRequestTypeDef TypedDict usage example

from mypy_boto3_privatenetworks.type_defs import UpdateNetworkSitePlanRequestTypeDef


def get_value() -> UpdateNetworkSitePlanRequestTypeDef:
    return {
        "networkSiteArn": ...,
    }


# UpdateNetworkSitePlanRequestTypeDef definition

class UpdateNetworkSitePlanRequestTypeDef(TypedDict):
    networkSiteArn: str,
    pendingPlan: SitePlanUnionTypeDef,  # (1)
    clientToken: NotRequired[str],
  1. See SitePlanUnionTypeDef