2023/06/27 - AWS Private 5G - 8 updated api methods
Changes This release allows Private5G customers to choose different commitment plans (60-days, 1-year, 3-years) when placing new orders, enables automatic renewal option for 1-year and 3-years commitments. It also allows customers to update the commitment plan of an existing radio unit.
{'order': {'orderedResources': [{'commitmentConfiguration': {'automaticRenewal': 'boolean',
'commitmentLength': 'SIXTY_DAYS '
'| '
'ONE_YEAR '
'| '
'THREE_YEARS'},
'count': 'integer',
'type': 'RADIO_UNIT | DEVICE_IDENTIFIER'}],
'shippingAddress': {'emailAddress': 'string'}}}
Acknowledges that the specified network order was received.
See also: AWS API Documentation
Request Syntax
client.acknowledge_order_receipt(
orderArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the order.
dict
Response Syntax
{
'order': {
'acknowledgmentStatus': 'ACKNOWLEDGING'|'ACKNOWLEDGED'|'UNACKNOWLEDGED',
'createdAt': datetime(2015, 1, 1),
'networkArn': 'string',
'networkSiteArn': 'string',
'orderArn': 'string',
'orderedResources': [
{
'commitmentConfiguration': {
'automaticRenewal': True|False,
'commitmentLength': 'SIXTY_DAYS'|'ONE_YEAR'|'THREE_YEARS'
},
'count': 123,
'type': 'RADIO_UNIT'|'DEVICE_IDENTIFIER'
},
],
'shippingAddress': {
'city': 'string',
'company': 'string',
'country': 'string',
'emailAddress': 'string',
'name': 'string',
'phoneNumber': 'string',
'postalCode': 'string',
'stateOrProvince': 'string',
'street1': 'string',
'street2': 'string',
'street3': 'string'
},
'trackingInformation': [
{
'trackingNumber': 'string'
},
]
}
}
Response Structure
(dict) --
order (dict) --
Information about the 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.
orderedResources (list) --
A list of the network resources placed in the order.
(dict) --
Details of the network resources in the order.
commitmentConfiguration (dict) --
The duration and renewal status of the commitment period for each radio unit in the order. Does not show details if the resource type is DEVICE_IDENTIFIER.
automaticRenewal (boolean) --
Determines whether the commitment period for a radio unit is set to automatically renew for an additional 1 year after your current commitment period expires.
Set to True, if you want your commitment period to automatically renew. Set to False if you do not want your commitment to automatically renew.
You can do the following:
Set a 1-year commitment to automatically renew for an additional 1 year. The hourly rate for the additional year will continue to be the same as your existing 1-year rate.
Set a 3-year commitment to automatically renew for an additional 1 year. The hourly rate for the additional year will continue to be the same as your existing 3-year rate.
Turn off a previously-enabled automatic renewal on a 1-year or 3-year commitment.
You cannot use the automatic-renewal option for a 60-day commitment.
commitmentLength (string) --
The duration of the commitment period for the radio unit. You can choose a 60-day, 1-year, or 3-year period.
count (integer) --
The number of network resources in the order.
type (string) --
The type of network resource in 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.
emailAddress (string) --
The recipient's email address.
name (string) --
The recipient's name for this address.
phoneNumber (string) --
The recipient's phone number.
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.
{'commitmentConfiguration': {'automaticRenewal': 'boolean',
'commitmentLength': 'SIXTY_DAYS | ONE_YEAR | '
'THREE_YEARS'},
'shippingAddress': {'emailAddress': 'string'}}
Activates the specified network site.
See also: AWS API Documentation
Request Syntax
client.activate_network_site(
clientToken='string',
commitmentConfiguration={
'automaticRenewal': True|False,
'commitmentLength': 'SIXTY_DAYS'|'ONE_YEAR'|'THREE_YEARS'
},
networkSiteArn='string',
shippingAddress={
'city': 'string',
'company': 'string',
'country': 'string',
'emailAddress': 'string',
'name': 'string',
'phoneNumber': 'string',
'postalCode': 'string',
'stateOrProvince': 'string',
'street1': 'string',
'street2': 'string',
'street3': 'string'
}
)
string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
dict
Determines the duration and renewal status of the commitment period for all pending radio units.
If you include commitmentConfiguration in the ActivateNetworkSiteRequest action, you must specify the following:
The commitment period for the radio unit. You can choose a 60-day, 1-year, or 3-year period.
Whether you want your commitment period to automatically renew for one more year after your current commitment period expires.
For pricing, see Amazon Web Services Private 5G Pricing.
If you do not include commitmentConfiguration in the ActivateNetworkSiteRequest action, the commitment period is set to 60-days.
automaticRenewal (boolean) -- [REQUIRED]
Determines whether the commitment period for a radio unit is set to automatically renew for an additional 1 year after your current commitment period expires.
Set to True, if you want your commitment period to automatically renew. Set to False if you do not want your commitment to automatically renew.
You can do the following:
Set a 1-year commitment to automatically renew for an additional 1 year. The hourly rate for the additional year will continue to be the same as your existing 1-year rate.
Set a 3-year commitment to automatically renew for an additional 1 year. The hourly rate for the additional year will continue to be the same as your existing 3-year rate.
Turn off a previously-enabled automatic renewal on a 1-year or 3-year commitment.
You cannot use the automatic-renewal option for a 60-day commitment.
commitmentLength (string) -- [REQUIRED]
The duration of the commitment period for the radio unit. You can choose a 60-day, 1-year, or 3-year period.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the network site.
dict
[REQUIRED]
The shipping address of the network site.
city (string) -- [REQUIRED]
The city for this address.
company (string) --
The company name for this address.
country (string) -- [REQUIRED]
The country for this address.
emailAddress (string) --
The recipient's email address.
name (string) -- [REQUIRED]
The recipient's name for this address.
phoneNumber (string) --
The recipient's phone number.
postalCode (string) -- [REQUIRED]
The postal code for this address.
stateOrProvince (string) -- [REQUIRED]
The state or province for this address.
street1 (string) -- [REQUIRED]
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.
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.
{'accessPoint': {'commitmentInformation': {'commitmentConfiguration': {'automaticRenewal': 'boolean',
'commitmentLength': 'SIXTY_DAYS '
'| '
'ONE_YEAR '
'| '
'THREE_YEARS'},
'expiresOn': 'timestamp',
'startAt': 'timestamp'},
'returnInformation': {'shippingAddress': {'emailAddress': 'string'}}}}
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
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
}
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the network resource.
string
A Base64 encoded string of the CPI certificate associated with the CPI user who is certifying the coordinates of the network resource.
string
The CPI user ID of the CPI user who is certifying the coordinates of the network resource.
string
The CPI password associated with the CPI certificate in cpiSecretKey.
string
The CPI user name of the CPI user who is certifying the coordinates of the radio unit.
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.
dict
Response Syntax
{
'accessPoint': {
'attributes': [
{
'name': 'string',
'value': 'string'
},
],
'commitmentInformation': {
'commitmentConfiguration': {
'automaticRenewal': True|False,
'commitmentLength': 'SIXTY_DAYS'|'ONE_YEAR'|'THREE_YEARS'
},
'expiresOn': datetime(2015, 1, 1),
'startAt': datetime(2015, 1, 1)
},
'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
},
'returnInformation': {
'replacementOrderArn': 'string',
'returnReason': 'string',
'shippingAddress': {
'city': 'string',
'company': 'string',
'country': 'string',
'emailAddress': 'string',
'name': 'string',
'phoneNumber': 'string',
'postalCode': 'string',
'stateOrProvince': 'string',
'street1': 'string',
'street2': 'string',
'street3': 'string'
},
'shippingLabel': 'string'
},
'serialNumber': 'string',
'status': 'PENDING'|'SHIPPED'|'PROVISIONING'|'PROVISIONED'|'AVAILABLE'|'DELETING'|'PENDING_RETURN'|'DELETED'|'CREATING_SHIPPING_LABEL',
'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.
commitmentInformation (dict) --
Information about the commitment period for the radio unit. Shows the duration, the date and time that the contract started and ends, and the renewal status of the commitment period.
commitmentConfiguration (dict) --
The duration and renewal status of the commitment period for the radio unit.
automaticRenewal (boolean) --
Determines whether the commitment period for a radio unit is set to automatically renew for an additional 1 year after your current commitment period expires.
Set to True, if you want your commitment period to automatically renew. Set to False if you do not want your commitment to automatically renew.
You can do the following:
Set a 1-year commitment to automatically renew for an additional 1 year. The hourly rate for the additional year will continue to be the same as your existing 1-year rate.
Set a 3-year commitment to automatically renew for an additional 1 year. The hourly rate for the additional year will continue to be the same as your existing 3-year rate.
Turn off a previously-enabled automatic renewal on a 1-year or 3-year commitment.
You cannot use the automatic-renewal option for a 60-day commitment.
commitmentLength (string) --
The duration of the commitment period for the radio unit. You can choose a 60-day, 1-year, or 3-year period.
expiresOn (datetime) --
The date and time that the commitment period ends. If you do not cancel or renew the commitment before the expiration date, you will be billed at the 60-day-commitment rate.
startAt (datetime) --
The date and time that the commitment period started.
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.
returnInformation (dict) --
Information about a request to return the network resource.
replacementOrderArn (string) --
The Amazon Resource Name (ARN) of the replacement order.
returnReason (string) --
The reason for the return. If the return request did not include a reason for the return, this value is null.
shippingAddress (dict) --
The shipping address.
city (string) --
The city for this address.
company (string) --
The company name for this address.
country (string) --
The country for this address.
emailAddress (string) --
The recipient's email address.
name (string) --
The recipient's name for this address.
phoneNumber (string) --
The recipient's phone number.
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.
shippingLabel (string) --
The URL of the shipping label. The shipping label is available for download only if the status of the network resource is PENDING_RETURN. For more information, see Return a radio unit.
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.
{'networkResource': {'commitmentInformation': {'commitmentConfiguration': {'automaticRenewal': 'boolean',
'commitmentLength': 'SIXTY_DAYS '
'| '
'ONE_YEAR '
'| '
'THREE_YEARS'},
'expiresOn': 'timestamp',
'startAt': 'timestamp'},
'returnInformation': {'shippingAddress': {'emailAddress': 'string'}}}}
Gets the specified network resource.
See also: AWS API Documentation
Request Syntax
client.get_network_resource(
networkResourceArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the network resource.
dict
Response Syntax
{
'networkResource': {
'attributes': [
{
'name': 'string',
'value': 'string'
},
],
'commitmentInformation': {
'commitmentConfiguration': {
'automaticRenewal': True|False,
'commitmentLength': 'SIXTY_DAYS'|'ONE_YEAR'|'THREE_YEARS'
},
'expiresOn': datetime(2015, 1, 1),
'startAt': datetime(2015, 1, 1)
},
'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
},
'returnInformation': {
'replacementOrderArn': 'string',
'returnReason': 'string',
'shippingAddress': {
'city': 'string',
'company': 'string',
'country': 'string',
'emailAddress': 'string',
'name': 'string',
'phoneNumber': 'string',
'postalCode': 'string',
'stateOrProvince': 'string',
'street1': 'string',
'street2': 'string',
'street3': 'string'
},
'shippingLabel': 'string'
},
'serialNumber': 'string',
'status': 'PENDING'|'SHIPPED'|'PROVISIONING'|'PROVISIONED'|'AVAILABLE'|'DELETING'|'PENDING_RETURN'|'DELETED'|'CREATING_SHIPPING_LABEL',
'statusReason': 'string',
'type': 'RADIO_UNIT',
'vendor': 'string'
},
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
networkResource (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.
commitmentInformation (dict) --
Information about the commitment period for the radio unit. Shows the duration, the date and time that the contract started and ends, and the renewal status of the commitment period.
commitmentConfiguration (dict) --
The duration and renewal status of the commitment period for the radio unit.
automaticRenewal (boolean) --
Determines whether the commitment period for a radio unit is set to automatically renew for an additional 1 year after your current commitment period expires.
Set to True, if you want your commitment period to automatically renew. Set to False if you do not want your commitment to automatically renew.
You can do the following:
Set a 1-year commitment to automatically renew for an additional 1 year. The hourly rate for the additional year will continue to be the same as your existing 1-year rate.
Set a 3-year commitment to automatically renew for an additional 1 year. The hourly rate for the additional year will continue to be the same as your existing 3-year rate.
Turn off a previously-enabled automatic renewal on a 1-year or 3-year commitment.
You cannot use the automatic-renewal option for a 60-day commitment.
commitmentLength (string) --
The duration of the commitment period for the radio unit. You can choose a 60-day, 1-year, or 3-year period.
expiresOn (datetime) --
The date and time that the commitment period ends. If you do not cancel or renew the commitment before the expiration date, you will be billed at the 60-day-commitment rate.
startAt (datetime) --
The date and time that the commitment period started.
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.
returnInformation (dict) --
Information about a request to return the network resource.
replacementOrderArn (string) --
The Amazon Resource Name (ARN) of the replacement order.
returnReason (string) --
The reason for the return. If the return request did not include a reason for the return, this value is null.
shippingAddress (dict) --
The shipping address.
city (string) --
The city for this address.
company (string) --
The company name for this address.
country (string) --
The country for this address.
emailAddress (string) --
The recipient's email address.
name (string) --
The recipient's name for this address.
phoneNumber (string) --
The recipient's phone number.
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.
shippingLabel (string) --
The URL of the shipping label. The shipping label is available for download only if the status of the network resource is PENDING_RETURN. For more information, see Return a radio unit.
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.
tags (dict) --
The network resource tags.
(string) --
(string) --
{'order': {'orderedResources': [{'commitmentConfiguration': {'automaticRenewal': 'boolean',
'commitmentLength': 'SIXTY_DAYS '
'| '
'ONE_YEAR '
'| '
'THREE_YEARS'},
'count': 'integer',
'type': 'RADIO_UNIT | DEVICE_IDENTIFIER'}],
'shippingAddress': {'emailAddress': 'string'}}}
Gets the specified order.
See also: AWS API Documentation
Request Syntax
client.get_order(
orderArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the order.
dict
Response Syntax
{
'order': {
'acknowledgmentStatus': 'ACKNOWLEDGING'|'ACKNOWLEDGED'|'UNACKNOWLEDGED',
'createdAt': datetime(2015, 1, 1),
'networkArn': 'string',
'networkSiteArn': 'string',
'orderArn': 'string',
'orderedResources': [
{
'commitmentConfiguration': {
'automaticRenewal': True|False,
'commitmentLength': 'SIXTY_DAYS'|'ONE_YEAR'|'THREE_YEARS'
},
'count': 123,
'type': 'RADIO_UNIT'|'DEVICE_IDENTIFIER'
},
],
'shippingAddress': {
'city': 'string',
'company': 'string',
'country': 'string',
'emailAddress': 'string',
'name': 'string',
'phoneNumber': 'string',
'postalCode': 'string',
'stateOrProvince': 'string',
'street1': 'string',
'street2': 'string',
'street3': 'string'
},
'trackingInformation': [
{
'trackingNumber': 'string'
},
]
},
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
order (dict) --
Information about the 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.
orderedResources (list) --
A list of the network resources placed in the order.
(dict) --
Details of the network resources in the order.
commitmentConfiguration (dict) --
The duration and renewal status of the commitment period for each radio unit in the order. Does not show details if the resource type is DEVICE_IDENTIFIER.
automaticRenewal (boolean) --
Determines whether the commitment period for a radio unit is set to automatically renew for an additional 1 year after your current commitment period expires.
Set to True, if you want your commitment period to automatically renew. Set to False if you do not want your commitment to automatically renew.
You can do the following:
Set a 1-year commitment to automatically renew for an additional 1 year. The hourly rate for the additional year will continue to be the same as your existing 1-year rate.
Set a 3-year commitment to automatically renew for an additional 1 year. The hourly rate for the additional year will continue to be the same as your existing 3-year rate.
Turn off a previously-enabled automatic renewal on a 1-year or 3-year commitment.
You cannot use the automatic-renewal option for a 60-day commitment.
commitmentLength (string) --
The duration of the commitment period for the radio unit. You can choose a 60-day, 1-year, or 3-year period.
count (integer) --
The number of network resources in the order.
type (string) --
The type of network resource in 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.
emailAddress (string) --
The recipient's email address.
name (string) --
The recipient's name for this address.
phoneNumber (string) --
The recipient's phone number.
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.
tags (dict) --
The order tags.
(string) --
(string) --
{'networkResources': {'commitmentInformation': {'commitmentConfiguration': {'automaticRenewal': 'boolean',
'commitmentLength': 'SIXTY_DAYS '
'| '
'ONE_YEAR '
'| '
'THREE_YEARS'},
'expiresOn': 'timestamp',
'startAt': 'timestamp'},
'returnInformation': {'shippingAddress': {'emailAddress': 'string'}}}}
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
client.list_network_resources(
filters={
'string': [
'string',
]
},
maxResults=123,
networkArn='string',
startToken='string'
)
dict
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.
(string) --
(list) --
(string) --
integer
The maximum number of results to return.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the network.
string
The token for the next page of results.
dict
Response Syntax
{
'networkResources': [
{
'attributes': [
{
'name': 'string',
'value': 'string'
},
],
'commitmentInformation': {
'commitmentConfiguration': {
'automaticRenewal': True|False,
'commitmentLength': 'SIXTY_DAYS'|'ONE_YEAR'|'THREE_YEARS'
},
'expiresOn': datetime(2015, 1, 1),
'startAt': datetime(2015, 1, 1)
},
'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
},
'returnInformation': {
'replacementOrderArn': 'string',
'returnReason': 'string',
'shippingAddress': {
'city': 'string',
'company': 'string',
'country': 'string',
'emailAddress': 'string',
'name': 'string',
'phoneNumber': 'string',
'postalCode': 'string',
'stateOrProvince': 'string',
'street1': 'string',
'street2': 'string',
'street3': 'string'
},
'shippingLabel': 'string'
},
'serialNumber': 'string',
'status': 'PENDING'|'SHIPPED'|'PROVISIONING'|'PROVISIONED'|'AVAILABLE'|'DELETING'|'PENDING_RETURN'|'DELETED'|'CREATING_SHIPPING_LABEL',
'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.
commitmentInformation (dict) --
Information about the commitment period for the radio unit. Shows the duration, the date and time that the contract started and ends, and the renewal status of the commitment period.
commitmentConfiguration (dict) --
The duration and renewal status of the commitment period for the radio unit.
automaticRenewal (boolean) --
Determines whether the commitment period for a radio unit is set to automatically renew for an additional 1 year after your current commitment period expires.
Set to True, if you want your commitment period to automatically renew. Set to False if you do not want your commitment to automatically renew.
You can do the following:
Set a 1-year commitment to automatically renew for an additional 1 year. The hourly rate for the additional year will continue to be the same as your existing 1-year rate.
Set a 3-year commitment to automatically renew for an additional 1 year. The hourly rate for the additional year will continue to be the same as your existing 3-year rate.
Turn off a previously-enabled automatic renewal on a 1-year or 3-year commitment.
You cannot use the automatic-renewal option for a 60-day commitment.
commitmentLength (string) --
The duration of the commitment period for the radio unit. You can choose a 60-day, 1-year, or 3-year period.
expiresOn (datetime) --
The date and time that the commitment period ends. If you do not cancel or renew the commitment before the expiration date, you will be billed at the 60-day-commitment rate.
startAt (datetime) --
The date and time that the commitment period started.
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.
returnInformation (dict) --
Information about a request to return the network resource.
replacementOrderArn (string) --
The Amazon Resource Name (ARN) of the replacement order.
returnReason (string) --
The reason for the return. If the return request did not include a reason for the return, this value is null.
shippingAddress (dict) --
The shipping address.
city (string) --
The city for this address.
company (string) --
The company name for this address.
country (string) --
The country for this address.
emailAddress (string) --
The recipient's email address.
name (string) --
The recipient's name for this address.
phoneNumber (string) --
The recipient's phone number.
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.
shippingLabel (string) --
The URL of the shipping label. The shipping label is available for download only if the status of the network resource is PENDING_RETURN. For more information, see Return a radio unit.
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.
{'orders': {'orderedResources': [{'commitmentConfiguration': {'automaticRenewal': 'boolean',
'commitmentLength': 'SIXTY_DAYS '
'| '
'ONE_YEAR '
'| '
'THREE_YEARS'},
'count': 'integer',
'type': 'RADIO_UNIT | DEVICE_IDENTIFIER'}],
'shippingAddress': {'emailAddress': 'string'}}}
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
client.list_orders(
filters={
'string': [
'string',
]
},
maxResults=123,
networkArn='string',
startToken='string'
)
dict
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.
(string) --
(list) --
(string) --
integer
The maximum number of results to return.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the network.
string
The token for the next page of results.
dict
Response Syntax
{
'nextToken': 'string',
'orders': [
{
'acknowledgmentStatus': 'ACKNOWLEDGING'|'ACKNOWLEDGED'|'UNACKNOWLEDGED',
'createdAt': datetime(2015, 1, 1),
'networkArn': 'string',
'networkSiteArn': 'string',
'orderArn': 'string',
'orderedResources': [
{
'commitmentConfiguration': {
'automaticRenewal': True|False,
'commitmentLength': 'SIXTY_DAYS'|'ONE_YEAR'|'THREE_YEARS'
},
'count': 123,
'type': 'RADIO_UNIT'|'DEVICE_IDENTIFIER'
},
],
'shippingAddress': {
'city': 'string',
'company': 'string',
'country': 'string',
'emailAddress': '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.
orderedResources (list) --
A list of the network resources placed in the order.
(dict) --
Details of the network resources in the order.
commitmentConfiguration (dict) --
The duration and renewal status of the commitment period for each radio unit in the order. Does not show details if the resource type is DEVICE_IDENTIFIER.
automaticRenewal (boolean) --
Determines whether the commitment period for a radio unit is set to automatically renew for an additional 1 year after your current commitment period expires.
Set to True, if you want your commitment period to automatically renew. Set to False if you do not want your commitment to automatically renew.
You can do the following:
Set a 1-year commitment to automatically renew for an additional 1 year. The hourly rate for the additional year will continue to be the same as your existing 1-year rate.
Set a 3-year commitment to automatically renew for an additional 1 year. The hourly rate for the additional year will continue to be the same as your existing 3-year rate.
Turn off a previously-enabled automatic renewal on a 1-year or 3-year commitment.
You cannot use the automatic-renewal option for a 60-day commitment.
commitmentLength (string) --
The duration of the commitment period for the radio unit. You can choose a 60-day, 1-year, or 3-year period.
count (integer) --
The number of network resources in the order.
type (string) --
The type of network resource in 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.
emailAddress (string) --
The recipient's email address.
name (string) --
The recipient's name for this address.
phoneNumber (string) --
The recipient's phone number.
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.
{'commitmentConfiguration': {'automaticRenewal': 'boolean',
'commitmentLength': 'SIXTY_DAYS | ONE_YEAR | '
'THREE_YEARS'},
'shippingAddress': {'emailAddress': 'string'},
'updateType': {'COMMITMENT'}}
Response {'networkResource': {'commitmentInformation': {'commitmentConfiguration': {'automaticRenewal': 'boolean',
'commitmentLength': 'SIXTY_DAYS '
'| '
'ONE_YEAR '
'| '
'THREE_YEARS'},
'expiresOn': 'timestamp',
'startAt': 'timestamp'},
'returnInformation': {'shippingAddress': {'emailAddress': 'string'}}}}
Use this action to do the following tasks:
Update the duration and renewal status of the commitment period for a radio unit. The update goes into effect immediately.
Request a replacement for a network resource.
Request that you return a network resource.
After you submit a request to replace or return a network resource, the status of the network resource changes to CREATING_SHIPPING_LABEL. The shipping label is available when the status of the network resource is PENDING_RETURN. After the network resource is successfully returned, its status changes to DELETED. For more information, see Return a radio unit.
See also: AWS API Documentation
Request Syntax
client.start_network_resource_update(
commitmentConfiguration={
'automaticRenewal': True|False,
'commitmentLength': 'SIXTY_DAYS'|'ONE_YEAR'|'THREE_YEARS'
},
networkResourceArn='string',
returnReason='string',
shippingAddress={
'city': 'string',
'company': 'string',
'country': 'string',
'emailAddress': 'string',
'name': 'string',
'phoneNumber': 'string',
'postalCode': 'string',
'stateOrProvince': 'string',
'street1': 'string',
'street2': 'string',
'street3': 'string'
},
updateType='REPLACE'|'RETURN'|'COMMITMENT'
)
dict
Use this action to extend and automatically renew the commitment period for the radio unit. You can do the following:
Change a 60-day commitment to a 1-year or 3-year commitment. The change is immediate and the hourly rate decreases to the rate for the new commitment period.
Change a 1-year commitment to a 3-year commitment. The change is immediate and the hourly rate decreases to the rate for the 3-year commitment period.
Set a 1-year commitment to automatically renew for an additional 1 year. The hourly rate for the additional year will continue to be the same as your existing 1-year rate.
Set a 3-year commitment to automatically renew for an additional 1 year. The hourly rate for the additional year will continue to be the same as your existing 3-year rate.
Turn off a previously-enabled automatic renewal on a 1-year or 3-year commitment. You cannot use the automatic-renewal option for a 60-day commitment.
For pricing, see Amazon Web Services Private 5G Pricing.
automaticRenewal (boolean) -- [REQUIRED]
Determines whether the commitment period for a radio unit is set to automatically renew for an additional 1 year after your current commitment period expires.
Set to True, if you want your commitment period to automatically renew. Set to False if you do not want your commitment to automatically renew.
You can do the following:
Set a 1-year commitment to automatically renew for an additional 1 year. The hourly rate for the additional year will continue to be the same as your existing 1-year rate.
Set a 3-year commitment to automatically renew for an additional 1 year. The hourly rate for the additional year will continue to be the same as your existing 3-year rate.
Turn off a previously-enabled automatic renewal on a 1-year or 3-year commitment.
You cannot use the automatic-renewal option for a 60-day commitment.
commitmentLength (string) -- [REQUIRED]
The duration of the commitment period for the radio unit. You can choose a 60-day, 1-year, or 3-year period.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the network resource.
string
The reason for the return. Providing a reason for a return is optional.
dict
The shipping address. If you don't provide a shipping address when replacing or returning a network resource, we use the address from the original order for the network resource.
city (string) -- [REQUIRED]
The city for this address.
company (string) --
The company name for this address.
country (string) -- [REQUIRED]
The country for this address.
emailAddress (string) --
The recipient's email address.
name (string) -- [REQUIRED]
The recipient's name for this address.
phoneNumber (string) --
The recipient's phone number.
postalCode (string) -- [REQUIRED]
The postal code for this address.
stateOrProvince (string) -- [REQUIRED]
The state or province for this address.
street1 (string) -- [REQUIRED]
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.
string
[REQUIRED]
The update type.
REPLACE - Submits a request to replace a defective radio unit. We provide a shipping label that you can use for the return process and we ship a replacement radio unit to you.
RETURN - Submits a request to return a radio unit that you no longer need. We provide a shipping label that you can use for the return process.
COMMITMENT - Submits a request to change or renew the commitment period. If you choose this value, then you must set commitmentConfiguration.
dict
Response Syntax
{
'networkResource': {
'attributes': [
{
'name': 'string',
'value': 'string'
},
],
'commitmentInformation': {
'commitmentConfiguration': {
'automaticRenewal': True|False,
'commitmentLength': 'SIXTY_DAYS'|'ONE_YEAR'|'THREE_YEARS'
},
'expiresOn': datetime(2015, 1, 1),
'startAt': datetime(2015, 1, 1)
},
'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
},
'returnInformation': {
'replacementOrderArn': 'string',
'returnReason': 'string',
'shippingAddress': {
'city': 'string',
'company': 'string',
'country': 'string',
'emailAddress': 'string',
'name': 'string',
'phoneNumber': 'string',
'postalCode': 'string',
'stateOrProvince': 'string',
'street1': 'string',
'street2': 'string',
'street3': 'string'
},
'shippingLabel': 'string'
},
'serialNumber': 'string',
'status': 'PENDING'|'SHIPPED'|'PROVISIONING'|'PROVISIONED'|'AVAILABLE'|'DELETING'|'PENDING_RETURN'|'DELETED'|'CREATING_SHIPPING_LABEL',
'statusReason': 'string',
'type': 'RADIO_UNIT',
'vendor': 'string'
}
}
Response Structure
(dict) --
networkResource (dict) --
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.
commitmentInformation (dict) --
Information about the commitment period for the radio unit. Shows the duration, the date and time that the contract started and ends, and the renewal status of the commitment period.
commitmentConfiguration (dict) --
The duration and renewal status of the commitment period for the radio unit.
automaticRenewal (boolean) --
Determines whether the commitment period for a radio unit is set to automatically renew for an additional 1 year after your current commitment period expires.
Set to True, if you want your commitment period to automatically renew. Set to False if you do not want your commitment to automatically renew.
You can do the following:
Set a 1-year commitment to automatically renew for an additional 1 year. The hourly rate for the additional year will continue to be the same as your existing 1-year rate.
Set a 3-year commitment to automatically renew for an additional 1 year. The hourly rate for the additional year will continue to be the same as your existing 3-year rate.
Turn off a previously-enabled automatic renewal on a 1-year or 3-year commitment.
You cannot use the automatic-renewal option for a 60-day commitment.
commitmentLength (string) --
The duration of the commitment period for the radio unit. You can choose a 60-day, 1-year, or 3-year period.
expiresOn (datetime) --
The date and time that the commitment period ends. If you do not cancel or renew the commitment before the expiration date, you will be billed at the 60-day-commitment rate.
startAt (datetime) --
The date and time that the commitment period started.
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.
returnInformation (dict) --
Information about a request to return the network resource.
replacementOrderArn (string) --
The Amazon Resource Name (ARN) of the replacement order.
returnReason (string) --
The reason for the return. If the return request did not include a reason for the return, this value is null.
shippingAddress (dict) --
The shipping address.
city (string) --
The city for this address.
company (string) --
The company name for this address.
country (string) --
The country for this address.
emailAddress (string) --
The recipient's email address.
name (string) --
The recipient's name for this address.
phoneNumber (string) --
The recipient's phone number.
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.
shippingLabel (string) --
The URL of the shipping label. The shipping label is available for download only if the status of the network resource is PENDING_RETURN. For more information, see Return a radio unit.
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.