Type definitions#
Auto-generated documentation for Private5G type annotations stubs module mypy-boto3-privatenetworks.
AcknowledgeOrderReceiptRequestRequestTypeDef#
# AcknowledgeOrderReceiptRequestRequestTypeDef definition
class AcknowledgeOrderReceiptRequestRequestTypeDef(TypedDict):
orderArn: str,
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
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],
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)
PositionTypeDef#
# PositionTypeDef definition
class PositionTypeDef(TypedDict):
elevation: NotRequired[float],
elevationReference: NotRequired[ElevationReferenceType], # (1)
elevationUnit: NotRequired[ElevationUnitType], # (2)
latitude: NotRequired[float],
longitude: NotRequired[float],
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],
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],
ListNetworkResourcesRequestRequestTypeDef#
# ListNetworkResourcesRequestRequestTypeDef definition
class ListNetworkResourcesRequestRequestTypeDef(TypedDict):
networkArn: str,
filters: NotRequired[Mapping[NetworkResourceFilterKeysType, Sequence[str]]], # (1)
maxResults: NotRequired[int],
startToken: NotRequired[str],
ListNetworkSitesRequestRequestTypeDef#
# ListNetworkSitesRequestRequestTypeDef definition
class ListNetworkSitesRequestRequestTypeDef(TypedDict):
networkArn: str,
filters: NotRequired[Mapping[NetworkSiteFilterKeysType, Sequence[str]]], # (1)
maxResults: NotRequired[int],
startToken: NotRequired[str],
ListNetworksRequestRequestTypeDef#
# ListNetworksRequestRequestTypeDef definition
class ListNetworksRequestRequestTypeDef(TypedDict):
filters: NotRequired[Mapping[NetworkFilterKeysType, Sequence[str]]], # (1)
maxResults: NotRequired[int],
startToken: NotRequired[str],
ListOrdersRequestRequestTypeDef#
# ListOrdersRequestRequestTypeDef definition
class ListOrdersRequestRequestTypeDef(TypedDict):
networkArn: str,
filters: NotRequired[Mapping[OrderFilterKeysType, Sequence[str]]], # (1)
maxResults: NotRequired[int],
startToken: NotRequired[str],
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)
PingResponseTypeDef#
# PingResponseTypeDef definition
class PingResponseTypeDef(TypedDict):
status: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ActivateDeviceIdentifierResponseTypeDef#
# ActivateDeviceIdentifierResponseTypeDef definition
class ActivateDeviceIdentifierResponseTypeDef(TypedDict):
deviceIdentifier: DeviceIdentifierTypeDef, # (1)
tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DeactivateDeviceIdentifierResponseTypeDef#
# DeactivateDeviceIdentifierResponseTypeDef definition
class DeactivateDeviceIdentifierResponseTypeDef(TypedDict):
deviceIdentifier: DeviceIdentifierTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetDeviceIdentifierResponseTypeDef#
# GetDeviceIdentifierResponseTypeDef definition
class GetDeviceIdentifierResponseTypeDef(TypedDict):
deviceIdentifier: DeviceIdentifierTypeDef, # (1)
tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListDeviceIdentifiersResponseTypeDef#
# ListDeviceIdentifiersResponseTypeDef definition
class ListDeviceIdentifiersResponseTypeDef(TypedDict):
deviceIdentifiers: List[DeviceIdentifierTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ReturnInformationTypeDef#
# ReturnInformationTypeDef definition
class ReturnInformationTypeDef(TypedDict):
replacementOrderArn: NotRequired[str],
returnReason: NotRequired[str],
shippingAddress: NotRequired[AddressTypeDef], # (1)
shippingLabel: NotRequired[str],
- See AddressTypeDef
ActivateNetworkSiteRequestRequestTypeDef#
# ActivateNetworkSiteRequestRequestTypeDef definition
class ActivateNetworkSiteRequestRequestTypeDef(TypedDict):
networkSiteArn: str,
shippingAddress: AddressTypeDef, # (1)
clientToken: NotRequired[str],
commitmentConfiguration: NotRequired[CommitmentConfigurationTypeDef], # (2)
CommitmentInformationTypeDef#
# CommitmentInformationTypeDef definition
class CommitmentInformationTypeDef(TypedDict):
commitmentConfiguration: CommitmentConfigurationTypeDef, # (1)
expiresOn: NotRequired[datetime],
startAt: NotRequired[datetime],
OrderedResourceDefinitionTypeDef#
# OrderedResourceDefinitionTypeDef definition
class OrderedResourceDefinitionTypeDef(TypedDict):
count: int,
type: NetworkResourceDefinitionTypeType, # (2)
commitmentConfiguration: NotRequired[CommitmentConfigurationTypeDef], # (1)
StartNetworkResourceUpdateRequestRequestTypeDef#
# StartNetworkResourceUpdateRequestRequestTypeDef definition
class StartNetworkResourceUpdateRequestRequestTypeDef(TypedDict):
networkResourceArn: str,
updateType: UpdateTypeType, # (1)
commitmentConfiguration: NotRequired[CommitmentConfigurationTypeDef], # (2)
returnReason: NotRequired[str],
shippingAddress: NotRequired[AddressTypeDef], # (3)
ConfigureAccessPointRequestRequestTypeDef#
# ConfigureAccessPointRequestRequestTypeDef definition
class ConfigureAccessPointRequestRequestTypeDef(TypedDict):
accessPointArn: str,
cpiSecretKey: NotRequired[str],
cpiUserId: NotRequired[str],
cpiUserPassword: NotRequired[str],
cpiUsername: NotRequired[str],
position: NotRequired[PositionTypeDef], # (1)
- See PositionTypeDef
CreateNetworkResponseTypeDef#
# CreateNetworkResponseTypeDef definition
class CreateNetworkResponseTypeDef(TypedDict):
network: NetworkTypeDef, # (1)
tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DeleteNetworkResponseTypeDef#
# DeleteNetworkResponseTypeDef definition
class DeleteNetworkResponseTypeDef(TypedDict):
network: NetworkTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetNetworkResponseTypeDef#
# GetNetworkResponseTypeDef definition
class GetNetworkResponseTypeDef(TypedDict):
network: NetworkTypeDef, # (1)
tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListNetworksResponseTypeDef#
# ListNetworksResponseTypeDef definition
class ListNetworksResponseTypeDef(TypedDict):
networks: List[NetworkTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListDeviceIdentifiersRequestListDeviceIdentifiersPaginateTypeDef#
# ListDeviceIdentifiersRequestListDeviceIdentifiersPaginateTypeDef definition
class ListDeviceIdentifiersRequestListDeviceIdentifiersPaginateTypeDef(TypedDict):
networkArn: str,
filters: NotRequired[Mapping[DeviceIdentifierFilterKeysType, Sequence[str]]], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
ListNetworkResourcesRequestListNetworkResourcesPaginateTypeDef#
# ListNetworkResourcesRequestListNetworkResourcesPaginateTypeDef definition
class ListNetworkResourcesRequestListNetworkResourcesPaginateTypeDef(TypedDict):
networkArn: str,
filters: NotRequired[Mapping[NetworkResourceFilterKeysType, Sequence[str]]], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
ListNetworkSitesRequestListNetworkSitesPaginateTypeDef#
# ListNetworkSitesRequestListNetworkSitesPaginateTypeDef definition
class ListNetworkSitesRequestListNetworkSitesPaginateTypeDef(TypedDict):
networkArn: str,
filters: NotRequired[Mapping[NetworkSiteFilterKeysType, Sequence[str]]], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
ListNetworksRequestListNetworksPaginateTypeDef#
# ListNetworksRequestListNetworksPaginateTypeDef definition
class ListNetworksRequestListNetworksPaginateTypeDef(TypedDict):
filters: NotRequired[Mapping[NetworkFilterKeysType, Sequence[str]]], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
ListOrdersRequestListOrdersPaginateTypeDef#
# ListOrdersRequestListOrdersPaginateTypeDef definition
class ListOrdersRequestListOrdersPaginateTypeDef(TypedDict):
networkArn: str,
filters: NotRequired[Mapping[OrderFilterKeysType, Sequence[str]]], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
NetworkResourceDefinitionTypeDef#
# NetworkResourceDefinitionTypeDef definition
class NetworkResourceDefinitionTypeDef(TypedDict):
count: int,
type: NetworkResourceDefinitionTypeType, # (2)
options: NotRequired[List[NameValuePairTypeDef]], # (1)
NetworkResourceTypeDef#
# NetworkResourceTypeDef definition
class NetworkResourceTypeDef(TypedDict):
attributes: NotRequired[List[NameValuePairTypeDef]], # (1)
commitmentInformation: NotRequired[CommitmentInformationTypeDef], # (2)
createdAt: NotRequired[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],
- See NameValuePairTypeDef
- See CommitmentInformationTypeDef
- See HealthStatusType
- See PositionTypeDef
- See ReturnInformationTypeDef
- See NetworkResourceStatusType
- See NetworkResourceTypeType
OrderTypeDef#
# OrderTypeDef definition
class OrderTypeDef(TypedDict):
acknowledgmentStatus: NotRequired[AcknowledgmentStatusType], # (1)
createdAt: NotRequired[datetime],
networkArn: NotRequired[str],
networkSiteArn: NotRequired[str],
orderArn: NotRequired[str],
orderedResources: NotRequired[List[OrderedResourceDefinitionTypeDef]], # (2)
shippingAddress: NotRequired[AddressTypeDef], # (3)
trackingInformation: NotRequired[List[TrackingInformationTypeDef]], # (4)
- See AcknowledgmentStatusType
- See OrderedResourceDefinitionTypeDef
- See AddressTypeDef
- See TrackingInformationTypeDef
SitePlanTypeDef#
# SitePlanTypeDef definition
class SitePlanTypeDef(TypedDict):
options: NotRequired[List[NameValuePairTypeDef]], # (1)
resourceDefinitions: NotRequired[List[NetworkResourceDefinitionTypeDef]], # (2)
ConfigureAccessPointResponseTypeDef#
# ConfigureAccessPointResponseTypeDef definition
class ConfigureAccessPointResponseTypeDef(TypedDict):
accessPoint: NetworkResourceTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetNetworkResourceResponseTypeDef#
# GetNetworkResourceResponseTypeDef definition
class GetNetworkResourceResponseTypeDef(TypedDict):
networkResource: NetworkResourceTypeDef, # (1)
tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListNetworkResourcesResponseTypeDef#
# ListNetworkResourcesResponseTypeDef definition
class ListNetworkResourcesResponseTypeDef(TypedDict):
networkResources: List[NetworkResourceTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
StartNetworkResourceUpdateResponseTypeDef#
# StartNetworkResourceUpdateResponseTypeDef definition
class StartNetworkResourceUpdateResponseTypeDef(TypedDict):
networkResource: NetworkResourceTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
AcknowledgeOrderReceiptResponseTypeDef#
# AcknowledgeOrderReceiptResponseTypeDef definition
class AcknowledgeOrderReceiptResponseTypeDef(TypedDict):
order: OrderTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See OrderTypeDef
- See ResponseMetadataTypeDef
GetOrderResponseTypeDef#
# GetOrderResponseTypeDef definition
class GetOrderResponseTypeDef(TypedDict):
order: OrderTypeDef, # (1)
tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See OrderTypeDef
- See ResponseMetadataTypeDef
ListOrdersResponseTypeDef#
# ListOrdersResponseTypeDef definition
class ListOrdersResponseTypeDef(TypedDict):
nextToken: str,
orders: List[OrderTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See OrderTypeDef
- See ResponseMetadataTypeDef
CreateNetworkSiteRequestRequestTypeDef#
# CreateNetworkSiteRequestRequestTypeDef definition
class CreateNetworkSiteRequestRequestTypeDef(TypedDict):
networkArn: str,
networkSiteName: str,
availabilityZone: NotRequired[str],
availabilityZoneId: NotRequired[str],
clientToken: NotRequired[str],
description: NotRequired[str],
pendingPlan: NotRequired[SitePlanTypeDef], # (1)
tags: NotRequired[Mapping[str, str]],
- See SitePlanTypeDef
NetworkSiteTypeDef#
# NetworkSiteTypeDef definition
class NetworkSiteTypeDef(TypedDict):
networkArn: str,
networkSiteArn: str,
networkSiteName: str,
status: NetworkSiteStatusType, # (3)
availabilityZone: NotRequired[str],
availabilityZoneId: NotRequired[str],
createdAt: NotRequired[datetime],
currentPlan: NotRequired[SitePlanTypeDef], # (1)
description: NotRequired[str],
pendingPlan: NotRequired[SitePlanTypeDef], # (1)
statusReason: NotRequired[str],
- See SitePlanTypeDef
- See SitePlanTypeDef
- See NetworkSiteStatusType
UpdateNetworkSitePlanRequestRequestTypeDef#
# UpdateNetworkSitePlanRequestRequestTypeDef definition
class UpdateNetworkSitePlanRequestRequestTypeDef(TypedDict):
networkSiteArn: str,
pendingPlan: SitePlanTypeDef, # (1)
clientToken: NotRequired[str],
- See SitePlanTypeDef
ActivateNetworkSiteResponseTypeDef#
# ActivateNetworkSiteResponseTypeDef definition
class ActivateNetworkSiteResponseTypeDef(TypedDict):
networkSite: NetworkSiteTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateNetworkSiteResponseTypeDef#
# CreateNetworkSiteResponseTypeDef definition
class CreateNetworkSiteResponseTypeDef(TypedDict):
networkSite: NetworkSiteTypeDef, # (1)
tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (2)