Skip to content

Privatenetworks Classes

AcknowledgeOrderReceiptRequest

orderArn

  • Type:
  • Required: Yes

AcknowledgeOrderReceiptResponse

order

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ActivateDeviceIdentifierRequest

deviceIdentifierArn

  • Type:
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

ActivateDeviceIdentifierResponse

deviceIdentifier

  • Type:
  • Required: Yes

tags

  • Type: typing.Dict[str, str]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ActivateNetworkSiteRequest

networkSiteArn

  • Type:
  • Required: Yes

shippingAddress

  • Type:
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

commitmentConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.privatenetworks.privatenetworks_classes.CommitmentConfiguration]

ActivateNetworkSiteResponse

networkSite

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

Address

city

  • Type:
  • Required: Yes

country

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

postalCode

  • Type:
  • Required: Yes

stateOrProvince

  • Type:
  • Required: Yes

street1

  • Type:
  • Required: Yes

company

  • Type: typing.Optional[str]

emailAddress

  • Type: typing.Optional[str]

phoneNumber

  • Type: typing.Optional[str]

street2

  • Type: typing.Optional[str]

street3

  • Type: typing.Optional[str]

BaseValidatorModel

Oops! This Pydantic model is currently empty. Stay tuned!

CommitmentConfiguration

automaticRenewal

  • Type:
  • Required: Yes

commitmentLength

  • Type: typing.Literal['ONE_YEAR', 'SIXTY_DAYS', 'THREE_YEARS']
  • Required: Yes

CommitmentInformation

commitmentConfiguration

  • Type:
  • Required: Yes

expiresOn

  • Type: typing.Optional[datetime.datetime]

startAt

  • Type: typing.Optional[datetime.datetime]

ConfigureAccessPointRequest

accessPointArn

  • Type:
  • Required: Yes

cpiSecretKey

  • Type: typing.Optional[str]

cpiUserId

  • Type: typing.Optional[str]

cpiUserPassword

  • Type: typing.Optional[str]

cpiUsername

  • Type: typing.Optional[str]

position

  • Type: typing.Optional[aws_resource_validator.pydantic_models.privatenetworks.privatenetworks_classes.Position]

ConfigureAccessPointResponse

accessPoint

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateNetworkRequest

networkName

  • Type:
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

description

  • Type: typing.Optional[str]

tags

  • Type: typing.Optional[typing.Dict[str, str]]

CreateNetworkResponse

network

  • Type:
  • Required: Yes

tags

  • Type: typing.Dict[str, str]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateNetworkSiteRequest

networkArn

  • Type:
  • Required: Yes

networkSiteName

  • Type:
  • Required: Yes

availabilityZone

  • Type: typing.Optional[str]

availabilityZoneId

  • Type: typing.Optional[str]

clientToken

  • Type: typing.Optional[str]

description

  • Type: typing.Optional[str]

pendingPlan

  • Type: typing.Union[aws_resource_validator.pydantic_models.privatenetworks.privatenetworks_classes.SitePlan, aws_resource_validator.pydantic_models.privatenetworks.privatenetworks_classes.SitePlanOutput, NoneType]

tags

  • Type: typing.Optional[typing.Dict[str, str]]

CreateNetworkSiteResponse

networkSite

  • Type:
  • Required: Yes

tags

  • Type: typing.Dict[str, str]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeactivateDeviceIdentifierRequest

deviceIdentifierArn

  • Type:
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

DeactivateDeviceIdentifierResponse

deviceIdentifier

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeleteNetworkRequest

networkArn

  • Type:
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

DeleteNetworkResponse

network

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeleteNetworkSiteRequest

networkSiteArn

  • Type:
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

DeleteNetworkSiteResponse

networkSite

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeviceIdentifier

createdAt

  • Type: typing.Optional[datetime.datetime]

deviceIdentifierArn

  • Type: typing.Optional[str]

iccid

  • Type: typing.Optional[str]

imsi

  • Type: typing.Optional[str]

networkArn

  • Type: typing.Optional[str]

orderArn

  • Type: typing.Optional[str]

status

  • Type: typing.Optional[typing.Literal['ACTIVE', 'INACTIVE']]

trafficGroupArn

  • Type: typing.Optional[str]

