Note:
You are viewing the documentation for an older major version of the AWS CLI (version 1).AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
[ aws . privatenetworks ]
update-network-site-plan¶
Synopsis¶
update-network-site-plan
[--client-token <value>]
--network-site-arn <value>
--pending-plan <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
Options¶
--client-token (string)
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency .
--network-site-arn (string)
The Amazon Resource Name (ARN) of the network site.
--pending-plan (structure)
The pending plan.
options -> (list)
The options of the plan.
(structure)
Information about a name/value pair.
name -> (string)
The name of the pair.value -> (string)
The value of the pair.resourceDefinitions -> (list)
The resource definitions of the plan.
(structure)
Information about a network resource definition.
count -> (integer)
The count in the network resource definition.options -> (list)
The options in the network resource definition.
(structure)
Information about a name/value pair.
name -> (string)
The name of the pair.value -> (string)
The value of the pair.type -> (string)
The type in the network resource definition.
JSON Syntax:
{
"options": [
{
"name": "string",
"value": "string"
}
...
],
"resourceDefinitions": [
{
"count": integer,
"options": [
{
"name": "string",
"value": "string"
}
...
],
"type": "RADIO_UNIT"|"DEVICE_IDENTIFIER"
}
...
]
}
--cli-input-json (string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.
--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
Global Options¶
--debug (boolean)
Turn on debug logging.
--endpoint-url (string)
Override command's default URL with the given URL.
--no-verify-ssl (boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate (boolean)
Disable automatic pagination.
--output (string)
The formatting style for command output.
- json
- text
- table
--query (string)
A JMESPath query to use in filtering the response data.
--profile (string)
Use a specific profile from your credential file.
--region (string)
The region to use. Overrides config/env settings.
--version (string)
Display the version of this tool.
--color (string)
Turn on/off color output.
- on
- off
- auto
--no-sign-request (boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle (string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout (int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout (int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
Output¶
networkSite -> (structure)
Information about the network site.
availabilityZone -> (string)
The parent Availability Zone for the network site.availabilityZoneId -> (string)
The parent Availability Zone ID for the network site.createdAt -> (timestamp)
The creation time of the network site.currentPlan -> (structure)
The current plan of the network site.
options -> (list)
The options of the plan.
(structure)
Information about a name/value pair.
name -> (string)
The name of the pair.value -> (string)
The value of the pair.resourceDefinitions -> (list)
The resource definitions of the plan.
(structure)
Information about a network resource definition.
count -> (integer)
The count in the network resource definition.options -> (list)
The options in the network resource definition.
(structure)
Information about a name/value pair.
name -> (string)
The name of the pair.value -> (string)
The value of the pair.type -> (string)
The type in the network resource definition.description -> (string)
The description of the network site.networkArn -> (string)
The Amazon Resource Name (ARN) of the network to which the network site belongs.networkSiteArn -> (string)
The Amazon Resource Name (ARN) of the network site.networkSiteName -> (string)
The name of the network site.pendingPlan -> (structure)
The pending plan of the network site.
options -> (list)
The options of the plan.
(structure)
Information about a name/value pair.
name -> (string)
The name of the pair.value -> (string)
The value of the pair.resourceDefinitions -> (list)
The resource definitions of the plan.
(structure)
Information about a network resource definition.
count -> (integer)
The count in the network resource definition.options -> (list)
The options in the network resource definition.
(structure)
Information about a name/value pair.
name -> (string)
The name of the pair.value -> (string)
The value of the pair.type -> (string)
The type in the network resource definition.status -> (string)
The status of the network site.statusReason -> (string)
The status reason of the network site.
tags -> (map)
The network site tags.
key -> (string)
value -> (string)