Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

StartNetworkResourceUpdate

Use this action to do the following tasks:

Update the duration and renewal status of the commitment period for a radio unit. The update goes into effect immediately.
Request a replacement for a network resource.
Request that you return a network resource.

After you submit a request to replace or return a network resource, the status of the network resource changes to CREATING_SHIPPING_LABEL. The shipping label is available when the status of the network resource is PENDING_RETURN. After the network resource is successfully returned, its status changes to DELETED. For more information, see Return a radio unit.

Request Syntax


POST /v1/network-resources/update HTTP/1.1
Content-type: application/json

{
   "commitmentConfiguration": { 
      "automaticRenewal": boolean,
      "commitmentLength": "string"
   },
   "networkResourceArn": "string",
   "returnReason": "string",
   "shippingAddress": { 
      "city": "string",
      "company": "string",
      "country": "string",
      "emailAddress": "string",
      "name": "string",
      "phoneNumber": "string",
      "postalCode": "string",
      "stateOrProvince": "string",
      "street1": "string",
      "street2": "string",
      "street3": "string"
   },
   "updateType": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

commitmentConfiguration

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. Your commitment will renew each year. The hourly rate will continue at your existing 1-year rate.
Set a 3-year commitment to automatically renew in 1 year increments. The hourly rate will continue at 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 AWS Private 5G Pricing.

Type: CommitmentConfiguration object

Required: No

networkResourceArn

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

Type: String

Pattern: ^arn:aws:private-networks:[a-z0-9-]+:[^:]*:.*$

Required: Yes

returnReason

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

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1000.

Required: No

shippingAddress

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.

Type: Address object

Required: No

updateType

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.

Type: String

Valid Values: REPLACE | RETURN | COMMITMENT

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "networkResource": { 
      "attributes": [ 
         { 
            "name": "string",
            "value": "string"
         }
      ],
      "commitmentInformation": { 
         "commitmentConfiguration": { 
            "automaticRenewal": boolean,
            "commitmentLength": "string"
         },
         "expiresOn": "string",
         "startAt": "string"
      },
      "createdAt": "string",
      "description": "string",
      "health": "string",
      "model": "string",
      "networkArn": "string",
      "networkResourceArn": "string",
      "networkSiteArn": "string",
      "orderArn": "string",
      "position": { 
         "elevation": number,
         "elevationReference": "string",
         "elevationUnit": "string",
         "latitude": number,
         "longitude": number
      },
      "returnInformation": { 
         "replacementOrderArn": "string",
         "returnReason": "string",
         "shippingAddress": { 
            "city": "string",
            "company": "string",
            "country": "string",
            "emailAddress": "string",
            "name": "string",
            "phoneNumber": "string",
            "postalCode": "string",
            "stateOrProvince": "string",
            "street1": "string",
            "street2": "string",
            "street3": "string"
         },
         "shippingLabel": "string"
      },
      "serialNumber": "string",
      "status": "string",
      "statusReason": "string",
      "type": "string",
      "vendor": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

networkResource

The network resource.

Type: NetworkResource object

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerException

Information about an internal error.

HTTP Status Code: 500

ResourceNotFoundException

The resource was not found.

HTTP Status Code: 404

ValidationException

The request failed validation.

HTTP Status Code: 400