vendor

  • Type: typing.Optional[str]

GetDeviceIdentifierRequest

deviceIdentifierArn

  • Type:
  • Required: Yes

GetDeviceIdentifierResponse

deviceIdentifier

  • Type:
  • Required: Yes

tags

  • Type: typing.Dict[str, str]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetNetworkRequest

networkArn

  • Type:
  • Required: Yes

GetNetworkResourceRequest

networkResourceArn

  • Type:
  • Required: Yes

GetNetworkResourceResponse

networkResource

  • Type:
  • Required: Yes

tags

  • Type: typing.Dict[str, str]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetNetworkResponse

network

  • Type:
  • Required: Yes

tags

  • Type: typing.Dict[str, str]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetNetworkSiteRequest

networkSiteArn

  • Type:
  • Required: Yes

GetNetworkSiteResponse

networkSite

  • Type:
  • Required: Yes

tags

  • Type: typing.Dict[str, str]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetOrderRequest

orderArn

  • Type:
  • Required: Yes

GetOrderResponse

order

  • Type:
  • Required: Yes

tags

  • Type: typing.Dict[str, str]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListDeviceIdentifiersRequest

networkArn

  • Type:
  • Required: Yes

filters

  • Type: typing.Optional[typing.Dict[typing.Literal['ORDER', 'STATUS', 'TRAFFIC_GROUP'], typing.List[str]]]

maxResults

  • Type: typing.Optional[int]

startToken

  • Type: typing.Optional[str]

ListDeviceIdentifiersRequestPaginate

networkArn

  • Type:
  • Required: Yes

filters

  • Type: typing.Optional[typing.Dict[typing.Literal['ORDER', 'STATUS', 'TRAFFIC_GROUP'], typing.List[str]]]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.privatenetworks.privatenetworks_classes.PaginatorConfig]

ListDeviceIdentifiersResponse

deviceIdentifiers

  • Type: typing.List[aws_resource_validator.pydantic_models.privatenetworks.privatenetworks_classes.DeviceIdentifier]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListNetworkResourcesRequest

networkArn

  • Type:
  • Required: Yes

filters

  • Type: typing.Optional[typing.Dict[typing.Literal['ORDER', 'STATUS'], typing.List[str]]]

maxResults

  • Type: typing.Optional[int]

startToken

  • Type: typing.Optional[str]

ListNetworkResourcesRequestPaginate

networkArn

  • Type:
  • Required: Yes

filters

  • Type: typing.Optional[typing.Dict[typing.Literal['ORDER', 'STATUS'], typing.List[str]]]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.privatenetworks.privatenetworks_classes.PaginatorConfig]

ListNetworkResourcesResponse

networkResources

  • Type: typing.List[aws_resource_validator.pydantic_models.privatenetworks.privatenetworks_classes.NetworkResource]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListNetworkSitesRequest

networkArn

  • Type:
  • Required: Yes

filters

  • Type: typing.Optional[typing.Dict[typing.Literal['STATUS'], typing.List[str]]]

maxResults

  • Type: typing.Optional[int]

startToken

  • Type: typing.Optional[str]

ListNetworkSitesRequestPaginate

networkArn

  • Type:
  • Required: Yes

filters

  • Type: typing.Optional[typing.Dict[typing.Literal['STATUS'], typing.List[str]]]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.privatenetworks.privatenetworks_classes.PaginatorConfig]

ListNetworkSitesResponse

networkSites

  • Type: typing.List[aws_resource_validator.pydantic_models.privatenetworks.privatenetworks_classes.NetworkSite]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListNetworksRequest

filters

  • Type: typing.Optional[typing.Dict[typing.Literal['STATUS'], typing.List[str]]]

maxResults

  • Type: typing.Optional[int]

startToken

  • Type: typing.Optional[str]

ListNetworksRequestPaginate

filters

  • Type: typing.Optional[typing.Dict[typing.Literal['STATUS'], typing.List[str]]]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.privatenetworks.privatenetworks_classes.PaginatorConfig]

ListNetworksResponse

networks

  • Type: typing.List[aws_resource_validator.pydantic_models.privatenetworks.privatenetworks_classes.Network]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListOrdersRequest

networkArn

  • Type:
  • Required: Yes

