Table of Contents
Private5G.Client¶A low-level client representing AWS Private 5G
Amazon Web Services Private 5G is a managed service that makes it easy to deploy, operate, and scale your own private mobile network at your on-premises location. Private 5G provides the pre-configured hardware and software for mobile networks, helps automate setup, and scales capacity on demand to support additional devices as needed.
import boto3
client = boto3.client('privatenetworks')
These are the available methods:
acknowledge_order_receipt()activate_device_identifier()activate_network_site()can_paginate()close()configure_access_point()create_network()create_network_site()deactivate_device_identifier()delete_network()delete_network_site()get_device_identifier()get_network()get_network_resource()get_network_site()get_order()get_paginator()get_waiter()list_device_identifiers()list_network_resources()list_network_sites()list_networks()list_orders()list_tags_for_resource()ping()tag_resource()untag_resource()update_network_site()update_network_site_plan()acknowledge_order_receipt(**kwargs)¶Acknowledges that the specified network order was received.
See also: AWS API Documentation
Request Syntax
response = client.acknowledge_order_receipt(
orderArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the order.
{
'order': {
'acknowledgmentStatus': 'ACKNOWLEDGING'|'ACKNOWLEDGED'|'UNACKNOWLEDGED',
'createdAt': datetime(2015, 1, 1),
'networkArn': 'string',
'networkSiteArn': 'string',
'orderArn': 'string',
'shippingAddress': {
'city': 'string',
'company': 'string',
'country': 'string',
'name': 'string',
'phoneNumber': 'string',
'postalCode': 'string',
'stateOrProvince': 'string',
'street1': 'string',
'street2': 'string',
'street3': 'string'
},
'trackingInformation': [
{
'trackingNumber': 'string'
},
]
}
}
Response Structure
Information about the order.
The acknowledgement status of the order.
The creation time of the order.
The Amazon Resource Name (ARN) of the network associated with this order.
The Amazon Resource Name (ARN) of the network site associated with this order.
The Amazon Resource Name (ARN) of the order.
The shipping address of the order.
The city for this address.
The company name for this address.
The country for this address.
The recipient's name for this address.
The phone number for this address.
The postal code for this address.
The state or province for this address.
The first line of the street address.
The second line of the street address.
The third line of the street address.
The tracking information of the order.
Information about tracking a shipment.
The tracking number of the shipment.
Exceptions
Private5G.Client.exceptions.ResourceNotFoundExceptionPrivate5G.Client.exceptions.ValidationExceptionPrivate5G.Client.exceptions.InternalServerExceptionactivate_device_identifier(**kwargs)¶Activates the specified device identifier.
See also: AWS API Documentation
Request Syntax
response = client.activate_device_identifier(
clientToken='string',
deviceIdentifierArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the device identifier.
dict
Response Syntax
{
'deviceIdentifier': {
'createdAt': datetime(2015, 1, 1),
'deviceIdentifierArn': 'string',
'iccid': 'string',
'imsi': 'string',
'networkArn': 'string',
'orderArn': 'string',
'status': 'ACTIVE'|'INACTIVE',
'trafficGroupArn': 'string',
'vendor': 'string'
},
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
deviceIdentifier (dict) --
Information about the device identifier.
createdAt (datetime) --
The creation time of this device identifier.
deviceIdentifierArn (string) --
The Amazon Resource Name (ARN) of the device identifier.
iccid (string) --
The Integrated Circuit Card Identifier of the device identifier.
imsi (string) --
The International Mobile Subscriber Identity of the device identifier.
networkArn (string) --
The Amazon Resource Name (ARN) of the network on which the device identifier appears.
orderArn (string) --
The Amazon Resource Name (ARN) of the order used to purchase the device identifier.
status (string) --
The status of the device identifier.
trafficGroupArn (string) --
The Amazon Resource Name (ARN) of the traffic group to which the device identifier belongs.
vendor (string) --
The vendor of the device identifier.
tags (dict) --
The tags on the device identifier.
Exceptions
Private5G.Client.exceptions.ResourceNotFoundExceptionPrivate5G.Client.exceptions.ValidationExceptionPrivate5G.Client.exceptions.InternalServerExceptionactivate_network_site(**kwargs)¶Activates the specified network site.
See also: AWS API Documentation
Request Syntax
response = client.activate_network_site(
clientToken='string',
networkSiteArn='string',
shippingAddress={
'city': 'string',
'company': 'string',
'country': 'string',
'name': 'string',
'phoneNumber': 'string',
'postalCode': 'string',
'stateOrProvince': 'string',
'street1': 'string',
'street2': 'string',
'street3': 'string'
}
)
[REQUIRED]
The Amazon Resource Name (ARN) of the network site.
[REQUIRED]
The shipping address of the network site.
The city for this address.
The company name for this address.
The country for this address.
The recipient's name for this address.
The phone number for this address.
The postal code for this address.
The state or province for this address.
The first line of the street address.
The second line of the street address.
The third line of the street address.
dict
Response Syntax
{
'networkSite': {
'availabilityZone': 'string',
'availabilityZoneId': 'string',
'createdAt': datetime(2015, 1, 1),
'currentPlan': {
'options': [
{
'name': 'string',
'value': 'string'
},
],
'resourceDefinitions': [
{
'count': 123,
'options': [
{
'name': 'string',
'value': 'string'
},
],
'type': 'RADIO_UNIT'|'DEVICE_IDENTIFIER'
},
]
},
'description': 'string',
'networkArn': 'string',
'networkSiteArn': 'string',
'networkSiteName': 'string',
'pendingPlan': {
'options': [
{
'name': 'string',
'value': 'string'
},
],
'resourceDefinitions': [
{
'count': 123,
'options': [
{
'name': 'string',
'value': 'string'
},
],
'type': 'RADIO_UNIT'|'DEVICE_IDENTIFIER'
},
]
},
'status': 'CREATED'|'PROVISIONING'|'AVAILABLE'|'DEPROVISIONING'|'DELETED',
'statusReason': 'string'
}
}
Response Structure
(dict) --
networkSite (dict) --
Information about the network site.
availabilityZone (string) --
The parent Availability Zone for the network site.
availabilityZoneId (string) --
The parent Availability Zone ID for the network site.
createdAt (datetime) --
The creation time of the network site.
currentPlan (dict) --
The current plan of the network site.
options (list) --
The options of the plan.
(dict) --
Information about a name/value pair.
name (string) --
The name of the pair.
value (string) --
The value of the pair.
resourceDefinitions (list) --
The resource definitions of the plan.
(dict) --
Information about a network resource definition.
count (integer) --
The count in the network resource definition.
options (list) --
The options in the network resource definition.
(dict) --
Information about a name/value pair.
name (string) --
The name of the pair.
value (string) --
The value of the pair.
type (string) --
The type in the network resource definition.
description (string) --
The description of the network site.
networkArn (string) --
The Amazon Resource Name (ARN) of the network to which the network site belongs.
networkSiteArn (string) --
The Amazon Resource Name (ARN) of the network site.
networkSiteName (string) --
The name of the network site.
pendingPlan (dict) --
The pending plan of the network site.
options (list) --
The options of the plan.
(dict) --
Information about a name/value pair.
name (string) --
The name of the pair.
value (string) --
The value of the pair.
resourceDefinitions (list) --
The resource definitions of the plan.
(dict) --
Information about a network resource definition.
count (integer) --
The count in the network resource definition.
options (list) --
The options in the network resource definition.
(dict) --
Information about a name/value pair.
name (string) --
The name of the pair.
value (string) --
The value of the pair.
type (string) --
The type in the network resource definition.
status (string) --
The status of the network site.
statusReason (string) --
The status reason of the network site.
Exceptions
Private5G.Client.exceptions.ResourceNotFoundExceptionPrivate5G.Client.exceptions.ValidationExceptionPrivate5G.Client.exceptions.InternalServerExceptioncan_paginate(operation_name)¶Check if an operation can be paginated.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").True if the operation can be paginated,
False otherwise.close()¶Closes underlying endpoint connections.
configure_access_point(**kwargs)¶Configures the specified network resource.
Use this action to specify the geographic position of the hardware. You must provide Certified Professional Installer (CPI) credentials in the request so that we can obtain spectrum grants. For more information, see Radio units in the Amazon Web Services Private 5G User Guide .
See also: AWS API Documentation
Request Syntax
response = client.configure_access_point(
accessPointArn='string',
cpiSecretKey='string',
cpiUserId='string',
cpiUserPassword='string',
cpiUsername='string',
position={
'elevation': 123.0,
'elevationReference': 'AGL'|'AMSL',
'elevationUnit': 'FEET',
'latitude': 123.0,
'longitude': 123.0
}
)
[REQUIRED]
The Amazon Resource Name (ARN) of the network resource.
cpiSecretKey .The position of the network resource.
The elevation of the equipment at this position.
The reference point from which elevation is reported.
The units used to measure the elevation of the position.
The latitude of the position.
The longitude of the position.
dict
Response Syntax
{
'accessPoint': {
'attributes': [
{
'name': 'string',
'value': 'string'
},
],
'createdAt': datetime(2015, 1, 1),
'description': 'string',
'health': 'INITIAL'|'HEALTHY'|'UNHEALTHY',
'model': 'string',
'networkArn': 'string',
'networkResourceArn': 'string',
'networkSiteArn': 'string',
'orderArn': 'string',
'position': {
'elevation': 123.0,
'elevationReference': 'AGL'|'AMSL',
'elevationUnit': 'FEET',
'latitude': 123.0,
'longitude': 123.0
},
'serialNumber': 'string',
'status': 'PENDING'|'SHIPPED'|'PROVISIONING'|'PROVISIONED'|'AVAILABLE'|'DELETING'|'PENDING_RETURN'|'DELETED',
'statusReason': 'string',
'type': 'RADIO_UNIT',
'vendor': 'string'
}
}
Response Structure
(dict) --
accessPoint (dict) --
Information about the network resource.
attributes (list) --
The attributes of the network resource.
(dict) --
Information about a name/value pair.
name (string) --
The name of the pair.
value (string) --
The value of the pair.
createdAt (datetime) --
The creation time of the network resource.
description (string) --
The description of the network resource.
health (string) --
The health of the network resource.
model (string) --
The model of the network resource.
networkArn (string) --
The Amazon Resource Name (ARN) of the network on which this network resource appears.
networkResourceArn (string) --
The Amazon Resource Name (ARN) of the network resource.
networkSiteArn (string) --
The Amazon Resource Name (ARN) of the network site on which this network resource appears.
orderArn (string) --
The Amazon Resource Name (ARN) of the order used to purchase this network resource.
position (dict) --
The position of the network resource.
elevation (float) --
The elevation of the equipment at this position.
elevationReference (string) --
The reference point from which elevation is reported.
elevationUnit (string) --
The units used to measure the elevation of the position.
latitude (float) --
The latitude of the position.
longitude (float) --
The longitude of the position.
serialNumber (string) --
The serial number of the network resource.
status (string) --
The status of the network resource.
statusReason (string) --
The status reason of the network resource.
type (string) --
The type of the network resource.
vendor (string) --
The vendor of the network resource.
Exceptions
Private5G.Client.exceptions.ResourceNotFoundExceptionPrivate5G.Client.exceptions.ValidationExceptionPrivate5G.Client.exceptions.InternalServerExceptioncreate_network(**kwargs)¶Creates a network.
See also: AWS API Documentation
Request Syntax
response = client.create_network(
clientToken='string',
description='string',
networkName='string',
tags={
'string': 'string'
}
)
[REQUIRED]
The name of the network. You can't change the name after you create the network.
The tags to apply to the network.
dict
Response Syntax
{
'network': {
'createdAt': datetime(2015, 1, 1),
'description': 'string',
'networkArn': 'string',
'networkName': 'string',
'status': 'CREATED'|'PROVISIONING'|'AVAILABLE'|'DEPROVISIONING'|'DELETED',
'statusReason': 'string'
},
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
network (dict) --
Information about the network.
createdAt (datetime) --
The creation time of the network.
description (string) --
The description of the network.
networkArn (string) --
The Amazon Resource Name (ARN) of the network.
networkName (string) --
The name of the network.
status (string) --
The status of the network.
statusReason (string) --
The status reason of the network.
tags (dict) --
The network tags.
Exceptions
Private5G.Client.exceptions.LimitExceededExceptionPrivate5G.Client.exceptions.ValidationExceptionPrivate5G.Client.exceptions.InternalServerExceptioncreate_network_site(**kwargs)¶Creates a network site.
See also: AWS API Documentation
Request Syntax
response = client.create_network_site(
availabilityZone='string',
availabilityZoneId='string',
clientToken='string',
description='string',
networkArn='string',
networkSiteName='string',
pendingPlan={
'options': [
{
'name': 'string',
'value': 'string'
},
],
'resourceDefinitions': [
{
'count': 123,
'options': [
{
'name': 'string',
'value': 'string'
},
],
'type': 'RADIO_UNIT'|'DEVICE_IDENTIFIER'
},
]
},
tags={
'string': 'string'
}
)
[REQUIRED]
The Amazon Resource Name (ARN) of the network.
[REQUIRED]
The name of the site. You can't change the name after you create the site.
Information about the pending plan for this site.
The options of the plan.
Information about a name/value pair.
The name of the pair.
The value of the pair.
The resource definitions of the plan.
Information about a network resource definition.
The count in the network resource definition.
The options in the network resource definition.
Information about a name/value pair.
The name of the pair.
The value of the pair.
The type in the network resource definition.
The tags to apply to the network site.
dict
Response Syntax
{
'networkSite': {
'availabilityZone': 'string',
'availabilityZoneId': 'string',
'createdAt': datetime(2015, 1, 1),
'currentPlan': {
'options': [
{
'name': 'string',
'value': 'string'
},
],
'resourceDefinitions': [
{
'count': 123,
'options': [
{
'name': 'string',
'value': 'string'
},
],
'type': 'RADIO_UNIT'|'DEVICE_IDENTIFIER'
},
]
},
'description': 'string',
'networkArn': 'string',
'networkSiteArn': 'string',
'networkSiteName': 'string',
'pendingPlan': {
'options': [
{
'name': 'string',
'value': 'string'
},
],
'resourceDefinitions': [
{
'count': 123,
'options': [
{
'name': 'string',
'value': 'string'
},
],
'type': 'RADIO_UNIT'|'DEVICE_IDENTIFIER'
},
]
},
'status': 'CREATED'|'PROVISIONING'|'AVAILABLE'|'DEPROVISIONING'|'DELETED',
'statusReason': 'string'
},
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
networkSite (dict) --
Information about the network site.
availabilityZone (string) --
The parent Availability Zone for the network site.
availabilityZoneId (string) --
The parent Availability Zone ID for the network site.
createdAt (datetime) --
The creation time of the network site.
currentPlan (dict) --
The current plan of the network site.
options (list) --
The options of the plan.
(dict) --
Information about a name/value pair.
name (string) --
The name of the pair.
value (string) --
The value of the pair.
resourceDefinitions (list) --
The resource definitions of the plan.
(dict) --
Information about a network resource definition.
count (integer) --
The count in the network resource definition.
options (list) --
The options in the network resource definition.
(dict) --
Information about a name/value pair.
name (string) --
The name of the pair.
value (string) --
The value of the pair.
type (string) --
The type in the network resource definition.
description (string) --
The description of the network site.
networkArn (string) --
The Amazon Resource Name (ARN) of the network to which the network site belongs.
networkSiteArn (string) --
The Amazon Resource Name (ARN) of the network site.
networkSiteName (string) --
The name of the network site.
pendingPlan (dict) --
The pending plan of the network site.
options (list) --
The options of the plan.
(dict) --
Information about a name/value pair.
name (string) --
The name of the pair.
value (string) --
The value of the pair.
resourceDefinitions (list) --
The resource definitions of the plan.
(dict) --
Information about a network resource definition.
count (integer) --
The count in the network resource definition.
options (list) --
The options in the network resource definition.
(dict) --
Information about a name/value pair.
name (string) --
The name of the pair.
value (string) --
The value of the pair.
type (string) --
The type in the network resource definition.
status (string) --
The status of the network site.
statusReason (string) --
The status reason of the network site.
tags (dict) --
The network site tags.
Exceptions
Private5G.Client.exceptions.ResourceNotFoundExceptionPrivate5G.Client.exceptions.ValidationExceptionPrivate5G.Client.exceptions.InternalServerExceptiondeactivate_device_identifier(**kwargs)¶Deactivates the specified device identifier.
See also: AWS API Documentation
Request Syntax
response = client.deactivate_device_identifier(
clientToken='string',
deviceIdentifierArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the device identifier.
dict
Response Syntax
{
'deviceIdentifier': {
'createdAt': datetime(2015, 1, 1),
'deviceIdentifierArn': 'string',
'iccid': 'string',
'imsi': 'string',
'networkArn': 'string',
'orderArn': 'string',
'status': 'ACTIVE'|'INACTIVE',
'trafficGroupArn': 'string',
'vendor': 'string'
}
}
Response Structure
(dict) --
deviceIdentifier (dict) --
Information about the device identifier.
createdAt (datetime) --
The creation time of this device identifier.
deviceIdentifierArn (string) --
The Amazon Resource Name (ARN) of the device identifier.
iccid (string) --
The Integrated Circuit Card Identifier of the device identifier.
imsi (string) --
The International Mobile Subscriber Identity of the device identifier.
networkArn (string) --
The Amazon Resource Name (ARN) of the network on which the device identifier appears.
orderArn (string) --
The Amazon Resource Name (ARN) of the order used to purchase the device identifier.
status (string) --
The status of the device identifier.
trafficGroupArn (string) --
The Amazon Resource Name (ARN) of the traffic group to which the device identifier belongs.
vendor (string) --
The vendor of the device identifier.
Exceptions
Private5G.Client.exceptions.ResourceNotFoundExceptionPrivate5G.Client.exceptions.ValidationExceptionPrivate5G.Client.exceptions.InternalServerExceptiondelete_network(**kwargs)¶Deletes the specified network. You must delete network sites before you delete the network. For more information, see DeleteNetworkSite in the API Reference for Amazon Web Services Private 5G .
See also: AWS API Documentation
Request Syntax
response = client.delete_network(
clientToken='string',
networkArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the network.
dict
Response Syntax
{
'network': {
'createdAt': datetime(2015, 1, 1),
'description': 'string',
'networkArn': 'string',
'networkName': 'string',
'status': 'CREATED'|'PROVISIONING'|'AVAILABLE'|'DEPROVISIONING'|'DELETED',
'statusReason': 'string'
}
}
Response Structure
(dict) --
network (dict) --
Information about the network.
createdAt (datetime) --
The creation time of the network.
description (string) --
The description of the network.
networkArn (string) --
The Amazon Resource Name (ARN) of the network.
networkName (string) --
The name of the network.
status (string) --
The status of the network.
statusReason (string) --
The status reason of the network.
Exceptions
Private5G.Client.exceptions.ResourceNotFoundExceptionPrivate5G.Client.exceptions.ValidationExceptionPrivate5G.Client.exceptions.InternalServerExceptiondelete_network_site(**kwargs)¶Deletes the specified network site. Return the hardware after you delete the network site. You are responsible for minimum charges. For more information, see Hardware returns in the Amazon Web Services Private 5G User Guide .
See also: AWS API Documentation
Request Syntax
response = client.delete_network_site(
clientToken='string',
networkSiteArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the network site.
dict
Response Syntax
{
'networkSite': {
'availabilityZone': 'string',
'availabilityZoneId': 'string',
'createdAt': datetime(2015, 1, 1),
'currentPlan': {
'options': [
{
'name': 'string',
'value': 'string'
},
],
'resourceDefinitions': [
{
'count': 123,
'options': [
{
'name': 'string',
'value': 'string'
},
],
'type': 'RADIO_UNIT'|'DEVICE_IDENTIFIER'
},
]
},
'description': 'string',
'networkArn': 'string',
'networkSiteArn': 'string',
'networkSiteName': 'string',
'pendingPlan': {
'options': [
{
'name': 'string',
'value': 'string'
},
],
'resourceDefinitions': [
{
'count': 123,
'options': [
{
'name': 'string',
'value': 'string'
},
],
'type': 'RADIO_UNIT'|'DEVICE_IDENTIFIER'
},
]
},
'status': 'CREATED'|'PROVISIONING'|'AVAILABLE'|'DEPROVISIONING'|'DELETED',
'statusReason': 'string'
}
}
Response Structure
(dict) --
networkSite (dict) --
Information about the network site.
availabilityZone (string) --
The parent Availability Zone for the network site.
availabilityZoneId (string) --
The parent Availability Zone ID for the network site.
createdAt (datetime) --
The creation time of the network site.
currentPlan (dict) --
The current plan of the network site.
options (list) --
The options of the plan.
(dict) --
Information about a name/value pair.
name (string) --
The name of the pair.
value (string) --
The value of the pair.
resourceDefinitions (list) --
The resource definitions of the plan.
(dict) --
Information about a network resource definition.
count (integer) --
The count in the network resource definition.
options (list) --
The options in the network resource definition.
(dict) --
Information about a name/value pair.
name (string) --
The name of the pair.
value (string) --
The value of the pair.
type (string) --
The type in the network resource definition.
description (string) --
The description of the network site.
networkArn (string) --
The Amazon Resource Name (ARN) of the network to which the network site belongs.
networkSiteArn (string) --
The Amazon Resource Name (ARN) of the network site.
networkSiteName (string) --
The name of the network site.
pendingPlan (dict) --
The pending plan of the network site.
options (list) --
The options of the plan.
(dict) --
Information about a name/value pair.
name (string) --
The name of the pair.
value (string) --
The value of the pair.
resourceDefinitions (list) --
The resource definitions of the plan.
(dict) --
Information about a network resource definition.
count (integer) --
The count in the network resource definition.
options (list) --
The options in the network resource definition.
(dict) --
Information about a name/value pair.
name (string) --
The name of the pair.
value (string) --
The value of the pair.
type (string) --
The type in the network resource definition.
status (string) --
The status of the network site.
statusReason (string) --
The status reason of the network site.
Exceptions
Private5G.Client.exceptions.ResourceNotFoundExceptionPrivate5G.Client.exceptions.ValidationExceptionPrivate5G.Client.exceptions.InternalServerExceptionget_device_identifier(**kwargs)¶Gets the specified device identifier.
See also: AWS API Documentation
Request Syntax
response = client.get_device_identifier(
deviceIdentifierArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the device identifier.
{
'deviceIdentifier': {
'createdAt': datetime(2015, 1, 1),
'deviceIdentifierArn': 'string',
'iccid': 'string',
'imsi': 'string',
'networkArn': 'string',
'orderArn': 'string',
'status': 'ACTIVE'|'INACTIVE',
'trafficGroupArn': 'string',
'vendor': 'string'
},
'tags': {
'string': 'string'
}
}
Response Structure
Information about the device identifier.
The creation time of this device identifier.
The Amazon Resource Name (ARN) of the device identifier.
The Integrated Circuit Card Identifier of the device identifier.
The International Mobile Subscriber Identity of the device identifier.
The Amazon Resource Name (ARN) of the network on which the device identifier appears.
The Amazon Resource Name (ARN) of the order used to purchase the device identifier.
The status of the device identifier.
The Amazon Resource Name (ARN) of the traffic group to which the device identifier belongs.
The vendor of the device identifier.
The device identifier tags.
Exceptions
Private5G.Client.exceptions.ResourceNotFoundExceptionPrivate5G.Client.exceptions.ValidationExceptionPrivate5G.Client.exceptions.InternalServerExceptionget_network(**kwargs)¶Gets the specified network.
See also: AWS API Documentation
Request Syntax
response = client.get_network(
networkArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the network.
{
'network': {
'createdAt': datetime(2015, 1, 1),
'description': 'string',
'networkArn': 'string',
'networkName': 'string',
'status': 'CREATED'|'PROVISIONING'|'AVAILABLE'|'DEPROVISIONING'|'DELETED',
'statusReason': 'string'
},
'tags': {
'string': 'string'
}
}
Response Structure
Information about the network.
The creation time of the network.
The description of the network.
The Amazon Resource Name (ARN) of the network.
The name of the network.
The status of the network.
The status reason of the network.
The network tags.
Exceptions
Private5G.Client.exceptions.ResourceNotFoundExceptionPrivate5G.Client.exceptions.ValidationExceptionPrivate5G.Client.exceptions.InternalServerExceptionget_network_resource(**kwargs)¶Gets the specified network resource.
See also: AWS API Documentation
Request Syntax
response = client.get_network_resource(
networkResourceArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the network resource.
{
'networkResource': {
'attributes': [
{
'name': 'string',
'value': 'string'
},
],
'createdAt': datetime(2015, 1, 1),
'description': 'string',
'health': 'INITIAL'|'HEALTHY'|'UNHEALTHY',
'model': 'string',
'networkArn': 'string',
'networkResourceArn': 'string',
'networkSiteArn': 'string',
'orderArn': 'string',
'position': {
'elevation': 123.0,
'elevationReference': 'AGL'|'AMSL',
'elevationUnit': 'FEET',
'latitude': 123.0,
'longitude': 123.0
},
'serialNumber': 'string',
'status': 'PENDING'|'SHIPPED'|'PROVISIONING'|'PROVISIONED'|'AVAILABLE'|'DELETING'|'PENDING_RETURN'|'DELETED',
'statusReason': 'string',
'type': 'RADIO_UNIT',
'vendor': 'string'
},
'tags': {
'string': 'string'
}
}
Response Structure
Information about the network resource.
The attributes of the network resource.
Information about a name/value pair.
The name of the pair.
The value of the pair.
The creation time of the network resource.
The description of the network resource.
The health of the network resource.
The model of the network resource.
The Amazon Resource Name (ARN) of the network on which this network resource appears.
The Amazon Resource Name (ARN) of the network resource.
The Amazon Resource Name (ARN) of the network site on which this network resource appears.
The Amazon Resource Name (ARN) of the order used to purchase this network resource.
The position of the network resource.
The elevation of the equipment at this position.
The reference point from which elevation is reported.
The units used to measure the elevation of the position.
The latitude of the position.
The longitude of the position.
The serial number of the network resource.
The status of the network resource.
The status reason of the network resource.
The type of the network resource.
The vendor of the network resource.
The network resource tags.
Exceptions
Private5G.Client.exceptions.ResourceNotFoundExceptionPrivate5G.Client.exceptions.ValidationExceptionPrivate5G.Client.exceptions.InternalServerExceptionget_network_site(**kwargs)¶Gets the specified network site.
See also: AWS API Documentation
Request Syntax
response = client.get_network_site(
networkSiteArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the network site.
{
'networkSite': {
'availabilityZone': 'string',
'availabilityZoneId': 'string',
'createdAt': datetime(2015, 1, 1),
'currentPlan': {
'options': [
{
'name': 'string',
'value': 'string'
},
],
'resourceDefinitions': [
{
'count': 123,
'options': [
{
'name': 'string',
'value': 'string'
},
],
'type': 'RADIO_UNIT'|'DEVICE_IDENTIFIER'
},
]
},
'description': 'string',
'networkArn': 'string',
'networkSiteArn': 'string',
'networkSiteName': 'string',
'pendingPlan': {
'options': [
{
'name': 'string',
'value': 'string'
},
],
'resourceDefinitions': [
{
'count': 123,
'options': [
{
'name': 'string',
'value': 'string'
},
],
'type': 'RADIO_UNIT'|'DEVICE_IDENTIFIER'
},
]
},
'status': 'CREATED'|'PROVISIONING'|'AVAILABLE'|'DEPROVISIONING'|'DELETED',
'statusReason': 'string'
},
'tags': {
'string': 'string'
}
}
Response Structure
Information about the network site.
The parent Availability Zone for the network site.
The parent Availability Zone ID for the network site.
The creation time of the network site.
The current plan of the network site.
The options of the plan.
Information about a name/value pair.
The name of the pair.
The value of the pair.
The resource definitions of the plan.
Information about a network resource definition.
The count in the network resource definition.
The options in the network resource definition.
Information about a name/value pair.
The name of the pair.
The value of the pair.
The type in the network resource definition.
The description of the network site.
The Amazon Resource Name (ARN) of the network to which the network site belongs.
The Amazon Resource Name (ARN) of the network site.
The name of the network site.
The pending plan of the network site.
The options of the plan.
Information about a name/value pair.
The name of the pair.
The value of the pair.
The resource definitions of the plan.
Information about a network resource definition.
The count in the network resource definition.
The options in the network resource definition.
Information about a name/value pair.
The name of the pair.
The value of the pair.
The type in the network resource definition.
The status of the network site.
The status reason of the network site.
The network site tags.
Exceptions
Private5G.Client.exceptions.ResourceNotFoundExceptionPrivate5G.Client.exceptions.ValidationExceptionPrivate5G.Client.exceptions.InternalServerExceptionget_order(**kwargs)¶Gets the specified order.
See also: AWS API Documentation
Request Syntax
response = client.get_order(
orderArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the order.
{
'order': {
'acknowledgmentStatus': 'ACKNOWLEDGING'|'ACKNOWLEDGED'|'UNACKNOWLEDGED',
'createdAt': datetime(2015, 1, 1),
'networkArn': 'string',
'networkSiteArn': 'string',
'orderArn': 'string',
'shippingAddress': {
'city': 'string',
'company': 'string',
'country': 'string',
'name': 'string',
'phoneNumber': 'string',
'postalCode': 'string',
'stateOrProvince': 'string',
'street1': 'string',
'street2': 'string',
'street3': 'string'
},
'trackingInformation': [
{
'trackingNumber': 'string'
},
]
},
'tags': {
'string': 'string'
}
}
Response Structure
Information about the order.
The acknowledgement status of the order.
The creation time of the order.
The Amazon Resource Name (ARN) of the network associated with this order.
The Amazon Resource Name (ARN) of the network site associated with this order.
The Amazon Resource Name (ARN) of the order.
The shipping address of the order.
The city for this address.
The company name for this address.
The country for this address.
The recipient's name for this address.
The phone number for this address.
The postal code for this address.
The state or province for this address.
The first line of the street address.
The second line of the street address.
The third line of the street address.
The tracking information of the order.
Information about tracking a shipment.
The tracking number of the shipment.
The order tags.
Exceptions
Private5G.Client.exceptions.ResourceNotFoundExceptionPrivate5G.Client.exceptions.ValidationExceptionPrivate5G.Client.exceptions.InternalServerExceptionget_paginator(operation_name)¶Create a paginator for an operation.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").client.can_paginate method to
check if an operation is pageable.get_waiter(waiter_name)¶Returns an object that can wait for some condition.
list_device_identifiers(**kwargs)¶Lists device identifiers. Add filters to your request to return a more specific list of results. Use filters to match the Amazon Resource Name (ARN) of an order, the status of device identifiers, or the ARN of the traffic group.
<p>If you specify multiple filters, filters are joined with an OR, and the request
returns results that match all of the specified filters.
See also: AWS API Documentation
Request Syntax
response = client.list_device_identifiers(
filters={
'string': [
'string',
]
},
maxResults=123,
networkArn='string',
startToken='string'
)
The filters.
ORDER - The Amazon Resource Name (ARN) of the order.STATUS - The status (ACTIVE | INACTIVE ).TRAFFIC_GROUP - The Amazon Resource Name (ARN) of the traffic group.Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR , and the request returns all results that match any of the specified values.
[REQUIRED]
The Amazon Resource Name (ARN) of the network.
dict
Response Syntax
{
'deviceIdentifiers': [
{
'createdAt': datetime(2015, 1, 1),
'deviceIdentifierArn': 'string',
'iccid': 'string',
'imsi': 'string',
'networkArn': 'string',
'orderArn': 'string',
'status': 'ACTIVE'|'INACTIVE',
'trafficGroupArn': 'string',
'vendor': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
deviceIdentifiers (list) --
Information about the device identifiers.
(dict) --
Information about a subscriber of a device that can use a network.
createdAt (datetime) --
The creation time of this device identifier.
deviceIdentifierArn (string) --
The Amazon Resource Name (ARN) of the device identifier.
iccid (string) --
The Integrated Circuit Card Identifier of the device identifier.
imsi (string) --
The International Mobile Subscriber Identity of the device identifier.
networkArn (string) --
The Amazon Resource Name (ARN) of the network on which the device identifier appears.
orderArn (string) --
The Amazon Resource Name (ARN) of the order used to purchase the device identifier.
status (string) --
The status of the device identifier.
trafficGroupArn (string) --
The Amazon Resource Name (ARN) of the traffic group to which the device identifier belongs.
vendor (string) --
The vendor of the device identifier.
nextToken (string) --
The token for the next page of results.
Exceptions
Private5G.Client.exceptions.ResourceNotFoundExceptionPrivate5G.Client.exceptions.ValidationExceptionPrivate5G.Client.exceptions.InternalServerExceptionlist_network_resources(**kwargs)¶Lists network resources. Add filters to your request to return a more specific list of results. Use filters to match the Amazon Resource Name (ARN) of an order or the status of network resources.
If you specify multiple filters, filters are joined with an OR, and the request returns results that match all of the specified filters.
See also: AWS API Documentation
Request Syntax
response = client.list_network_resources(
filters={
'string': [
'string',
]
},
maxResults=123,
networkArn='string',
startToken='string'
)
The filters.
ORDER - The Amazon Resource Name (ARN) of the order.STATUS - The status (AVAILABLE | DELETED | DELETING | PENDING | PENDING_RETURN | PROVISIONING | SHIPPED ).Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR , and the request returns all results that match any of the specified values.
[REQUIRED]
The Amazon Resource Name (ARN) of the network.
dict
Response Syntax
{
'networkResources': [
{
'attributes': [
{
'name': 'string',
'value': 'string'
},
],
'createdAt': datetime(2015, 1, 1),
'description': 'string',
'health': 'INITIAL'|'HEALTHY'|'UNHEALTHY',
'model': 'string',
'networkArn': 'string',
'networkResourceArn': 'string',
'networkSiteArn': 'string',
'orderArn': 'string',
'position': {
'elevation': 123.0,
'elevationReference': 'AGL'|'AMSL',
'elevationUnit': 'FEET',
'latitude': 123.0,
'longitude': 123.0
},
'serialNumber': 'string',
'status': 'PENDING'|'SHIPPED'|'PROVISIONING'|'PROVISIONED'|'AVAILABLE'|'DELETING'|'PENDING_RETURN'|'DELETED',
'statusReason': 'string',
'type': 'RADIO_UNIT',
'vendor': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
networkResources (list) --
Information about network resources.
(dict) --
Information about a network resource.
attributes (list) --
The attributes of the network resource.
(dict) --
Information about a name/value pair.
name (string) --
The name of the pair.
value (string) --
The value of the pair.
createdAt (datetime) --
The creation time of the network resource.
description (string) --
The description of the network resource.
health (string) --
The health of the network resource.
model (string) --
The model of the network resource.
networkArn (string) --
The Amazon Resource Name (ARN) of the network on which this network resource appears.
networkResourceArn (string) --
The Amazon Resource Name (ARN) of the network resource.
networkSiteArn (string) --
The Amazon Resource Name (ARN) of the network site on which this network resource appears.
orderArn (string) --
The Amazon Resource Name (ARN) of the order used to purchase this network resource.
position (dict) --
The position of the network resource.
elevation (float) --
The elevation of the equipment at this position.
elevationReference (string) --
The reference point from which elevation is reported.
elevationUnit (string) --
The units used to measure the elevation of the position.
latitude (float) --
The latitude of the position.
longitude (float) --
The longitude of the position.
serialNumber (string) --
The serial number of the network resource.
status (string) --
The status of the network resource.
statusReason (string) --
The status reason of the network resource.
type (string) --
The type of the network resource.
vendor (string) --
The vendor of the network resource.
nextToken (string) --
The token for the next page of results.
Exceptions
Private5G.Client.exceptions.ResourceNotFoundExceptionPrivate5G.Client.exceptions.ValidationExceptionPrivate5G.Client.exceptions.InternalServerExceptionlist_network_sites(**kwargs)¶Lists network sites. Add filters to your request to return a more specific list of results. Use filters to match the status of the network site.
See also: AWS API Documentation
Request Syntax
response = client.list_network_sites(
filters={
'string': [
'string',
]
},
maxResults=123,
networkArn='string',
startToken='string'
)
The filters. Add filters to your request to return a more specific list of results. Use filters to match the status of the network sites.
STATUS - The status (AVAILABLE | CREATED | DELETED | DEPROVISIONING | PROVISIONING ).Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR , and the request returns all results that match any of the specified values.
[REQUIRED]
The Amazon Resource Name (ARN) of the network.
dict
Response Syntax
{
'networkSites': [
{
'availabilityZone': 'string',
'availabilityZoneId': 'string',
'createdAt': datetime(2015, 1, 1),
'currentPlan': {
'options': [
{
'name': 'string',
'value': 'string'
},
],
'resourceDefinitions': [
{
'count': 123,
'options': [
{
'name': 'string',
'value': 'string'
},
],
'type': 'RADIO_UNIT'|'DEVICE_IDENTIFIER'
},
]
},
'description': 'string',
'networkArn': 'string',
'networkSiteArn': 'string',
'networkSiteName': 'string',
'pendingPlan': {
'options': [
{
'name': 'string',
'value': 'string'
},
],
'resourceDefinitions': [
{
'count': 123,
'options': [
{
'name': 'string',
'value': 'string'
},
],
'type': 'RADIO_UNIT'|'DEVICE_IDENTIFIER'
},
]
},
'status': 'CREATED'|'PROVISIONING'|'AVAILABLE'|'DEPROVISIONING'|'DELETED',
'statusReason': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
networkSites (list) --
Information about the network sites.
(dict) --
Information about a network site.
availabilityZone (string) --
The parent Availability Zone for the network site.
availabilityZoneId (string) --
The parent Availability Zone ID for the network site.
createdAt (datetime) --
The creation time of the network site.
currentPlan (dict) --
The current plan of the network site.
options (list) --
The options of the plan.
(dict) --
Information about a name/value pair.
name (string) --
The name of the pair.
value (string) --
The value of the pair.
resourceDefinitions (list) --
The resource definitions of the plan.
(dict) --
Information about a network resource definition.
count (integer) --
The count in the network resource definition.
options (list) --
The options in the network resource definition.
(dict) --
Information about a name/value pair.
name (string) --
The name of the pair.
value (string) --
The value of the pair.
type (string) --
The type in the network resource definition.
description (string) --
The description of the network site.
networkArn (string) --
The Amazon Resource Name (ARN) of the network to which the network site belongs.
networkSiteArn (string) --
The Amazon Resource Name (ARN) of the network site.
networkSiteName (string) --
The name of the network site.
pendingPlan (dict) --
The pending plan of the network site.
options (list) --
The options of the plan.
(dict) --
Information about a name/value pair.
name (string) --
The name of the pair.
value (string) --
The value of the pair.
resourceDefinitions (list) --
The resource definitions of the plan.
(dict) --
Information about a network resource definition.
count (integer) --
The count in the network resource definition.
options (list) --
The options in the network resource definition.
(dict) --
Information about a name/value pair.
name (string) --
The name of the pair.
value (string) --
The value of the pair.
type (string) --
The type in the network resource definition.
status (string) --
The status of the network site.
statusReason (string) --
The status reason of the network site.
nextToken (string) --
The token for the next page of results.
Exceptions
Private5G.Client.exceptions.ResourceNotFoundExceptionPrivate5G.Client.exceptions.ValidationExceptionPrivate5G.Client.exceptions.InternalServerExceptionlist_networks(**kwargs)¶Lists networks. Add filters to your request to return a more specific list of results. Use filters to match the status of the network.
See also: AWS API Documentation
Request Syntax
response = client.list_networks(
filters={
'string': [
'string',
]
},
maxResults=123,
startToken='string'
)
The filters.
STATUS - The status (AVAILABLE | CREATED | DELETED | DEPROVISIONING | PROVISIONING ).Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR , and the request returns all results that match any of the specified values.
dict
Response Syntax
{
'networks': [
{
'createdAt': datetime(2015, 1, 1),
'description': 'string',
'networkArn': 'string',
'networkName': 'string',
'status': 'CREATED'|'PROVISIONING'|'AVAILABLE'|'DEPROVISIONING'|'DELETED',
'statusReason': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
networks (list) --
The networks.
(dict) --
Information about a network.
createdAt (datetime) --
The creation time of the network.
description (string) --
The description of the network.
networkArn (string) --
The Amazon Resource Name (ARN) of the network.
networkName (string) --
The name of the network.
status (string) --
The status of the network.
statusReason (string) --
The status reason of the network.
nextToken (string) --
The token for the next page of results.
Exceptions
Private5G.Client.exceptions.ResourceNotFoundExceptionPrivate5G.Client.exceptions.ValidationExceptionPrivate5G.Client.exceptions.InternalServerExceptionlist_orders(**kwargs)¶Lists orders. Add filters to your request to return a more specific list of results. Use filters to match the Amazon Resource Name (ARN) of the network site or the status of the order.
If you specify multiple filters, filters are joined with an OR, and the request returns results that match all of the specified filters.
See also: AWS API Documentation
Request Syntax
response = client.list_orders(
filters={
'string': [
'string',
]
},
maxResults=123,
networkArn='string',
startToken='string'
)
The filters.
NETWORK_SITE - The Amazon Resource Name (ARN) of the network site.STATUS - The status (ACKNOWLEDGING | ACKNOWLEDGED | UNACKNOWLEDGED ).Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR , and the request returns all results that match any of the specified values.
[REQUIRED]
The Amazon Resource Name (ARN) of the network.
dict
Response Syntax
{
'nextToken': 'string',
'orders': [
{
'acknowledgmentStatus': 'ACKNOWLEDGING'|'ACKNOWLEDGED'|'UNACKNOWLEDGED',
'createdAt': datetime(2015, 1, 1),
'networkArn': 'string',
'networkSiteArn': 'string',
'orderArn': 'string',
'shippingAddress': {
'city': 'string',
'company': 'string',
'country': 'string',
'name': 'string',
'phoneNumber': 'string',
'postalCode': 'string',
'stateOrProvince': 'string',
'street1': 'string',
'street2': 'string',
'street3': 'string'
},
'trackingInformation': [
{
'trackingNumber': 'string'
},
]
},
]
}
Response Structure
(dict) --
nextToken (string) --
The token for the next page of results.
orders (list) --
Information about the orders.
(dict) --
Information about an order.
acknowledgmentStatus (string) --
The acknowledgement status of the order.
createdAt (datetime) --
The creation time of the order.
networkArn (string) --
The Amazon Resource Name (ARN) of the network associated with this order.
networkSiteArn (string) --
The Amazon Resource Name (ARN) of the network site associated with this order.
orderArn (string) --
The Amazon Resource Name (ARN) of the order.
shippingAddress (dict) --
The shipping address of the order.
city (string) --
The city for this address.
company (string) --
The company name for this address.
country (string) --
The country for this address.
name (string) --
The recipient's name for this address.
phoneNumber (string) --
The phone number for this address.
postalCode (string) --
The postal code for this address.
stateOrProvince (string) --
The state or province for this address.
street1 (string) --
The first line of the street address.
street2 (string) --
The second line of the street address.
street3 (string) --
The third line of the street address.
trackingInformation (list) --
The tracking information of the order.
(dict) --
Information about tracking a shipment.
trackingNumber (string) --
The tracking number of the shipment.
Exceptions
Private5G.Client.exceptions.ResourceNotFoundExceptionPrivate5G.Client.exceptions.ValidationExceptionPrivate5G.Client.exceptions.InternalServerExceptionLists the tags for the specified resource.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
resourceArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource.
{
'tags': {
'string': 'string'
}
}
Response Structure
The resource tags.
Exceptions
Private5G.Client.exceptions.ResourceNotFoundExceptionPrivate5G.Client.exceptions.AccessDeniedExceptionPrivate5G.Client.exceptions.ValidationExceptionPrivate5G.Client.exceptions.InternalServerExceptionPrivate5G.Client.exceptions.ThrottlingExceptionping()¶Checks the health of the service.
See also: AWS API Documentation
Request Syntax
response = client.ping()
{
'status': 'string'
}
Response Structure
Information about the health of the service.
Exceptions
Private5G.Client.exceptions.InternalServerExceptiontag_resource(**kwargs)¶Adds tags to the specified resource.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
resourceArn='string',
tags={
'string': 'string'
}
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource.
[REQUIRED]
The tags to add to the resource.
dict
Response Syntax
{}
Response Structure
Exceptions
Private5G.Client.exceptions.ResourceNotFoundExceptionPrivate5G.Client.exceptions.AccessDeniedExceptionPrivate5G.Client.exceptions.ValidationExceptionPrivate5G.Client.exceptions.InternalServerExceptionPrivate5G.Client.exceptions.ThrottlingExceptionuntag_resource(**kwargs)¶Removes tags from the specified resource.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
resourceArn='string',
tagKeys=[
'string',
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource.
[REQUIRED]
The tag keys.
dict
Response Syntax
{}
Response Structure
Exceptions
Private5G.Client.exceptions.ResourceNotFoundExceptionPrivate5G.Client.exceptions.AccessDeniedExceptionPrivate5G.Client.exceptions.ValidationExceptionPrivate5G.Client.exceptions.InternalServerExceptionPrivate5G.Client.exceptions.ThrottlingExceptionupdate_network_site(**kwargs)¶Updates the specified network site.
See also: AWS API Documentation
Request Syntax
response = client.update_network_site(
clientToken='string',
description='string',
networkSiteArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the network site.
dict
Response Syntax
{
'networkSite': {
'availabilityZone': 'string',
'availabilityZoneId': 'string',
'createdAt': datetime(2015, 1, 1),
'currentPlan': {
'options': [
{
'name': 'string',
'value': 'string'
},
],
'resourceDefinitions': [
{
'count': 123,
'options': [
{
'name': 'string',
'value': 'string'
},
],
'type': 'RADIO_UNIT'|'DEVICE_IDENTIFIER'
},
]
},
'description': 'string',
'networkArn': 'string',
'networkSiteArn': 'string',
'networkSiteName': 'string',
'pendingPlan': {
'options': [
{
'name': 'string',
'value': 'string'
},
],
'resourceDefinitions': [
{
'count': 123,
'options': [
{
'name': 'string',
'value': 'string'
},
],
'type': 'RADIO_UNIT'|'DEVICE_IDENTIFIER'
},
]
},
'status': 'CREATED'|'PROVISIONING'|'AVAILABLE'|'DEPROVISIONING'|'DELETED',
'statusReason': 'string'
},
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
networkSite (dict) --
Information about the network site.
availabilityZone (string) --
The parent Availability Zone for the network site.
availabilityZoneId (string) --
The parent Availability Zone ID for the network site.
createdAt (datetime) --
The creation time of the network site.
currentPlan (dict) --
The current plan of the network site.
options (list) --
The options of the plan.
(dict) --
Information about a name/value pair.
name (string) --
The name of the pair.
value (string) --
The value of the pair.
resourceDefinitions (list) --
The resource definitions of the plan.
(dict) --
Information about a network resource definition.
count (integer) --
The count in the network resource definition.
options (list) --
The options in the network resource definition.
(dict) --
Information about a name/value pair.
name (string) --
The name of the pair.
value (string) --
The value of the pair.
type (string) --
The type in the network resource definition.
description (string) --
The description of the network site.
networkArn (string) --
The Amazon Resource Name (ARN) of the network to which the network site belongs.
networkSiteArn (string) --
The Amazon Resource Name (ARN) of the network site.
networkSiteName (string) --
The name of the network site.
pendingPlan (dict) --
The pending plan of the network site.
options (list) --
The options of the plan.
(dict) --
Information about a name/value pair.
name (string) --
The name of the pair.
value (string) --
The value of the pair.
resourceDefinitions (list) --
The resource definitions of the plan.
(dict) --
Information about a network resource definition.
count (integer) --
The count in the network resource definition.
options (list) --
The options in the network resource definition.
(dict) --
Information about a name/value pair.
name (string) --
The name of the pair.
value (string) --
The value of the pair.
type (string) --
The type in the network resource definition.
status (string) --
The status of the network site.
statusReason (string) --
The status reason of the network site.
tags (dict) --
The network site tags.
Exceptions
Private5G.Client.exceptions.ResourceNotFoundExceptionPrivate5G.Client.exceptions.ValidationExceptionPrivate5G.Client.exceptions.InternalServerExceptionupdate_network_site_plan(**kwargs)¶Updates the specified network site plan.
See also: AWS API Documentation
Request Syntax
response = client.update_network_site_plan(
clientToken='string',
networkSiteArn='string',
pendingPlan={
'options': [
{
'name': 'string',
'value': 'string'
},
],
'resourceDefinitions': [
{
'count': 123,
'options': [
{
'name': 'string',
'value': 'string'
},
],
'type': 'RADIO_UNIT'|'DEVICE_IDENTIFIER'
},
]
}
)
[REQUIRED]
The Amazon Resource Name (ARN) of the network site.
[REQUIRED]
The pending plan.
The options of the plan.
Information about a name/value pair.
The name of the pair.
The value of the pair.
The resource definitions of the plan.
Information about a network resource definition.
The count in the network resource definition.
The options in the network resource definition.
Information about a name/value pair.
The name of the pair.
The value of the pair.
The type in the network resource definition.
dict
Response Syntax
{
'networkSite': {
'availabilityZone': 'string',
'availabilityZoneId': 'string',
'createdAt': datetime(2015, 1, 1),
'currentPlan': {
'options': [
{
'name': 'string',
'value': 'string'
},
],
'resourceDefinitions': [
{
'count': 123,
'options': [
{
'name': 'string',
'value': 'string'
},
],
'type': 'RADIO_UNIT'|'DEVICE_IDENTIFIER'
},
]
},
'description': 'string',
'networkArn': 'string',
'networkSiteArn': 'string',
'networkSiteName': 'string',
'pendingPlan': {
'options': [
{
'name': 'string',
'value': 'string'
},
],
'resourceDefinitions': [
{
'count': 123,
'options': [
{
'name': 'string',
'value': 'string'
},
],
'type': 'RADIO_UNIT'|'DEVICE_IDENTIFIER'
},
]
},
'status': 'CREATED'|'PROVISIONING'|'AVAILABLE'|'DEPROVISIONING'|'DELETED',
'statusReason': 'string'
},
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
networkSite (dict) --
Information about the network site.
availabilityZone (string) --
The parent Availability Zone for the network site.
availabilityZoneId (string) --
The parent Availability Zone ID for the network site.
createdAt (datetime) --
The creation time of the network site.
currentPlan (dict) --
The current plan of the network site.
options (list) --
The options of the plan.
(dict) --
Information about a name/value pair.
name (string) --
The name of the pair.
value (string) --
The value of the pair.
resourceDefinitions (list) --
The resource definitions of the plan.
(dict) --
Information about a network resource definition.
count (integer) --
The count in the network resource definition.
options (list) --
The options in the network resource definition.
(dict) --
Information about a name/value pair.
name (string) --
The name of the pair.
value (string) --
The value of the pair.
type (string) --
The type in the network resource definition.
description (string) --
The description of the network site.
networkArn (string) --
The Amazon Resource Name (ARN) of the network to which the network site belongs.
networkSiteArn (string) --
The Amazon Resource Name (ARN) of the network site.
networkSiteName (string) --
The name of the network site.
pendingPlan (dict) --
The pending plan of the network site.
options (list) --
The options of the plan.
(dict) --
Information about a name/value pair.
name (string) --
The name of the pair.
value (string) --
The value of the pair.
resourceDefinitions (list) --
The resource definitions of the plan.
(dict) --
Information about a network resource definition.
count (integer) --
The count in the network resource definition.
options (list) --
The options in the network resource definition.
(dict) --
Information about a name/value pair.
name (string) --
The name of the pair.
value (string) --
The value of the pair.
type (string) --
The type in the network resource definition.
status (string) --
The status of the network site.
statusReason (string) --
The status reason of the network site.
tags (dict) --
The network site tags.
Exceptions
Private5G.Client.exceptions.ResourceNotFoundExceptionPrivate5G.Client.exceptions.ValidationExceptionPrivate5G.Client.exceptions.InternalServerExceptionThe available paginators are:
Private5G.Paginator.ListDeviceIdentifiersPrivate5G.Paginator.ListNetworkResourcesPrivate5G.Paginator.ListNetworkSitesPrivate5G.Paginator.ListNetworksPrivate5G.Paginator.ListOrdersPrivate5G.Paginator.ListDeviceIdentifiers¶paginator = client.get_paginator('list_device_identifiers')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Private5G.Client.list_device_identifiers().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
filters={
'string': [
'string',
]
},
networkArn='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The filters.
ORDER - The Amazon Resource Name (ARN) of the order.STATUS - The status (ACTIVE | INACTIVE ).TRAFFIC_GROUP - The Amazon Resource Name (ARN) of the traffic group.Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR , and the request returns all results that match any of the specified values.
[REQUIRED]
The Amazon Resource Name (ARN) of the network.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'deviceIdentifiers': [
{
'createdAt': datetime(2015, 1, 1),
'deviceIdentifierArn': 'string',
'iccid': 'string',
'imsi': 'string',
'networkArn': 'string',
'orderArn': 'string',
'status': 'ACTIVE'|'INACTIVE',
'trafficGroupArn': 'string',
'vendor': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
deviceIdentifiers (list) --
Information about the device identifiers.
(dict) --
Information about a subscriber of a device that can use a network.
createdAt (datetime) --
The creation time of this device identifier.
deviceIdentifierArn (string) --
The Amazon Resource Name (ARN) of the device identifier.
iccid (string) --
The Integrated Circuit Card Identifier of the device identifier.
imsi (string) --
The International Mobile Subscriber Identity of the device identifier.
networkArn (string) --
The Amazon Resource Name (ARN) of the network on which the device identifier appears.
orderArn (string) --
The Amazon Resource Name (ARN) of the order used to purchase the device identifier.
status (string) --
The status of the device identifier.
trafficGroupArn (string) --
The Amazon Resource Name (ARN) of the traffic group to which the device identifier belongs.
vendor (string) --
The vendor of the device identifier.
NextToken (string) --
A token to resume pagination.
Private5G.Paginator.ListNetworkResources¶paginator = client.get_paginator('list_network_resources')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Private5G.Client.list_network_resources().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
filters={
'string': [
'string',
]
},
networkArn='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The filters.
ORDER - The Amazon Resource Name (ARN) of the order.STATUS - The status (AVAILABLE | DELETED | DELETING | PENDING | PENDING_RETURN | PROVISIONING | SHIPPED ).Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR , and the request returns all results that match any of the specified values.
[REQUIRED]
The Amazon Resource Name (ARN) of the network.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'networkResources': [
{
'attributes': [
{
'name': 'string',
'value': 'string'
},
],
'createdAt': datetime(2015, 1, 1),
'description': 'string',
'health': 'INITIAL'|'HEALTHY'|'UNHEALTHY',
'model': 'string',
'networkArn': 'string',
'networkResourceArn': 'string',
'networkSiteArn': 'string',
'orderArn': 'string',
'position': {
'elevation': 123.0,
'elevationReference': 'AGL'|'AMSL',
'elevationUnit': 'FEET',
'latitude': 123.0,
'longitude': 123.0
},
'serialNumber': 'string',
'status': 'PENDING'|'SHIPPED'|'PROVISIONING'|'PROVISIONED'|'AVAILABLE'|'DELETING'|'PENDING_RETURN'|'DELETED',
'statusReason': 'string',
'type': 'RADIO_UNIT',
'vendor': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
networkResources (list) --
Information about network resources.
(dict) --
Information about a network resource.
attributes (list) --
The attributes of the network resource.
(dict) --
Information about a name/value pair.
name (string) --
The name of the pair.
value (string) --
The value of the pair.
createdAt (datetime) --
The creation time of the network resource.
description (string) --
The description of the network resource.
health (string) --
The health of the network resource.
model (string) --
The model of the network resource.
networkArn (string) --
The Amazon Resource Name (ARN) of the network on which this network resource appears.
networkResourceArn (string) --
The Amazon Resource Name (ARN) of the network resource.
networkSiteArn (string) --
The Amazon Resource Name (ARN) of the network site on which this network resource appears.
orderArn (string) --
The Amazon Resource Name (ARN) of the order used to purchase this network resource.
position (dict) --
The position of the network resource.
elevation (float) --
The elevation of the equipment at this position.
elevationReference (string) --
The reference point from which elevation is reported.
elevationUnit (string) --
The units used to measure the elevation of the position.
latitude (float) --
The latitude of the position.
longitude (float) --
The longitude of the position.
serialNumber (string) --
The serial number of the network resource.
status (string) --
The status of the network resource.
statusReason (string) --
The status reason of the network resource.
type (string) --
The type of the network resource.
vendor (string) --
The vendor of the network resource.
NextToken (string) --
A token to resume pagination.
Private5G.Paginator.ListNetworkSites¶paginator = client.get_paginator('list_network_sites')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Private5G.Client.list_network_sites().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
filters={
'string': [
'string',
]
},
networkArn='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The filters. Add filters to your request to return a more specific list of results. Use filters to match the status of the network sites.
STATUS - The status (AVAILABLE | CREATED | DELETED | DEPROVISIONING | PROVISIONING ).Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR , and the request returns all results that match any of the specified values.
[REQUIRED]
The Amazon Resource Name (ARN) of the network.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'networkSites': [
{
'availabilityZone': 'string',
'availabilityZoneId': 'string',
'createdAt': datetime(2015, 1, 1),
'currentPlan': {
'options': [
{
'name': 'string',
'value': 'string'
},
],
'resourceDefinitions': [
{
'count': 123,
'options': [
{
'name': 'string',
'value': 'string'
},
],
'type': 'RADIO_UNIT'|'DEVICE_IDENTIFIER'
},
]
},
'description': 'string',
'networkArn': 'string',
'networkSiteArn': 'string',
'networkSiteName': 'string',
'pendingPlan': {
'options': [
{
'name': 'string',
'value': 'string'
},
],
'resourceDefinitions': [
{
'count': 123,
'options': [
{
'name': 'string',
'value': 'string'
},
],
'type': 'RADIO_UNIT'|'DEVICE_IDENTIFIER'
},
]
},
'status': 'CREATED'|'PROVISIONING'|'AVAILABLE'|'DEPROVISIONING'|'DELETED',
'statusReason': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
networkSites (list) --
Information about the network sites.
(dict) --
Information about a network site.
availabilityZone (string) --
The parent Availability Zone for the network site.
availabilityZoneId (string) --
The parent Availability Zone ID for the network site.
createdAt (datetime) --
The creation time of the network site.
currentPlan (dict) --
The current plan of the network site.
options (list) --
The options of the plan.
(dict) --
Information about a name/value pair.
name (string) --
The name of the pair.
value (string) --
The value of the pair.
resourceDefinitions (list) --
The resource definitions of the plan.
(dict) --
Information about a network resource definition.
count (integer) --
The count in the network resource definition.
options (list) --
The options in the network resource definition.
(dict) --
Information about a name/value pair.
name (string) --
The name of the pair.
value (string) --
The value of the pair.
type (string) --
The type in the network resource definition.
description (string) --
The description of the network site.
networkArn (string) --
The Amazon Resource Name (ARN) of the network to which the network site belongs.
networkSiteArn (string) --
The Amazon Resource Name (ARN) of the network site.
networkSiteName (string) --
The name of the network site.
pendingPlan (dict) --
The pending plan of the network site.
options (list) --
The options of the plan.
(dict) --
Information about a name/value pair.
name (string) --
The name of the pair.
value (string) --
The value of the pair.
resourceDefinitions (list) --
The resource definitions of the plan.
(dict) --
Information about a network resource definition.
count (integer) --
The count in the network resource definition.
options (list) --
The options in the network resource definition.
(dict) --
Information about a name/value pair.
name (string) --
The name of the pair.
value (string) --
The value of the pair.
type (string) --
The type in the network resource definition.
status (string) --
The status of the network site.
statusReason (string) --
The status reason of the network site.
NextToken (string) --
A token to resume pagination.
Private5G.Paginator.ListNetworks¶paginator = client.get_paginator('list_networks')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Private5G.Client.list_networks().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
filters={
'string': [
'string',
]
},
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The filters.
STATUS - The status (AVAILABLE | CREATED | DELETED | DEPROVISIONING | PROVISIONING ).Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR , and the request returns all results that match any of the specified values.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'networks': [
{
'createdAt': datetime(2015, 1, 1),
'description': 'string',
'networkArn': 'string',
'networkName': 'string',
'status': 'CREATED'|'PROVISIONING'|'AVAILABLE'|'DEPROVISIONING'|'DELETED',
'statusReason': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
networks (list) --
The networks.
(dict) --
Information about a network.
createdAt (datetime) --
The creation time of the network.
description (string) --
The description of the network.
networkArn (string) --
The Amazon Resource Name (ARN) of the network.
networkName (string) --
The name of the network.
status (string) --
The status of the network.
statusReason (string) --
The status reason of the network.
NextToken (string) --
A token to resume pagination.
Private5G.Paginator.ListOrders¶paginator = client.get_paginator('list_orders')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Private5G.Client.list_orders().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
filters={
'string': [
'string',
]
},
networkArn='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The filters.
NETWORK_SITE - The Amazon Resource Name (ARN) of the network site.STATUS - The status (ACKNOWLEDGING | ACKNOWLEDGED | UNACKNOWLEDGED ).Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR , and the request returns all results that match any of the specified values.
[REQUIRED]
The Amazon Resource Name (ARN) of the network.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'orders': [
{
'acknowledgmentStatus': 'ACKNOWLEDGING'|'ACKNOWLEDGED'|'UNACKNOWLEDGED',
'createdAt': datetime(2015, 1, 1),
'networkArn': 'string',
'networkSiteArn': 'string',
'orderArn': 'string',
'shippingAddress': {
'city': 'string',
'company': 'string',
'country': 'string',
'name': 'string',
'phoneNumber': 'string',
'postalCode': 'string',
'stateOrProvince': 'string',
'street1': 'string',
'street2': 'string',
'street3': 'string'
},
'trackingInformation': [
{
'trackingNumber': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
orders (list) --
Information about the orders.
(dict) --
Information about an order.
acknowledgmentStatus (string) --
The acknowledgement status of the order.
createdAt (datetime) --
The creation time of the order.
networkArn (string) --
The Amazon Resource Name (ARN) of the network associated with this order.
networkSiteArn (string) --
The Amazon Resource Name (ARN) of the network site associated with this order.
orderArn (string) --
The Amazon Resource Name (ARN) of the order.
shippingAddress (dict) --
The shipping address of the order.
city (string) --
The city for this address.
company (string) --
The company name for this address.
country (string) --
The country for this address.
name (string) --
The recipient's name for this address.
phoneNumber (string) --
The phone number for this address.
postalCode (string) --
The postal code for this address.
stateOrProvince (string) --
The state or province for this address.
street1 (string) --
The first line of the street address.
street2 (string) --
The second line of the street address.
street3 (string) --
The third line of the street address.
trackingInformation (list) --
The tracking information of the order.
(dict) --
Information about tracking a shipment.
trackingNumber (string) --
The tracking number of the shipment.
NextToken (string) --
A token to resume pagination.