AWS CLI Command Reference

[ aws . privatenetworks ]

activate-network-site

Description

Activates the specified network site.

See also: AWS API Documentation

Synopsis

  activate-network-site
[--client-token <value>]
[--commitment-configuration <value>]
--network-site-arn <value>
--shipping-address <value>
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

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 .

--commitment-configuration (structure)

Determines the duration and renewal status of the commitment period for all pending radio units.

If you include commitmentConfiguration in the ActivateNetworkSiteRequest 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 for one more year after your current commitment period expires.

For pricing, see Amazon Web Services Private 5G Pricing .

If you do not include commitmentConfiguration in the ActivateNetworkSiteRequest action, the commitment period is set to 60-days.

automaticRenewal -> (boolean)

Determines whether the commitment period for a radio unit is set to automatically renew for an additional 1 year after your current commitment period expires.

Set to True , if you want your commitment period to automatically renew. Set to False if you do not want your commitment to automatically renew.

You can do the following:

  • Set a 1-year commitment to automatically renew for an additional 1 year. The hourly rate for the additional year will continue to be the same as your existing 1-year rate.
  • Set a 3-year commitment to automatically renew for an additional 1 year. The hourly rate for the additional year will continue to be the same as your existing 3-year rate.
  • Turn off a previously-enabled automatic renewal on a 1-year or 3-year commitment.

You cannot use the automatic-renewal option for a 60-day commitment.

commitmentLength -> (string)

The duration of the commitment period for the radio unit. You can choose a 60-day, 1-year, or 3-year period.

Shorthand Syntax:

automaticRenewal=boolean,commitmentLength=string

JSON Syntax:

{
  "automaticRenewal": true|false,
  "commitmentLength": "SIXTY_DAYS"|"ONE_YEAR"|"THREE_YEARS"
}

--network-site-arn (string)

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

--shipping-address (structure)

The shipping address of the network site.

city -> (string)

The city for this address.

company -> (string)

The company name for this address.

country -> (string)

The country for this address.

emailAddress -> (string)

The recipient’s email address.

name -> (string)

The recipient’s name for this address.

phoneNumber -> (string)

The recipient’s phone number.

postalCode -> (string)

The postal code for this address.

stateOrProvince -> (string)

The state or province for this address.

street1 -> (string)

The first line of the street address.

street2 -> (string)

The second line of the street address.

street3 -> (string)

The third line of the street address.

Shorthand Syntax:

city=string,company=string,country=string,emailAddress=string,name=string,phoneNumber=string,postalCode=string,stateOrProvince=string,street1=string,street2=string,street3=string

JSON Syntax:

{
  "city": "string",
  "company": "string",
  "country": "string",
  "emailAddress": "string",
  "name": "string",
  "phoneNumber": "string",
  "postalCode": "string",
  "stateOrProvince": "string",
  "street1": "string",
  "street2": "string",
  "street3": "string"
}

--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.

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. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--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.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

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.
© Copyright 2018, Amazon Web Services. Created using Sphinx.