String orderArn
The Amazon Resource Name (ARN) of the order.
Order order
Information about the order.
String clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
String deviceIdentifierArn
The Amazon Resource Name (ARN) of the device identifier.
DeviceIdentifier deviceIdentifier
Information about the device identifier.
Map<K,V> tags
The tags on the device identifier.
String clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
CommitmentConfiguration commitmentConfiguration
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.
String networkSiteArn
The Amazon Resource Name (ARN) of the network site.
Address shippingAddress
The shipping address of the network site.
NetworkSite networkSite
Information about the network site.
String city
The city for this address.
String company
The company name for this address.
String country
The country for this address.
String emailAddress
The recipient's email address.
String name
The recipient's name for this address.
String phoneNumber
The recipient's phone number.
String postalCode
The postal code for this address.
String stateOrProvince
The state or province for this address.
String street1
The first line of the street address.
String street2
The second line of the street address.
String street3
The third line of the street address.
Boolean automaticRenewal
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.
String commitmentLength
The duration of the commitment period for the radio unit. You can choose a 60-day, 1-year, or 3-year period.
CommitmentConfiguration commitmentConfiguration
The duration and renewal status of the commitment period for the radio unit.
Date expiresOn
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.
Date startAt
The date and time that the commitment period started.
String accessPointArn
The Amazon Resource Name (ARN) of the network resource.
String cpiSecretKey
A Base64 encoded string of the CPI certificate associated with the CPI user who is certifying the coordinates of the network resource.
String cpiUserId
The CPI user ID of the CPI user who is certifying the coordinates of the network resource.
String cpiUserPassword
The CPI password associated with the CPI certificate in cpiSecretKey.
String cpiUsername
The CPI user name of the CPI user who is certifying the coordinates of the radio unit.
Position position
The position of the network resource.
NetworkResource accessPoint
Information about the network resource.
String clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
String description
The description of the network.
String networkName
The name of the network. You can't change the name after you create the network.
Map<K,V> tags
The tags to apply to the network.
String availabilityZone
The Availability Zone that is the parent of this site. You can't change the Availability Zone after you create the site.
String availabilityZoneId
The ID of the Availability Zone that is the parent of this site. You can't change the Availability Zone after you create the site.
String clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
String description
The description of the site.
String networkArn
The Amazon Resource Name (ARN) of the network.
String networkSiteName
The name of the site. You can't change the name after you create the site.
SitePlan pendingPlan
Information about the pending plan for this site.
Map<K,V> tags
The tags to apply to the network site.
NetworkSite networkSite
Information about the network site.
Map<K,V> tags
The network site tags.
String clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
String deviceIdentifierArn
The Amazon Resource Name (ARN) of the device identifier.
DeviceIdentifier deviceIdentifier
Information about the device identifier.
String clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
String networkArn
The Amazon Resource Name (ARN) of the network.
Network network
Information about the network.
String clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
String networkSiteArn
The Amazon Resource Name (ARN) of the network site.
NetworkSite networkSite
Information about the network site.
Date createdAt
The creation time of this device identifier.
String deviceIdentifierArn
The Amazon Resource Name (ARN) of the device identifier.
String iccid
The Integrated Circuit Card Identifier of the device identifier.
String imsi
The International Mobile Subscriber Identity of the device identifier.
String networkArn
The Amazon Resource Name (ARN) of the network on which the device identifier appears.
String orderArn
The Amazon Resource Name (ARN) of the order used to purchase the device identifier.
String status
The status of the device identifier.
String trafficGroupArn
The Amazon Resource Name (ARN) of the traffic group to which the device identifier belongs.
String vendor
The vendor of the device identifier.
String deviceIdentifierArn
The Amazon Resource Name (ARN) of the device identifier.
DeviceIdentifier deviceIdentifier
Information about the device identifier.
Map<K,V> tags
The device identifier tags.
String networkArn
The Amazon Resource Name (ARN) of the network.
String networkResourceArn
The Amazon Resource Name (ARN) of the network resource.
NetworkResource networkResource
Information about the network resource.
Map<K,V> tags
The network resource tags.
String networkSiteArn
The Amazon Resource Name (ARN) of the network site.
NetworkSite networkSite
Information about the network site.
Map<K,V> tags
The network site tags.
String orderArn
The Amazon Resource Name (ARN) of the order.
Integer retryAfterSeconds
Advice to clients on when the call can be safely retried.
Map<K,V> filters
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.
Integer maxResults
The maximum number of results to return.
String networkArn
The Amazon Resource Name (ARN) of the network.
String startToken
The token for the next page of results.
Map<K,V> filters
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.
Integer maxResults
The maximum number of results to return.
String networkArn
The Amazon Resource Name (ARN) of the network.
String startToken
The token for the next page of results.
Map<K,V> filters
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.
Integer maxResults
The maximum number of results to return.
String networkArn
The Amazon Resource Name (ARN) of the network.
String startToken
The token for the next page of results.
Map<K,V> filters
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.
Integer maxResults
The maximum number of results to return.
String startToken
The token for the next page of results.
Map<K,V> filters
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.
Integer maxResults
The maximum number of results to return.
String networkArn
The Amazon Resource Name (ARN) of the network.
String startToken
The token for the next page of results.
String resourceArn
The Amazon Resource Name (ARN) of the resource.
Date createdAt
The creation time of the network.
String description
The description of the network.
String networkArn
The Amazon Resource Name (ARN) of the network.
String networkName
The name of the network.
String status
The status of the network.
String statusReason
The status reason of the network.
List<E> attributes
The attributes of the network resource.
CommitmentInformation commitmentInformation
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.
Date createdAt
The creation time of the network resource.
String description
The description of the network resource.
String health
The health of the network resource.
String model
The model of the network resource.
String networkArn
The Amazon Resource Name (ARN) of the network on which this network resource appears.
String networkResourceArn
The Amazon Resource Name (ARN) of the network resource.
String networkSiteArn
The Amazon Resource Name (ARN) of the network site on which this network resource appears.
String orderArn
The Amazon Resource Name (ARN) of the order used to purchase this network resource.
Position position
The position of the network resource.
ReturnInformation returnInformation
Information about a request to return the network resource.
String serialNumber
The serial number of the network resource.
String status
The status of the network resource.
String statusReason
The status reason of the network resource.
String type
The type of the network resource.
String vendor
The vendor of the network resource.
String availabilityZone
The parent Availability Zone for the network site.
String availabilityZoneId
The parent Availability Zone ID for the network site.
Date createdAt
The creation time of the network site.
SitePlan currentPlan
The current plan of the network site.
String description
The description of the network site.
String networkArn
The Amazon Resource Name (ARN) of the network to which the network site belongs.
String networkSiteArn
The Amazon Resource Name (ARN) of the network site.
String networkSiteName
The name of the network site.
SitePlan pendingPlan
The pending plan of the network site.
String status
The status of the network site.
String statusReason
The status reason of the network site.
String acknowledgmentStatus
The acknowledgement status of the order.
Date createdAt
The creation time of the order.
String networkArn
The Amazon Resource Name (ARN) of the network associated with this order.
String networkSiteArn
The Amazon Resource Name (ARN) of the network site associated with this order.
String orderArn
The Amazon Resource Name (ARN) of the order.
List<E> orderedResources
A list of the network resources placed in the order.
Address shippingAddress
The shipping address of the order.
List<E> trackingInformation
The tracking information of the order.
CommitmentConfiguration commitmentConfiguration
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.
Integer count
The number of network resources in the order.
String type
The type of network resource in the order.
String status
Information about the health of the service.
Double elevation
The elevation of the equipment at this position.
String elevationReference
The reference point from which elevation is reported.
String elevationUnit
The units used to measure the elevation of the position.
Double latitude
The latitude of the position.
Double longitude
The longitude of the position.
String replacementOrderArn
The Amazon Resource Name (ARN) of the replacement order.
String returnReason
The reason for the return. If the return request did not include a reason for the return, this value is null.
Address shippingAddress
The shipping address.
String shippingLabel
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.
CommitmentConfiguration commitmentConfiguration
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.
String networkResourceArn
The Amazon Resource Name (ARN) of the network resource.
String returnReason
The reason for the return. Providing a reason for a return is optional.
Address shippingAddress
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.
String updateType
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 .
NetworkResource networkResource
The network resource.
String trackingNumber
The tracking number of the shipment.
String clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
String networkSiteArn
The Amazon Resource Name (ARN) of the network site.
SitePlan pendingPlan
The pending plan.
NetworkSite networkSite
Information about the network site.
Map<K,V> tags
The network site tags.
String clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
String description
The description.
String networkSiteArn
The Amazon Resource Name (ARN) of the network site.
NetworkSite networkSite
Information about the network site.
Map<K,V> tags
The network site tags.
Copyright © 2025. All rights reserved.