Skip to content

Type definitions#

Index > Private5G > Type definitions

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

SitePlanUnionTypeDef#

# SitePlanUnionTypeDef definition

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

AcknowledgeOrderReceiptRequestRequestTypeDef#

# AcknowledgeOrderReceiptRequestRequestTypeDef definition

class AcknowledgeOrderReceiptRequestRequestTypeDef(TypedDict):
    orderArn: str,

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

ActivateDeviceIdentifierRequestRequestTypeDef#

# ActivateDeviceIdentifierRequestRequestTypeDef definition

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

DeviceIdentifierTypeDef#

# DeviceIdentifierTypeDef definition

class DeviceIdentifierTypeDef(TypedDict):
    createdAt: NotRequired[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 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 definition

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

PositionTypeDef#

# 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

CreateNetworkRequestRequestTypeDef#

# CreateNetworkRequestRequestTypeDef definition

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

NetworkTypeDef#

# NetworkTypeDef definition

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

DeactivateDeviceIdentifierRequestRequestTypeDef#

# DeactivateDeviceIdentifierRequestRequestTypeDef definition

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

DeleteNetworkRequestRequestTypeDef#

# DeleteNetworkRequestRequestTypeDef definition

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

DeleteNetworkSiteRequestRequestTypeDef#

# DeleteNetworkSiteRequestRequestTypeDef definition

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

GetDeviceIdentifierRequestRequestTypeDef#

# GetDeviceIdentifierRequestRequestTypeDef definition

class GetDeviceIdentifierRequestRequestTypeDef(TypedDict):
    deviceIdentifierArn: str,

GetNetworkRequestRequestTypeDef#

# GetNetworkRequestRequestTypeDef definition

class GetNetworkRequestRequestTypeDef(TypedDict):
    networkArn: str,

GetNetworkResourceRequestRequestTypeDef#

# GetNetworkResourceRequestRequestTypeDef definition

class GetNetworkResourceRequestRequestTypeDef(TypedDict):
    networkResourceArn: str,

GetNetworkSiteRequestRequestTypeDef#

# GetNetworkSiteRequestRequestTypeDef definition

class GetNetworkSiteRequestRequestTypeDef(TypedDict):
    networkSiteArn: str,

GetOrderRequestRequestTypeDef#

# GetOrderRequestRequestTypeDef definition

class GetOrderRequestRequestTypeDef(TypedDict):
    orderArn: str,

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

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

ListDeviceIdentifiersRequestRequestTypeDef#

# ListDeviceIdentifiersRequestRequestTypeDef definition

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

ListNetworkResourcesRequestRequestTypeDef#

# ListNetworkResourcesRequestRequestTypeDef definition

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

ListNetworkSitesRequestRequestTypeDef#

# ListNetworkSitesRequestRequestTypeDef definition

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

ListNetworksRequestRequestTypeDef#

# ListNetworksRequestRequestTypeDef definition

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

ListOrdersRequestRequestTypeDef#

# ListOrdersRequestRequestTypeDef definition

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

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,

NameValuePairTypeDef#

# NameValuePairTypeDef definition

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

TrackingInformationTypeDef#

# TrackingInformationTypeDef definition

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

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

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

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

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

UpdateNetworkSiteRequestRequestTypeDef#

# UpdateNetworkSiteRequestRequestTypeDef definition

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

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

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

PingResponseTypeDef#

# PingResponseTypeDef definition

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

ActivateDeviceIdentifierResponseTypeDef#

# ActivateDeviceIdentifierResponseTypeDef definition

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

DeactivateDeviceIdentifierResponseTypeDef#

# DeactivateDeviceIdentifierResponseTypeDef definition

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

GetDeviceIdentifierResponseTypeDef#

# GetDeviceIdentifierResponseTypeDef definition

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

ListDeviceIdentifiersResponseTypeDef#

# ListDeviceIdentifiersResponseTypeDef definition

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

ReturnInformationTypeDef#

# ReturnInformationTypeDef definition

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

ActivateNetworkSiteRequestRequestTypeDef#

# ActivateNetworkSiteRequestRequestTypeDef definition

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

CommitmentInformationTypeDef#

# CommitmentInformationTypeDef definition

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

OrderedResourceDefinitionTypeDef#

# OrderedResourceDefinitionTypeDef definition

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

StartNetworkResourceUpdateRequestRequestTypeDef#

# StartNetworkResourceUpdateRequestRequestTypeDef definition

class StartNetworkResourceUpdateRequestRequestTypeDef(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

ConfigureAccessPointRequestRequestTypeDef#

# ConfigureAccessPointRequestRequestTypeDef definition

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

CreateNetworkResponseTypeDef#

# CreateNetworkResponseTypeDef definition

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

DeleteNetworkResponseTypeDef#

# DeleteNetworkResponseTypeDef definition

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

GetNetworkResponseTypeDef#

# GetNetworkResponseTypeDef definition

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

ListNetworksResponseTypeDef#

# ListNetworksResponseTypeDef definition

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

ListDeviceIdentifiersRequestListDeviceIdentifiersPaginateTypeDef#

# ListDeviceIdentifiersRequestListDeviceIdentifiersPaginateTypeDef definition

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

ListNetworkResourcesRequestListNetworkResourcesPaginateTypeDef#

# ListNetworkResourcesRequestListNetworkResourcesPaginateTypeDef definition

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

ListNetworkSitesRequestListNetworkSitesPaginateTypeDef#

# ListNetworkSitesRequestListNetworkSitesPaginateTypeDef definition

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

ListNetworksRequestListNetworksPaginateTypeDef#

# ListNetworksRequestListNetworksPaginateTypeDef definition

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

ListOrdersRequestListOrdersPaginateTypeDef#

# ListOrdersRequestListOrdersPaginateTypeDef definition

class ListOrdersRequestListOrder