filters

  • Type: typing.Optional[typing.Dict[typing.Literal['NETWORK_SITE', 'STATUS'], typing.List[str]]]

maxResults

  • Type: typing.Optional[int]

startToken

  • Type: typing.Optional[str]

ListOrdersRequestPaginate

networkArn

  • Type:
  • Required: Yes

filters

  • Type: typing.Optional[typing.Dict[typing.Literal['NETWORK_SITE', 'STATUS'], typing.List[str]]]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.privatenetworks.privatenetworks_classes.PaginatorConfig]

ListOrdersResponse

orders

  • Type: typing.List[aws_resource_validator.pydantic_models.privatenetworks.privatenetworks_classes.Order]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListTagsForResourceRequest

resourceArn

  • Type:
  • Required: Yes

ListTagsForResourceResponse

tags

  • Type: typing.Dict[str, str]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

NameValuePair

name

  • Type:
  • Required: Yes

value

  • Type: typing.Optional[str]

Network

networkArn

  • Type:
  • Required: Yes

networkName

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['AVAILABLE', 'CREATED', 'DELETED', 'DEPROVISIONING', 'PROVISIONING']
  • Required: Yes

createdAt

  • Type: typing.Optional[datetime.datetime]

description

  • Type: typing.Optional[str]

statusReason

  • Type: typing.Optional[str]

NetworkResource

attributes

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.privatenetworks.privatenetworks_classes.NameValuePair]]

commitmentInformation

  • Type: typing.Optional[aws_resource_validator.pydantic_models.privatenetworks.privatenetworks_classes.CommitmentInformation]

createdAt

  • Type: typing.Optional[datetime.datetime]

description

  • Type: typing.Optional[str]

health

  • Type: typing.Optional[typing.Literal['HEALTHY', 'INITIAL', 'UNHEALTHY']]

model

  • Type: typing.Optional[str]

networkArn

  • Type: typing.Optional[str]

networkResourceArn

  • Type: typing.Optional[str]

networkSiteArn

  • Type: typing.Optional[str]

orderArn

  • Type: typing.Optional[str]

position

  • Type: typing.Optional[aws_resource_validator.pydantic_models.privatenetworks.privatenetworks_classes.Position]

returnInformation

  • Type: typing.Optional[aws_resource_validator.pydantic_models.privatenetworks.privatenetworks_classes.ReturnInformation]

serialNumber

  • Type: typing.Optional[str]

status

  • Type: typing.Optional[typing.Literal['AVAILABLE', 'CREATING_SHIPPING_LABEL', 'DELETED', 'DELETING', 'PENDING', 'PENDING_RETURN', 'PROVISIONED', 'PROVISIONING', 'SHIPPED']]

statusReason

  • Type: typing.Optional[str]

type

  • Type: typing.Optional[typing.Literal['RADIO_UNIT']]

vendor

  • Type: typing.Optional[str]

NetworkResourceDefinition

count

  • Type:
  • Required: Yes

type

  • Type: typing.Literal['DEVICE_IDENTIFIER', 'RADIO_UNIT']
  • Required: Yes

options

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.privatenetworks.privatenetworks_classes.NameValuePair]]

NetworkResourceDefinitionOutput

count

  • Type:
  • Required: Yes

type

  • Type: typing.Literal['DEVICE_IDENTIFIER', 'RADIO_UNIT']
  • Required: Yes

options

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.privatenetworks.privatenetworks_classes.NameValuePair]]

NetworkSite

networkArn

  • Type:
  • Required: Yes

networkSiteArn

  • Type:
  • Required: Yes

networkSiteName

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['AVAILABLE', 'CREATED', 'DELETED', 'DEPROVISIONING', 'PROVISIONING']
  • Required: Yes

availabilityZone

  • Type: typing.Optional[str]

availabilityZoneId

  • Type: typing.Optional[str]

createdAt

  • Type: typing.Optional[datetime.datetime]

currentPlan

  • Type: typing.Optional[aws_resource_validator.pydantic_models.privatenetworks.privatenetworks_classes.SitePlanOutput]

description

  • Type: typing.Optional[str]

pendingPlan

  • Type: typing.Optional[aws_resource_validator.pydantic_models.privatenetworks.privatenetworks_classes.SitePlanOutput]

