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

DeleteNetworkSite

Deletes the specified network site. Return the hardware after you delete the network site. You are responsible for minimum charges. For more information, see Hardware returns in the AWS Private 5G User Guide.

Request Syntax


DELETE /v1/network-sites/networkSiteArn?clientToken=clientToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

clientToken

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

Length Constraints: Minimum length of 1. Maximum length of 100.

networkSiteArn

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

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

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "networkSite": { 
      "availabilityZone": "string",
      "availabilityZoneId": "string",
      "createdAt": "string",
      "currentPlan": { 
         "options": [ 
            { 
               "name": "string",
               "value": "string"
            }
         ],
         "resourceDefinitions": [ 
            { 
               "count": number,
               "options": [ 
                  { 
                     "name": "string",
                     "value": "string"
                  }
               ],
               "type": "string"
            }
         ]
      },
      "description": "string",
      "networkArn": "string",
      "networkSiteArn": "string",
      "networkSiteName": "string",
      "pendingPlan": { 
         "options": [ 
            { 
               "name": "string",
               "value": "string"
            }
         ],
         "resourceDefinitions": [ 
            { 
               "count": number,
               "options": [ 
                  { 
                     "name": "string",
                     "value": "string"
                  }
               ],
               "type": "string"
            }
         ]
      },
      "status": "string",
      "statusReason": "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.

networkSite

Information about the network site.

Type: NetworkSite object

Errors

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

AccessDeniedException

You do not have permission to perform this operation.

HTTP Status Code: 403

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