[ aws . privatenetworks ]

configure-access-point

Description

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 Amazon Web Services Private 5G User Guide .

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  configure-access-point
--access-point-arn <value>
[--cpi-secret-key <value>]
[--cpi-user-id <value>]
[--cpi-user-password <value>]
[--cpi-username <value>]
[--position <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--access-point-arn (string)

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

--cpi-secret-key (string)

A Base64 encoded string of the CPI certificate associated with the CPI user who is certifying the coordinates of the network resource.

--cpi-user-id (string)

The CPI user ID of the CPI user who is certifying the coordinates of the network resource.

--cpi-user-password (string)

The CPI password associated with the CPI certificate in cpiSecretKey .

--cpi-username (string)

The CPI user name of the CPI user who is certifying the coordinates of the radio unit.

--position (structure)

The position of the network resource.

elevation -> (double)

The elevation of the equipment at this position.

elevationReference -> (string)

The reference point from which elevation is reported.

elevationUnit -> (string)

The units used to measure the elevation of the position.

latitude -> (double)

The latitude of the position.

longitude -> (double)

The longitude of the position.

Shorthand Syntax:

elevation=double,elevationReference=string,elevationUnit=string,latitude=double,longitude=double

JSON Syntax:

{
  "elevation": double,
  "elevationReference": "AGL"|"AMSL",
  "elevationUnit": "FEET",
  "latitude": double,
  "longitude": double
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

accessPoint -> (structure)

Information about the network resource.

attributes -> (list)

The attributes of the network resource.

(structure)

Information about a name/value pair.

name -> (string)

The name of the pair.

value -> (string)

The value of the pair.

createdAt -> (timestamp)

The creation time of the network resource.

description -> (string)

The description of the network resource.

health -> (string)

The health of the network resource.

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 -> (structure)

The position of the network resource.

elevation -> (double)

The elevation of the equipment at this position.

elevationReference -> (string)

The reference point from which elevation is reported.

elevationUnit -> (string)

The units used to measure the elevation of the position.

latitude -> (double)

The latitude of the position.

longitude -> (double)

The longitude of the position.

serialNumber -> (string)

The serial number of the network resource.

status -> (string)

The status of the network resource.

statusReason -> (string)

The status reason of the network resource.

type -> (string)

The type of the network resource.

vendor -> (string)

The vendor of the network resource.