ConfigureAccessPoint
Configures the specified network resource.
Use this action to specify the geographic position of the hardware. You must provide Certified Professional Installer (CPI) credentials in the request so that we can obtain spectrum grants. For more information, see Radio units in the AWS Private 5G User Guide.
Request Syntax
POST /v1/network-resources/configure HTTP/1.1
Content-type: application/json
{
"accessPointArn": "string",
"cpiSecretKey": "string",
"cpiUserId": "string",
"cpiUsername": "string",
"cpiUserPassword": "string",
"position": {
"elevation": number,
"elevationReference": "string",
"elevationUnit": "string",
"latitude": number,
"longitude": number
}
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- accessPointArn
-
The Amazon Resource Name (ARN) of the network resource.
Type: String
Pattern:
^arn:aws:private-networks:[a-z0-9-]+:[^:]*:.*$Required: Yes
- cpiSecretKey
-
A Base64 encoded string of the CPI certificate associated with the CPI user who is certifying the coordinates of the network resource.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100000.
Required: No
- cpiUserId
-
The CPI user ID of the CPI user who is certifying the coordinates of the network resource.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 4096.
Required: No
- cpiUsername
-
The CPI user name of the CPI user who is certifying the coordinates of the radio unit.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 4096.
Required: No
- cpiUserPassword
-
The CPI password associated with the CPI certificate in
cpiSecretKey.Type: String
Length Constraints: Minimum length of 1. Maximum length of 4096.
Required: No
- position
-
The position of the network resource.
Type: Position object
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"accessPoint": {
"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.
- accessPoint
-
Information about 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
