You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.PrivateNetworks

Inherits:
AWS.Service show all
Identifier:
privatenetworks
API Version:
2021-12-03
Defined in:
(unknown)

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();

Version:

  • 2021-12-03

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

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.

Examples:

Constructing a PrivateNetworks object

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

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.PrivateNetworks.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.PrivateNetworks.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.PrivateNetworks.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean)

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined)

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

  • useFipsEndpoint (Boolean)

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean)

    Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

endpointAWS.Endpoint (readwrite)

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

Returns:

  • (AWS.Endpoint)

    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.

Service Reference:

Examples:

Calling the acknowledgeOrderReceipt operation

var params = {
  orderArn: 'STRING_VALUE' /* required */
};
privatenetworks.acknowledgeOrderReceipt(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • orderArn — (String)

      The Amazon Resource Name (ARN) of the order.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • order — (map)

        Information about the order.

        • acknowledgmentStatus — (String)

          The acknowledgement status of the order.

          Possible values include:
          • "ACKNOWLEDGING"
          • "ACKNOWLEDGED"
          • "UNACKNOWLEDGED"
        • createdAt — (Date)

          The creation time of the order.

        • networkArn — (String)

          The Amazon Resource Name (ARN) of the network associated with this order.

        • networkSiteArn — (String)

          The Amazon Resource Name (ARN) of the network site associated with this order.

        • orderArn — (String)

          The Amazon Resource Name (ARN) of the order.

        • shippingAddress — (map)

          The shipping address of the order.

          • cityrequired — (String)

            The city for this address.

          • company — (String)

            The company name for this address.

          • countryrequired — (String)

            The country for this address.

          • namerequired — (String)

            The recipient's name for this address.

          • phoneNumber — (String)

            The phone number for this address.

          • postalCoderequired — (String)

            The postal code for this address.

          • stateOrProvincerequired — (String)

            The state or province for this address.

          • street1required — (String)

            The first line of the street address.

          • street2 — (String)

            The second line of the street address.

          • street3 — (String)

            The third line of the street address.

        • trackingInformation — (Array<map>)

          The tracking information of the order.

          • trackingNumber — (String)

            The tracking number of the shipment.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Activates the specified device identifier.

Service Reference:

Examples:

Calling the activateDeviceIdentifier operation

var params = {
  deviceIdentifierArn: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
privatenetworks.activateDeviceIdentifier(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • clientToken — (String)

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

    • deviceIdentifierArn — (String)

      The Amazon Resource Name (ARN) of the device identifier.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • deviceIdentifier — (map)

        Information about the device identifier.

        • createdAt — (Date)

          The creation time of this device identifier.

        • deviceIdentifierArn — (String)

          The Amazon Resource Name (ARN) of the device identifier.

        • iccid — (String)

          The Integrated Circuit Card Identifier of the device identifier.

        • imsi — (String)

          The International Mobile Subscriber Identity of the device identifier.

        • networkArn — (String)

          The Amazon Resource Name (ARN) of the network on which the device identifier appears.

        • orderArn — (String)

          The Amazon Resource Name (ARN) of the order used to purchase the device identifier.

        • status — (String)

          The status of the device identifier.

          Possible values include:
          • "ACTIVE"
          • "INACTIVE"
        • trafficGroupArn — (String)

          The Amazon Resource Name (ARN) of the traffic group to which the device identifier belongs.

        • vendor — (String)

          The vendor of the device identifier.

      • tags — (map<String>)

        The tags on the device identifier.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Activates the specified network site.

Service Reference:

Examples:

Calling the activateNetworkSite operation

var params = {
  networkSiteArn: 'STRING_VALUE', /* required */
  shippingAddress: { /* required */
    city: 'STRING_VALUE', /* required */
    country: 'STRING_VALUE', /* required */
    name: 'STRING_VALUE', /* required */
    postalCode: 'STRING_VALUE', /* required */
    stateOrProvince: 'STRING_VALUE', /* required */
    street1: 'STRING_VALUE', /* required */
    company: 'STRING_VALUE',
    phoneNumber: 'STRING_VALUE',
    street2: 'STRING_VALUE',
    street3: 'STRING_VALUE'
  },
  clientToken: 'STRING_VALUE'
};
privatenetworks.activateNetworkSite(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • clientToken — (String)

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

    • networkSiteArn — (String)

      The Amazon Resource Name (ARN) of the network site.

    • shippingAddress — (map)

      The shipping address of the network site.

      • cityrequired — (String)

        The city for this address.

      • company — (String)

        The company name for this address.

      • countryrequired — (String)

        The country for this address.

      • namerequired — (String)

        The recipient's name for this address.

      • phoneNumber — (String)

        The phone number for this address.

      • postalCoderequired — (String)

        The postal code for this address.

      • stateOrProvincerequired — (String)

        The state or province for this address.

      • street1required — (String)

        The first line of the street address.

      • street2 — (String)

        The second line of the street address.

      • street3 — (String)

        The third line of the street address.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • networkSite — (map)

        Information about the network site.

        • availabilityZone — (String)

          The parent Availability Zone for the network site.

        • availabilityZoneId — (String)

          The parent Availability Zone ID for the network site.

        • createdAt — (Date)

          The creation time of the network site.

        • currentPlan — (map)

          The current plan of the network site.

          • options — (Array<map>)

            The options of the plan.

            • namerequired — (String)

              The name of the pair.

            • value — (String)

              The value of the pair.

          • resourceDefinitions — (Array<map>)

            The resource definitions of the plan.

            • countrequired — (Integer)

              The count in the network resource definition.

            • options — (Array<map>)

              The options in the network resource definition.

              • namerequired — (String)

                The name of the pair.

              • value — (String)

                The value of the pair.

            • typerequired — (String)

              The type in the network resource definition.

              Possible values include:
              • "RADIO_UNIT"
              • "DEVICE_IDENTIFIER"
        • description — (String)

          The description of the network site.

        • networkArnrequired — (String)

          The Amazon Resource Name (ARN) of the network to which the network site belongs.

        • networkSiteArnrequired — (String)

          The Amazon Resource Name (ARN) of the network site.

        • networkSiteNamerequired — (String)

          The name of the network site.

        • pendingPlan — (map)

          The pending plan of the network site.

          • options — (Array<map>)

            The options of the plan.

            • namerequired — (String)

              The name of the pair.

            • value — (String)

              The value of the pair.

          • resourceDefinitions — (Array<map>)

            The resource definitions of the plan.

            • countrequired — (Integer)

              The count in the network resource definition.

            • options — (Array<map>)

              The options in the network resource definition.

              • namerequired — (String)

                The name of the pair.

              • value — (String)

                The value of the pair.

            • typerequired — (String)

              The type in the network resource definition.

              Possible values include:
              • "RADIO_UNIT"
              • "DEVICE_IDENTIFIER"
        • statusrequired — (String)

          The status of the network site.

          Possible values include:
          • "CREATED"
          • "PROVISIONING"
          • "AVAILABLE"
          • "DEPROVISIONING"
          • "DELETED"
        • statusReason — (String)

          The status reason of the network site.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

Examples:

Calling the configureAccessPoint operation

var params = {
  accessPointArn: 'STRING_VALUE', /* required */
  cpiSecretKey: 'STRING_VALUE',
  cpiUserId: 'STRING_VALUE',
  cpiUserPassword: 'STRING_VALUE',
  cpiUsername: 'STRING_VALUE',
  position: {
    elevation: 'NUMBER_VALUE',
    elevationReference: AGL | AMSL,
    elevationUnit: FEET,
    latitude: 'NUMBER_VALUE',
    longitude: 'NUMBER_VALUE'
  }
};
privatenetworks.configureAccessPoint(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • accessPointArn — (String)

      The Amazon Resource Name (ARN) of the network resource.

    • cpiSecretKey — (String)

      A Base64 encoded string of the CPI certificate associated with the CPI user who is certifying the coordinates of the network resource.

    • cpiUserId — (String)

      The CPI user ID of the CPI user who is certifying the coordinates of the network resource.

    • cpiUserPassword — (String)

      The CPI password associated with the CPI certificate in cpiSecretKey.

    • cpiUsername — (String)

      The CPI user name of the CPI user who is certifying the coordinates of the radio unit.

    • position — (map)

      The position of the network resource.

      • elevation — (Float)

        The elevation of the equipment at this position.

      • elevationReference — (String)

        The reference point from which elevation is reported.

        Possible values include:
        • "AGL"
        • "AMSL"
      • elevationUnit — (String)

        The units used to measure the elevation of the position.

        Possible values include:
        • "FEET"
      • latitude — (Float)

        The latitude of the position.

      • longitude — (Float)

        The longitude of the position.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • accessPoint — (map)

        Information about the network resource.

        • attributes — (Array<map>)

          The attributes of the network resource.

          • namerequired — (String)

            The name of the pair.

          • value — (String)

            The value of the pair.

        • createdAt — (Date)

          The creation time of the network resource.

        • description — (String)

          The description of the network resource.

        • health — (String)

          The health of the network resource.

          Possible values include:
          • "INITIAL"
          • "HEALTHY"
          • "UNHEALTHY"
        • model — (String)

          The model of the network resource.

        • networkArn — (String)

          The Amazon Resource Name (ARN) of the network on which this network resource appears.

        • networkResourceArn — (String)

          The Amazon Resource Name (ARN) of the network resource.

        • networkSiteArn — (String)

          The Amazon Resource Name (ARN) of the network site on which this network resource appears.

        • orderArn — (String)

          The Amazon Resource Name (ARN) of the order used to purchase this network resource.

        • position — (map)

          The position of the network resource.

          • elevation — (Float)

            The elevation of the equipment at this position.

          • elevationReference — (String)

            The reference point from which elevation is reported.

            Possible values include:
            • "AGL"
            • "AMSL"
          • elevationUnit — (String)

            The units used to measure the elevation of the position.

            Possible values include:
            • "FEET"
          • latitude — (Float)

            The latitude of the position.

          • longitude — (Float)

            The longitude of the position.

        • serialNumber — (String)

          The serial number of the network resource.

        • status — (String)

          The status of the network resource.

          Possible values include:
          • "PENDING"
          • "SHIPPED"
          • "PROVISIONING"
          • "PROVISIONED"
          • "AVAILABLE"
          • "DELETING"
          • "PENDING_RETURN"
          • "DELETED"
        • statusReason — (String)

          The status reason of the network resource.

        • type — (String)

          The type of the network resource.

          Possible values include:
          • "RADIO_UNIT"
        • vendor — (String)

          The vendor of the network resource.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Creates a network.

Service Reference:

Examples:

Calling the createNetwork operation

var params = {
  networkName: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  description: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
privatenetworks.createNetwork(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • clientToken — (String)

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

    • description — (String)

      The description of the network.

    • networkName — (String)

      The name of the network. You can't change the name after you create the network.

    • tags — (map<String>)

      The tags to apply to the network.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • network — (map)

        Information about the network.

        • createdAt — (Date)

          The creation time of the network.

        • description — (String)

          The description of the network.

        • networkArnrequired — (String)

          The Amazon Resource Name (ARN) of the network.

        • networkNamerequired — (String)

          The name of the network.

        • statusrequired — (String)

          The status of the network.

          Possible values include:
          • "CREATED"
          • "PROVISIONING"
          • "AVAILABLE"
          • "DEPROVISIONING"
          • "DELETED"
        • statusReason — (String)

          The status reason of the network.

      • tags — (map<String>)

        The network tags.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Creates a network site.

Service Reference:

Examples:

Calling the createNetworkSite operation

var params = {
  networkArn: 'STRING_VALUE', /* required */
  networkSiteName: 'STRING_VALUE', /* required */
  availabilityZone: 'STRING_VALUE',
  availabilityZoneId: 'STRING_VALUE',
  clientToken: 'STRING_VALUE',
  description: 'STRING_VALUE',
  pendingPlan: {
    options: [
      {
        name: 'STRING_VALUE', /* required */
        value: 'STRING_VALUE'
      },
      /* more items */
    ],
    resourceDefinitions: [
      {
        count: 'NUMBER_VALUE', /* required */
        type: RADIO_UNIT | DEVICE_IDENTIFIER, /* required */
        options: [
          {
            name: 'STRING_VALUE', /* required */
            value: 'STRING_VALUE'
          },
          /* more items */
        ]
      },
      /* more items */
    ]
  },
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
privatenetworks.createNetworkSite(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • availabilityZone — (String)

      The Availability Zone that is the parent of this site. You can't change the Availability Zone after you create the site.

    • availabilityZoneId — (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 — (String)

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

    • description — (String)

      The description of the site.

    • networkArn — (String)

      The Amazon Resource Name (ARN) of the network.

    • networkSiteName — (String)

      The name of the site. You can't change the name after you create the site.

    • pendingPlan — (map)

      Information about the pending plan for this site.

      • options — (Array<map>)

        The options of the plan.

        • namerequired — (String)

          The name of the pair.

        • value — (String)

          The value of the pair.

      • resourceDefinitions — (Array<map>)

        The resource definitions of the plan.

        • countrequired — (Integer)

          The count in the network resource definition.

        • options — (Array<map>)

          The options in the network resource definition.

          • namerequired — (String)

            The name of the pair.

          • value — (String)

            The value of the pair.

        • typerequired — (String)

          The type in the network resource definition.

          Possible values include:
          • "RADIO_UNIT"
          • "DEVICE_IDENTIFIER"
    • tags — (map<String>)

      The tags to apply to the network site.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • networkSite — (map)

        Information about the network site.

        • availabilityZone — (String)

          The parent Availability Zone for the network site.

        • availabilityZoneId — (String)

          The parent Availability Zone ID for the network site.

        • createdAt — (Date)

          The creation time of the network site.

        • currentPlan — (map)

          The current plan of the network site.

          • options — (Array<map>)

            The options of the plan.

            • namerequired — (String)

              The name of the pair.

            • value — (String)

              The value of the pair.

          • resourceDefinitions — (Array<map>)

            The resource definitions of the plan.

            • countrequired — (Integer)

              The count in the network resource definition.

            • options — (Array<map>)

              The options in the network resource definition.

              • namerequired — (String)

                The name of the pair.

              • value — (String)

                The value of the pair.

            • typerequired — (String)

              The type in the network resource definition.

              Possible values include:
              • "RADIO_UNIT"
              • "DEVICE_IDENTIFIER"
        • description — (String)

          The description of the network site.

        • networkArnrequired — (String)

          The Amazon Resource Name (ARN) of the network to which the network site belongs.

        • networkSiteArnrequired — (String)

          The Amazon Resource Name (ARN) of the network site.

        • networkSiteNamerequired — (String)

          The name of the network site.

        • pendingPlan — (map)

          The pending plan of the network site.

          • options — (Array<map>)

            The options of the plan.

            • namerequired — (String)

              The name of the pair.

            • value — (String)

              The value of the pair.

          • resourceDefinitions — (Array<map>)

            The resource definitions of the plan.

            • countrequired — (Integer)

              The count in the network resource definition.

            • options — (Array<map>)

              The options in the network resource definition.

              • namerequired — (String)

                The name of the pair.

              • value — (String)

                The value of the pair.

            • typerequired — (String)

              The type in the network resource definition.

              Possible values include:
              • "RADIO_UNIT"
              • "DEVICE_IDENTIFIER"
        • statusrequired — (String)

          The status of the network site.

          Possible values include:
          • "CREATED"
          • "PROVISIONING"
          • "AVAILABLE"
          • "DEPROVISIONING"
          • "DELETED"
        • statusReason — (String)

          The status reason of the network site.

      • tags — (map<String>)

        The network site tags.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Deactivates the specified device identifier.

Service Reference:

Examples:

Calling the deactivateDeviceIdentifier operation

var params = {
  deviceIdentifierArn: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
privatenetworks.deactivateDeviceIdentifier(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • clientToken — (String)

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

    • deviceIdentifierArn — (String)

      The Amazon Resource Name (ARN) of the device identifier.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • deviceIdentifier — (map)

        Information about the device identifier.

        • createdAt — (Date)

          The creation time of this device identifier.

        • deviceIdentifierArn — (String)

          The Amazon Resource Name (ARN) of the device identifier.

        • iccid — (String)

          The Integrated Circuit Card Identifier of the device identifier.

        • imsi — (String)

          The International Mobile Subscriber Identity of the device identifier.

        • networkArn — (String)

          The Amazon Resource Name (ARN) of the network on which the device identifier appears.

        • orderArn — (String)

          The Amazon Resource Name (ARN) of the order used to purchase the device identifier.

        • status — (String)

          The status of the device identifier.

          Possible values include:
          • "ACTIVE"
          • "INACTIVE"
        • trafficGroupArn — (String)

          The Amazon Resource Name (ARN) of the traffic group to which the device identifier belongs.

        • vendor — (String)

          The vendor of the device identifier.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

Examples:

Calling the deleteNetwork operation

var params = {
  networkArn: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
privatenetworks.deleteNetwork(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • clientToken — (String)

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

    • networkArn — (String)

      The Amazon Resource Name (ARN) of the network.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • network — (map)

        Information about the network.

        • createdAt — (Date)

          The creation time of the network.

        • description — (String)

          The description of the network.

        • networkArnrequired — (String)

          The Amazon Resource Name (ARN) of the network.

        • networkNamerequired — (String)

          The name of the network.

        • statusrequired — (String)

          The status of the network.

          Possible values include:
          • "CREATED"
          • "PROVISIONING"
          • "AVAILABLE"
          • "DEPROVISIONING"
          • "DELETED"
        • statusReason — (String)

          The status reason of the network.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

Examples:

Calling the deleteNetworkSite operation

var params = {
  networkSiteArn: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
privatenetworks.deleteNetworkSite(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • clientToken — (String)

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

    • networkSiteArn — (String)

      The Amazon Resource Name (ARN) of the network site.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • networkSite — (map)

        Information about the network site.

        • availabilityZone — (String)

          The parent Availability Zone for the network site.

        • availabilityZoneId — (String)

          The parent Availability Zone ID for the network site.

        • createdAt — (Date)

          The creation time of the network site.

        • currentPlan — (map)

          The current plan of the network site.

          • options — (Array<map>)

            The options of the plan.

            • namerequired — (String)

              The name of the pair.

            • value — (String)

              The value of the pair.

          • resourceDefinitions — (Array<map>)

            The resource definitions of the plan.

            • countrequired — (Integer)

              The count in the network resource definition.

            • options — (Array<map>)

              The options in the network resource definition.

              • namerequired — (String)

                The name of the pair.

              • value — (String)

                The value of the pair.

            • typerequired — (String)

              The type in the network resource definition.

              Possible values include:
              • "RADIO_UNIT"
              • "DEVICE_IDENTIFIER"
        • description — (String)

          The description of the network site.

        • networkArnrequired — (String)

          The Amazon Resource Name (ARN) of the network to which the network site belongs.

        • networkSiteArnrequired — (String)

          The Amazon Resource Name (ARN) of the network site.

        • networkSiteNamerequired — (String)

          The name of the network site.

        • pendingPlan — (map)

          The pending plan of the network site.

          • options — (Array<map>)

            The options of the plan.

            • namerequired — (String)

              The name of the pair.

            • value — (String)

              The value of the pair.

          • resourceDefinitions — (Array<map>)

            The resource definitions of the plan.

            • countrequired — (Integer)

              The count in the network resource definition.

            • options — (Array<map>)

              The options in the network resource definition.

              • namerequired — (String)

                The name of the pair.

              • value — (String)

                The value of the pair.

            • typerequired — (String)

              The type in the network resource definition.

              Possible values include:
              • "RADIO_UNIT"
              • "DEVICE_IDENTIFIER"
        • statusrequired — (String)

          The status of the network site.

          Possible values include:
          • "CREATED"
          • "PROVISIONING"
          • "AVAILABLE"
          • "DEPROVISIONING"
          • "DELETED"
        • statusReason — (String)

          The status reason of the network site.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Gets the specified device identifier.

Service Reference:

Examples:

Calling the getDeviceIdentifier operation

var params = {
  deviceIdentifierArn: 'STRING_VALUE' /* required */
};
privatenetworks.getDeviceIdentifier(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • deviceIdentifierArn — (String)

      The Amazon Resource Name (ARN) of the device identifier.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • deviceIdentifier — (map)

        Information about the device identifier.

        • createdAt — (Date)

          The creation time of this device identifier.

        • deviceIdentifierArn — (String)

          The Amazon Resource Name (ARN) of the device identifier.

        • iccid — (String)

          The Integrated Circuit Card Identifier of the device identifier.

        • imsi — (String)

          The International Mobile Subscriber Identity of the device identifier.

        • networkArn — (String)

          The Amazon Resource Name (ARN) of the network on which the device identifier appears.

        • orderArn — (String)

          The Amazon Resource Name (ARN) of the order used to purchase the device identifier.

        • status — (String)

          The status of the device identifier.

          Possible values include:
          • "ACTIVE"
          • "INACTIVE"
        • trafficGroupArn — (String)

          The Amazon Resource Name (ARN) of the traffic group to which the device identifier belongs.

        • vendor — (String)

          The vendor of the device identifier.

      • tags — (map<String>)

        The device identifier tags.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Gets the specified network.

Service Reference:

Examples:

Calling the getNetwork operation

var params = {
  networkArn: 'STRING_VALUE' /* required */
};
privatenetworks.getNetwork(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • networkArn — (String)

      The Amazon Resource Name (ARN) of the network.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • network — (map)

        Information about the network.

        • createdAt — (Date)

          The creation time of the network.

        • description — (String)

          The description of the network.

        • networkArnrequired — (String)

          The Amazon Resource Name (ARN) of the network.

        • networkNamerequired — (String)

          The name of the network.

        • statusrequired — (String)

          The status of the network.

          Possible values include:
          • "CREATED"
          • "PROVISIONING"
          • "AVAILABLE"
          • "DEPROVISIONING"
          • "DELETED"
        • statusReason — (String)

          The status reason of the network.

      • tags — (map<String>)

        The network tags.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Gets the specified network resource.

Service Reference:

Examples:

Calling the getNetworkResource operation

var params = {
  networkResourceArn: 'STRING_VALUE' /* required */
};
privatenetworks.getNetworkResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • networkResourceArn — (String)

      The Amazon Resource Name (ARN) of the network resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • networkResource — (map)

        Information about the network resource.

        • attributes — (Array<map>)

          The attributes of the network resource.

          • namerequired — (String)

            The name of the pair.

          • value — (String)

            The value of the pair.

        • createdAt — (Date)

          The creation time of the network resource.

        • description — (String)

          The description of the network resource.

        • health — (String)

          The health of the network resource.

          Possible values include:
          • "INITIAL"
          • "HEALTHY"
          • "UNHEALTHY"
        • model — (String)

          The model of the network resource.

        • networkArn — (String)

          The Amazon Resource Name (ARN) of the network on which this network resource appears.

        • networkResourceArn — (String)

          The Amazon Resource Name (ARN) of the network resource.

        • networkSiteArn — (String)

          The Amazon Resource Name (ARN) of the network site on which this network resource appears.

        • orderArn — (String)

          The Amazon Resource Name (ARN) of the order used to purchase this network resource.

        • position — (map)

          The position of the network resource.

          • elevation — (Float)

            The elevation of the equipment at this position.

          • elevationReference — (String)

            The reference point from which elevation is reported.

            Possible values include:
            • "AGL"
            • "AMSL"
          • elevationUnit — (String)

            The units used to measure the elevation of the position.

            Possible values include:
            • "FEET"
          • latitude — (Float)

            The latitude of the position.

          • longitude — (Float)

            The longitude of the position.

        • serialNumber — (String)

          The serial number of the network resource.

        • status — (String)

          The status of the network resource.

          Possible values include:
          • "PENDING"
          • "SHIPPED"
          • "PROVISIONING"
          • "PROVISIONED"
          • "AVAILABLE"
          • "DELETING"
          • "PENDING_RETURN"
          • "DELETED"
        • statusReason — (String)

          The status reason of the network resource.

        • type — (String)

          The type of the network resource.

          Possible values include:
          • "RADIO_UNIT"
        • vendor — (String)

          The vendor of the network resource.

      • tags — (map<String>)

        The network resource tags.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Gets the specified network site.

Service Reference:

Examples:

Calling the getNetworkSite operation

var params = {
  networkSiteArn: 'STRING_VALUE' /* required */
};
privatenetworks.getNetworkSite(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • networkSiteArn — (String)

      The Amazon Resource Name (ARN) of the network site.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • networkSite — (map)

        Information about the network site.

        • availabilityZone — (String)

          The parent Availability Zone for the network site.

        • availabilityZoneId — (String)

          The parent Availability Zone ID for the network site.

        • createdAt — (Date)

          The creation time of the network site.

        • currentPlan — (map)

          The current plan of the network site.

          • options — (Array<map>)

            The options of the plan.

            • namerequired — (String)

              The name of the pair.

            • value — (String)

              The value of the pair.

          • resourceDefinitions — (Array<map>)

            The resource definitions of the plan.

            • countrequired — (Integer)

              The count in the network resource definition.

            • options — (Array<map>)

              The options in the network resource definition.

              • namerequired — (String)

                The name of the pair.

              • value — (String)

                The value of the pair.

            • typerequired — (String)

              The type in the network resource definition.

              Possible values include:
              • "RADIO_UNIT"
              • "DEVICE_IDENTIFIER"
        • description — (String)

          The description of the network site.

        • networkArnrequired — (String)

          The Amazon Resource Name (ARN) of the network to which the network site belongs.

        • networkSiteArnrequired — (String)

          The Amazon Resource Name (ARN) of the network site.

        • networkSiteNamerequired — (String)

          The name of the network site.

        • pendingPlan — (map)

          The pending plan of the network site.

          • options — (Array<map>)

            The options of the plan.

            • namerequired — (String)

              The name of the pair.

            • value — (String)

              The value of the pair.

          • resourceDefinitions — (Array<map>)

            The resource definitions of the plan.

            • countrequired — (Integer)

              The count in the network resource definition.

            • options — (Array<map>)

              The options in the network resource definition.

              • namerequired — (String)

                The name of the pair.

              • value — (String)

                The value of the pair.

            • typerequired — (String)

              The type in the network resource definition.

              Possible values include:
              • "RADIO_UNIT"
              • "DEVICE_IDENTIFIER"
        • statusrequired — (String)

          The status of the network site.

          Possible values include:
          • "CREATED"
          • "PROVISIONING"
          • "AVAILABLE"
          • "DEPROVISIONING"
          • "DELETED"
        • statusReason — (String)

          The status reason of the network site.

      • tags — (map<String>)

        The network site tags.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Gets the specified order.

Service Reference:

Examples:

Calling the getOrder operation

var params = {
  orderArn: 'STRING_VALUE' /* required */
};
privatenetworks.getOrder(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • orderArn — (String)

      The Amazon Resource Name (ARN) of the order.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • order — (map)

        Information about the order.

        • acknowledgmentStatus — (String)

          The acknowledgement status of the order.

          Possible values include:
          • "ACKNOWLEDGING"
          • "ACKNOWLEDGED"
          • "UNACKNOWLEDGED"
        • createdAt — (Date)

          The creation time of the order.

        • networkArn — (String)

          The Amazon Resource Name (ARN) of the network associated with this order.

        • networkSiteArn — (String)

          The Amazon Resource Name (ARN) of the network site associated with this order.

        • orderArn — (String)

          The Amazon Resource Name (ARN) of the order.

        • shippingAddress — (map)

          The shipping address of the order.

          • cityrequired — (String)

            The city for this address.

          • company — (String)

            The company name for this address.

          • countryrequired — (String)

            The country for this address.

          • namerequired — (String)

            The recipient's name for this address.

          • phoneNumber — (String)

            The phone number for this address.

          • postalCoderequired — (String)

            The postal code for this address.

          • stateOrProvincerequired — (String)

            The state or province for this address.

          • street1required — (String)

            The first line of the street address.

          • street2 — (String)

            The second line of the street address.

          • street3 — (String)

            The third line of the street address.

        • trackingInformation — (Array<map>)

          The tracking information of the order.

          • trackingNumber — (String)

            The tracking number of the shipment.

      • tags — (map<String>)

        The order tags.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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.

 <p>If you specify multiple filters, filters are joined with an OR, and the request 

returns results that match all of the specified filters.

Service Reference:

Examples:

Calling the listDeviceIdentifiers operation

var params = {
  networkArn: 'STRING_VALUE', /* required */
  filters: {
    '<DeviceIdentifierFilterKeys>': [
      'STRING_VALUE',
      /* more items */
    ],
    /* '<DeviceIdentifierFilterKeys>': ... */
  },
  maxResults: 'NUMBER_VALUE',
  startToken: 'STRING_VALUE'
};
privatenetworks.listDeviceIdentifiers(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • filters — (map<Array<String>>)

      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 — (Integer)

      The maximum number of results to return.

    • networkArn — (String)

      The Amazon Resource Name (ARN) of the network.

    • startToken — (String)

      The token for the next page of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • deviceIdentifiers — (Array<map>)

        Information about the device identifiers.

        • createdAt — (Date)

          The creation time of this device identifier.

        • deviceIdentifierArn — (String)

          The Amazon Resource Name (ARN) of the device identifier.

        • iccid — (String)

          The Integrated Circuit Card Identifier of the device identifier.

        • imsi — (String)

          The International Mobile Subscriber Identity of the device identifier.

        • networkArn — (String)

          The Amazon Resource Name (ARN) of the network on which the device identifier appears.

        • orderArn — (String)

          The Amazon Resource Name (ARN) of the order used to purchase the device identifier.

        • status — (String)

          The status of the device identifier.

          Possible values include:
          • "ACTIVE"
          • "INACTIVE"
        • trafficGroupArn — (String)

          The Amazon Resource Name (ARN) of the traffic group to which the device identifier belongs.

        • vendor — (String)

          The vendor of the device identifier.

      • nextToken — (String)

        The token for the next page of results.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

Examples:

Calling the listNetworkResources operation

var params = {
  networkArn: 'STRING_VALUE', /* required */
  filters: {
    '<NetworkResourceFilterKeys>': [
      'STRING_VALUE',
      /* more items */
    ],
    /* '<NetworkResourceFilterKeys>': ... */
  },
  maxResults: 'NUMBER_VALUE',
  startToken: 'STRING_VALUE'
};
privatenetworks.listNetworkResources(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • filters — (map<Array<String>>)

      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 — (Integer)

      The maximum number of results to return.

    • networkArn — (String)

      The Amazon Resource Name (ARN) of the network.

    • startToken — (String)

      The token for the next page of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • networkResources — (Array<map>)

        Information about network resources.

        • attributes — (Array<map>)

          The attributes of the network resource.

          • namerequired — (String)

            The name of the pair.

          • value — (String)

            The value of the pair.

        • createdAt — (Date)

          The creation time of the network resource.

        • description — (String)

          The description of the network resource.

        • health — (String)

          The health of the network resource.

          Possible values include:
          • "INITIAL"
          • "HEALTHY"
          • "UNHEALTHY"
        • model — (String)

          The model of the network resource.

        • networkArn — (String)

          The Amazon Resource Name (ARN) of the network on which this network resource appears.

        • networkResourceArn — (String)

          The Amazon Resource Name (ARN) of the network resource.

        • networkSiteArn — (String)

          The Amazon Resource Name (ARN) of the network site on which this network resource appears.

        • orderArn — (String)

          The Amazon Resource Name (ARN) of the order used to purchase this network resource.

        • position — (map)

          The position of the network resource.

          • elevation — (Float)

            The elevation of the equipment at this position.

          • elevationReference — (String)

            The reference point from which elevation is reported.

            Possible values include:
            • "AGL"
            • "AMSL"
          • elevationUnit — (String)

            The units used to measure the elevation of the position.

            Possible values include:
            • "FEET"
          • latitude — (Float)

            The latitude of the position.

          • longitude — (Float)

            The longitude of the position.

        • serialNumber — (String)

          The serial number of the network resource.

        • status — (String)

          The status of the network resource.

          Possible values include:
          • "PENDING"
          • "SHIPPED"
          • "PROVISIONING"
          • "PROVISIONED"
          • "AVAILABLE"
          • "DELETING"
          • "PENDING_RETURN"
          • "DELETED"
        • statusReason — (String)

          The status reason of the network resource.

        • type — (String)

          The type of the network resource.

          Possible values include:
          • "RADIO_UNIT"
        • vendor — (String)

          The vendor of the network resource.

      • nextToken — (String)

        The token for the next page of results.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

Examples:

Calling the listNetworks operation

var params = {
  filters: {
    '<NetworkFilterKeys>': [
      'STRING_VALUE',
      /* more items */
    ],
    /* '<NetworkFilterKeys>': ... */
  },
  maxResults: 'NUMBER_VALUE',
  startToken: 'STRING_VALUE'
};
privatenetworks.listNetworks(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • filters — (map<Array<String>>)

      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 — (Integer)

      The maximum number of results to return.

    • startToken — (String)

      The token for the next page of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • networks — (Array<map>)

        The networks.

        • createdAt — (Date)

          The creation time of the network.

        • description — (String)

          The description of the network.

        • networkArnrequired — (String)

          The Amazon Resource Name (ARN) of the network.

        • networkNamerequired — (String)

          The name of the network.

        • statusrequired — (String)

          The status of the network.

          Possible values include:
          • "CREATED"
          • "PROVISIONING"
          • "AVAILABLE"
          • "DEPROVISIONING"
          • "DELETED"
        • statusReason — (String)

          The status reason of the network.

      • nextToken — (String)

        The token for the next page of results.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

Examples:

Calling the listNetworkSites operation

var params = {
  networkArn: 'STRING_VALUE', /* required */
  filters: {
    '<NetworkSiteFilterKeys>': [
      'STRING_VALUE',
      /* more items */
    ],
    /* '<NetworkSiteFilterKeys>': ... */
  },
  maxResults: 'NUMBER_VALUE',
  startToken: 'STRING_VALUE'
};
privatenetworks.listNetworkSites(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • filters — (map<Array<String>>)

      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 — (Integer)

      The maximum number of results to return.

    • networkArn — (String)

      The Amazon Resource Name (ARN) of the network.

    • startToken — (String)

      The token for the next page of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • networkSites — (Array<map>)

        Information about the network sites.

        • availabilityZone — (String)

          The parent Availability Zone for the network site.

        • availabilityZoneId — (String)

          The parent Availability Zone ID for the network site.

        • createdAt — (Date)

          The creation time of the network site.

        • currentPlan — (map)

          The current plan of the network site.

          • options — (Array<map>)

            The options of the plan.

            • namerequired — (String)

              The name of the pair.

            • value — (String)

              The value of the pair.

          • resourceDefinitions — (Array<map>)

            The resource definitions of the plan.

            • countrequired — (Integer)

              The count in the network resource definition.

            • options — (Array<map>)

              The options in the network resource definition.

              • namerequired — (String)

                The name of the pair.

              • value — (String)

                The value of the pair.

            • typerequired — (String)

              The type in the network resource definition.

              Possible values include:
              • "RADIO_UNIT"
              • "DEVICE_IDENTIFIER"
        • description — (String)

          The description of the network site.

        • networkArnrequired — (String)

          The Amazon Resource Name (ARN) of the network to which the network site belongs.

        • networkSiteArnrequired — (String)

          The Amazon Resource Name (ARN) of the network site.

        • networkSiteNamerequired — (String)

          The name of the network site.

        • pendingPlan — (map)

          The pending plan of the network site.

          • options — (Array<map>)

            The options of the plan.

            • namerequired — (String)

              The name of the pair.

            • value — (String)

              The value of the pair.

          • resourceDefinitions — (Array<map>)

            The resource definitions of the plan.

            • countrequired — (Integer)

              The count in the network resource definition.

            • options — (Array<map>)

              The options in the network resource definition.

              • namerequired — (String)

                The name of the pair.

              • value — (String)

                The value of the pair.

            • typerequired — (String)

              The type in the network resource definition.

              Possible values include:
              • "RADIO_UNIT"
              • "DEVICE_IDENTIFIER"
        • statusrequired — (String)

          The status of the network site.

          Possible values include:
          • "CREATED"
          • "PROVISIONING"
          • "AVAILABLE"
          • "DEPROVISIONING"
          • "DELETED"
        • statusReason — (String)

          The status reason of the network site.

      • nextToken — (String)

        The token for the next page of results.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

Examples:

Calling the listOrders operation

var params = {
  networkArn: 'STRING_VALUE', /* required */
  filters: {
    '<OrderFilterKeys>': [
      'STRING_VALUE',
      /* more items */
    ],
    /* '<OrderFilterKeys>': ... */
  },
  maxResults: 'NUMBER_VALUE',
  startToken: 'STRING_VALUE'
};
privatenetworks.listOrders(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • filters — (map<Array<String>>)

      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 — (Integer)

      The maximum number of results to return.

    • networkArn — (String)

      The Amazon Resource Name (ARN) of the network.

    • startToken — (String)

      The token for the next page of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • nextToken — (String)

        The token for the next page of results.

      • orders — (Array<map>)

        Information about the orders.

        • acknowledgmentStatus — (String)

          The acknowledgement status of the order.

          Possible values include:
          • "ACKNOWLEDGING"
          • "ACKNOWLEDGED"
          • "UNACKNOWLEDGED"
        • createdAt — (Date)

          The creation time of the order.

        • networkArn — (String)

          The Amazon Resource Name (ARN) of the network associated with this order.

        • networkSiteArn — (String)

          The Amazon Resource Name (ARN) of the network site associated with this order.

        • orderArn — (String)

          The Amazon Resource Name (ARN) of the order.

        • shippingAddress — (map)

          The shipping address of the order.

          • cityrequired — (String)

            The city for this address.

          • company — (String)

            The company name for this address.

          • countryrequired — (String)

            The country for this address.

          • namerequired — (String)

            The recipient's name for this address.

          • phoneNumber — (String)

            The phone number for this address.

          • postalCoderequired — (String)

            The postal code for this address.

          • stateOrProvincerequired — (String)

            The state or province for this address.

          • street1required — (String)

            The first line of the street address.

          • street2 — (String)

            The second line of the street address.

          • street3 — (String)

            The third line of the street address.

        • trackingInformation — (Array<map>)

          The tracking information of the order.

          • trackingNumber — (String)

            The tracking number of the shipment.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Lists the tags for the specified resource.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
privatenetworks.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • resourceArn — (String)

      The Amazon Resource Name (ARN) of the resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • tags — (map<String>)

        The resource tags.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Checks the health of the service.

Service Reference:

Examples:

Calling the ping operation

privatenetworks.ping(function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • status — (String)

        Information about the health of the service.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Adds tags to the specified resource.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
privatenetworks.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • resourceArn — (String)

      The Amazon Resource Name (ARN) of the resource.

    • tags — (map<String>)

      The tags to add to the resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Removes tags from the specified resource.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
privatenetworks.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • resourceArn — (String)

      The Amazon Resource Name (ARN) of the resource.

    • tagKeys — (Array<String>)

      The tag keys.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Updates the specified network site.

Service Reference:

Examples:

Calling the updateNetworkSite operation

var params = {
  networkSiteArn: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  description: 'STRING_VALUE'
};
privatenetworks.updateNetworkSite(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • clientToken — (String)

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

    • description — (String)

      The description.

    • networkSiteArn — (String)

      The Amazon Resource Name (ARN) of the network site.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • networkSite — (map)

        Information about the network site.

        • availabilityZone — (String)

          The parent Availability Zone for the network site.

        • availabilityZoneId — (String)

          The parent Availability Zone ID for the network site.

        • createdAt — (Date)

          The creation time of the network site.

        • currentPlan — (map)

          The current plan of the network site.

          • options — (Array<map>)

            The options of the plan.

            • namerequired — (String)

              The name of the pair.

            • value — (String)

              The value of the pair.

          • resourceDefinitions — (Array<map>)

            The resource definitions of the plan.

            • countrequired — (Integer)

              The count in the network resource definition.

            • options — (Array<map>)

              The options in the network resource definition.

              • namerequired — (String)

                The name of the pair.

              • value — (String)

                The value of the pair.

            • typerequired — (String)

              The type in the network resource definition.

              Possible values include:
              • "RADIO_UNIT"
              • "DEVICE_IDENTIFIER"
        • description — (String)

          The description of the network site.

        • networkArnrequired — (String)

          The Amazon Resource Name (ARN) of the network to which the network site belongs.

        • networkSiteArnrequired — (String)

          The Amazon Resource Name (ARN) of the network site.

        • networkSiteNamerequired — (String)

          The name of the network site.

        • pendingPlan — (map)

          The pending plan of the network site.

          • options — (Array<map>)

            The options of the plan.

            • namerequired — (String)

              The name of the pair.

            • value — (String)

              The value of the pair.

          • resourceDefinitions — (Array<map>)

            The resource definitions of the plan.

            • countrequired — (Integer)

              The count in the network resource definition.

            • options — (Array<map>)

              The options in the network resource definition.

              • namerequired — (String)

                The name of the pair.

              • value — (String)

                The value of the pair.

            • typerequired — (String)

              The type in the network resource definition.

              Possible values include:
              • "RADIO_UNIT"
              • "DEVICE_IDENTIFIER"
        • statusrequired — (String)

          The status of the network site.

          Possible values include:
          • "CREATED"
          • "PROVISIONING"
          • "AVAILABLE"
          • "DEPROVISIONING"
          • "DELETED"
        • statusReason — (String)

          The status reason of the network site.

      • tags — (map<String>)

        The network site tags.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Updates the specified network site plan.

Service Reference:

Examples:

Calling the updateNetworkSitePlan operation

var params = {
  networkSiteArn: 'STRING_VALUE', /* required */
  pendingPlan: { /* required */
    options: [
      {
        name: 'STRING_VALUE', /* required */
        value: 'STRING_VALUE'
      },
      /* more items */
    ],
    resourceDefinitions: [
      {
        count: 'NUMBER_VALUE', /* required */
        type: RADIO_UNIT | DEVICE_IDENTIFIER, /* required */
        options: [
          {
            name: 'STRING_VALUE', /* required */
            value: 'STRING_VALUE'
          },
          /* more items */
        ]
      },
      /* more items */
    ]
  },
  clientToken: 'STRING_VALUE'
};
privatenetworks.updateNetworkSitePlan(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • clientToken — (String)

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

    • networkSiteArn — (String)

      The Amazon Resource Name (ARN) of the network site.

    • pendingPlan — (map)

      The pending plan.

      • options — (Array<map>)

        The options of the plan.

        • namerequired — (String)

          The name of the pair.

        • value — (String)

          The value of the pair.

      • resourceDefinitions — (Array<map>)

        The resource definitions of the plan.

        • countrequired — (Integer)

          The count in the network resource definition.

        • options — (Array<map>)

          The options in the network resource definition.

          • namerequired — (String)

            The name of the pair.

          • value — (String)

            The value of the pair.

        • typerequired — (String)

          The type in the network resource definition.

          Possible values include:
          • "RADIO_UNIT"
          • "DEVICE_IDENTIFIER"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • networkSite — (map)

        Information about the network site.

        • availabilityZone — (String)

          The parent Availability Zone for the network site.

        • availabilityZoneId — (String)

          The parent Availability Zone ID for the network site.

        • createdAt — (Date)

          The creation time of the network site.

        • currentPlan — (map)

          The current plan of the network site.

          • options — (Array<map>)

            The options of the plan.

            • namerequired — (String)

              The name of the pair.

            • value — (String)

              The value of the pair.

          • resourceDefinitions — (Array<map>)

            The resource definitions of the plan.

            • countrequired — (Integer)

              The count in the network resource definition.

            • options — (Array<map>)

              The options in the network resource definition.

              • namerequired — (String)

                The name of the pair.

              • value — (String)

                The value of the pair.

            • typerequired — (String)

              The type in the network resource definition.

              Possible values include:
              • "RADIO_UNIT"
              • "DEVICE_IDENTIFIER"
        • description — (String)

          The description of the network site.

        • networkArnrequired — (String)

          The Amazon Resource Name (ARN) of the network to which the network site belongs.

        • networkSiteArnrequired — (String)

          The Amazon Resource Name (ARN) of the network site.

        • networkSiteNamerequired — (String)

          The name of the network site.

        • pendingPlan — (map)

          The pending plan of the network site.

          • options — (Array<map>)

            The options of the plan.

            • namerequired — (String)

              The name of the pair.

            • value — (String)

              The value of the pair.

          • resourceDefinitions — (Array<map>)

            The resource definitions of the plan.

            • countrequired — (Integer)

              The count in the network resource definition.

            • options — (Array<map>)

              The options in the network resource definition.

              • namerequired — (String)

                The name of the pair.

              • value — (String)

                The value of the pair.

            • typerequired — (String)

              The type in the network resource definition.

              Possible values include:
              • "RADIO_UNIT"
              • "DEVICE_IDENTIFIER"
        • statusrequired — (String)

          The status of the network site.

          Possible values include:
          • "CREATED"
          • "PROVISIONING"
          • "AVAILABLE"
          • "DEPROVISIONING"
          • "DELETED"
        • statusReason — (String)

          The status reason of the network site.

      • tags — (map<String>)

        The network site tags.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.