statusReason

  • Type: typing.Optional[str]

Order

acknowledgmentStatus

  • Type: typing.Optional[typing.Literal['ACKNOWLEDGED', 'ACKNOWLEDGING', 'UNACKNOWLEDGED']]

createdAt

  • Type: typing.Optional[datetime.datetime]

networkArn

  • Type: typing.Optional[str]

networkSiteArn

  • Type: typing.Optional[str]

orderArn

  • Type: typing.Optional[str]

orderedResources

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.privatenetworks.privatenetworks_classes.OrderedResourceDefinition]]

shippingAddress

  • Type: typing.Optional[aws_resource_validator.pydantic_models.privatenetworks.privatenetworks_classes.Address]

trackingInformation

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.privatenetworks.privatenetworks_classes.TrackingInformation]]

OrderedResourceDefinition

count

  • Type:
  • Required: Yes

type

  • Type: typing.Literal['DEVICE_IDENTIFIER', 'RADIO_UNIT']
  • Required: Yes

commitmentConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.privatenetworks.privatenetworks_classes.CommitmentConfiguration]

PaginatorConfig

MaxItems

  • Type: typing.Optional[int]

PageSize

  • Type: typing.Optional[int]

StartingToken

  • Type: typing.Optional[str]

PingResponse

status

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

Position

elevation

  • Type: typing.Optional[float]

elevationReference

  • Type: typing.Optional[typing.Literal['AGL', 'AMSL']]

elevationUnit

  • Type: typing.Optional[typing.Literal['FEET']]

latitude

  • Type: typing.Optional[float]

longitude

  • Type: typing.Optional[float]

ResponseMetadata

RequestId

  • Type:
  • Required: Yes

HTTPStatusCode

  • Type:
  • Required: Yes

HTTPHeaders

  • Type: typing.Dict[str, str]
  • Required: Yes

RetryAttempts

  • Type:
  • Required: Yes

HostId

  • Type: typing.Optional[str]

ReturnInformation

replacementOrderArn

  • Type: typing.Optional[str]

returnReason

  • Type: typing.Optional[str]

shippingAddress

  • Type: typing.Optional[aws_resource_validator.pydantic_models.privatenetworks.privatenetworks_classes.Address]

shippingLabel

  • Type: typing.Optional[str]

SitePlan

options

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.privatenetworks.privatenetworks_classes.NameValuePair]]

resourceDefinitions

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.privatenetworks.privatenetworks_classes.NetworkResourceDefinition]]

SitePlanOutput

options

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.privatenetworks.privatenetworks_classes.NameValuePair]]

resourceDefinitions

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.privatenetworks.privatenetworks_classes.NetworkResourceDefinitionOutput]]

StartNetworkResourceUpdateRequest

networkResourceArn

  • Type:
  • Required: Yes

updateType

  • Type: typing.Literal['COMMITMENT', 'REPLACE', 'RETURN']
  • Required: Yes

commitmentConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.privatenetworks.privatenetworks_classes.CommitmentConfiguration]

returnReason

  • Type: typing.Optional[str]

shippingAddress

  • Type: typing.Optional[aws_resource_validator.pydantic_models.privatenetworks.privatenetworks_classes.Address]

StartNetworkResourceUpdateResponse

networkResource

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

TagResourceRequest

resourceArn

  • Type:
  • Required: Yes

tags

  • Type: typing.Dict[str, str]
  • Required: Yes

TrackingInformation

trackingNumber

  • Type: typing.Optional[str]

UntagResourceRequest

resourceArn

  • Type:
  • Required: Yes

tagKeys

  • Type: typing.List[str]
  • Required: Yes

UpdateNetworkSitePlanRequest

networkSiteArn

  • Type:
  • Required: Yes

pendingPlan

  • Type: typing.Union[aws_resource_validator.pydantic_models.privatenetworks.privatenetworks_classes.SitePlan, aws_resource_validator.pydantic_models.privatenetworks.privatenetworks_classes.SitePlanOutput]
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

UpdateNetworkSiteRequest

networkSiteArn

  • Type:
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

description

  • Type: typing.Optional[str]

UpdateNetworkSiteResponse

networkSite

  • Type:
  • Required: Yes

tags

  • Type: typing.Dict[str, str]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes