TelcoNetworkBuilder / Client / update_sol_network_instance

update_sol_network_instance#

TelcoNetworkBuilder.Client.update_sol_network_instance(**kwargs)#

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

Request Syntax

response = client.update_sol_network_instance(
    modifyVnfInfoData={
        'vnfConfigurableProperties': {...}|[...]|123|123.4|'string'|True|None,
        'vnfInstanceId': 'string'
    },
    nsInstanceId='string',
    tags={
        'string': 'string'
    },
    updateNs={
        'additionalParamsForNs': {...}|[...]|123|123.4|'string'|True|None,
        'nsdInfoId': 'string'
    },
    updateType='MODIFY_VNF_INFORMATION'|'UPDATE_NS'
)
Parameters:

  • modifyVnfInfoData (dict) –

    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) – [REQUIRED]

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

    • vnfInstanceId (string) – [REQUIRED]

      ID of the network function instance.

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

  • nsInstanceId (string) –

    [REQUIRED]

    ID of the network instance.

  • tags (dict) –

    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.

    • (string) –

      • (string) –

  • updateNs (dict) –

    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) – [REQUIRED]

      ID of the network service descriptor.

  • updateType (string) –

    [REQUIRED]

    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.

Return type:

dict

Returns:

Response Syntax

{
    'nsLcmOpOccId': 'string',
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) –

    • nsLcmOpOccId (string) –

      The identifier of the network operation.

    • tags (dict) –

      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.

      • (string) –

        • (string) –

Exceptions

  • TelcoNetworkBuilder.Client.exceptions.InternalServerException

  • TelcoNetworkBuilder.Client.exceptions.ServiceQuotaExceededException

  • TelcoNetworkBuilder.Client.exceptions.ThrottlingException

  • TelcoNetworkBuilder.Client.exceptions.ValidationException

  • TelcoNetworkBuilder.Client.exceptions.ResourceNotFoundException

  • TelcoNetworkBuilder.Client.exceptions.AccessDeniedException