AWS.PrivateNetworks — AWS SDK for JavaScript (original) (raw)

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

Amazon Web Services Private 5G is a managed service that makes it easy to deploy, operate, and scale your own private mobile network at your on-premises location. Private 5G provides the pre-configured hardware and software for mobile networks, helps automate setup, and scales capacity on demand to support additional devices as needed.

Sending a Request Using PrivateNetworks

var privatenetworks = new AWS.PrivateNetworks();
privatenetworks.acknowledgeOrderReceipt(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the PrivateNetworks object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var privatenetworks = new AWS.PrivateNetworks({apiVersion: '2021-12-03'});

You can also set the API version globally in AWS.config.apiVersions using the privatenetworks service identifier:

AWS.config.apiVersions = {
  privatenetworks: '2021-12-03',
  // other service API versions
};

var privatenetworks = new AWS.PrivateNetworks();

Constructor Summarycollapse

Property Summarycollapse

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.PrivateNetworks(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

acknowledgeOrderReceipt(params = {}, callback) ⇒ AWS.Request

Acknowledges that the specified network order was received.

activateDeviceIdentifier(params = {}, callback) ⇒ AWS.Request

Activates the specified device identifier.

activateNetworkSite(params = {}, callback) ⇒ AWS.Request

Activates the specified network site.

configureAccessPoint(params = {}, callback) ⇒ AWS.Request

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.

createNetwork(params = {}, callback) ⇒ AWS.Request

createNetworkSite(params = {}, callback) ⇒ AWS.Request

deactivateDeviceIdentifier(params = {}, callback) ⇒ AWS.Request

Deactivates the specified device identifier.

deleteNetwork(params = {}, callback) ⇒ AWS.Request

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.

deleteNetworkSite(params = {}, callback) ⇒ AWS.Request

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.

getDeviceIdentifier(params = {}, callback) ⇒ AWS.Request

Gets the specified device identifier.

getNetwork(params = {}, callback) ⇒ AWS.Request

Gets the specified network.

getNetworkResource(params = {}, callback) ⇒ AWS.Request

Gets the specified network resource.

getNetworkSite(params = {}, callback) ⇒ AWS.Request

Gets the specified network site.

getOrder(params = {}, callback) ⇒ AWS.Request

Gets the specified order.

listDeviceIdentifiers(params = {}, callback) ⇒ AWS.Request

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.

listNetworkResources(params = {}, callback) ⇒ AWS.Request

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.

listNetworks(params = {}, callback) ⇒ AWS.Request

Lists networks. Add filters to your request to return a more specific list of results. Use filters to match the status of the network.

listNetworkSites(params = {}, callback) ⇒ AWS.Request

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.

listOrders(params = {}, callback) ⇒ AWS.Request

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.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Lists the tags for the specified resource.

ping(params = {}, callback) ⇒ AWS.Request

Checks the health of the service.

startNetworkResourceUpdate(params = {}, callback) ⇒ AWS.Request

Use this action to do the following tasks:

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.

tagResource(params = {}, callback) ⇒ AWS.Request

Adds tags to the specified resource.

untagResource(params = {}, callback) ⇒ AWS.Request

Removes tags from the specified resource.

updateNetworkSite(params = {}, callback) ⇒ AWS.Request

Updates the specified network site.

updateNetworkSitePlan(params = {}, callback) ⇒ AWS.Request

Updates the specified network site plan.