AWS CLI Command Reference

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

update-sol-network-instance

Description

Update a network instance.

A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.

Choose the updateType parameter to target the necessary update of the network instance.

See also: AWS API Documentation

update-sol-network-instance uses document type values. Document types follow the JSON data model where valid values are: strings, numbers, booleans, null, arrays, and objects. For command input, options and nested parameters that are labeled with the type document must be provided as JSON. Shorthand syntax does not support document types.

Synopsis

  update-sol-network-instance
[--modify-vnf-info-data <value>]
--ns-instance-id <value>
[--tags <value>]
[--update-ns <value>]
--update-type <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

--modify-vnf-info-data (structure)

Identifies the network function information parameters and/or the configurable properties of the network function to be modified.

Include this property only if the update type is MODIFY_VNF_INFORMATION .

vnfConfigurableProperties -> (document)

Provides values for the configurable properties declared in the function package descriptor.

vnfInstanceId -> (string)

ID of the network function instance.

A network function instance is a function in a function package .

Shorthand Syntax:

vnfInstanceId=string

JSON Syntax:

{
  "vnfConfigurableProperties": {...},
  "vnfInstanceId": "string"
}

--ns-instance-id (string)

ID of the network instance.

--tags (map)

A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are only applied to the network operation that is created. These tags are not applied to the network instance. Use tags to search and filter your resources or track your Amazon Web Services costs.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--update-ns (structure)

Identifies the network service descriptor and the configurable properties of the descriptor, to be used for the update.

Include this property only if the update type is UPDATE_NS .

additionalParamsForNs -> (document)

Values for the configurable properties declared in the network service descriptor.

nsdInfoId -> (string)

ID of the network service descriptor.

Shorthand Syntax:

nsdInfoId=string

JSON Syntax:

{
  "additionalParamsForNs": {...},
  "nsdInfoId": "string"
}

--update-type (string)

The type of update.

  • Use the MODIFY_VNF_INFORMATION update type, to update a specific network function configuration, in the network instance.
  • Use the UPDATE_NS update type, to update the network instance to a new network service descriptor.

Possible values:

  • MODIFY_VNF_INFORMATION
  • UPDATE_NS

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

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

nsLcmOpOccId -> (string)

The identifier of the network operation.

tags -> (map)

A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are only applied to the network operation that is created. These tags are not applied to the network instance. Use tags to search and filter your resources or track your Amazon Web Services costs.

key -> (string)

value -> (string)