ActivateNetworkSite
Activates the specified network site.
Request Syntax
POST /v1/network-sites/activate HTTP/1.1
Content-type: application/json
{
"clientToken": "string
",
"commitmentConfiguration": {
"automaticRenewal": boolean
,
"commitmentLength": "string
"
},
"networkSiteArn": "string
",
"shippingAddress": {
"city": "string
",
"company": "string
",
"country": "string
",
"emailAddress": "string
",
"name": "string
",
"phoneNumber": "string
",
"postalCode": "string
",
"stateOrProvince": "string
",
"street1": "string
",
"street2": "string
",
"street3": "string
"
}
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- clientToken
-
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: No
- commitmentConfiguration
-
Determines the duration and renewal status of the commitment period for all pending radio units.
If you include
commitmentConfiguration
in theActivateNetworkSiteRequest
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 in 1-year increments after your current commitment period expires.
For pricing, see AWS Private 5G Pricing
. If you do not include
commitmentConfiguration
in theActivateNetworkSiteRequest
action, the commitment period is set to 60-days.Type: CommitmentConfiguration object
Required: No
-
- networkSiteArn
-
The Amazon Resource Name (ARN) of the network site.
Type: String
Pattern:
^arn:aws:private-networks:[a-z0-9-]+:[^:]*:.*$
Required: Yes
- shippingAddress
-
The shipping address of the network site.
Type: Address object
Required: Yes
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.
- 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: