Class: AWS.Tnb

var params = {
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
tnb.createSolFunctionPackage(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • tags — (map<String>)

    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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • arn — (String)

      Function package ARN.

    • id — (String)

      ID of the function package.

    • onboardingState — (String)

      Onboarding state of the function package.

      Possible values include:
      • "CREATED"
      • "ONBOARDED"
      • "ERROR"
    • operationalState — (String)

      Operational state of the function package.

      Possible values include:
      • "ENABLED"
      • "DISABLED"
    • tags — (map<String>)

      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.

    • usageState — (String)

      Usage state of the function package.

      Possible values include:
      • "IN_USE"
      • "NOT_IN_USE"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  nsName: 'STRING_VALUE', /* required */
  nsdInfoId: 'STRING_VALUE', /* required */
  nsDescription: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
tnb.createSolNetworkInstance(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • nsDescription — (String)

    Network instance description.

  • nsName — (String)

    Network instance name.

  • nsdInfoId — (String)

    ID for network service descriptor.

  • tags — (map<String>)

    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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • arn — (String)

      Network instance ARN.

    • id — (String)

      Network instance ID.

    • nsInstanceName — (String)

      Network instance name.

    • nsdInfoId — (String)

      Network service descriptor ID.

    • tags — (map<String>)

      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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
tnb.createSolNetworkPackage(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • tags — (map<String>)

    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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • arn — (String)

      Network package ARN.

    • id — (String)

      ID of the network package.

    • nsdOnboardingState — (String)

      Onboarding state of the network service descriptor in the network package.

      Possible values include:
      • "CREATED"
      • "ONBOARDED"
      • "ERROR"
    • nsdOperationalState — (String)

      Operational state of the network service descriptor in the network package.

      Possible values include:
      • "ENABLED"
      • "DISABLED"
    • nsdUsageState — (String)

      Usage state of the network service descriptor in the network package.

      Possible values include:
      • "IN_USE"
      • "NOT_IN_USE"
    • tags — (map<String>)

      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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  vnfPkgId: 'STRING_VALUE' /* required */
};
tnb.deleteSolFunctionPackage(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • vnfPkgId — (String)

    ID of the function package.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  nsInstanceId: 'STRING_VALUE' /* required */
};
tnb.deleteSolNetworkInstance(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • nsInstanceId — (String)

    Network instance ID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  nsdInfoId: 'STRING_VALUE' /* required */
};
tnb.deleteSolNetworkPackage(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • nsdInfoId — (String)

    ID of the network service descriptor in the network package.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  vnfInstanceId: 'STRING_VALUE' /* required */
};
tnb.getSolFunctionInstance(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • vnfInstanceId — (String)

    ID of the network function.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • arn — (String)

      Network function instance ARN.

    • id — (String)

      Network function instance ID.

    • instantiatedVnfInfo — (map)

      Information about the network function.

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

      • vnfState — (String)

        State of the network function instance.

        Possible values include:
        • "STARTED"
        • "STOPPED"
      • vnfcResourceInfo — (Array<map>)

        Compute info used by the network function instance.

        • metadata — (map)

          The metadata of the network function compute.

          • cluster — (String)

            Information about the cluster.

          • helmChart — (String)

            Information about the helm chart.

          • nodeGroup — (String)

            Information about the node group.

    • instantiationState — (String)

      Network function instantiation state.

      Possible values include:
      • "INSTANTIATED"
      • "NOT_INSTANTIATED"
    • metadata — (map)

      The metadata of a network function instance.

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

      • createdAt — required — (Date)

        The date that the resource was created.

      • lastModified — required — (Date)

        The date that the resource was last modified.

    • nsInstanceId — (String)

      Network instance ID.

    • tags — (map<String>)

      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.

    • vnfPkgId — (String)

      Function package ID.

    • vnfProductName — (String)

      Network function product name.

    • vnfProvider — (String)

      Network function provider.

    • vnfdId — (String)

      Function package descriptor ID.

    • vnfdVersion — (String)

      Function package descriptor version.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  vnfPkgId: 'STRING_VALUE' /* required */
};
tnb.getSolFunctionPackage(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • vnfPkgId — (String)

    ID of the function package.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • arn — (String)

      Function package ARN.

    • id — (String)

      Function package ID.

    • metadata — (map)

      Metadata related to the function package.

      A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.

      • createdAt — required — (Date)

        The date that the resource was created.

      • lastModified — required — (Date)

        The date that the resource was last modified.

      • vnfd — (map)

        Metadata related to the function package descriptor of the function package.

        • overrides — (Array<map>)

          Lists of function package overrides.

          • defaultValue — (String)

            Default value for the override.

          • name — (String)

            Name of the TOSCA override.

    • onboardingState — (String)

      Function package onboarding state.

      Possible values include:
      • "CREATED"
      • "ONBOARDED"
      • "ERROR"
    • operationalState — (String)

      Function package operational state.

      Possible values include:
      • "ENABLED"
      • "DISABLED"
    • tags — (map<String>)

      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.

    • usageState — (String)

      Function package usage state.

      Possible values include:
      • "IN_USE"
      • "NOT_IN_USE"
    • vnfProductName — (String)

      Network function product name.

    • vnfProvider — (String)

      Network function provider.

    • vnfdId — (String)

      Function package descriptor ID.

    • vnfdVersion — (String)

      Function package descriptor version.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  accept: application/zip, /* required */
  vnfPkgId: 'STRING_VALUE' /* required */
};
tnb.getSolFunctionPackageContent(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • accept — (String)

    The format of the package that you want to download from the function packages.

    Possible values include:
    • "application/zip"
  • vnfPkgId — (String)

    ID of the function package.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • contentType — (String)

      Indicates the media type of the resource.

      Possible values include:
      • "application/zip"
    • packageContent — (Buffer(Node.js), Typed Array(Browser))

      Contents of the function package.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  accept: text/plain, /* required */
  vnfPkgId: 'STRING_VALUE' /* required */
};
tnb.getSolFunctionPackageDescriptor(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • accept — (String)

    Indicates which content types, expressed as MIME types, the client is able to understand.

    Possible values include:
    • "text/plain"
  • vnfPkgId — (String)

    ID of the function package.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • contentType — (String)

      Indicates the media type of the resource.

      Possible values include:
      • "text/plain"
    • vnfd — (Buffer(Node.js), Typed Array(Browser))

      Contents of the function package descriptor.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  nsInstanceId: 'STRING_VALUE' /* required */
};
tnb.getSolNetworkInstance(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • nsInstanceId — (String)

    ID of the network instance.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • arn — (String)

      Network instance ARN.

    • id — (String)

      Network instance ID.

    • lcmOpInfo — (map)

      Lifecycle management operation details on the network instance.

      Lifecycle management operations are deploy, update, or delete operations.

      • nsLcmOpOccId — required — (String)

        The identifier of the network operation.

    • metadata — (map)

      The metadata of 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.

      • createdAt — required — (Date)

        The date that the resource was created.

      • lastModified — required — (Date)

        The date that the resource was last modified.

    • nsInstanceDescription — (String)

      Network instance description.

    • nsInstanceName — (String)

      Network instance name.

    • nsState — (String)

      Network instance state.

      Possible values include:
      • "INSTANTIATED"
      • "NOT_INSTANTIATED"
      • "UPDATED"
      • "IMPAIRED"
      • "UPDATE_FAILED"
      • "STOPPED"
      • "DELETED"
      • "INSTANTIATE_IN_PROGRESS"
      • "INTENT_TO_UPDATE_IN_PROGRESS"
      • "UPDATE_IN_PROGRESS"
      • "TERMINATE_IN_PROGRESS"
    • nsdId — (String)

      Network service descriptor ID.

    • nsdInfoId — (String)

      Network service descriptor info ID.

    • tags — (map<String>)

      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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  nsLcmOpOccId: 'STRING_VALUE' /* required */
};
tnb.getSolNetworkOperation(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • nsLcmOpOccId — (String)

    The identifier of the network operation.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • arn — (String)

      Network operation ARN.

    • error — (map)

      Error related to this specific network operation occurrence.

      • detail — required — (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.

      Possible values include:
      • "INSTANTIATE"
      • "UPDATE"
      • "TERMINATE"
    • metadata — (map)

      Metadata of this network operation occurrence.

      • createdAt — required — (Date)

        The date that the resource was created.

      • instantiateMetadata — (map)

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

        • additionalParamsForNs — (map)

          The configurable properties used during instantiation.

        • nsdInfoId — required — (String)

          The network service descriptor used for instantiating the network instance.

      • lastModified — required — (Date)

        The date that the resource was last modified.

      • modifyVnfInfoMetadata — (map)

        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 — required — (map)

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

        • vnfInstanceId — required — (String)

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

      • updateNsMetadata — (map)

        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 — (map)

          The configurable properties used during update.

        • nsdInfoId — required — (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.

      Possible values include:
      • "PROCESSING"
      • "COMPLETED"
      • "FAILED"
      • "CANCELLING"
      • "CANCELLED"
    • tags — (map<String>)

      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.

    • tasks — (Array<map>)

      All tasks associated with this operation occurrence.

      • taskContext — (map<String>)

        Context for the network operation task.

      • taskEndTime — (Date)

        Task end time.

      • taskErrorDetails — (map)

        Task error details.

        • cause — (String)

          Error cause.

        • details — (String)

          Error details.

      • taskName — (String)

        Task name.

      • taskStartTime — (Date)

        Task start time.

      • taskStatus — (String)

        Task status.

        Possible values include:
        • "SCHEDULED"
        • "STARTED"
        • "IN_PROGRESS"
        • "COMPLETED"
        • "ERROR"
        • "SKIPPED"
        • "CANCELLED"
    • updateType — (String)

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

      Possible values include:
      • "MODIFY_VNF_INFORMATION"
      • "UPDATE_NS"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  nsdInfoId: 'STRING_VALUE' /* required */
};
tnb.getSolNetworkPackage(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • nsdInfoId — (String)

    ID of the network service descriptor in the network package.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • arn — (String)

      Network package ARN.

    • id — (String)

      Network package ID.

    • metadata — (map)

      Metadata associated with a network package.

      A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.

      • createdAt — required — (Date)

        The date that the resource was created.

      • lastModified — required — (Date)

        The date that the resource was last modified.

      • nsd — (map)

        Metadata related to the onboarded network service descriptor in the network package.

        • overrides — (Array<map>)

          Lists network package overrides.

          • defaultValue — (String)

            Default value for the override.

          • name — (String)

            Name of the TOSCA override.

    • nsdId — (String)

      Network service descriptor ID.

    • nsdName — (String)

      Network service descriptor name.

    • nsdOnboardingState — (String)

      Network service descriptor onboarding state.

      Possible values include:
      • "CREATED"
      • "ONBOARDED"
      • "ERROR"
    • nsdOperationalState — (String)

      Network service descriptor operational state.

      Possible values include:
      • "ENABLED"
      • "DISABLED"
    • nsdUsageState — (String)

      Network service descriptor usage state.

      Possible values include:
      • "IN_USE"
      • "NOT_IN_USE"
    • nsdVersion — (String)

      Network service descriptor version.

    • tags — (map<String>)

      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.

    • vnfPkgIds — (Array<String>)

      Identifies the function package for the function package descriptor referenced by the onboarded network package.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  accept: application/zip, /* required */
  nsdInfoId: 'STRING_VALUE' /* required */
};
tnb.getSolNetworkPackageContent(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • accept — (String)

    The format of the package you want to download from the network package.

    Possible values include:
    • "application/zip"
  • nsdInfoId — (String)

    ID of the network service descriptor in the network package.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • contentType — (String)

      Indicates the media type of the resource.

      Possible values include:
      • "application/zip"
    • nsdContent — (Buffer(Node.js), Typed Array(Browser))

      Content of the network service descriptor in the network package.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  nsdInfoId: 'STRING_VALUE' /* required */
};
tnb.getSolNetworkPackageDescriptor(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • nsdInfoId — (String)

    ID of the network service descriptor in the network package.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • contentType — (String)

      Indicates the media type of the resource.

      Possible values include:
      • "text/plain"
    • nsd — (Buffer(Node.js), Typed Array(Browser))

      Contents of the network service descriptor in the network package.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  nsInstanceId: 'STRING_VALUE', /* required */
  additionalParamsForNs: {
  },
  dryRun: true || false,
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
tnb.instantiateSolNetworkInstance(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • additionalParamsForNs — (map)

    Provides values for the configurable properties.

  • dryRun — (Boolean)

    A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

  • nsInstanceId — (String)

    ID of the network instance.

  • tags — (map<String>)

    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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • nsLcmOpOccId — (String)

      The identifier of the network operation.

    • tags — (map<String>)

      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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
tnb.listSolFunctionInstances(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • maxResults — (Integer)

    The maximum number of results to include in the response.

  • nextToken — (String)

    The token for the next page of results.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • functionInstances — (Array<map>)

      Network function instances.

      • arn — required — (String)

        Network function instance ARN.

      • id — required — (String)

        Network function instance ID.

      • instantiatedVnfInfo — (map)

        Information about a network function.

        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.

        • vnfState — (String)

          State of the network function.

          Possible values include:
          • "STARTED"
          • "STOPPED"
      • instantiationState — required — (String)

        Network function instance instantiation state.

        Possible values include:
        • "INSTANTIATED"
        • "NOT_INSTANTIATED"
      • metadata — required — (map)

        Network function instance metadata.

        • createdAt — required — (Date)

          When the network function instance was created.

        • lastModified — required — (Date)

          When the network function instance was last modified.

      • nsInstanceId — required — (String)

        Network instance ID.

      • vnfPkgId — required — (String)

        Function package ID.

      • vnfPkgName — (String)

        Function package name.

    • nextToken — (String)

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
tnb.listSolFunctionPackages(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • maxResults — (Integer)

    The maximum number of results to include in the response.

  • nextToken — (String)

    The token for the next page of results.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • functionPackages — (Array<map>)

      Function packages. A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.

      • arn — required — (String)

        Function package ARN.

      • id — required — (String)

        ID of the function package.

      • metadata — (map)

        The metadata of the function package.

        • createdAt — required — (Date)

          The date that the resource was created.

        • lastModified — required — (Date)

          The date that the resource was last modified.

      • onboardingState — required — (String)

        Onboarding state of the function package.

        Possible values include:
        • "CREATED"
        • "ONBOARDED"
        • "ERROR"
      • operationalState — required — (String)

        Operational state of the function package.

        Possible values include:
        • "ENABLED"
        • "DISABLED"
      • usageState — required — (String)

        Usage state of the function package.

        Possible values include:
        • "IN_USE"
        • "NOT_IN_USE"
      • vnfProductName — (String)

        The product name for the network function.

      • vnfProvider — (String)

        Provider of the function package and the function package descriptor.

      • vnfdId — (String)

        Identifies the function package and the function package descriptor.

      • vnfdVersion — (String)

        Identifies the version of the function package descriptor.

    • nextToken — (String)

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
tnb.listSolNetworkInstances(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • maxResults — (Integer)

    The maximum number of results to include in the response.

  • nextToken — (String)

    The token for the next page of results.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • networkInstances — (Array<map>)

      Lists network instances.

      • arn — required — (String)

        Network instance ARN.

      • id — required — (String)

        ID of the network instance.

      • metadata — required — (map)

        The metadata of the network instance.

        • createdAt — required — (Date)

          The date that the resource was created.

        • lastModified — required — (Date)

          The date that the resource was last modified.

      • nsInstanceDescription — required — (String)

        Human-readable description of the network instance.

      • nsInstanceName — required — (String)

        Human-readable name of the network instance.

      • nsState — required — (String)

        The state of the network instance.

        Possible values include:
        • "INSTANTIATED"
        • "NOT_INSTANTIATED"
        • "UPDATED"
        • "IMPAIRED"
        • "UPDATE_FAILED"
        • "STOPPED"
        • "DELETED"
        • "INSTANTIATE_IN_PROGRESS"
        • "INTENT_TO_UPDATE_IN_PROGRESS"
        • "UPDATE_IN_PROGRESS"
        • "TERMINATE_IN_PROGRESS"
      • nsdId — required — (String)

        ID of the network service descriptor in the network package.

      • nsdInfoId — required — (String)

        ID of the network service descriptor in the network package.

    • nextToken — (String)

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  nsInstanceId: 'STRING_VALUE'
};
tnb.listSolNetworkOperations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • maxResults — (Integer)

    The maximum number of results to include in the response.

  • nextToken — (String)

    The token for the next page of results.

  • nsInstanceId — (String)

    Network instance id filter, to retrieve network operations associated to a network instance.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • networkOperations — (Array<map>)

      Lists network operation occurrences. Lifecycle management operations are deploy, update, or delete operations.

      • arn — required — (String)

        Network operation ARN.

      • error — (map)

        Error related to this specific network operation.

        • detail — required — (String)

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

        • title — (String)

          A human-readable title of the problem type.

      • id — required — (String)

        ID of this network operation.

      • lcmOperationType — required — (String)

        Type of lifecycle management network operation.

        Possible values include:
        • "INSTANTIATE"
        • "UPDATE"
        • "TERMINATE"
      • metadata — (map)

        Metadata related to this network operation.

        • createdAt — required — (Date)

          The date that the resource was created.

        • lastModified — required — (Date)

          The date that the resource was last modified.

        • nsdInfoId — (String)

          The network service descriptor id used for the operation.

          Only present if the updateType is UPDATE_NS.

        • vnfInstanceId — (String)

          The network function id used for the operation.

          Only present if the updateType is MODIFY_VNF_INFO.

      • nsInstanceId — required — (String)

        ID of the network instance related to this operation.

      • operationState — required — (String)

        The state of the network operation.

        Possible values include:
        • "PROCESSING"
        • "COMPLETED"
        • "FAILED"
        • "CANCELLING"
        • "CANCELLED"
      • updateType — (String)

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

        Possible values include:
        • "MODIFY_VNF_INFORMATION"
        • "UPDATE_NS"
    • nextToken — (String)

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
tnb.listSolNetworkPackages(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • maxResults — (Integer)

    The maximum number of results to include in the response.

  • nextToken — (String)

    The token for the next page of results.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • networkPackages — (Array<map>)

      Network packages. A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.

      • arn — required — (String)

        Network package ARN.

      • id — required — (String)

        ID of the individual network package.

      • metadata — required — (map)

        The metadata of the network package.

        • createdAt — required — (Date)

          The date that the resource was created.

        • lastModified — required — (Date)

          The date that the resource was last modified.

      • nsdDesigner — (String)

        Designer of the onboarded network service descriptor in the network package.

      • nsdId — (String)

        ID of the network service descriptor on which the network package is based.

      • nsdInvariantId — (String)

        Identifies a network service descriptor in a version independent manner.

      • nsdName — (String)

        Name of the onboarded network service descriptor in the network package.

      • nsdOnboardingState — required — (String)

        Onboarding state of the network service descriptor in the network package.

        Possible values include:
        • "CREATED"
        • "ONBOARDED"
        • "ERROR"
      • nsdOperationalState — required — (String)

        Operational state of the network service descriptor in the network package.

        Possible values include:
        • "ENABLED"
        • "DISABLED"
      • nsdUsageState — required — (String)

        Usage state of the network service descriptor in the network package.

        Possible values include:
        • "IN_USE"
        • "NOT_IN_USE"
      • nsdVersion — (String)

        Version of the onboarded network service descriptor in the network package.

      • vnfPkgIds — (Array<String>)

        Identifies the function package for the function package descriptor referenced by the onboarded network package.

    • nextToken — (String)

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
tnb.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • resourceArn — (String)

    Resource ARN.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • tags — (map<String>)

      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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  file: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */, /* required */
  vnfPkgId: 'STRING_VALUE', /* required */
  contentType: application/zip
};
tnb.putSolFunctionPackageContent(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • contentType — (String)

    Function package content type.

    Possible values include:
    • "application/zip"
  • file — (Buffer, Typed Array, Blob, String)

    Function package file.

  • vnfPkgId — (String)

    Function package ID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • id — (String)

      Function package ID.

    • metadata — (map)

      Function package metadata.

      • vnfd — (map)

        Metadata for function package artifacts.

        Artifacts are the contents of the package descriptor file and the state of the package.

        • overrides — (Array<map>)

          Lists of function package overrides.

          • defaultValue — (String)

            Default value for the override.

          • name — (String)

            Name of the TOSCA override.

    • vnfProductName — (String)

      Function product name.

    • vnfProvider — (String)

      Function provider.

    • vnfdId — (String)

      Function package descriptor ID.

    • vnfdVersion — (String)

      Function package descriptor version.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  file: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */, /* required */
  nsdInfoId: 'STRING_VALUE', /* required */
  contentType: application/zip
};
tnb.putSolNetworkPackageContent(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • contentType — (String)

    Network package content type.

    Possible values include:
    • "application/zip"
  • file — (Buffer, Typed Array, Blob, String)

    Network package file.

  • nsdInfoId — (String)

    Network service descriptor info ID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • arn — (String)

      Network package ARN.

    • id — (String)

      Network package ID.

    • metadata — (map)

      Network package metadata.

      • nsd — (map)

        Metadata for network package artifacts.

        Artifacts are the contents of the package descriptor file and the state of the package.

        • overrides — (Array<map>)

          Lists network package overrides.

          • defaultValue — (String)

            Default value for the override.

          • name — (String)

            Name of the TOSCA override.

    • nsdId — (String)

      Network service descriptor ID.

    • nsdName — (String)

      Network service descriptor name.

    • nsdVersion — (String)

      Network service descriptor version.

    • vnfPkgIds — (Array<String>)

      Function package IDs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
tnb.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • resourceArn — (String)

    Resource ARN.

  • tags — (map<String>)

    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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  nsInstanceId: 'STRING_VALUE', /* required */
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
tnb.terminateSolNetworkInstance(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • nsInstanceId — (String)

    ID of the network instance.

  • tags — (map<String>)

    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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • nsLcmOpOccId — (String)

      The identifier of the network operation.

    • tags — (map<String>)

      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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
tnb.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • resourceArn — (String)

    Resource ARN.

  • tagKeys — (Array<String>)

    Tag keys.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  operationalState: ENABLED | DISABLED, /* required */
  vnfPkgId: 'STRING_VALUE' /* required */
};
tnb.updateSolFunctionPackage(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • operationalState — (String)

    Operational state of the function package.

    Possible values include:
    • "ENABLED"
    • "DISABLED"
  • vnfPkgId — (String)

    ID of the function package.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • operationalState — (String)

      Operational state of the function package.

      Possible values include:
      • "ENABLED"
      • "DISABLED"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  nsInstanceId: 'STRING_VALUE', /* required */
  updateType: MODIFY_VNF_INFORMATION | UPDATE_NS, /* required */
  modifyVnfInfoData: {
    vnfConfigurableProperties: { /* required */
    },
    vnfInstanceId: 'STRING_VALUE' /* required */
  },
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  updateNs: {
    nsdInfoId: 'STRING_VALUE', /* required */
    additionalParamsForNs: {
    }
  }
};
tnb.updateSolNetworkInstance(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • modifyVnfInfoData — (map)

    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 — required — (map)

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

    • vnfInstanceId — required — (String)

      ID of the network function instance.

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

  • nsInstanceId — (String)

    ID of the network instance.

  • tags — (map<String>)

    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.

  • updateNs — (map)

    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 — (map)

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

    • nsdInfoId — required — (String)

      ID of the network service descriptor.

  • updateType — (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 include:
    • "MODIFY_VNF_INFORMATION"
    • "UPDATE_NS"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • nsLcmOpOccId — (String)

      The identifier of the network operation.

    • tags — (map<String>)

      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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  nsdInfoId: 'STRING_VALUE', /* required */
  nsdOperationalState: ENABLED | DISABLED /* required */
};
tnb.updateSolNetworkPackage(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • nsdInfoId — (String)

    ID of the network service descriptor in the network package.

  • nsdOperationalState — (String)

    Operational state of the network service descriptor in the network package.

    Possible values include:
    • "ENABLED"
    • "DISABLED"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • nsdOperationalState — (String)

      Operational state of the network service descriptor in the network package.

      Possible values include:
      • "ENABLED"
      • "DISABLED"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  file: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */, /* required */
  vnfPkgId: 'STRING_VALUE', /* required */
  contentType: application/zip
};
tnb.validateSolFunctionPackageContent(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • contentType — (String)

    Function package content type.

    Possible values include:
    • "application/zip"
  • file — (Buffer, Typed Array, Blob, String)

    Function package file.

  • vnfPkgId — (String)

    Function package ID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • id — (String)

      Function package ID.

    • metadata — (map)

      Function package metadata.

      • vnfd — (map)

        Metadata for function package artifacts.

        Artifacts are the contents of the package descriptor file and the state of the package.

        • overrides — (Array<map>)

          Lists of function package overrides.

          • defaultValue — (String)

            Default value for the override.

          • name — (String)

            Name of the TOSCA override.

    • vnfProductName — (String)

      Network function product name.

    • vnfProvider — (String)

      Network function provider.

    • vnfdId — (String)

      Function package descriptor ID.

    • vnfdVersion — (String)

      Function package descriptor version.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  file: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */, /* required */
  nsdInfoId: 'STRING_VALUE', /* required */
  contentType: application/zip
};
tnb.validateSolNetworkPackageContent(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • contentType — (String)

    Network package content type.

    Possible values include:
    • "application/zip"
  • file — (Buffer, Typed Array, Blob, String)

    Network package file.

  • nsdInfoId — (String)

    Network service descriptor file.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • arn — (String)

      Network package ARN.

    • id — (String)

      Network package ID.

    • metadata — (map)

      Network package metadata.

      • nsd — (map)

        Metadata for network package artifacts.

        Artifacts are the contents of the package descriptor file and the state of the package.

        • overrides — (Array<map>)

          Lists network package overrides.

          • defaultValue — (String)

            Default value for the override.

          • name — (String)

            Name of the TOSCA override.

    • nsdId — (String)

      Network service descriptor ID.

    • nsdName — (String)

      Network service descriptor name.

    • nsdVersion — (String)

      Network service descriptor version.

    • vnfPkgIds — (Array<String>)

      Function package IDs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.