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>',
        'orderedResources' => [
            [
                'commitmentConfiguration' => [
                    'automaticRenewal' => true || false,
                    'commitmentLength' => 'SIXTY_DAYS|ONE_YEAR|THREE_YEARS',
                ],
                'count' => <integer>,
                '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>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

ResourceNotFoundException:

The resource was not found.

ValidationException:

The request failed validation.

InternalServerException:

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

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

Errors

ResourceNotFoundException:

The resource was not found.

ValidationException:

The request failed validation.

InternalServerException:

Information about an internal error.

ActivateNetworkSite

$result = $client->activateNetworkSite([/* ... */]);
$promise = $client->activateNetworkSiteAsync([/* ... */]);

Activates the specified network site.

Parameter Syntax

$result = $client->activateNetworkSite([
    'clientToken' => '<string>',
    'commitmentConfiguration' => [
        'automaticRenewal' => true || false, // REQUIRED
        'commitmentLength' => 'SIXTY_DAYS|ONE_YEAR|THREE_YEARS', // REQUIRED
    ],
    'networkSiteArn' => '<string>', // REQUIRED
    'shippingAddress' => [ // REQUIRED
        'city' => '<string>', // REQUIRED
        'company' => '<string>',
        'country' => '<string>', // REQUIRED
        'emailAddress' => '<string>',
        'name' => '<string>', // REQUIRED
        'phoneNumber' => '<string>',
        'postalCode' => '<string>', // REQUIRED
        'stateOrProvince' => '<string>', // REQUIRED
        'street1' => '<string>', // REQUIRED
        'street2' => '<string>',
        'street3' => '<string>',
    ],
]);

Parameter Details

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

Errors

ResourceNotFoundException:

The resource was not found.

ValidationException:

The request failed validation.

InternalServerException:

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

Result Syntax

[
    'accessPoint' => [
        'attributes' => [
            [
                'name' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
        'commitmentInformation' => [
            'commitmentConfiguration' => [
                'automaticRenewal' => true || false,
                'commitmentLength' => 'SIXTY_DAYS|ONE_YEAR|THREE_YEARS',
            ],
            'expiresOn' => <DateTime>,
            'startAt' => <DateTime>,
        ],
        '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>',
                '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>',
    ],
]

Result Details

Errors

ResourceNotFoundException:

The resource was not found.

ValidationException:

The request failed validation.

InternalServerException:

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

Result Syntax

[
    'network' => [
        'createdAt' => <DateTime>,
        'description' => '<string>',
        'networkArn' => '<string>',
        'networkName' => '<string>',
        'status' => 'CREATED|PROVISIONING|AVAILABLE|DEPROVISIONING|DELETED',
        'statusReason' => '<string>',
    ],
    'tags' => ['<string>', ...],
]

Result Details

Errors

LimitExceededException:

The limit was exceeded.

ValidationException:

The request failed validation.

InternalServerException:

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

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

Errors

ResourceNotFoundException:

The resource was not found.

ValidationException:

The request failed validation.

InternalServerException:

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

Result Syntax

[
    'deviceIdentifier' => [
        'createdAt' => <DateTime>,
        'deviceIdentifierArn' => '<string>',
        'iccid' => '<string>',
        'imsi' => '<string>',
        'networkArn' => '<string>',
        'orderArn' => '<string>',
        'status' => 'ACTIVE|INACTIVE',
        'trafficGroupArn' => '<string>',
        'vendor' => '<string>',
    ],
]

Result Details

Errors

ResourceNotFoundException:

The resource was not found.

ValidationException:

The request failed validation.

InternalServerException:

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

Result Syntax

[
    'network' => [
        'createdAt' => <DateTime>,
        'description' => '<string>',
        'networkArn' => '<string>',
        'networkName' => '<string>',
        'status' => 'CREATED|PROVISIONING|AVAILABLE|DEPROVISIONING|DELETED',
        'statusReason' => '<string>',
    ],
]

Result Details

Errors

ResourceNotFoundException:

The resource was not found.

AccessDeniedException:

You do not have permission to perform this operation.

ValidationException:

The request failed validation.

InternalServerException:

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

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

Errors

ResourceNotFoundException:

The resource was not found.

AccessDeniedException:

You do not have permission to perform this operation.

ValidationException:

The request failed validation.

InternalServerException:

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

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

Errors

ResourceNotFoundException:

The resource was not found.

ValidationException:

The request failed validation.

InternalServerException:

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

Errors

ResourceNotFoundException:

The resource was not found.

ValidationException:

The request failed validation.

InternalServerException:

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

Result Syntax

[
    'networkResource' => [
        'attributes' => [
            [
                'name' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
        'commitmentInformation' => [
            'commitmentConfiguration' => [
                'automaticRenewal' => true || false,
                'commitmentLength' => 'SIXTY_DAYS|ONE_YEAR|THREE_YEARS',
            ],
            'expiresOn' => <DateTime>,
            'startAt' => <DateTime>,
        ],
        '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>',
                '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>', ...],
]

Result Details

Errors

ResourceNotFoundException:

The resource was not found.

ValidationException:

The request failed validation.

InternalServerException:

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

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

Errors

ResourceNotFoundException:

The resource was not found.

ValidationException:

The request failed validation.

InternalServerException:

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>',
        'orderedResources' => [
            [
                'commitmentConfiguration' => [
                    'automaticRenewal' => true || false,
                    'commitmentLength' => 'SIXTY_DAYS|ONE_YEAR|THREE_YEARS',
                ],
                'count' => <integer>,
                '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>', ...],
]

Result Details

Errors

ResourceNotFoundException:

The resource was not found.

ValidationException:

The request failed validation.

InternalServerException:

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

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

Errors

ResourceNotFoundException:

The resource was not found.

ValidationException:

The request failed validation.

InternalServerException:

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

Result Syntax

[
    'networkResources' => [
        [
            'attributes' => [
                [
                    'name' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
            'commitmentInformation' => [
                'commitmentConfiguration' => [
                    'automaticRenewal' => true || false,
                    'commitmentLength' => 'SIXTY_DAYS|ONE_YEAR|THREE_YEARS',
                ],
                'expiresOn' => <DateTime>,
                'startAt' => <DateTime>,
            ],
            '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>',
                    '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>',
]

Result Details

Errors

ResourceNotFoundException:

The resource was not found.

ValidationException:

The request failed validation.

InternalServerException:

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

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

Errors

ResourceNotFoundException:

The resource was not found.

ValidationException:

The request failed validation.

InternalServerException:

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

Result Syntax

[
    'networks' => [
        [
            'createdAt' => <DateTime>,
            'description' => '<string>',
            'networkArn' => '<string>',
            'networkName' => '<string>',
            'status' => 'CREATED|PROVISIONING|AVAILABLE|DEPROVISIONING|DELETED',
            'statusReason' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The resource was not found.

ValidationException:

The request failed validation.

InternalServerException:

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

Result Syntax

[
    'nextToken' => '<string>',
    'orders' => [
        [
            'acknowledgmentStatus' => 'ACKNOWLEDGING|ACKNOWLEDGED|UNACKNOWLEDGED',
            'createdAt' => <DateTime>,
            'networkArn' => '<string>',
            'networkSiteArn' => '<string>',
            'orderArn' => '<string>',
            'orderedResources' => [
                [
                    'commitmentConfiguration' => [
                        'automaticRenewal' => true || false,
                        'commitmentLength' => 'SIXTY_DAYS|ONE_YEAR|THREE_YEARS',
                    ],
                    'count' => <integer>,
                    '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>',
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

The resource was not found.

ValidationException:

The request failed validation.

InternalServerException:

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

ResourceNotFoundException:

The resource was not found.

AccessDeniedException:

You do not have permission to perform this operation.

ValidationException:

The request failed validation.

InternalServerException:

Information about an internal error.

ThrottlingException:

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

Result Syntax

[
    'status' => '<string>',
]

Result Details

Errors

InternalServerException:

Information about an internal error.

StartNetworkResourceUpdate

$result = $client->startNetworkResourceUpdate([/* ... */]);
$promise = $client->startNetworkResourceUpdateAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->startNetworkResourceUpdate([
    'commitmentConfiguration' => [
        'automaticRenewal' => true || false, // REQUIRED
        'commitmentLength' => 'SIXTY_DAYS|ONE_YEAR|THREE_YEARS', // REQUIRED
    ],
    'networkResourceArn' => '<string>', // REQUIRED
    'returnReason' => '<string>',
    'shippingAddress' => [
        'city' => '<string>', // REQUIRED
        'company' => '<string>',
        'country' => '<string>', // REQUIRED
        'emailAddress' => '<string>',
        'name' => '<string>', // REQUIRED
        'phoneNumber' => '<string>',
        'postalCode' => '<string>', // REQUIRED
        'stateOrProvince' => '<string>', // REQUIRED
        'street1' => '<string>', // REQUIRED
        'street2' => '<string>',
        'street3' => '<string>',
    ],
    'updateType' => 'REPLACE|RETURN|COMMITMENT', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'networkResource' => [
        'attributes' => [
            [
                'name' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
        'commitmentInformation' => [
            'commitmentConfiguration' => [
                'automaticRenewal' => true || false,
                'commitmentLength' => 'SIXTY_DAYS|ONE_YEAR|THREE_YEARS',
            ],
            'expiresOn' => <DateTime>,
            'startAt' => <DateTime>,
        ],
        '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>',
                '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>',
    ],
]

Result Details

Errors

ResourceNotFoundException:

The resource was not found.

ValidationException:

The request failed validation.

InternalServerException:

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

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The resource was not found.

AccessDeniedException:

You do not have permission to perform this operation.

ValidationException:

The request failed validation.

InternalServerException:

Information about an internal error.

ThrottlingException:

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

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The resource was not found.

AccessDeniedException:

You do not have permission to perform this operation.

ValidationException:

The request failed validation.

InternalServerException:

Information about an internal error.

ThrottlingException:

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

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

Errors

ResourceNotFoundException:

The resource was not found.

ValidationException:

The request failed validation.

InternalServerException:

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

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

Errors

ResourceNotFoundException:

The resource was not found.

ValidationException:

The request failed validation.

InternalServerException:

Information about an internal error.