TelcoNetworkBuilder / Client / get_sol_network_operation

get_sol_network_operation

TelcoNetworkBuilder.Client.get_sol_network_operation(**kwargs)

Gets the details of a network operation, including the tasks involved in the network operation and the status of the tasks.

A network operation is any operation that is done to your network, such as network instance instantiation or termination.

See also: AWS API Documentation

Request Syntax

response = client.get_sol_network_operation(
    nsLcmOpOccId='string'
)

Parameters:

nsLcmOpOccId (string) –

[REQUIRED]

The identifier of the network operation.

Return type:

dict

Returns:

Response Syntax

{
    'arn': 'string',
    'error': {
        'detail': 'string',
        'title': 'string'
    },
    'id': 'string',
    'lcmOperationType': 'INSTANTIATE'|'UPDATE'|'TERMINATE',
    'metadata': {
        'createdAt': datetime(2015, 1, 1),
        'instantiateMetadata': {
            'additionalParamsForNs': {...}|[...]|123|123.4|'string'|True|None,
            'nsdInfoId': 'string'
        },
        'lastModified': datetime(2015, 1, 1),
        'modifyVnfInfoMetadata': {
            'vnfConfigurableProperties': {...}|[...]|123|123.4|'string'|True|None,
            'vnfInstanceId': 'string'
        },
        'updateNsMetadata': {
            'additionalParamsForNs': {...}|[...]|123|123.4|'string'|True|None,
            'nsdInfoId': 'string'
        }
    },
    'nsInstanceId': 'string',
    'operationState': 'PROCESSING'|'COMPLETED'|'FAILED'|'CANCELLING'|'CANCELLED',
    'tags': {
        'string': 'string'
    },
    'tasks': [
        {
            'taskContext': {
                'string': 'string'
            },
            'taskEndTime': datetime(2015, 1, 1),
            'taskErrorDetails': {
                'cause': 'string',
                'details': 'string'
            },
            'taskName': 'string',
            'taskStartTime': datetime(2015, 1, 1),
            'taskStatus': 'SCHEDULED'|'STARTED'|'IN_PROGRESS'|'COMPLETED'|'ERROR'|'SKIPPED'|'CANCELLED'
        },
    ],
    'updateType': 'MODIFY_VNF_INFORMATION'|'UPDATE_NS'
}

Response Structure

• (dict) –

  • arn (string) –

    Network operation ARN.

  • error (dict) –

    Error related to this specific network operation occurrence.

    • detail (string) –

      A human-readable explanation specific to this occurrence of the problem.

    • title (string) –

      A human-readable title of the problem type.

  • id (string) –

    ID of this network operation occurrence.

  • lcmOperationType (string) –

    Type of the operation represented by this occurrence.

  • metadata (dict) –

    Metadata of this network operation occurrence.

    • createdAt (datetime) –

      The date that the resource was created.

    • instantiateMetadata (dict) –

      Metadata related to the network operation occurrence for network instantiation. This is populated only if the lcmOperationType is INSTANTIATE.

      • additionalParamsForNs (document) –

        The configurable properties used during instantiation.

      • nsdInfoId (string) –

        The network service descriptor used for instantiating the network instance.

    • lastModified (datetime) –

      The date that the resource was last modified.

    • modifyVnfInfoMetadata (dict) –

      Metadata related to the network operation occurrence for network function updates in a network instance. This is populated only if the lcmOperationType is UPDATE and the updateType is MODIFY_VNF_INFORMATION.

      • vnfConfigurableProperties (document) –

        The configurable properties used during update of the network function instance.

      • vnfInstanceId (string) –

        The network function instance that was updated in the network instance.

    • updateNsMetadata (dict) –

      Metadata related to the network operation occurrence for network instance updates. This is populated only if the lcmOperationType is UPDATE and the updateType is UPDATE_NS.

      • additionalParamsForNs (document) –

        The configurable properties used during update.

      • nsdInfoId (string) –

        The network service descriptor used for updating the network instance.

  • nsInstanceId (string) –

    ID of the network operation instance.

  • operationState (string) –

    The state 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. You can use tags to search and filter your resources or track your Amazon Web Services costs.

    • (string) –

      • (string) –

  • tasks (list) –

    All tasks associated with this operation occurrence.

    • (dict) –

      Gets the details of a network operation.

      A network operation is any operation that is done to your network, such as network instance instantiation or termination.

      • taskContext (dict) –

        Context for the network operation task.

        • (string) –

          • (string) –

      • taskEndTime (datetime) –

        Task end time.

      • taskErrorDetails (dict) –

        Task error details.

        • cause (string) –

          Error cause.

        • details (string) –

          Error details.

      • taskName (string) –

        Task name.

      • taskStartTime (datetime) –

        Task start time.

      • taskStatus (string) –

        Task status.

  • updateType (string) –

    Type of the update. Only present if the network operation lcmOperationType is UPDATE.

Exceptions

• TelcoNetworkBuilder.Client.exceptions.InternalServerException

• TelcoNetworkBuilder.Client.exceptions.ThrottlingException

• TelcoNetworkBuilder.Client.exceptions.ValidationException

• TelcoNetworkBuilder.Client.exceptions.ResourceNotFoundException

• TelcoNetworkBuilder.Client.exceptions.AccessDeniedException