CancelSolNetworkOperation

$result = $client->cancelSolNetworkOperation([/* ... */]);
$promise = $client->cancelSolNetworkOperationAsync([/* ... */]);

Cancels a network operation.

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

Parameter Syntax

$result = $client->cancelSolNetworkOperation([
    'nsLcmOpOccId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

Unexpected error occurred. Problem on the server.

ThrottlingException:

Exception caused by throttling.

ValidationException:

Unable to process the request because the client provided input failed to satisfy request constraints.

ResourceNotFoundException:

Request references a resource that doesn't exist.

AccessDeniedException:

Insufficient permissions to make request.

CreateSolFunctionPackage

$result = $client->createSolFunctionPackage([/* ... */]);
$promise = $client->createSolFunctionPackageAsync([/* ... */]);

Creates a 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. For more information, see Function packages in the Amazon Web Services Telco Network Builder User Guide.

Creating a function package is the first step for creating a network in AWS TNB. This request creates an empty container with an ID. The next step is to upload the actual CSAR zip file into that empty container. To upload function package content, see PutSolFunctionPackageContent.

Parameter Syntax

$result = $client->createSolFunctionPackage([
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'id' => '<string>',
    'onboardingState' => 'CREATED|ONBOARDED|ERROR',
    'operationalState' => 'ENABLED|DISABLED',
    'tags' => ['<string>', ...],
    'usageState' => 'IN_USE|NOT_IN_USE',
]

Result Details

Errors

InternalServerException:

Unexpected error occurred. Problem on the server.

ServiceQuotaExceededException:

Service quotas have been exceeded.

ThrottlingException:

Exception caused by throttling.

ValidationException:

Unable to process the request because the client provided input failed to satisfy request constraints.

AccessDeniedException:

Insufficient permissions to make request.

CreateSolNetworkInstance

$result = $client->createSolNetworkInstance([/* ... */]);
$promise = $client->createSolNetworkInstanceAsync([/* ... */]);

Creates 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. Creating a network instance is the third step after creating a network package. For more information about network instances, Network instances in the Amazon Web Services Telco Network Builder User Guide.

Once you create a network instance, you can instantiate it. To instantiate a network, see InstantiateSolNetworkInstance.

Parameter Syntax

$result = $client->createSolNetworkInstance([
    'nsDescription' => '<string>',
    'nsName' => '<string>', // REQUIRED
    'nsdInfoId' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'id' => '<string>',
    'nsInstanceName' => '<string>',
    'nsdInfoId' => '<string>',
    'tags' => ['<string>', ...],
]

Result Details

Errors

InternalServerException:

Unexpected error occurred. Problem on the server.

ServiceQuotaExceededException:

Service quotas have been exceeded.

ThrottlingException:

Exception caused by throttling.

ValidationException:

Unable to process the request because the client provided input failed to satisfy request constraints.

ResourceNotFoundException:

Request references a resource that doesn't exist.

AccessDeniedException:

Insufficient permissions to make request.

CreateSolNetworkPackage

$result = $client->createSolNetworkPackage([/* ... */]);
$promise = $client->createSolNetworkPackageAsync([/* ... */]);

Creates 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. For more information, see Network instances in the Amazon Web Services Telco Network Builder User Guide.

A network package consists of a network service descriptor (NSD) file (required) and any additional files (optional), such as scripts specific to your needs. For example, if you have multiple function packages in your network package, you can use the NSD to define which network functions should run in certain VPCs, subnets, or EKS clusters.

This request creates an empty network package container with an ID. Once you create a network package, you can upload the network package content using PutSolNetworkPackageContent.

Parameter Syntax

$result = $client->createSolNetworkPackage([
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'id' => '<string>',
    'nsdOnboardingState' => 'CREATED|ONBOARDED|ERROR',
    'nsdOperationalState' => 'ENABLED|DISABLED',
    'nsdUsageState' => 'IN_USE|NOT_IN_USE',
    'tags' => ['<string>', ...],
]

Result Details

Errors

InternalServerException:

Unexpected error occurred. Problem on the server.

ServiceQuotaExceededException:

Service quotas have been exceeded.

ThrottlingException:

Exception caused by throttling.

ValidationException:

Unable to process the request because the client provided input failed to satisfy request constraints.

AccessDeniedException:

Insufficient permissions to make request.

DeleteSolFunctionPackage

$result = $client->deleteSolFunctionPackage([/* ... */]);
$promise = $client->deleteSolFunctionPackageAsync([/* ... */]);

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

To delete a function package, the package must be in a disabled state. To disable a function package, see UpdateSolFunctionPackage.

Parameter Syntax

$result = $client->deleteSolFunctionPackage([
    'vnfPkgId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

Unexpected error occurred. Problem on the server.

ThrottlingException:

Exception caused by throttling.

ValidationException:

Unable to process the request because the client provided input failed to satisfy request constraints.

ResourceNotFoundException:

Request references a resource that doesn't exist.

AccessDeniedException:

Insufficient permissions to make request.

DeleteSolNetworkInstance

$result = $client->deleteSolNetworkInstance([/* ... */]);
$promise = $client->deleteSolNetworkInstanceAsync([/* ... */]);

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

To delete a network instance, the instance must be in a stopped or terminated state. To terminate a network instance, see TerminateSolNetworkInstance.

Parameter Syntax

$result = $client->deleteSolNetworkInstance([
    'nsInstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

Unexpected error occurred. Problem on the server.

ThrottlingException:

Exception caused by throttling.

ValidationException:

Unable to process the request because the client provided input failed to satisfy request constraints.

ResourceNotFoundException:

Request references a resource that doesn't exist.

AccessDeniedException:

Insufficient permissions to make request.

DeleteSolNetworkPackage

$result = $client->deleteSolNetworkPackage([/* ... */]);
$promise = $client->deleteSolNetworkPackageAsync([/* ... */]);

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

To delete a network package, the package must be in a disable state. To disable a network package, see UpdateSolNetworkPackage.

Parameter Syntax

$result = $client->deleteSolNetworkPackage([
    'nsdInfoId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

Unexpected error occurred. Problem on the server.

ThrottlingException:

Exception caused by throttling.

ValidationException:

Unable to process the request because the client provided input failed to satisfy request constraints.

ResourceNotFoundException:

Request references a resource that doesn't exist.

AccessDeniedException:

Insufficient permissions to make request.

GetSolFunctionInstance

$result = $client->getSolFunctionInstance([/* ... */]);
$promise = $client->getSolFunctionInstanceAsync([/* ... */]);

Gets the details of a network function instance, including the instantiation state and metadata from the function package descriptor in the network function package.

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

Parameter Syntax

$result = $client->getSolFunctionInstance([
    'vnfInstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'id' => '<string>',
    'instantiatedVnfInfo' => [
        'vnfState' => 'STARTED|STOPPED',
        'vnfcResourceInfo' => [
            [
                'metadata' => [
                    'cluster' => '<string>',
                    'helmChart' => '<string>',
                    'nodeGroup' => '<string>',
                ],
            ],
            // ...
        ],
    ],
    'instantiationState' => 'INSTANTIATED|NOT_INSTANTIATED',
    'metadata' => [
        'createdAt' => <DateTime>,
        'lastModified' => <DateTime>,
    ],
    'nsInstanceId' => '<string>',
    'tags' => ['<string>', ...],
    'vnfPkgId' => '<string>',
    'vnfProductName' => '<string>',
    'vnfProvider' => '<string>',
    'vnfdId' => '<string>',
    'vnfdVersion' => '<string>',
]

Result Details

Errors

InternalServerException:

Unexpected error occurred. Problem on the server.

ThrottlingException:

Exception caused by throttling.

ValidationException:

Unable to process the request because the client provided input failed to satisfy request constraints.

ResourceNotFoundException:

Request references a resource that doesn't exist.

AccessDeniedException:

Insufficient permissions to make request.

GetSolFunctionPackage

$result = $client->getSolFunctionPackage([/* ... */]);
$promise = $client->getSolFunctionPackageAsync([/* ... */]);

Gets the details of an individual function package, such as the operational state and whether the package is in use.

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

Parameter Syntax

$result = $client->getSolFunctionPackage([
    'vnfPkgId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'id' => '<string>',
    'metadata' => [
        'createdAt' => <DateTime>,
        'lastModified' => <DateTime>,
        'vnfd' => [
            'overrides' => [
                [
                    'defaultValue' => '<string>',
                    'name' => '<string>',
                ],
                // ...
            ],
        ],
    ],
    'onboardingState' => 'CREATED|ONBOARDED|ERROR',
    'operationalState' => 'ENABLED|DISABLED',
    'tags' => ['<string>', ...],
    'usageState' => 'IN_USE|NOT_IN_USE',
    'vnfProductName' => '<string>',
    'vnfProvider' => '<string>',
    'vnfdId' => '<string>',
    'vnfdVersion' => '<string>',
]

Result Details

Errors

InternalServerException:

Unexpected error occurred. Problem on the server.

ThrottlingException:

Exception caused by throttling.

ValidationException:

Unable to process the request because the client provided input failed to satisfy request constraints.

ResourceNotFoundException:

Request references a resource that doesn't exist.

AccessDeniedException:

Insufficient permissions to make request.

GetSolFunctionPackageContent

$result = $client->getSolFunctionPackageContent([/* ... */]);
$promise = $client->getSolFunctionPackageContentAsync([/* ... */]);

Gets the contents of a 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.

Parameter Syntax

$result = $client->getSolFunctionPackageContent([
    'accept' => 'application/zip', // REQUIRED
    'vnfPkgId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'contentType' => 'application/zip',
    'packageContent' => <string || resource || Psr\Http\Message\StreamInterface>,
]

Result Details

Errors

InternalServerException:

Unexpected error occurred. Problem on the server.

ThrottlingException:

Exception caused by throttling.

ValidationException:

Unable to process the request because the client provided input failed to satisfy request constraints.

ResourceNotFoundException:

Request references a resource that doesn't exist.

AccessDeniedException:

Insufficient permissions to make request.

GetSolFunctionPackageDescriptor

$result = $client->getSolFunctionPackageDescriptor([/* ... */]);
$promise = $client->getSolFunctionPackageDescriptorAsync([/* ... */]);

Gets a function package descriptor in a function package.

A function package descriptor is a .yaml file in a function package that uses the TOSCA standard to describe how the network function in the function package should run on your network.

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.

Parameter Syntax

$result = $client->getSolFunctionPackageDescriptor([
    'accept' => 'text/plain', // REQUIRED
    'vnfPkgId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'contentType' => 'text/plain',
    'vnfd' => <string || resource || Psr\Http\Message\StreamInterface>,
]

Result Details

Errors

InternalServerException:

Unexpected error occurred. Problem on the server.

ThrottlingException:

Exception caused by throttling.

ValidationException:

Unable to process the request because the client provided input failed to satisfy request constraints.

ResourceNotFoundException:

Request references a resource that doesn't exist.

AccessDeniedException:

Insufficient permissions to make request.

GetSolNetworkInstance

$result = $client->getSolNetworkInstance([/* ... */]);
$promise = $client->getSolNetworkInstanceAsync([/* ... */]);

Gets the details of the 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.

Parameter Syntax

$result = $client->getSolNetworkInstance([
    'nsInstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'id' => '<string>',
    'lcmOpInfo' => [
        'nsLcmOpOccId' => '<string>',
    ],
    'metadata' => [
        'createdAt' => <DateTime>,
        'lastModified' => <DateTime>,
    ],
    'nsInstanceDescription' => '<string>',
    'nsInstanceName' => '<string>',
    'nsState' => '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>',
    'nsdInfoId' => '<string>',
    'tags' => ['<string>', ...],
]

Result Details

Errors

InternalServerException:

Unexpected error occurred. Problem on the server.

ThrottlingException:

Exception caused by throttling.

ValidationException:

Unable to process the request because the client provided input failed to satisfy request constraints.

ResourceNotFoundException:

Request references a resource that doesn't exist.

AccessDeniedException:

Insufficient permissions to make request.

GetSolNetworkOperation

$result = $client->getSolNetworkOperation([/* ... */]);
$promise = $client->getSolNetworkOperationAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getSolNetworkOperation([
    'nsLcmOpOccId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'error' => [
        'detail' => '<string>',
        'title' => '<string>',
    ],
    'id' => '<string>',
    'lcmOperationType' => 'INSTANTIATE|UPDATE|TERMINATE',
    'metadata' => [
        'createdAt' => <DateTime>,
        'instantiateMetadata' => [
            'additionalParamsForNs' => [
            ],
            'nsdInfoId' => '<string>',
        ],
        'lastModified' => <DateTime>,
        'modifyVnfInfoMetadata' => [
            'vnfConfigurableProperties' => [
            ],
            'vnfInstanceId' => '<string>',
        ],
        'updateNsMetadata' => [
            'additionalParamsForNs' => [
            ],
            'nsdInfoId' => '<string>',
        ],
    ],
    'nsInstanceId' => '<string>',
    'operationState' => 'PROCESSING|COMPLETED|FAILED|CANCELLING|CANCELLED',
    'tags' => ['<string>', ...],
    'tasks' => [
        [
            'taskContext' => ['<string>', ...],
            'taskEndTime' => <DateTime>,
            'taskErrorDetails' => [
                'cause' => '<string>',
                'details' => '<string>',
            ],
            'taskName' => '<string>',
            'taskStartTime' => <DateTime>,
            'taskStatus' => 'SCHEDULED|STARTED|IN_PROGRESS|COMPLETED|ERROR|SKIPPED|CANCELLED',
        ],
        // ...
    ],
    'updateType' => 'MODIFY_VNF_INFORMATION|UPDATE_NS',
]

Result Details

Errors

InternalServerException:

Unexpected error occurred. Problem on the server.

ThrottlingException:

Exception caused by throttling.

ValidationException:

Unable to process the request because the client provided input failed to satisfy request constraints.

ResourceNotFoundException:

Request references a resource that doesn't exist.

AccessDeniedException:

Insufficient permissions to make request.

GetSolNetworkPackage

$result = $client->getSolNetworkPackage([/* ... */]);
$promise = $client->getSolNetworkPackageAsync([/* ... */]);

Gets the details of 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.

Parameter Syntax

$result = $client->getSolNetworkPackage([
    'nsdInfoId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'id' => '<string>',
    'metadata' => [
        'createdAt' => <DateTime>,
        'lastModified' => <DateTime>,
        'nsd' => [
            'overrides' => [
                [
                    'defaultValue' => '<string>',
                    'name' => '<string>',
                ],
                // ...
            ],
        ],
    ],
    'nsdId' => '<string>',
    'nsdName' => '<string>',
    'nsdOnboardingState' => 'CREATED|ONBOARDED|ERROR',
    'nsdOperationalState' => 'ENABLED|DISABLED',
    'nsdUsageState' => 'IN_USE|NOT_IN_USE',
    'nsdVersion' => '<string>',
    'tags' => ['<string>', ...],
    'vnfPkgIds' => ['<string>', ...],
]

Result Details

Errors

InternalServerException:

Unexpected error occurred. Problem on the server.

ThrottlingException:

Exception caused by throttling.

ValidationException:

Unable to process the request because the client provided input failed to satisfy request constraints.

ResourceNotFoundException:

Request references a resource that doesn't exist.

AccessDeniedException:

Insufficient permissions to make request.

GetSolNetworkPackageContent

$result = $client->getSolNetworkPackageContent([/* ... */]);
$promise = $client->getSolNetworkPackageContentAsync([/* ... */]);

Gets the contents of 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.

Parameter Syntax

$result = $client->getSolNetworkPackageContent([
    'accept' => 'application/zip', // REQUIRED
    'nsdInfoId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'contentType' => 'application/zip',
    'nsdContent' => <string || resource || Psr\Http\Message\StreamInterface>,
]

Result Details

Errors

InternalServerException:

Unexpected error occurred. Problem on the server.

ThrottlingException:

Exception caused by throttling.

ValidationException:

Unable to process the request because the client provided input failed to satisfy request constraints.

ResourceNotFoundException:

Request references a resource that doesn't exist.

AccessDeniedException:

Insufficient permissions to make request.

GetSolNetworkPackageDescriptor

$result = $client->getSolNetworkPackageDescriptor([/* ... */]);
$promise = $client->getSolNetworkPackageDescriptorAsync([/* ... */]);

Gets the content of the network service descriptor.

A network service descriptor is a .yaml file in a network package that uses the TOSCA standard to describe the network functions you want to deploy and the Amazon Web Services infrastructure you want to deploy the network functions on.

Parameter Syntax

$result = $client->getSolNetworkPackageDescriptor([
    'nsdInfoId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'contentType' => 'text/plain',
    'nsd' => <string || resource || Psr\Http\Message\StreamInterface>,
]

Result Details

Errors

InternalServerException:

Unexpected error occurred. Problem on the server.

ThrottlingException:

Exception caused by throttling.

ValidationException:

Unable to process the request because the client provided input failed to satisfy request constraints.

ResourceNotFoundException:

Request references a resource that doesn't exist.

AccessDeniedException:

Insufficient permissions to make request.

InstantiateSolNetworkInstance

$result = $client->instantiateSolNetworkInstance([/* ... */]);
$promise = $client->instantiateSolNetworkInstanceAsync([/* ... */]);

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

Before you can instantiate a network instance, you have to create a network instance. For more information, see CreateSolNetworkInstance.

Parameter Syntax

$result = $client->instantiateSolNetworkInstance([
    'additionalParamsForNs' => [
    ],
    'dryRun' => true || false,
    'nsInstanceId' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'nsLcmOpOccId' => '<string>',
    'tags' => ['<string>', ...],
]

Result Details

Errors

InternalServerException:

Unexpected error occurred. Problem on the server.

ServiceQuotaExceededException:

Service quotas have been exceeded.

ThrottlingException:

Exception caused by throttling.

ValidationException:

Unable to process the request because the client provided input failed to satisfy request constraints.

ResourceNotFoundException:

Request references a resource that doesn't exist.

AccessDeniedException:

Insufficient permissions to make request.

ListSolFunctionInstances

$result = $client->listSolFunctionInstances([/* ... */]);
$promise = $client->listSolFunctionInstancesAsync([/* ... */]);

Lists network function instances.

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

Parameter Syntax

$result = $client->listSolFunctionInstances([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'functionInstances' => [
        [
            'arn' => '<string>',
            'id' => '<string>',
            'instantiatedVnfInfo' => [
                'vnfState' => 'STARTED|STOPPED',
            ],
            'instantiationState' => 'INSTANTIATED|NOT_INSTANTIATED',
            'metadata' => [
                'createdAt' => <DateTime>,
                'lastModified' => <DateTime>,
            ],
            'nsInstanceId' => '<string>',
            'vnfPkgId' => '<string>',
            'vnfPkgName' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

InternalServerException:

Unexpected error occurred. Problem on the server.

ThrottlingException:

Exception caused by throttling.

ValidationException:

Unable to process the request because the client provided input failed to satisfy request constraints.

AccessDeniedException:

Insufficient permissions to make request.

ListSolFunctionPackages

$result = $client->listSolFunctionPackages([/* ... */]);
$promise = $client->listSolFunctionPackagesAsync([/* ... */]);

Lists information about 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.

Parameter Syntax

$result = $client->listSolFunctionPackages([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'functionPackages' => [
        [
            'arn' => '<string>',
            'id' => '<string>',
            'metadata' => [
                'createdAt' => <DateTime>,
                'lastModified' => <DateTime>,
            ],
            'onboardingState' => 'CREATED|ONBOARDED|ERROR',
            'operationalState' => 'ENABLED|DISABLED',
            'usageState' => 'IN_USE|NOT_IN_USE',
            'vnfProductName' => '<string>',
            'vnfProvider' => '<string>',
            'vnfdId' => '<string>',
            'vnfdVersion' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

InternalServerException:

Unexpected error occurred. Problem on the server.

ThrottlingException:

Exception caused by throttling.

ValidationException:

Unable to process the request because the client provided input failed to satisfy request constraints.

AccessDeniedException:

Insufficient permissions to make request.

ListSolNetworkInstances

$result = $client->listSolNetworkInstances([/* ... */]);
$promise = $client->listSolNetworkInstancesAsync([/* ... */]);

Lists your network instances.

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.

Parameter Syntax

$result = $client->listSolNetworkInstances([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'networkInstances' => [
        [
            'arn' => '<string>',
            'id' => '<string>',
            'metadata' => [
                'createdAt' => <DateTime>,
                'lastModified' => <DateTime>,
            ],
            'nsInstanceDescription' => '<string>',
            'nsInstanceName' => '<string>',
            'nsState' => '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>',
            'nsdInfoId' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

InternalServerException:

Unexpected error occurred. Problem on the server.

ThrottlingException:

Exception caused by throttling.

ValidationException:

Unable to process the request because the client provided input failed to satisfy request constraints.

AccessDeniedException:

Insufficient permissions to make request.

ListSolNetworkOperations

$result = $client->listSolNetworkOperations([/* ... */]);
$promise = $client->listSolNetworkOperationsAsync([/* ... */]);

Lists details for a network operation, including when the operation started and the status of the operation.

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

Parameter Syntax

$result = $client->listSolNetworkOperations([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'nsInstanceId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'networkOperations' => [
        [
            'arn' => '<string>',
            'error' => [
                'detail' => '<string>',
                'title' => '<string>',
            ],
            'id' => '<string>',
            'lcmOperationType' => 'INSTANTIATE|UPDATE|TERMINATE',
            'metadata' => [
                'createdAt' => <DateTime>,
                'lastModified' => <DateTime>,
                'nsdInfoId' => '<string>',
                'vnfInstanceId' => '<string>',
            ],
            'nsInstanceId' => '<string>',
            'operationState' => 'PROCESSING|COMPLETED|FAILED|CANCELLING|CANCELLED',
            'updateType' => 'MODIFY_VNF_INFORMATION|UPDATE_NS',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

InternalServerException:

Unexpected error occurred. Problem on the server.

ThrottlingException:

Exception caused by throttling.

ValidationException:

Unable to process the request because the client provided input failed to satisfy request constraints.

AccessDeniedException:

Insufficient permissions to make request.

ListSolNetworkPackages

$result = $client->listSolNetworkPackages([/* ... */]);
$promise = $client->listSolNetworkPackagesAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listSolNetworkPackages([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'networkPackages' => [
        [
            'arn' => '<string>',
            'id' => '<string>',
            'metadata' => [
                'createdAt' => <DateTime>,
                'lastModified' => <DateTime>,
            ],
            'nsdDesigner' => '<string>',
            'nsdId' => '<string>',
            'nsdInvariantId' => '<string>',
            'nsdName' => '<string>',
            'nsdOnboardingState' => 'CREATED|ONBOARDED|ERROR',
            'nsdOperationalState' => 'ENABLED|DISABLED',
            'nsdUsageState' => 'IN_USE|NOT_IN_USE',
            'nsdVersion' => '<string>',
            'vnfPkgIds' => ['<string>', ...],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

InternalServerException:

Unexpected error occurred. Problem on the server.

ThrottlingException:

Exception caused by throttling.

ValidationException:

Unable to process the request because the client provided input failed to satisfy request constraints.

AccessDeniedException:

Insufficient permissions to make request.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Lists tags for AWS TNB resources.

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'tags' => ['<string>', ...],
]

Result Details

Errors

InternalServerException:

Unexpected error occurred. Problem on the server.

ThrottlingException:

Exception caused by throttling.

ValidationException:

Unable to process the request because the client provided input failed to satisfy request constraints.

ResourceNotFoundException:

Request references a resource that doesn't exist.

AccessDeniedException:

Insufficient permissions to make request.

PutSolFunctionPackageContent

$result = $client->putSolFunctionPackageContent([/* ... */]);
$promise = $client->putSolFunctionPackageContentAsync([/* ... */]);

Uploads the contents of a 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.

Parameter Syntax

$result = $client->putSolFunctionPackageContent([
    'contentType' => 'application/zip',
    'file' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
    'vnfPkgId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'id' => '<string>',
    'metadata' => [
        'vnfd' => [
            'overrides' => [
                [
                    'defaultValue' => '<string>',
                    'name' => '<string>',
                ],
                // ...
            ],
        ],
    ],
    'vnfProductName' => '<string>',
    'vnfProvider' => '<string>',
    'vnfdId' => '<string>',
    'vnfdVersion' => '<string>',
]

Result Details

Errors

InternalServerException:

Unexpected error occurred. Problem on the server.

ThrottlingException:

Exception caused by throttling.

ValidationException:

Unable to process the request because the client provided input failed to satisfy request constraints.

ResourceNotFoundException:

Request references a resource that doesn't exist.

AccessDeniedException:

Insufficient permissions to make request.

PutSolNetworkPackageContent

$result = $client->putSolNetworkPackageContent([/* ... */]);
$promise = $client->putSolNetworkPackageContentAsync([/* ... */]);

Uploads the contents of 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.

Parameter Syntax

$result = $client->putSolNetworkPackageContent([
    'contentType' => 'application/zip',
    'file' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
    'nsdInfoId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'id' => '<string>',
    'metadata' => [
        'nsd' => [
            'overrides' => [
                [
                    'defaultValue' => '<string>',
                    'name' => '<string>',
                ],
                // ...
            ],
        ],
    ],
    'nsdId' => '<string>',
    'nsdName' => '<string>',
    'nsdVersion' => '<string>',
    'vnfPkgIds' => ['<string>', ...],
]

Result Details

Errors

InternalServerException:

Unexpected error occurred. Problem on the server.

ThrottlingException:

Exception caused by throttling.

ValidationException:

Unable to process the request because the client provided input failed to satisfy request constraints.

ResourceNotFoundException:

Request references a resource that doesn't exist.

AccessDeniedException:

Insufficient permissions to make request.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Tags an AWS TNB resource.

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.

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

Unexpected error occurred. Problem on the server.

ThrottlingException:

Exception caused by throttling.

ValidationException:

Unable to process the request because the client provided input failed to satisfy request constraints.

ResourceNotFoundException:

Request references a resource that doesn't exist.

AccessDeniedException:

Insufficient permissions to make request.

TerminateSolNetworkInstance

$result = $client->terminateSolNetworkInstance([/* ... */]);
$promise = $client->terminateSolNetworkInstanceAsync([/* ... */]);

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

You must terminate a network instance before you can delete it.

Parameter Syntax

$result = $client->terminateSolNetworkInstance([
    'nsInstanceId' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'nsLcmOpOccId' => '<string>',
    'tags' => ['<string>', ...],
]

Result Details

Errors

InternalServerException:

Unexpected error occurred. Problem on the server.

ServiceQuotaExceededException:

Service quotas have been exceeded.

ThrottlingException:

Exception caused by throttling.

ValidationException:

Unable to process the request because the client provided input failed to satisfy request constraints.

ResourceNotFoundException:

Request references a resource that doesn't exist.

AccessDeniedException:

Insufficient permissions to make request.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Untags an AWS TNB resource.

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.

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

Unexpected error occurred. Problem on the server.

ThrottlingException:

Exception caused by throttling.

ValidationException:

Unable to process the request because the client provided input failed to satisfy request constraints.

ResourceNotFoundException:

Request references a resource that doesn't exist.

AccessDeniedException:

Insufficient permissions to make request.

UpdateSolFunctionPackage

$result = $client->updateSolFunctionPackage([/* ... */]);
$promise = $client->updateSolFunctionPackageAsync([/* ... */]);

Updates the operational state of 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.

Parameter Syntax

$result = $client->updateSolFunctionPackage([
    'operationalState' => 'ENABLED|DISABLED', // REQUIRED
    'vnfPkgId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'operationalState' => 'ENABLED|DISABLED',
]

Result Details

Errors

InternalServerException:

Unexpected error occurred. Problem on the server.

ThrottlingException:

Exception caused by throttling.

ValidationException:

Unable to process the request because the client provided input failed to satisfy request constraints.

ResourceNotFoundException:

Request references a resource that doesn't exist.

AccessDeniedException:

Insufficient permissions to make request.

UpdateSolNetworkInstance

$result = $client->updateSolNetworkInstance([/* ... */]);
$promise = $client->updateSolNetworkInstanceAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->updateSolNetworkInstance([
    'modifyVnfInfoData' => [
        'vnfConfigurableProperties' => [ // REQUIRED
        ],
        'vnfInstanceId' => '<string>', // REQUIRED
    ],
    'nsInstanceId' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
    'updateNs' => [
        'additionalParamsForNs' => [
        ],
        'nsdInfoId' => '<string>', // REQUIRED
    ],
    'updateType' => 'MODIFY_VNF_INFORMATION|UPDATE_NS', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'nsLcmOpOccId' => '<string>',
    'tags' => ['<string>', ...],
]

Result Details

Errors

InternalServerException:

Unexpected error occurred. Problem on the server.

ServiceQuotaExceededException:

Service quotas have been exceeded.

ThrottlingException:

Exception caused by throttling.

ValidationException:

Unable to process the request because the client provided input failed to satisfy request constraints.

ResourceNotFoundException:

Request references a resource that doesn't exist.

AccessDeniedException:

Insufficient permissions to make request.

UpdateSolNetworkPackage

$result = $client->updateSolNetworkPackage([/* ... */]);
$promise = $client->updateSolNetworkPackageAsync([/* ... */]);

Updates the operational state of 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.

A network service descriptor is a .yaml file in a network package that uses the TOSCA standard to describe the network functions you want to deploy and the Amazon Web Services infrastructure you want to deploy the network functions on.

Parameter Syntax

$result = $client->updateSolNetworkPackage([
    'nsdInfoId' => '<string>', // REQUIRED
    'nsdOperationalState' => 'ENABLED|DISABLED', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'nsdOperationalState' => 'ENABLED|DISABLED',
]

Result Details

Errors

InternalServerException:

Unexpected error occurred. Problem on the server.

ThrottlingException:

Exception caused by throttling.

ValidationException:

Unable to process the request because the client provided input failed to satisfy request constraints.

ResourceNotFoundException:

Request references a resource that doesn't exist.

AccessDeniedException:

Insufficient permissions to make request.

ValidateSolFunctionPackageContent

$result = $client->validateSolFunctionPackageContent([/* ... */]);
$promise = $client->validateSolFunctionPackageContentAsync([/* ... */]);

Validates function package content. This can be used as a dry run before uploading function package content with PutSolFunctionPackageContent.

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.

Parameter Syntax

$result = $client->validateSolFunctionPackageContent([
    'contentType' => 'application/zip',
    'file' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
    'vnfPkgId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'id' => '<string>',
    'metadata' => [
        'vnfd' => [
            'overrides' => [
                [
                    'defaultValue' => '<string>',
                    'name' => '<string>',
                ],
                // ...
            ],
        ],
    ],
    'vnfProductName' => '<string>',
    'vnfProvider' => '<string>',
    'vnfdId' => '<string>',
    'vnfdVersion' => '<string>',
]

Result Details

Errors

InternalServerException:

Unexpected error occurred. Problem on the server.

ThrottlingException:

Exception caused by throttling.

ValidationException:

Unable to process the request because the client provided input failed to satisfy request constraints.

ResourceNotFoundException:

Request references a resource that doesn't exist.

AccessDeniedException:

Insufficient permissions to make request.

ValidateSolNetworkPackageContent

$result = $client->validateSolNetworkPackageContent([/* ... */]);
$promise = $client->validateSolNetworkPackageContentAsync([/* ... */]);

Validates network package content. This can be used as a dry run before uploading network package content with PutSolNetworkPackageContent.

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.

Parameter Syntax

$result = $client->validateSolNetworkPackageContent([
    'contentType' => 'application/zip',
    'file' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
    'nsdInfoId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'id' => '<string>',
    'metadata' => [
        'nsd' => [
            'overrides' => [
                [
                    'defaultValue' => '<string>',
                    'name' => '<string>',
                ],
                // ...
            ],
        ],
    ],
    'nsdId' => '<string>',
    'nsdName' => '<string>',
    'nsdVersion' => '<string>',
    'vnfPkgIds' => ['<string>', ...],
]

Result Details

Errors

InternalServerException:

Unexpected error occurred. Problem on the server.

ThrottlingException:

Exception caused by throttling.

ValidationException:

Unable to process the request because the client provided input failed to satisfy request constraints.

ResourceNotFoundException:

Request references a resource that doesn't exist.

AccessDeniedException:

Insufficient permissions to make request.