AWS Private 5G 2021-12-03
- Client: Aws\PrivateNetworks\PrivateNetworksClient
- Service ID: privatenetworks
- Version: 2021-12-03
This page describes the parameters and results for the operations of the AWS Private 5G (2021-12-03), and shows how to use the Aws\PrivateNetworks\PrivateNetworksClient object to call the described operations. This documentation is specific to the 2021-12-03 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- AcknowledgeOrderReceipt ( array $params = [] )
Acknowledges that the specified network order was received.
- ActivateDeviceIdentifier ( array $params = [] )
Activates the specified device identifier.
- ActivateNetworkSite ( array $params = [] )
Activates the specified network site.
- ConfigureAccessPoint ( array $params = [] )
Configures the specified network resource.
- CreateNetwork ( array $params = [] )
Creates a network.
- CreateNetworkSite ( array $params = [] )
Creates a network site.
- DeactivateDeviceIdentifier ( array $params = [] )
Deactivates the specified device identifier.
- DeleteNetwork ( array $params = [] )
Deletes the specified network.
- DeleteNetworkSite ( array $params = [] )
Deletes the specified network site.
- GetDeviceIdentifier ( array $params = [] )
Gets the specified device identifier.
- GetNetwork ( array $params = [] )
Gets the specified network.
- GetNetworkResource ( array $params = [] )
Gets the specified network resource.
- GetNetworkSite ( array $params = [] )
Gets the specified network site.
- GetOrder ( array $params = [] )
Gets the specified order.
- ListDeviceIdentifiers ( array $params = [] )
Lists device identifiers.
- ListNetworkResources ( array $params = [] )
Lists network resources.
- ListNetworkSites ( array $params = [] )
Lists network sites.
- ListNetworks ( array $params = [] )
Lists networks.
- ListOrders ( array $params = [] )
Lists orders.
- ListTagsForResource ( array $params = [] )
Lists the tags for the specified resource.
- Ping ( array $params = [] )
Checks the health of the service.
- StartNetworkResourceUpdate ( array $params = [] )
Starts an update of the specified network resource.
- TagResource ( array $params = [] )
Adds tags to the specified resource.
- UntagResource ( array $params = [] )
Removes tags from the specified resource.
- UpdateNetworkSite ( array $params = [] )
Updates the specified network site.
- UpdateNetworkSitePlan ( array $params = [] )
Updates the specified network site plan.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
Operations
AcknowledgeOrderReceipt
$result = $client->acknowledgeOrderReceipt([/* ... */]); $promise = $client->acknowledgeOrderReceiptAsync([/* ... */]);
Acknowledges that the specified network order was received.
Parameter Syntax
$result = $client->acknowledgeOrderReceipt([
'orderArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'order' => [
'acknowledgmentStatus' => 'ACKNOWLEDGING|ACKNOWLEDGED|UNACKNOWLEDGED',
'createdAt' => <DateTime>,
'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>',
],
// ...
],
],
]
Result Details
Members
- order
-
- Required: Yes
- Type: Order structure
Information about the order.
Errors
-
The resource was not found.
-
The request failed validation.
-
Information about an internal error.
ActivateDeviceIdentifier
$result = $client->activateDeviceIdentifier([/* ... */]); $promise = $client->activateDeviceIdentifierAsync([/* ... */]);
Activates the specified device identifier.
Parameter Syntax
$result = $client->activateDeviceIdentifier([
'clientToken' => '<string>',
'deviceIdentifierArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- clientToken
-
- Type: string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
- deviceIdentifierArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the device identifier.
Result Syntax
[
'deviceIdentifier' => [
'createdAt' => <DateTime>,
'deviceIdentifierArn' => '<string>',
'iccid' => '<string>',
'imsi' => '<string>',
'networkArn' => '<string>',
'orderArn' => '<string>',
'status' => 'ACTIVE|INACTIVE',
'trafficGroupArn' => '<string>',
'vendor' => '<string>',
],
'tags' => ['<string>', ...],
]
Result Details
Members
- deviceIdentifier
-
- Required: Yes
- Type: DeviceIdentifier structure
Information about the device identifier.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags on the device identifier.
Errors
-
The resource was not found.
-
The request failed validation.
-
Information about an internal error.
ActivateNetworkSite
$result = $client->activateNetworkSite([/* ... */]); $promise = $client->activateNetworkSiteAsync([/* ... */]);
Activates the specified network site.
Parameter Syntax
$result = $client->activateNetworkSite([
'clientToken' => '<string>',
'networkSiteArn' => '<string>', // REQUIRED
'shippingAddress' => [ // REQUIRED
'city' => '<string>', // REQUIRED
'company' => '<string>',
'country' => '<string>', // REQUIRED
'name' => '<string>', // REQUIRED
'phoneNumber' => '<string>',
'postalCode' => '<string>', // REQUIRED
'stateOrProvince' => '<string>', // REQUIRED
'street1' => '<string>', // REQUIRED
'street2' => '<string>',
'street3' => '<string>',
],
]);
Parameter Details
Members
- clientToken
-
- Type: string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
- networkSiteArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the network site.
- shippingAddress
-
- Required: Yes
- Type: Address structure
The shipping address of the network site.
Result Syntax
[
'networkSite' => [
'availabilityZone' => '<string>',
'availabilityZoneId' => '<string>',
'createdAt' => <DateTime>,
'currentPlan' => [
'options' => [
[
'name' => '<string>',
'value' => '<string>',
],
// ...
],
'resourceDefinitions' => [
[
'count' => <integer>,
'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' => <integer>,
'options' => [
[
'name' => '<string>',
'value' => '<string>',
],
// ...
],
'type' => 'RADIO_UNIT|DEVICE_IDENTIFIER',
],
// ...
],
],
'status' => 'CREATED|PROVISIONING|AVAILABLE|DEPROVISIONING|DELETED',
'statusReason' => '<string>',
],
]
Result Details
Members
- networkSite
-
- Type: NetworkSite structure
Information about the network site.
Errors
-
The resource was not found.
-
The request failed validation.
-
Information about an internal error.
ConfigureAccessPoint
$result = $client->configureAccessPoint([/* ... */]); $promise = $client->configureAccessPointAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->configureAccessPoint([
'accessPointArn' => '<string>', // REQUIRED
'cpiSecretKey' => '<string>',
'cpiUserId' => '<string>',
'cpiUserPassword' => '<string>',
'cpiUsername' => '<string>',
'position' => [
'elevation' => <float>,
'elevationReference' => 'AGL|AMSL',
'elevationUnit' => 'FEET',
'latitude' => <float>,
'longitude' => <float>,
],
]);
Parameter Details
Members
- accessPointArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the network resource.
- cpiSecretKey
-
- Type: string
A Base64 encoded string of the CPI certificate associated with the CPI user who is certifying the coordinates of the network resource.
- cpiUserId
-
- Type: string
The CPI user ID of the CPI user who is certifying the coordinates of the network resource.
- cpiUserPassword
-
- Type: string
The CPI password associated with the CPI certificate in
cpiSecretKey. - cpiUsername
-
- Type: string
The CPI user name of the CPI user who is certifying the coordinates of the radio unit.
- position
-
- Type: Position structure
The position of the network resource.
Result Syntax
[
'accessPoint' => [
'attributes' => [
[
'name' => '<string>',
'value' => '<string>',
],
// ...
],
'createdAt' => <DateTime>,
'description' => '<string>',
'health' => 'INITIAL|HEALTHY|UNHEALTHY',
'model' => '<string>',
'networkArn' => '<string>',
'networkResourceArn' => '<string>',
'networkSiteArn' => '<string>',
'orderArn' => '<string>',
'position' => [
'elevation' => <float>,
'elevationReference' => 'AGL|AMSL',
'elevationUnit' => 'FEET',
'latitude' => <float>,
'longitude' => <float>,
],
'returnInformation' => [
'replacementOrderArn' => '<string>',
'returnReason' => '<string>',
'shippingAddress' => [
'city' => '<string>',
'company' => '<string>',
'country' => '<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>',
],
]
Result Details
Members
- accessPoint
-
- Required: Yes
- Type: NetworkResource structure
Information about the network resource.
Errors
-
The resource was not found.
-
The request failed validation.
-
Information about an internal error.
CreateNetwork
$result = $client->createNetwork([/* ... */]); $promise = $client->createNetworkAsync([/* ... */]);
Creates a network.
Parameter Syntax
$result = $client->createNetwork([
'clientToken' => '<string>',
'description' => '<string>',
'networkName' => '<string>', // REQUIRED
'tags' => ['<string>', ...],
]);
Parameter Details
Members
- clientToken
-
- Type: string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
- description
-
- Type: string
The description of the network.
- networkName
-
- Required: Yes
- Type: string
The name of the network. You can't change the name after you create the network.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags to apply to the network.
Result Syntax
[
'network' => [
'createdAt' => <DateTime>,
'description' => '<string>',
'networkArn' => '<string>',
'networkName' => '<string>',
'status' => 'CREATED|PROVISIONING|AVAILABLE|DEPROVISIONING|DELETED',
'statusReason' => '<string>',
],
'tags' => ['<string>', ...],
]
Result Details
Members
- network
-
- Required: Yes
- Type: Network structure
Information about the network.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The network tags.
Errors
-
The limit was exceeded.
-
The request failed validation.
-
Information about an internal error.
CreateNetworkSite
$result = $client->createNetworkSite([/* ... */]); $promise = $client->createNetworkSiteAsync([/* ... */]);
Creates a network site.
Parameter Syntax
$result = $client->createNetworkSite([
'availabilityZone' => '<string>',
'availabilityZoneId' => '<string>',
'clientToken' => '<string>',
'description' => '<string>',
'networkArn' => '<string>', // REQUIRED
'networkSiteName' => '<string>', // REQUIRED
'pendingPlan' => [
'options' => [
[
'name' => '<string>', // REQUIRED
'value' => '<string>',
],
// ...
],
'resourceDefinitions' => [
[
'count' => <integer>, // REQUIRED
'options' => [
[
'name' => '<string>', // REQUIRED
'value' => '<string>',
],
// ...
],
'type' => 'RADIO_UNIT|DEVICE_IDENTIFIER', // REQUIRED
],
// ...
],
],
'tags' => ['<string>', ...],
]);
Parameter Details
Members
- availabilityZone
-
- Type: string
The Availability Zone that is the parent of this site. You can't change the Availability Zone after you create the site.
- availabilityZoneId
-
- Type: string
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.
- clientToken
-
- Type: string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
- description
-
- Type: string
The description of the site.
- networkArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the network.
- networkSiteName
-
- Required: Yes
- Type: string
The name of the site. You can't change the name after you create the site.
- pendingPlan
-
- Type: SitePlan structure
Information about the pending plan for this site.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags to apply to the network site.
Result Syntax
[
'networkSite' => [
'availabilityZone' => '<string>',
'availabilityZoneId' => '<string>',
'createdAt' => <DateTime>,
'currentPlan' => [
'options' => [
[
'name' => '<string>',
'value' => '<string>',
],
// ...
],
'resourceDefinitions' => [
[
'count' => <integer>,
'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' => <integer>,
'options' => [
[
'name' => '<string>',
'value' => '<string>',
],
// ...
],
'type' => 'RADIO_UNIT|DEVICE_IDENTIFIER',
],
// ...
],
],
'status' => 'CREATED|PROVISIONING|AVAILABLE|DEPROVISIONING|DELETED',
'statusReason' => '<string>',
],
'tags' => ['<string>', ...],
]
Result Details
Members
- networkSite
-
- Type: NetworkSite structure
Information about the network site.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The network site tags.
Errors
-
The resource was not found.
-
The request failed validation.
-
Information about an internal error.
DeactivateDeviceIdentifier
$result = $client->deactivateDeviceIdentifier([/* ... */]); $promise = $client->deactivateDeviceIdentifierAsync([/* ... */]);
Deactivates the specified device identifier.
Parameter Syntax
$result = $client->deactivateDeviceIdentifier([
'clientToken' => '<string>',
'deviceIdentifierArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- clientToken
-
- Type: string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
- deviceIdentifierArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the device identifier.
Result Syntax
[
'deviceIdentifier' => [
'createdAt' => <DateTime>,
'deviceIdentifierArn' => '<string>',
'iccid' => '<string>',
'imsi' => '<string>',
'networkArn' => '<string>',
'orderArn' => '<string>',
'status' => 'ACTIVE|INACTIVE',
'trafficGroupArn' => '<string>',
'vendor' => '<string>',
],
]
Result Details
Members
- deviceIdentifier
-
- Required: Yes
- Type: DeviceIdentifier structure
Information about the device identifier.
Errors
-
The resource was not found.
-
The request failed validation.
-
Information about an internal error.
DeleteNetwork
$result = $client->deleteNetwork([/* ... */]); $promise = $client->deleteNetworkAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->deleteNetwork([
'clientToken' => '<string>',
'networkArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- clientToken
-
- Type: string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
- networkArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the network.
Result Syntax
[
'network' => [
'createdAt' => <DateTime>,
'description' => '<string>',
'networkArn' => '<string>',
'networkName' => '<string>',
'status' => 'CREATED|PROVISIONING|AVAILABLE|DEPROVISIONING|DELETED',
'statusReason' => '<string>',
],
]
Result Details
Members
- network
-
- Required: Yes
- Type: Network structure
Information about the network.
Errors
-
The resource was not found.
-
You do not have permission to perform this operation.
-
The request failed validation.
-
Information about an internal error.
DeleteNetworkSite
$result = $client->deleteNetworkSite([/* ... */]); $promise = $client->deleteNetworkSiteAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->deleteNetworkSite([
'clientToken' => '<string>',
'networkSiteArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- clientToken
-
- Type: string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
- networkSiteArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the network site.
Result Syntax
[
'networkSite' => [
'availabilityZone' => '<string>',
'availabilityZoneId' => '<string>',
'createdAt' => <DateTime>,
'currentPlan' => [
'options' => [
[
'name' => '<string>',
'value' => '<string>',
],
// ...
],
'resourceDefinitions' => [
[
'count' => <integer>,
'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' => <integer>,
'options' => [
[
'name' => '<string>',
'value' => '<string>',
],
// ...
],
'type' => 'RADIO_UNIT|DEVICE_IDENTIFIER',
],
// ...
],
],
'status' => 'CREATED|PROVISIONING|AVAILABLE|DEPROVISIONING|DELETED',
'statusReason' => '<string>',
],
]
Result Details
Members
- networkSite
-
- Type: NetworkSite structure
Information about the network site.
Errors
-
The resource was not found.
-
You do not have permission to perform this operation.
-
The request failed validation.
-
Information about an internal error.
GetDeviceIdentifier
$result = $client->getDeviceIdentifier([/* ... */]); $promise = $client->getDeviceIdentifierAsync([/* ... */]);
Gets the specified device identifier.
Parameter Syntax
$result = $client->getDeviceIdentifier([
'deviceIdentifierArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'deviceIdentifier' => [
'createdAt' => <DateTime>,
'deviceIdentifierArn' => '<string>',
'iccid' => '<string>',
'imsi' => '<string>',
'networkArn' => '<string>',
'orderArn' => '<string>',
'status' => 'ACTIVE|INACTIVE',
'trafficGroupArn' => '<string>',
'vendor' => '<string>',
],
'tags' => ['<string>', ...],
]
Result Details
Members
- deviceIdentifier
-
- Type: DeviceIdentifier structure
Information about the device identifier.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The device identifier tags.
Errors
-
The resource was not found.
-
The request failed validation.
-
Information about an internal error.
GetNetwork
$result = $client->getNetwork([/* ... */]); $promise = $client->getNetworkAsync([/* ... */]);
Gets the specified network.
Parameter Syntax
$result = $client->getNetwork([
'networkArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'network' => [
'createdAt' => <DateTime>,
'description' => '<string>',
'networkArn' => '<string>',
'networkName' => '<string>',
'status' => 'CREATED|PROVISIONING|AVAILABLE|DEPROVISIONING|DELETED',
'statusReason' => '<string>',
],
'tags' => ['<string>', ...],
]
Result Details
Members
- network
-
- Required: Yes
- Type: Network structure
Information about the network.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The network tags.
Errors
-
The resource was not found.
-
The request failed validation.
-
Information about an internal error.
GetNetworkResource
$result = $client->getNetworkResource([/* ... */]); $promise = $client->getNetworkResourceAsync([/* ... */]);
Gets the specified network resource.
Parameter Syntax
$result = $client->getNetworkResource([
'networkResourceArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'networkResource' => [
'attributes' => [
[
'name' => '<string>',
'value' => '<string>',
],
// ...
],
'createdAt' => <DateTime>,
'description' => '<string>',
'health' => 'INITIAL|HEALTHY|UNHEALTHY',
'model' => '<string>',
'networkArn' => '<string>',
'networkResourceArn' => '<string>',
'networkSiteArn' => '<string>',
'orderArn' => '<string>',
'position' => [
'elevation' => <float>,
'elevationReference' => 'AGL|AMSL',
'elevationUnit' => 'FEET',
'latitude' => <float>,
'longitude' => <float>,
],
'returnInformation' => [
'replacementOrderArn' => '<string>',
'returnReason' => '<string>',
'shippingAddress' => [
'city' => '<string>',
'company' => '<string>',
'country' => '<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>', ...],
]
Result Details
Members
- networkResource
-
- Required: Yes
- Type: NetworkResource structure
Information about the network resource.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The network resource tags.
Errors
-
The resource was not found.
-
The request failed validation.
-
Information about an internal error.
GetNetworkSite
$result = $client->getNetworkSite([/* ... */]); $promise = $client->getNetworkSiteAsync([/* ... */]);
Gets the specified network site.
Parameter Syntax
$result = $client->getNetworkSite([
'networkSiteArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'networkSite' => [
'availabilityZone' => '<string>',
'availabilityZoneId' => '<string>',
'createdAt' => <DateTime>,
'currentPlan' => [
'options' => [
[
'name' => '<string>',
'value' => '<string>',
],
// ...
],
'resourceDefinitions' => [
[
'count' => <integer>,
'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' => <integer>,
'options' => [
[
'name' => '<string>',
'value' => '<string>',
],
// ...
],
'type' => 'RADIO_UNIT|DEVICE_IDENTIFIER',
],
// ...
],
],
'status' => 'CREATED|PROVISIONING|AVAILABLE|DEPROVISIONING|DELETED',
'statusReason' => '<string>',
],
'tags' => ['<string>', ...],
]
Result Details
Members
- networkSite
-
- Type: NetworkSite structure
Information about the network site.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The network site tags.
Errors
-
The resource was not found.
-
The request failed validation.
-
Information about an internal error.
GetOrder
$result = $client->getOrder([/* ... */]); $promise = $client->getOrderAsync([/* ... */]);
Gets the specified order.
Parameter Syntax
$result = $client->getOrder([
'orderArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'order' => [
'acknowledgmentStatus' => 'ACKNOWLEDGING|ACKNOWLEDGED|UNACKNOWLEDGED',
'createdAt' => <DateTime>,
'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>', ...],
]
Result Details
Members
- order
-
- Required: Yes
- Type: Order structure
Information about the order.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The order tags.
Errors
-
The resource was not found.
-
The request failed validation.
-
Information about an internal error.
ListDeviceIdentifiers
$result = $client->listDeviceIdentifiers([/* ... */]); $promise = $client->listDeviceIdentifiersAsync([/* ... */]);
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.
If you specify multiple filters, filters are joined with an OR, and the request returns results that match all of the specified filters.
Parameter Syntax
$result = $client->listDeviceIdentifiers([
'filters' => [
'<DeviceIdentifierFilterKeys>' => ['<string>', ...],
// ...
],
'maxResults' => <integer>,
'networkArn' => '<string>', // REQUIRED
'startToken' => '<string>',
]);
Parameter Details
Members
- filters
-
- Type: Associative array of custom strings keys (DeviceIdentifierFilterKeys) to stringss
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. - maxResults
-
- Type: int
The maximum number of results to return.
- networkArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the network.
- startToken
-
- Type: string
The token for the next page of results.
Result Syntax
[
'deviceIdentifiers' => [
[
'createdAt' => <DateTime>,
'deviceIdentifierArn' => '<string>',
'iccid' => '<string>',
'imsi' => '<string>',
'networkArn' => '<string>',
'orderArn' => '<string>',
'status' => 'ACTIVE|INACTIVE',
'trafficGroupArn' => '<string>',
'vendor' => '<string>',
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- deviceIdentifiers
-
- Type: Array of DeviceIdentifier structures
Information about the device identifiers.
- nextToken
-
- Type: string
The token for the next page of results.
Errors
-
The resource was not found.
-
The request failed validation.
-
Information about an internal error.
ListNetworkResources
$result = $client->listNetworkResources([/* ... */]); $promise = $client->listNetworkResourcesAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->listNetworkResources([
'filters' => [
'<NetworkResourceFilterKeys>' => ['<string>', ...],
// ...
],
'maxResults' => <integer>,
'networkArn' => '<string>', // REQUIRED
'startToken' => '<string>',
]);
Parameter Details
Members
- filters
-
- Type: Associative array of custom strings keys (NetworkResourceFilterKeys) to stringss
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. - maxResults
-
- Type: int
The maximum number of results to return.
- networkArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the network.
- startToken
-
- Type: string
The token for the next page of results.
Result Syntax
[
'networkResources' => [
[
'attributes' => [
[
'name' => '<string>',
'value' => '<string>',
],
// ...
],
'createdAt' => <DateTime>,
'description' => '<string>',
'health' => 'INITIAL|HEALTHY|UNHEALTHY',
'model' => '<string>',
'networkArn' => '<string>',
'networkResourceArn' => '<string>',
'networkSiteArn' => '<string>',
'orderArn' => '<string>',
'position' => [
'elevation' => <float>,
'elevationReference' => 'AGL|AMSL',
'elevationUnit' => 'FEET',
'latitude' => <float>,
'longitude' => <float>,
],
'returnInformation' => [
'replacementOrderArn' => '<string>',
'returnReason' => '<string>',
'shippingAddress' => [
'city' => '<string>',
'company' => '<string>',
'country' => '<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>',
]
Result Details
Members
- networkResources
-
- Type: Array of NetworkResource structures
Information about network resources.
- nextToken
-
- Type: string
The token for the next page of results.
Errors
-
The resource was not found.
-
The request failed validation.
-
Information about an internal error.
ListNetworkSites
$result = $client->listNetworkSites([/* ... */]); $promise = $client->listNetworkSitesAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->listNetworkSites([
'filters' => [
'<NetworkSiteFilterKeys>' => ['<string>', ...],
// ...
],
'maxResults' => <integer>,
'networkArn' => '<string>', // REQUIRED
'startToken' => '<string>',
]);
Parameter Details
Members
- filters
-
- Type: Associative array of custom strings keys (NetworkSiteFilterKeys) to stringss
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. - maxResults
-
- Type: int
The maximum number of results to return.
- networkArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the network.
- startToken
-
- Type: string
The token for the next page of results.
Result Syntax
[
'networkSites' => [
[
'availabilityZone' => '<string>',
'availabilityZoneId' => '<string>',
'createdAt' => <DateTime>,
'currentPlan' => [
'options' => [
[
'name' => '<string>',
'value' => '<string>',
],
// ...
],
'resourceDefinitions' => [
[
'count' => <integer>,
'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' => <integer>,
'options' => [
[
'name' => '<string>',
'value' => '<string>',
],
// ...
],
'type' => 'RADIO_UNIT|DEVICE_IDENTIFIER',
],
// ...
],
],
'status' => 'CREATED|PROVISIONING|AVAILABLE|DEPROVISIONING|DELETED',
'statusReason' => '<string>',
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- networkSites
-
- Type: Array of NetworkSite structures
Information about the network sites.
- nextToken
-
- Type: string
The token for the next page of results.
Errors
-
The resource was not found.
-
The request failed validation.
-
Information about an internal error.
ListNetworks
$result = $client->listNetworks([/* ... */]); $promise = $client->listNetworksAsync([/* ... */]);
Lists networks. Add filters to your request to return a more specific list of results. Use filters to match the status of the network.
Parameter Syntax
$result = $client->listNetworks([
'filters' => [
'<NetworkFilterKeys>' => ['<string>', ...],
// ...
],
'maxResults' => <integer>,
'startToken' => '<string>',
]);
Parameter Details
Members
- filters
-
- Type: Associative array of custom strings keys (NetworkFilterKeys) to stringss
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. - maxResults
-
- Type: int
The maximum number of results to return.
- startToken
-
- Type: string
The token for the next page of results.
Result Syntax
[
'networks' => [
[
'createdAt' => <DateTime>,
'description' => '<string>',
'networkArn' => '<string>',
'networkName' => '<string>',
'status' => 'CREATED|PROVISIONING|AVAILABLE|DEPROVISIONING|DELETED',
'statusReason' => '<string>',
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- networks
-
- Type: Array of Network structures
The networks.
- nextToken
-
- Type: string
The token for the next page of results.
Errors
-
The resource was not found.
-
The request failed validation.
-
Information about an internal error.
ListOrders
$result = $client->listOrders([/* ... */]); $promise = $client->listOrdersAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->listOrders([
'filters' => [
'<OrderFilterKeys>' => ['<string>', ...],
// ...
],
'maxResults' => <integer>,
'networkArn' => '<string>', // REQUIRED
'startToken' => '<string>',
]);
Parameter Details
Members
- filters
-
- Type: Associative array of custom strings keys (OrderFilterKeys) to stringss
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. - maxResults
-
- Type: int
The maximum number of results to return.
- networkArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the network.
- startToken
-
- Type: string
The token for the next page of results.
Result Syntax
[
'nextToken' => '<string>',
'orders' => [
[
'acknowledgmentStatus' => 'ACKNOWLEDGING|ACKNOWLEDGED|UNACKNOWLEDGED',
'createdAt' => <DateTime>,
'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>',
],
// ...
],
],
// ...
],
]
Result Details
Members
- nextToken
-
- Type: string
The token for the next page of results.
- orders
-
- Type: Array of Order structures
Information about the orders.
Errors
-
The resource was not found.
-
The request failed validation.
-
Information about an internal error.
ListTagsForResource
$result = $client->listTagsForResource([/* ... */]); $promise = $client->listTagsForResourceAsync([/* ... */]);
Lists the tags for the specified resource.
Parameter Syntax
$result = $client->listTagsForResource([
'resourceArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'tags' => ['<string>', ...],
]
Result Details
Errors
-
The resource was not found.
-
You do not have permission to perform this operation.
-
The request failed validation.
-
Information about an internal error.
-
The request was denied due to request throttling.
Ping
$result = $client->ping([/* ... */]); $promise = $client->pingAsync([/* ... */]);
Checks the health of the service.
Parameter Syntax
$result = $client->ping([ ]);
Parameter Details
Members
Result Syntax
[
'status' => '<string>',
]
Result Details
Errors
-
Information about an internal error.
StartNetworkResourceUpdate
$result = $client->startNetworkResourceUpdate([/* ... */]); $promise = $client->startNetworkResourceUpdateAsync([/* ... */]);
Starts an update of the specified network resource.
After you submit a request to replace or return a network resource, the status of the network resource is 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 is DELETED. For more information, see Return a radio unit.
Parameter Syntax
$result = $client->startNetworkResourceUpdate([
'networkResourceArn' => '<string>', // REQUIRED
'returnReason' => '<string>',
'shippingAddress' => [
'city' => '<string>', // REQUIRED
'company' => '<string>',
'country' => '<string>', // REQUIRED
'name' => '<string>', // REQUIRED
'phoneNumber' => '<string>',
'postalCode' => '<string>', // REQUIRED
'stateOrProvince' => '<string>', // REQUIRED
'street1' => '<string>', // REQUIRED
'street2' => '<string>',
'street3' => '<string>',
],
'updateType' => 'REPLACE|RETURN', // REQUIRED
]);
Parameter Details
Members
- networkResourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the network resource.
- returnReason
-
- Type: string
The reason for the return. Providing a reason for a return is optional.
- shippingAddress
-
- Type: Address structure
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.
- updateType
-
- Required: Yes
- Type: string
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 replace a radio unit that you no longer need. We provide a shipping label that you can use for the return process.
Result Syntax
[
'networkResource' => [
'attributes' => [
[
'name' => '<string>',
'value' => '<string>',
],
// ...
],
'createdAt' => <DateTime>,
'description' => '<string>',
'health' => 'INITIAL|HEALTHY|UNHEALTHY',
'model' => '<string>',
'networkArn' => '<string>',
'networkResourceArn' => '<string>',
'networkSiteArn' => '<string>',
'orderArn' => '<string>',
'position' => [
'elevation' => <float>,
'elevationReference' => 'AGL|AMSL',
'elevationUnit' => 'FEET',
'latitude' => <float>,
'longitude' => <float>,
],
'returnInformation' => [
'replacementOrderArn' => '<string>',
'returnReason' => '<string>',
'shippingAddress' => [
'city' => '<string>',
'company' => '<string>',
'country' => '<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>',
],
]
Result Details
Members
- networkResource
-
- Type: NetworkResource structure
The network resource.
Errors
-
The resource was not found.
-
The request failed validation.
-
Information about an internal error.
TagResource
$result = $client->tagResource([/* ... */]); $promise = $client->tagResourceAsync([/* ... */]);
Adds tags to the specified resource.
Parameter Syntax
$result = $client->tagResource([
'resourceArn' => '<string>', // REQUIRED
'tags' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The resource was not found.
-
You do not have permission to perform this operation.
-
The request failed validation.
-
Information about an internal error.
-
The request was denied due to request throttling.
UntagResource
$result = $client->untagResource([/* ... */]); $promise = $client->untagResourceAsync([/* ... */]);
Removes tags from the specified resource.
Parameter Syntax
$result = $client->untagResource([
'resourceArn' => '<string>', // REQUIRED
'tagKeys' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The resource was not found.
-
You do not have permission to perform this operation.
-
The request failed validation.
-
Information about an internal error.
-
The request was denied due to request throttling.
UpdateNetworkSite
$result = $client->updateNetworkSite([/* ... */]); $promise = $client->updateNetworkSiteAsync([/* ... */]);
Updates the specified network site.
Parameter Syntax
$result = $client->updateNetworkSite([
'clientToken' => '<string>',
'description' => '<string>',
'networkSiteArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- clientToken
-
- Type: string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
- description
-
- Type: string
The description.
- networkSiteArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the network site.
Result Syntax
[
'networkSite' => [
'availabilityZone' => '<string>',
'availabilityZoneId' => '<string>',
'createdAt' => <DateTime>,
'currentPlan' => [
'options' => [
[
'name' => '<string>',
'value' => '<string>',
],
// ...
],
'resourceDefinitions' => [
[
'count' => <integer>,
'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' => <integer>,
'options' => [
[
'name' => '<string>',
'value' => '<string>',
],
// ...
],
'type' => 'RADIO_UNIT|DEVICE_IDENTIFIER',
],
// ...
],
],
'status' => 'CREATED|PROVISIONING|AVAILABLE|DEPROVISIONING|DELETED',
'statusReason' => '<string>',
],
'tags' => ['<string>', ...],
]
Result Details
Members
- networkSite
-
- Type: NetworkSite structure
Information about the network site.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The network site tags.
Errors
-
The resource was not found.
-
The request failed validation.
-
Information about an internal error.
UpdateNetworkSitePlan
$result = $client->updateNetworkSitePlan([/* ... */]); $promise = $client->updateNetworkSitePlanAsync([/* ... */]);
Updates the specified network site plan.
Parameter Syntax
$result = $client->updateNetworkSitePlan([
'clientToken' => '<string>',
'networkSiteArn' => '<string>', // REQUIRED
'pendingPlan' => [ // REQUIRED
'options' => [
[
'name' => '<string>', // REQUIRED
'value' => '<string>',
],
// ...
],
'resourceDefinitions' => [
[
'count' => <integer>, // REQUIRED
'options' => [
[
'name' => '<string>', // REQUIRED
'value' => '<string>',
],
// ...
],
'type' => 'RADIO_UNIT|DEVICE_IDENTIFIER', // REQUIRED
],
// ...
],
],
]);
Parameter Details
Members
- clientToken
-
- Type: string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
- networkSiteArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the network site.
- pendingPlan
-
- Required: Yes
- Type: SitePlan structure
The pending plan.
Result Syntax
[
'networkSite' => [
'availabilityZone' => '<string>',
'availabilityZoneId' => '<string>',
'createdAt' => <DateTime>,
'currentPlan' => [
'options' => [
[
'name' => '<string>',
'value' => '<string>',
],
// ...
],
'resourceDefinitions' => [
[
'count' => <integer>,
'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' => <integer>,
'options' => [
[
'name' => '<string>',
'value' => '<string>',
],
// ...
],
'type' => 'RADIO_UNIT|DEVICE_IDENTIFIER',
],
// ...
],
],
'status' => 'CREATED|PROVISIONING|AVAILABLE|DEPROVISIONING|DELETED',
'statusReason' => '<string>',
],
'tags' => ['<string>', ...],
]
Result Details
Members
- networkSite
-
- Type: NetworkSite structure
Information about the network site.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The network site tags.
Errors
-
The resource was not found.
-
The request failed validation.
-
Information about an internal error.
Shapes
AccessDeniedException
Address
Description
Information about an address.
Members
- city
-
- Required: Yes
- Type: string
The city for this address.
- company
-
- Type: string
The company name for this address.
- country
-
- Required: Yes
- Type: string
The country for this address.
- name
-
- Required: Yes
- Type: string
The recipient's name for this address.
- phoneNumber
-
- Type: string
The phone number for this address.
- postalCode
-
- Required: Yes
- Type: string
The postal code for this address.
- stateOrProvince
-
- Required: Yes
- Type: string
The state or province for this address.
- street1
-
- Required: Yes
- Type: string
The first line of the street address.
- street2
-
- Type: string
The second line of the street address.
- street3
-
- Type: string
The third line of the street address.
DeviceIdentifier
Description
Information about a subscriber of a device that can use a network.
Members
- createdAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The creation time of this device identifier.
- deviceIdentifierArn
-
- Type: string
The Amazon Resource Name (ARN) of the device identifier.
- iccid
-
- Type: string
The Integrated Circuit Card Identifier of the device identifier.
- imsi
-
- Type: string
The International Mobile Subscriber Identity of the device identifier.
- networkArn
-
- Type: string
The Amazon Resource Name (ARN) of the network on which the device identifier appears.
- orderArn
-
- Type: string
The Amazon Resource Name (ARN) of the order used to purchase the device identifier.
- status
-
- Type: string
The status of the device identifier.
- trafficGroupArn
-
- Type: string
The Amazon Resource Name (ARN) of the traffic group to which the device identifier belongs.
- vendor
-
- Type: string
The vendor of the device identifier.
InternalServerException
Description
Information about an internal error.
Members
LimitExceededException
NameValuePair
Description
Information about a name/value pair.
Members
Network
Description
Information about a network.
Members
- createdAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The creation time of the network.
- description
-
- Type: string
The description of the network.
- networkArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the network.
- networkName
-
- Required: Yes
- Type: string
The name of the network.
- status
-
- Required: Yes
- Type: string
The status of the network.
- statusReason
-
- Type: string
The status reason of the network.
NetworkResource
Description
Information about a network resource.
Members
- attributes
-
- Type: Array of NameValuePair structures
The attributes of the network resource.
- createdAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The creation time of the network resource.
- description
-
- Type: string
The description of the network resource.
- health
-
- Type: string
The health of the network resource.
- model
-
- Type: string
The model of the network resource.
- networkArn
-
- Type: string
The Amazon Resource Name (ARN) of the network on which this network resource appears.
- networkResourceArn
-
- Type: string
The Amazon Resource Name (ARN) of the network resource.
- networkSiteArn
-
- Type: string
The Amazon Resource Name (ARN) of the network site on which this network resource appears.
- orderArn
-
- Type: string
The Amazon Resource Name (ARN) of the order used to purchase this network resource.
- position
-
- Type: Position structure
The position of the network resource.
- returnInformation
-
- Type: ReturnInformation structure
Information about a request to return the network resource.
- serialNumber
-
- Type: string
The serial number of the network resource.
- status
-
- Type: string
The status of the network resource.
- statusReason
-
- Type: string
The status reason of the network resource.
- type
-
- Type: string
The type of the network resource.
- vendor
-
- Type: string
The vendor of the network resource.
NetworkResourceDefinition
Description
Information about a network resource definition.
Members
- count
-
- Required: Yes
- Type: int
The count in the network resource definition.
- options
-
- Type: Array of NameValuePair structures
The options in the network resource definition.
- type
-
- Required: Yes
- Type: string
The type in the network resource definition.
NetworkSite
Description
Information about a network site.
Members
- availabilityZone
-
- Type: string
The parent Availability Zone for the network site.
- availabilityZoneId
-
- Type: string
The parent Availability Zone ID for the network site.
- createdAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The creation time of the network site.
- currentPlan
-
- Type: SitePlan structure
The current plan of the network site.
- description
-
- Type: string
The description of the network site.
- networkArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the network to which the network site belongs.
- networkSiteArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the network site.
- networkSiteName
-
- Required: Yes
- Type: string
The name of the network site.
- pendingPlan
-
- Type: SitePlan structure
The pending plan of the network site.
- status
-
- Required: Yes
- Type: string
The status of the network site.
- statusReason
-
- Type: string
The status reason of the network site.
Order
Description
Information about an order.
Members
- acknowledgmentStatus
-
- Type: string
The acknowledgement status of the order.
- createdAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The creation time of the order.
- networkArn
-
- Type: string
The Amazon Resource Name (ARN) of the network associated with this order.
- networkSiteArn
-
- Type: string
The Amazon Resource Name (ARN) of the network site associated with this order.
- orderArn
-
- Type: string
The Amazon Resource Name (ARN) of the order.
- shippingAddress
-
- Type: Address structure
The shipping address of the order.
- trackingInformation
-
- Type: Array of TrackingInformation structures
The tracking information of the order.
Position
Description
Information about a position.
Members
- elevation
-
- Type: double
The elevation of the equipment at this position.
- elevationReference
-
- Type: string
The reference point from which elevation is reported.
- elevationUnit
-
- Type: string
The units used to measure the elevation of the position.
- latitude
-
- Type: double
The latitude of the position.
- longitude
-
- Type: double
The longitude of the position.
ResourceNotFoundException
Description
The resource was not found.
Members
ReturnInformation
Description
Information about a request to return a network resource.
Members
- replacementOrderArn
-
- Type: string
The Amazon Resource Name (ARN) of the replacement order.
- returnReason
-
- Type: string
The reason for the return. If the return request did not include a reason for the return, this value is null.
- shippingAddress
-
- Type: Address structure
The shipping address.
- shippingLabel
-
- Type: 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.
SitePlan
Description
Information about a site plan.
Members
- options
-
- Type: Array of NameValuePair structures
The options of the plan.
- resourceDefinitions
-
- Type: Array of NetworkResourceDefinition structures
The resource definitions of the plan.
ThrottlingException
TrackingInformation
Description
Information about tracking a shipment.
Members
ValidationException
Description
The request failed validation.
Members
- fieldList
-
- Type: Array of ValidationExceptionField structures
The list of fields that caused the error, if applicable.
- message
-
- Required: Yes
- Type: string
Description of the error.
- reason
-
- Required: Yes
- Type: string
Reason the request failed validation.