Class: AWS.PrivateNetworks

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.

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',
    emailAddress: 'STRING_VALUE',
    phoneNumber: 'STRING_VALUE',
    street2: 'STRING_VALUE',
    street3: 'STRING_VALUE'
  },
  clientToken: 'STRING_VALUE',
  commitmentConfiguration: {
    automaticRenewal: true || false, /* required */
    commitmentLength: SIXTY_DAYS | ONE_YEAR | THREE_YEARS /* required */
  }
};
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.

  • commitmentConfiguration — (map)

    Determines the duration and renewal status of the commitment period for all pending radio units.

    If you include commitmentConfiguration in the ActivateNetworkSiteRequest action, you must specify the following:

    • The commitment period for the radio unit. You can choose a 60-day, 1-year, or 3-year period.

    • Whether you want your commitment period to automatically renew for one more year after your current commitment period expires.

    For pricing, see Amazon Web Services Private 5G Pricing.

    If you do not include commitmentConfiguration in the ActivateNetworkSiteRequest action, the commitment period is set to 60-days.

    • automaticRenewal — required — (Boolean)

      Determines whether the commitment period for a radio unit is set to automatically renew for an additional 1 year after your current commitment period expires.

      Set to True, if you want your commitment period to automatically renew. Set to False if you do not want your commitment to automatically renew.

      You can do the following:

      • Set a 1-year commitment to automatically renew for an additional 1 year. The hourly rate for the additional year will continue to be the same as your existing 1-year rate.

      • Set a 3-year commitment to automatically renew for an additional 1 year. The hourly rate for the additional year will continue to be the same as your existing 3-year rate.

      • Turn off a previously-enabled automatic renewal on a 1-year or 3-year commitment.

      You cannot use the automatic-renewal option for a 60-day commitment.

    • commitmentLength — required — (String)

      The duration of the commitment period for the radio unit. You can choose a 60-day, 1-year, or 3-year period.

      Possible values include:
      • "SIXTY_DAYS"
      • "ONE_YEAR"
      • "THREE_YEARS"
  • networkSiteArn — (String)

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

  • shippingAddress — (map)

    The shipping address of the network site.

    • city — required — (String)

      The city for this address.

    • company — (String)

      The company name for this address.

    • country — required — (String)

      The country for this address.

    • emailAddress — (String)

      The recipient's email address.

    • name — required — (String)

      The recipient's name for this address.

    • phoneNumber — (String)

      The recipient's phone number.

    • postalCode — required — (String)

      The postal code for this address.

    • stateOrProvince — required — (String)

      The state or province for this address.

    • street1 — required — (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.

          • name — required — (String)

            The name of the pair.

          • value — (String)

            The value of the pair.

        • resourceDefinitions — (Array<map>)

          The resource definitions of the plan.

          • count — required — (Integer)

            The count in the network resource definition.

          • options — (Array<map>)

            The options in the network resource definition.

            • name — required — (String)

              The name of the pair.

            • value — (String)

              The value of the pair.

          • type — required — (String)

            The type in the network resource definition.

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

        The description of the network site.

      • networkArn — required — (String)

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

      • networkSiteArn — required — (String)

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

      • networkSiteName — required — (String)

        The name of the network site.

      • pendingPlan — (map)

        The pending plan of the network site.

        • options — (Array<map>)

          The options of the plan.

          • name — required — (String)

            The name of the pair.

          • value — (String)

            The value of the pair.

        • resourceDefinitions — (Array<map>)

          The resource definitions of the plan.

          • count — required — (Integer)

            The count in the network resource definition.

          • options — (Array<map>)

            The options in the network resource definition.

            • name — required — (String)

              The name of the pair.

            • value — (String)

              The value of the pair.

          • type — required — (String)

            The type in the network resource definition.

            Possible values include:
            • "RADIO_UNIT"
            • "DEVICE_IDENTIFIER"
      • status — required — (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.

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.

        • name — required — (String)

          The name of the pair.

        • value — (String)

          The value of the pair.

      • commitmentInformation — (map)

        Information about the commitment period for the radio unit. Shows the duration, the date and time that the contract started and ends, and the renewal status of the commitment period.

        • commitmentConfiguration — required — (map)

          The duration and renewal status of the commitment period for the radio unit.

          • automaticRenewal — required — (Boolean)

            Determines whether the commitment period for a radio unit is set to automatically renew for an additional 1 year after your current commitment period expires.

            Set to True, if you want your commitment period to automatically renew. Set to False if you do not want your commitment to automatically renew.

            You can do the following:

            • Set a 1-year commitment to automatically renew for an additional 1 year. The hourly rate for the additional year will continue to be the same as your existing 1-year rate.

            • Set a 3-year commitment to automatically renew for an additional 1 year. The hourly rate for the additional year will continue to be the same as your existing 3-year rate.

            • Turn off a previously-enabled automatic renewal on a 1-year or 3-year commitment.

            You cannot use the automatic-renewal option for a 60-day commitment.

          • commitmentLength — required — (String)

            The duration of the commitment period for the radio unit. You can choose a 60-day, 1-year, or 3-year period.

            Possible values include:
            • "SIXTY_DAYS"
            • "ONE_YEAR"
            • "THREE_YEARS"
        • expiresOn — (Date)

          The date and time that the commitment period ends. If you do not cancel or renew the commitment before the expiration date, you will be billed at the 60-day-commitment rate.

        • startAt — (Date)

          The date and time that the commitment period started.

      • 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.

      • returnInformation — (map)

        Information about a request to return the network resource.

        • replacementOrderArn — (String)

          The Amazon Resource Name (ARN) of the replacement order.

        • returnReason — (String)

          The reason for the return. If the return request did not include a reason for the return, this value is null.

        • shippingAddress — (map)

          The shipping address.

          • city — required — (String)

            The city for this address.

          • company — (String)

            The company name for this address.

          • country — required — (String)

            The country for this address.

          • emailAddress — (String)

            The recipient's email address.

          • name — required — (String)

            The recipient's name for this address.

          • phoneNumber — (String)

            The recipient's phone number.

          • postalCode — required — (String)

            The postal code for this address.

          • stateOrProvince — required — (String)

            The state or province for this address.

          • street1 — required — (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.

        • shippingLabel — (String)

          The URL of the shipping label. The shipping label is available for download only if the status of the network resource is PENDING_RETURN. For more information, see Return a radio unit.

      • 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"
        • "CREATING_SHIPPING_LABEL"
      • 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.

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.

      • networkArn — required — (String)

        The Amazon Resource Name (ARN) of the network.

      • networkName — required — (String)

        The name of the network.

      • status — required — (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.

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.

      • name — required — (String)

        The name of the pair.

      • value — (String)

        The value of the pair.

    • resourceDefinitions — (Array<map>)

      The resource definitions of the plan.

      • count — required — (Integer)

        The count in the network resource definition.

      • options — (Array<map>)

        The options in the network resource definition.

        • name — required — (String)

          The name of the pair.

        • value — (String)

          The value of the pair.

      • type — required — (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.

          • name — required — (String)

            The name of the pair.

          • value — (String)

            The value of the pair.

        • resourceDefinitions — (Array<map>)

          The resource definitions of the plan.

          • count — required — (Integer)

            The count in the network resource definition.

          • options — (Array<map>)

            The options in the network resource definition.

            • name — required — (String)

              The name of the pair.

            • value — (String)

              The value of the pair.

          • type — required — (String)

            The type in the network resource definition.

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

        The description of the network site.

      • networkArn — required — (String)

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

      • networkSiteArn — required — (String)

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

      • networkSiteName — required — (String)

        The name of the network site.

      • pendingPlan — (map)

        The pending plan of the network site.

        • options — (Array<map>)

          The options of the plan.

          • name — required — (String)

            The name of the pair.

          • value — (String)

            The value of the pair.

        • resourceDefinitions — (Array<map>)

          The resource definitions of the plan.

          • count — required — (Integer)

            The count in the network resource definition.

          • options — (Array<map>)

            The options in the network resource definition.

            • name — required — (String)

              The name of the pair.

            • value — (String)

              The value of the pair.

          • type — required — (String)

            The type in the network resource definition.

            Possible values include:
            • "RADIO_UNIT"
            • "DEVICE_IDENTIFIER"
      • status — required — (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.

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.

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.

      • networkArn — required — (String)

        The Amazon Resource Name (ARN) of the network.

      • networkName — required — (String)

        The name of the network.

      • status — required — (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.

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.

          • name — required — (String)

            The name of the pair.

          • value — (String)

            The value of the pair.

        • resourceDefinitions — (Array<map>)

          The resource definitions of the plan.

          • count — required — (Integer)

            The count in the network resource definition.

          • options — (Array<map>)

            The options in the network resource definition.

            • name — required — (String)

              The name of the pair.

            • value — (String)

              The value of the pair.

          • type — required — (String)

            The type in the network resource definition.

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

        The description of the network site.

      • networkArn — required — (String)

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

      • networkSiteArn — required — (String)

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

      • networkSiteName — required — (String)

        The name of the network site.

      • pendingPlan — (map)

        The pending plan of the network site.

        • options — (Array<map>)

          The options of the plan.

          • name — required — (String)

            The name of the pair.

          • value — (String)

            The value of the pair.

        • resourceDefinitions — (Array<map>)

          The resource definitions of the plan.

          • count — required — (Integer)

            The count in the network resource definition.

          • options — (Array<map>)

            The options in the network resource definition.

            • name — required — (String)

              The name of the pair.

            • value — (String)

              The value of the pair.

          • type — required — (String)

            The type in the network resource definition.

            Possible values include:
            • "RADIO_UNIT"
            • "DEVICE_IDENTIFIER"
      • status — required — (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.

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.

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.

      • networkArn — required — (String)

        The Amazon Resource Name (ARN) of the network.

      • networkName — required — (String)

        The name of the network.

      • status — required — (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.

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.

        • name — required — (String)

          The name of the pair.

        • value — (String)

          The value of the pair.

      • commitmentInformation — (map)

        Information about the commitment period for the radio unit. Shows the duration, the date and time that the contract started and ends, and the renewal status of the commitment period.

        • commitmentConfiguration — required — (map)

          The duration and renewal status of the commitment period for the radio unit.

          • automaticRenewal — required — (Boolean)

            Determines whether the commitment period for a radio unit is set to automatically renew for an additional 1 year after your current commitment period expires.

            Set to True, if you want your commitment period to automatically renew. Set to False if you do not want your commitment to automatically renew.

            You can do the following:

            • Set a 1-year commitment to automatically renew for an additional 1 year. The hourly rate for the additional year will continue to be the same as your existing 1-year rate.

            • Set a 3-year commitment to automatically renew for an additional 1 year. The hourly rate for the additional year will continue to be the same as your existing 3-year rate.

            • Turn off a previously-enabled automatic renewal on a 1-year or 3-year commitment.

            You cannot use the automatic-renewal option for a 60-day commitment.

          • commitmentLength — required — (String)

            The duration of the commitment period for the radio unit. You can choose a 60-day, 1-year, or 3-year period.

            Possible values include:
            • "SIXTY_DAYS"
            • "ONE_YEAR"
            • "THREE_YEARS"
        • expiresOn — (Date)

          The date and time that the commitment period ends. If you do not cancel or renew the commitment before the expiration date, you will be billed at the 60-day-commitment rate.

        • startAt — (Date)

          The date and time that the commitment period started.

      • 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.

      • returnInformation — (map)

        Information about a request to return the network resource.

        • replacementOrderArn — (String)

          The Amazon Resource Name (ARN) of the replacement order.

        • returnReason — (String)

          The reason for the return. If the return request did not include a reason for the return, this value is null.

        • shippingAddress — (map)

          The shipping address.

          • city — required — (String)

            The city for this address.

          • company — (String)

            The company name for this address.

          • country — required — (String)

            The country for this address.

          • emailAddress — (String)

            The recipient's email address.

          • name — required — (String)

            The recipient's name for this address.

          • phoneNumber — (String)

            The recipient's phone number.

          • postalCode — required — (String)

            The postal code for this address.

          • stateOrProvince — required — (String)

            The state or province for this address.

          • street1 — required — (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.

        • shippingLabel — (String)

          The URL of the shipping label. The shipping label is available for download only if the status of the network resource is PENDING_RETURN. For more information, see Return a radio unit.

      • 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"
        • "CREATING_SHIPPING_LABEL"
      • 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.

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.

          • name — required — (String)

            The name of the pair.

          • value — (String)

            The value of the pair.

        • resourceDefinitions — (Array<map>)

          The resource definitions of the plan.

          • count — required — (Integer)

            The count in the network resource definition.

          • options — (Array<map>)

            The options in the network resource definition.

            • name — required — (String)

              The name of the pair.

            • value — (String)

              The value of the pair.

          • type — required — (String)

            The type in the network resource definition.

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

        The description of the network site.

      • networkArn — required — (String)

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

      • networkSiteArn — required — (String)

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

      • networkSiteName — required — (String)

        The name of the network site.

      • pendingPlan — (map)

        The pending plan of the network site.

        • options — (Array<map>)

          The options of the plan.

          • name — required — (String)

            The name of the pair.

          • value — (String)

            The value of the pair.

        • resourceDefinitions — (Array<map>)

          The resource definitions of the plan.

          • count — required — (Integer)

            The count in the network resource definition.

          • options — (Array<map>)

            The options in the network resource definition.

            • name — required — (String)

              The name of the pair.

            • value — (String)

              The value of the pair.

          • type — required — (String)

            The type in the network resource definition.

            Possible values include:
            • "RADIO_UNIT"
            • "DEVICE_IDENTIFIER"
      • status — required — (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.

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.

      • orderedResources — (Array<map>)

        A list of the network resources placed in the order.

        • commitmentConfiguration — (map)

          The duration and renewal status of the commitment period for each radio unit in the order. Does not show details if the resource type is DEVICE_IDENTIFIER.

          • automaticRenewal — required — (Boolean)

            Determines whether the commitment period for a radio unit is set to automatically renew for an additional 1 year after your current commitment period expires.

            Set to True, if you want your commitment period to automatically renew. Set to False if you do not want your commitment to automatically renew.

            You can do the following:

            • Set a 1-year commitment to automatically renew for an additional 1 year. The hourly rate for the additional year will continue to be the same as your existing 1-year rate.

            • Set a 3-year commitment to automatically renew for an additional 1 year. The hourly rate for the additional year will continue to be the same as your existing 3-year rate.

            • Turn off a previously-enabled automatic renewal on a 1-year or 3-year commitment.

            You cannot use the automatic-renewal option for a 60-day commitment.

          • commitmentLength — required — (String)

            The duration of the commitment period for the radio unit. You can choose a 60-day, 1-year, or 3-year period.

            Possible values include:
            • "SIXTY_DAYS"
            • "ONE_YEAR"
            • "THREE_YEARS"
        • count — required — (Integer)

          The number of network resources in the order.

        • type — required — (String)

          The type of network resource in the order.

          Possible values include:
          • "RADIO_UNIT"
          • "DEVICE_IDENTIFIER"
      • shippingAddress — (map)

        The shipping address of the order.

        • city — required — (String)

          The city for this address.

        • company — (String)

          The company name for this address.

        • country — required — (String)

          The country for this address.

        • emailAddress — (String)

          The recipient's email address.

        • name — required — (String)

          The recipient's name for this address.

        • phoneNumber — (String)

          The recipient's phone number.

        • postalCode — required — (String)

          The postal code for this address.

        • stateOrProvince — required — (String)

          The state or province for this address.

        • street1 — required — (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.

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.

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.

        • name — required — (String)

          The name of the pair.

        • value — (String)

          The value of the pair.

      • commitmentInformation — (map)

        Information about the commitment period for the radio unit. Shows the duration, the date and time that the contract started and ends, and the renewal status of the commitment period.

        • commitmentConfiguration — required — (map)

          The duration and renewal status of the commitment period for the radio unit.

          • automaticRenewal — required — (Boolean)

            Determines whether the commitment period for a radio unit is set to automatically renew for an additional 1 year after your current commitment period expires.

            Set to True, if you want your commitment period to automatically renew. Set to False if you do not want your commitment to automatically renew.

            You can do the following:

            • Set a 1-year commitment to automatically renew for an additional 1 year. The hourly rate for the additional year will continue to be the same as your existing 1-year rate.

            • Set a 3-year commitment to automatically renew for an additional 1 year. The hourly rate for the additional year will continue to be the same as your existing 3-year rate.

            • Turn off a previously-enabled automatic renewal on a 1-year or 3-year commitment.

            You cannot use the automatic-renewal option for a 60-day commitment.

          • commitmentLength — required — (String)

            The duration of the commitment period for the radio unit. You can choose a 60-day, 1-year, or 3-year period.

            Possible values include:
            • "SIXTY_DAYS"
            • "ONE_YEAR"
            • "THREE_YEARS"
        • expiresOn — (Date)

          The date and time that the commitment period ends. If you do not cancel or renew the commitment before the expiration date, you will be billed at the 60-day-commitment rate.

        • startAt — (Date)

          The date and time that the commitment period started.

      • 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.

      • returnInformation — (map)

        Information about a request to return the network resource.

        • replacementOrderArn — (String)

          The Amazon Resource Name (ARN) of the replacement order.

        • returnReason — (String)

          The reason for the return. If the return request did not include a reason for the return, this value is null.

        • shippingAddress — (map)

          The shipping address.

          • city — required — (String)

            The city for this address.

          • company — (String)

            The company name for this address.

          • country — required — (String)

            The country for this address.

          • emailAddress — (String)

            The recipient's email address.

          • name — required — (String)

            The recipient's name for this address.

          • phoneNumber — (String)

            The recipient's phone number.

          • postalCode — required — (String)

            The postal code for this address.

          • stateOrProvince — required — (String)

            The state or province for this address.

          • street1 — required — (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.

        • shippingLabel — (String)

          The URL of the shipping label. The shipping label is available for download only if the status of the network resource is PENDING_RETURN. For more information, see Return a radio unit.

      • 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"
        • "CREATING_SHIPPING_LABEL"
      • 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.

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.

      • networkArn — required — (String)

        The Amazon Resource Name (ARN) of the network.

      • networkName — required — (String)

        The name of the network.

      • status — required — (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.

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.

          • name — required — (String)

            The name of the pair.

          • value — (String)

            The value of the pair.

        • resourceDefinitions — (Array<map>)

          The resource definitions of the plan.

          • count — required — (Integer)

            The count in the network resource definition.

          • options — (Array<map>)

            The options in the network resource definition.

            • name — required — (String)

              The name of the pair.

            • value — (String)

              The value of the pair.

          • type — required — (String)

            The type in the network resource definition.

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

        The description of the network site.

      • networkArn — required — (String)

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

      • networkSiteArn — required — (String)

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

      • networkSiteName — required — (String)

        The name of the network site.

      • pendingPlan — (map)

        The pending plan of the network site.

        • options — (Array<map>)

          The options of the plan.

          • name — required — (String)

            The name of the pair.

          • value — (String)

            The value of the pair.

        • resourceDefinitions — (Array<map>)

          The resource definitions of the plan.

          • count — required — (Integer)

            The count in the network resource definition.

          • options — (Array<map>)

            The options in the network resource definition.

            • name — required — (String)

              The name of the pair.

            • value — (String)

              The value of the pair.

          • type — required — (String)

            The type in the network resource definition.

            Possible values include:
            • "RADIO_UNIT"
            • "DEVICE_IDENTIFIER"
      • status — required — (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.

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.

      • orderedResources — (Array<map>)

        A list of the network resources placed in the order.

        • commitmentConfiguration — (map)

          The duration and renewal status of the commitment period for each radio unit in the order. Does not show details if the resource type is DEVICE_IDENTIFIER.

          • automaticRenewal — required — (Boolean)

            Determines whether the commitment period for a radio unit is set to automatically renew for an additional 1 year after your current commitment period expires.

            Set to True, if you want your commitment period to automatically renew. Set to False if you do not want your commitment to automatically renew.

            You can do the following:

            • Set a 1-year commitment to automatically renew for an additional 1 year. The hourly rate for the additional year will continue to be the same as your existing 1-year rate.

            • Set a 3-year commitment to automatically renew for an additional 1 year. The hourly rate for the additional year will continue to be the same as your existing 3-year rate.

            • Turn off a previously-enabled automatic renewal on a 1-year or 3-year commitment.

            You cannot use the automatic-renewal option for a 60-day commitment.

          • commitmentLength — required — (String)

            The duration of the commitment period for the radio unit. You can choose a 60-day, 1-year, or 3-year period.

            Possible values include:
            • "SIXTY_DAYS"
            • "ONE_YEAR"
            • "THREE_YEARS"
        • count — required — (Integer)

          The number of network resources in the order.

        • type — required — (String)

          The type of network resource in the order.

          Possible values include:
          • "RADIO_UNIT"
          • "DEVICE_IDENTIFIER"
      • shippingAddress — (map)

        The shipping address of the order.

        • city — required — (String)

          The city for this address.

        • company — (String)

          The company name for this address.

        • country — required — (String)

          The country for this address.

        • emailAddress — (String)

          The recipient's email address.

        • name — required — (String)

          The recipient's name for this address.

        • phoneNumber — (String)

          The recipient's phone number.

        • postalCode — required — (String)

          The postal code for this address.

        • stateOrProvince — required — (String)

          The state or province for this address.

        • street1 — required — (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.

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.

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.

var params = {
  networkResourceArn: 'STRING_VALUE', /* required */
  updateType: REPLACE | RETURN | COMMITMENT, /* required */
  commitmentConfiguration: {
    automaticRenewal: true || false, /* required */
    commitmentLength: SIXTY_DAYS | ONE_YEAR | THREE_YEARS /* required */
  },
  returnReason: 'STRING_VALUE',
  shippingAddress: {
    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',
    emailAddress: 'STRING_VALUE',
    phoneNumber: 'STRING_VALUE',
    street2: 'STRING_VALUE',
    street3: 'STRING_VALUE'
  }
};
privatenetworks.startNetworkResourceUpdate(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: {}) —
  • commitmentConfiguration — (map)

    Use this action to extend and automatically renew the commitment period for the radio unit. You can do the following:

    • Change a 60-day commitment to a 1-year or 3-year commitment. The change is immediate and the hourly rate decreases to the rate for the new commitment period.

    • Change a 1-year commitment to a 3-year commitment. The change is immediate and the hourly rate decreases to the rate for the 3-year commitment period.

    • Set a 1-year commitment to automatically renew for an additional 1 year. The hourly rate for the additional year will continue to be the same as your existing 1-year rate.

    • Set a 3-year commitment to automatically renew for an additional 1 year. The hourly rate for the additional year will continue to be the same as your existing 3-year rate.

    • Turn off a previously-enabled automatic renewal on a 1-year or 3-year commitment. You cannot use the automatic-renewal option for a 60-day commitment.

    For pricing, see Amazon Web Services Private 5G Pricing.

    • automaticRenewal — required — (Boolean)

      Determines whether the commitment period for a radio unit is set to automatically renew for an additional 1 year after your current commitment period expires.

      Set to True, if you want your commitment period to automatically renew. Set to False if you do not want your commitment to automatically renew.

      You can do the following:

      • Set a 1-year commitment to automatically renew for an additional 1 year. The hourly rate for the additional year will continue to be the same as your existing 1-year rate.

      • Set a 3-year commitment to automatically renew for an additional 1 year. The hourly rate for the additional year will continue to be the same as your existing 3-year rate.

      • Turn off a previously-enabled automatic renewal on a 1-year or 3-year commitment.

      You cannot use the automatic-renewal option for a 60-day commitment.

    • commitmentLength — required — (String)

      The duration of the commitment period for the radio unit. You can choose a 60-day, 1-year, or 3-year period.

      Possible values include:
      • "SIXTY_DAYS"
      • "ONE_YEAR"
      • "THREE_YEARS"
  • networkResourceArn — (String)

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

  • returnReason — (String)

    The reason for the return. Providing a reason for a return is optional.

  • shippingAddress — (map)

    The shipping address. If you don't provide a shipping address when replacing or returning a network resource, we use the address from the original order for the network resource.

    • city — required — (String)

      The city for this address.

    • company — (String)

      The company name for this address.

    • country — required — (String)

      The country for this address.

    • emailAddress — (String)

      The recipient's email address.

    • name — required — (String)

      The recipient's name for this address.

    • phoneNumber — (String)

      The recipient's phone number.

    • postalCode — required — (String)

      The postal code for this address.

    • stateOrProvince — required — (String)

      The state or province for this address.

    • street1 — required — (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.

  • updateType — (String)

    The update type.

    • REPLACE - Submits a request to replace a defective radio unit. We provide a shipping label that you can use for the return process and we ship a replacement radio unit to you.

    • RETURN - Submits a request to return a radio unit that you no longer need. We provide a shipping label that you can use for the return process.

    • COMMITMENT - Submits a request to change or renew the commitment period. If you choose this value, then you must set commitmentConfiguration .

    Possible values include:
    • "REPLACE"
    • "RETURN"
    • "COMMITMENT"

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)

      The network resource.

      • attributes — (Array<map>)

        The attributes of the network resource.

        • name — required — (String)

          The name of the pair.

        • value — (String)

          The value of the pair.

      • commitmentInformation — (map)

        Information about the commitment period for the radio unit. Shows the duration, the date and time that the contract started and ends, and the renewal status of the commitment period.

        • commitmentConfiguration — required — (map)

          The duration and renewal status of the commitment period for the radio unit.

          • automaticRenewal — required — (Boolean)

            Determines whether the commitment period for a radio unit is set to automatically renew for an additional 1 year after your current commitment period expires.

            Set to True, if you want your commitment period to automatically renew. Set to False if you do not want your commitment to automatically renew.

            You can do the following:

            • Set a 1-year commitment to automatically renew for an additional 1 year. The hourly rate for the additional year will continue to be the same as your existing 1-year rate.

            • Set a 3-year commitment to automatically renew for an additional 1 year. The hourly rate for the additional year will continue to be the same as your existing 3-year rate.

            • Turn off a previously-enabled automatic renewal on a 1-year or 3-year commitment.

            You cannot use the automatic-renewal option for a 60-day commitment.

          • commitmentLength — required — (String)

            The duration of the commitment period for the radio unit. You can choose a 60-day, 1-year, or 3-year period.

            Possible values include:
            • "SIXTY_DAYS"
            • "ONE_YEAR"
            • "THREE_YEARS"
        • expiresOn — (Date)

          The date and time that the commitment period ends. If you do not cancel or renew the commitment before the expiration date, you will be billed at the 60-day-commitment rate.

        • startAt — (Date)

          The date and time that the commitment period started.

      • 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.

      • returnInformation — (map)

        Information about a request to return the network resource.

        • replacementOrderArn — (String)

          The Amazon Resource Name (ARN) of the replacement order.

        • returnReason — (String)

          The reason for the return. If the return request did not include a reason for the return, this value is null.

        • shippingAddress — (map)

          The shipping address.

          • city — required — (String)

            The city for this address.

          • company — (String)

            The company name for this address.

          • country — required — (String)

            The country for this address.

          • emailAddress — (String)

            The recipient's email address.

          • name — required — (String)

            The recipient's name for this address.

          • phoneNumber — (String)

            The recipient's phone number.

          • postalCode — required — (String)

            The postal code for this address.

          • stateOrProvince — required — (String)

            The state or province for this address.

          • street1 — required — (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.

        • shippingLabel — (String)

          The URL of the shipping label. The shipping label is available for download only if the status of the network resource is PENDING_RETURN. For more information, see Return a radio unit.

      • 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"
        • "CREATING_SHIPPING_LABEL"
      • 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.

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.

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.

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.

          • name — required — (String)

            The name of the pair.

          • value — (String)

            The value of the pair.

        • resourceDefinitions — (Array<map>)

          The resource definitions of the plan.

          • count — required — (Integer)

            The count in the network resource definition.

          • options — (Array<map>)

            The options in the network resource definition.

            • name — required — (String)

              The name of the pair.

            • value — (String)

              The value of the pair.

          • type — required — (String)

            The type in the network resource definition.

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

        The description of the network site.

      • networkArn — required — (String)

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

      • networkSiteArn — required — (String)

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

      • networkSiteName — required — (String)

        The name of the network site.

      • pendingPlan — (map)

        The pending plan of the network site.

        • options — (Array<map>)

          The options of the plan.

          • name — required — (String)

            The name of the pair.

          • value — (String)

            The value of the pair.

        • resourceDefinitions — (Array<map>)

          The resource definitions of the plan.

          • count — required — (Integer)

            The count in the network resource definition.

          • options — (Array<map>)

            The options in the network resource definition.

            • name — required — (String)

              The name of the pair.

            • value — (String)

              The value of the pair.

          • type — required — (String)

            The type in the network resource definition.

            Possible values include:
            • "RADIO_UNIT"
            • "DEVICE_IDENTIFIER"
      • status — required — (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.

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.

      • name — required — (String)

        The name of the pair.

      • value — (String)

        The value of the pair.

    • resourceDefinitions — (Array<map>)

      The resource definitions of the plan.

      • count — required — (Integer)

        The count in the network resource definition.

      • options — (Array<map>)

        The options in the network resource definition.

        • name — required — (String)

          The name of the pair.

        • value — (String)

          The value of the pair.

      • type — required — (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.

          • name — required — (String)

            The name of the pair.

          • value — (String)

            The value of the pair.

        • resourceDefinitions — (Array<map>)

          The resource definitions of the plan.

          • count — required — (Integer)

            The count in the network resource definition.

          • options — (Array<map>)

            The options in the network resource definition.

            • name — required — (String)

              The name of the pair.

            • value — (String)

              The value of the pair.

          • type — required — (String)

            The type in the network resource definition.

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

        The description of the network site.

      • networkArn — required — (String)

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

      • networkSiteArn — required — (String)

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

      • networkSiteName — required — (String)

        The name of the network site.

      • pendingPlan — (map)

        The pending plan of the network site.

        • options — (Array<map>)

          The options of the plan.

          • name — required — (String)

            The name of the pair.

          • value — (String)

            The value of the pair.

        • resourceDefinitions — (Array<map>)

          The resource definitions of the plan.

          • count — required — (Integer)

            The count in the network resource definition.

          • options — (Array<map>)

            The options in the network resource definition.

            • name — required — (String)

              The name of the pair.

            • value — (String)

              The value of the pair.

          • type — required — (String)

            The type in the network resource definition.

            Possible values include:
            • "RADIO_UNIT"
            • "DEVICE_IDENTIFIER"
      • status — required — (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.