SDK for PHP 3.x

Client: Aws\Tnb\TnbClient
Service ID: tnb
Version: 2008-10-21

This page describes the parameters and results for the operations of the AWS Telco Network Builder (2008-10-21), and shows how to use the Aws\Tnb\TnbClient object to call the described operations. This documentation is specific to the 2008-10-21 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

CancelSolNetworkOperation ( array $params = [] )
Cancels a network operation.
CreateSolFunctionPackage ( array $params = [] )
Creates a function package.
CreateSolNetworkInstance ( array $params = [] )
Creates a network instance.
CreateSolNetworkPackage ( array $params = [] )
Creates a network package.
DeleteSolFunctionPackage ( array $params = [] )
Deletes a function package.
DeleteSolNetworkInstance ( array $params = [] )
Deletes a network instance.
DeleteSolNetworkPackage ( array $params = [] )
Deletes network package.
GetSolFunctionInstance ( array $params = [] )
Gets the details of a network function instance, including the instantiation state and metadata from the function package descriptor in the network function package.
GetSolFunctionPackage ( array $params = [] )
Gets the details of an individual function package, such as the operational state and whether the package is in use.
GetSolFunctionPackageContent ( array $params = [] )
Gets the contents of a function package.
GetSolFunctionPackageDescriptor ( array $params = [] )
Gets a function package descriptor in a function package.
GetSolNetworkInstance ( array $params = [] )
Gets the details of the network instance.
GetSolNetworkOperation ( array $params = [] )
Gets the details of a network operation, including the tasks involved in the network operation and the status of the tasks.
GetSolNetworkPackage ( array $params = [] )
Gets the details of a network package.
GetSolNetworkPackageContent ( array $params = [] )
Gets the contents of a network package.
GetSolNetworkPackageDescriptor ( array $params = [] )
Gets the content of the network service descriptor.
InstantiateSolNetworkInstance ( array $params = [] )
Instantiates a network instance.
ListSolFunctionInstances ( array $params = [] )
Lists network function instances.
ListSolFunctionPackages ( array $params = [] )
Lists information about function packages.
ListSolNetworkInstances ( array $params = [] )
Lists your network instances.
ListSolNetworkOperations ( array $params = [] )
Lists details for a network operation, including when the operation started and the status of the operation.
ListSolNetworkPackages ( array $params = [] )
Lists network packages.
ListTagsForResource ( array $params = [] )
Lists tags for AWS TNB resources.
PutSolFunctionPackageContent ( array $params = [] )
Uploads the contents of a function package.
PutSolNetworkPackageContent ( array $params = [] )
Uploads the contents of a network package.
TagResource ( array $params = [] )
Tags an AWS TNB resource.
TerminateSolNetworkInstance ( array $params = [] )
Terminates a network instance.
UntagResource ( array $params = [] )
Untags an AWS TNB resource.
UpdateSolFunctionPackage ( array $params = [] )
Updates the operational state of function package.
UpdateSolNetworkInstance ( array $params = [] )
Update a network instance.
UpdateSolNetworkPackage ( array $params = [] )
Updates the operational state of a network package.
ValidateSolFunctionPackageContent ( array $params = [] )
Validates function package content.
ValidateSolNetworkPackageContent ( array $params = [] )
Validates network package content.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListSolFunctionInstances
ListSolFunctionPackages
ListSolNetworkInstances
ListSolNetworkOperations
ListSolNetworkPackages

Operations

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

Members
nsLcmOpOccId
Required: Yes
Type: string

The identifier of the network operation.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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

Members
tags
Type: Associative array of custom strings keys (TagKey) to strings

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.

Result Syntax

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

Result Details

Members
arn
Required: Yes
Type: string

Function package ARN.

id
Required: Yes
Type: string

ID of the function package.

onboardingState
Required: Yes
Type: string

Onboarding state of the function package.

operationalState
Required: Yes
Type: string

Operational state of the function package.

tags
Type: Associative array of custom strings keys (TagKey) to strings

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
Required: Yes
Type: string

Usage state of the function package.

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

Members
nsDescription
Type: string

Network instance description.

nsName
Required: Yes
Type: string

Network instance name.

nsdInfoId
Required: Yes
Type: string

ID for network service descriptor.

tags
Type: Associative array of custom strings keys (TagKey) to strings

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.

Result Syntax

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

Result Details

Members
arn
Required: Yes
Type: string

Network instance ARN.

id
Required: Yes
Type: string

Network instance ID.

nsInstanceName
Required: Yes
Type: string

Network instance name.

nsdInfoId
Required: Yes
Type: string

Network service descriptor ID.

tags
Type: Associative array of custom strings keys (TagKey) to strings

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.

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

Members
tags
Type: Associative array of custom strings keys (TagKey) to strings

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.

Result Syntax

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

Result Details

Members
arn
Required: Yes
Type: string

Network package ARN.

id
Required: Yes
Type: string

ID of the network package.

nsdOnboardingState
Required: Yes
Type: string

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

nsdOperationalState
Required: Yes
Type: string

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

nsdUsageState
Required: Yes
Type: string

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

tags
Type: Associative array of custom strings keys (TagKey) to strings

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.

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

Members
vnfPkgId
Required: Yes
Type: string

ID of the function package.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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

Members
nsInstanceId
Required: Yes
Type: string

Network instance ID.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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

Members
nsdInfoId
Required: Yes
Type: string

ID of the network service descriptor in the network package.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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

Members
vnfInstanceId
Required: Yes
Type: string

ID of the network function.

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

Members
arn
Required: Yes
Type: string

Network function instance ARN.

id
Required: Yes
Type: string

Network function instance ID.

instantiatedVnfInfo
Type: GetSolVnfInfo structure

Information about the network function.

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

instantiationState
Required: Yes
Type: string

Network function instantiation state.

metadata
Required: Yes
Type: GetSolFunctionInstanceMetadata structure

The metadata of a network function instance.

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

nsInstanceId
Required: Yes
Type: string

Network instance ID.

tags
Type: Associative array of custom strings keys (TagKey) to strings

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
Required: Yes
Type: string

Function package ID.

vnfProductName
Type: string

Network function product name.

vnfProvider
Type: string

Network function provider.

vnfdId
Required: Yes
Type: string

Function package descriptor ID.

vnfdVersion
Type: string

Function package descriptor version.

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

Members
vnfPkgId
Required: Yes
Type: string

ID of the function package.

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

Members
arn
Required: Yes
Type: string

Function package ARN.

id
Required: Yes
Type: string

Function package ID.

metadata

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.

onboardingState
Required: Yes
Type: string

Function package onboarding state.

operationalState
Required: Yes
Type: string

Function package operational state.

tags
Type: Associative array of custom strings keys (TagKey) to strings

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
Required: Yes
Type: string

Function package usage state.

vnfProductName
Type: string

Network function product name.

vnfProvider
Type: string

Network function provider.

vnfdId
Type: string

Function package descriptor ID.

vnfdVersion
Type: string

Function package descriptor version.

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

Members
accept
Required: Yes
Type: string

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

vnfPkgId
Required: Yes
Type: string

ID of the function package.

Result Syntax

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

Result Details

Members
contentType
Type: string

Indicates the media type of the resource.

packageContent
Type: blob (string|resource|Psr\Http\Message\StreamInterface)

Contents of the function package.

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

Members
accept
Required: Yes
Type: string

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

vnfPkgId
Required: Yes
Type: string

ID of the function package.

Result Syntax

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

Result Details

Members
contentType
Type: string

Indicates the media type of the resource.

vnfd
Type: blob (string|resource|Psr\Http\Message\StreamInterface)

Contents of the function package descriptor.

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

Members
nsInstanceId
Required: Yes
Type: string

ID of the network instance.

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

Members
arn
Required: Yes
Type: string

Network instance ARN.

id
Required: Yes
Type: string

Network instance ID.

lcmOpInfo
Type: LcmOperationInfo structure

Lifecycle management operation details on the network instance.

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

metadata
Required: Yes
Type: GetSolNetworkInstanceMetadata structure

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.

nsInstanceDescription
Required: Yes
Type: string

Network instance description.

nsInstanceName
Required: Yes
Type: string

Network instance name.

nsState
Type: string

Network instance state.

nsdId
Required: Yes
Type: string

Network service descriptor ID.

nsdInfoId
Required: Yes
Type: string

Network service descriptor info ID.

tags
Type: Associative array of custom strings keys (TagKey) to strings

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.

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

Members
nsLcmOpOccId
Required: Yes
Type: string

The identifier of the network operation.

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

Members
arn
Required: Yes
Type: string

Network operation ARN.

error
Type: ProblemDetails structure

Error related to this specific network operation occurrence.

id
Type: string

ID of this network operation occurrence.

lcmOperationType
Type: string

Type of the operation represented by this occurrence.

metadata

Metadata of this network operation occurrence.

nsInstanceId
Type: string

ID of the network operation instance.

operationState
Type: string

The state of the network operation.

tags
Type: Associative array of custom strings keys (TagKey) to strings

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
Type: Array of GetSolNetworkOperationTaskDetails structures

All tasks associated with this operation occurrence.

updateType
Type: string

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

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

Members
nsdInfoId
Required: Yes
Type: string

ID of the network service descriptor in the network package.

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

Members
arn
Required: Yes
Type: string

Network package ARN.

id
Required: Yes
Type: string

Network package ID.

metadata
Required: Yes
Type: GetSolNetworkPackageMetadata structure

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.

nsdId
Required: Yes
Type: string

Network service descriptor ID.

nsdName
Required: Yes
Type: string

Network service descriptor name.

nsdOnboardingState
Required: Yes
Type: string

Network service descriptor onboarding state.

nsdOperationalState
Required: Yes
Type: string

Network service descriptor operational state.

nsdUsageState
Required: Yes
Type: string

Network service descriptor usage state.

nsdVersion
Required: Yes
Type: string

Network service descriptor version.

tags
Type: Associative array of custom strings keys (TagKey) to strings

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
Required: Yes
Type: Array of strings

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

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

Members
accept
Required: Yes
Type: string

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

nsdInfoId
Required: Yes
Type: string

ID of the network service descriptor in the network package.

Result Syntax

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

Result Details

Members
contentType
Type: string

Indicates the media type of the resource.

nsdContent
Type: blob (string|resource|Psr\Http\Message\StreamInterface)

Content of the network service descriptor in the network package.

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

Members
nsdInfoId
Required: Yes
Type: string

ID of the network service descriptor in the network package.

Result Syntax

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

Result Details

Members
contentType
Type: string

Indicates the media type of the resource.

nsd
Type: blob (string|resource|Psr\Http\Message\StreamInterface)

Contents of the network service descriptor in the network package.

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

Members
additionalParamsForNs
Type: document (null|bool|string|numeric) or an (array|associative array) whose members are all valid documents

Provides values for the configurable properties.

dryRun
Type: 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
Required: Yes
Type: string

ID of the network instance.

tags
Type: Associative array of custom strings keys (TagKey) to strings

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.

Result Syntax

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

Result Details

Members
nsLcmOpOccId
Required: Yes
Type: string

The identifier of the network operation.

tags
Type: Associative array of custom strings keys (TagKey) to strings

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.

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

Members
maxResults
Type: int

The maximum number of results to include in the response.

nextToken
Type: string

The token for the next page of results.

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

Members
functionInstances
Type: Array of ListSolFunctionInstanceInfo structures

Network function instances.

nextToken
Type: string

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

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

Members
maxResults
Type: int

The maximum number of results to include in the response.

nextToken
Type: string

The token for the next page of results.

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

Members
functionPackages
Required: Yes
Type: Array of ListSolFunctionPackageInfo structures

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.

nextToken
Type: string

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

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

Members
maxResults
Type: int

The maximum number of results to include in the response.

nextToken
Type: string

The token for the next page of results.

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

Members
networkInstances
Type: Array of ListSolNetworkInstanceInfo structures

Lists network instances.

nextToken
Type: string

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

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

Members
maxResults
Type: int

The maximum number of results to include in the response.

nextToken
Type: string

The token for the next page of results.

nsInstanceId
Type: string

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

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

Members
networkOperations
Type: Array of ListSolNetworkOperationsInfo structures

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

nextToken
Type: string

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

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

Members
maxResults
Type: int

The maximum number of results to include in the response.

nextToken
Type: string

The token for the next page of results.

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

Members
networkPackages
Required: Yes
Type: Array of ListSolNetworkPackageInfo structures

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.

nextToken
Type: string

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

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

Members
resourceArn
Required: Yes
Type: string

Resource ARN.

Result Syntax

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

Result Details

Members
tags
Required: Yes
Type: Associative array of custom strings keys (TagKey) to strings

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.

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

Members
contentType
Type: string

Function package content type.

file
Required: Yes
Type: blob (string|resource|Psr\Http\Message\StreamInterface)

Function package file.

vnfPkgId
Required: Yes
Type: string

Function package ID.

Result Syntax

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

Result Details

Members
id
Required: Yes
Type: string

Function package ID.

metadata
Required: Yes
Type: PutSolFunctionPackageContentMetadata structure

Function package metadata.

vnfProductName
Required: Yes
Type: string

Function product name.

vnfProvider
Required: Yes
Type: string

Function provider.

vnfdId
Required: Yes
Type: string

Function package descriptor ID.

vnfdVersion
Required: Yes
Type: string

Function package descriptor version.

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

Members
contentType
Type: string

Network package content type.

file
Required: Yes
Type: blob (string|resource|Psr\Http\Message\StreamInterface)

Network package file.

nsdInfoId
Required: Yes
Type: string

Network service descriptor info ID.

Result Syntax

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

Result Details

Members
arn
Required: Yes
Type: string

Network package ARN.

id
Required: Yes
Type: string

Network package ID.

metadata
Required: Yes
Type: PutSolNetworkPackageContentMetadata structure

Network package metadata.

nsdId
Required: Yes
Type: string

Network service descriptor ID.

nsdName
Required: Yes
Type: string

Network service descriptor name.

nsdVersion
Required: Yes
Type: string

Network service descriptor version.

vnfPkgIds
Required: Yes
Type: Array of strings

Function package IDs.

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

Members
resourceArn
Required: Yes
Type: string

Resource ARN.

tags
Required: Yes
Type: Associative array of custom strings keys (TagKey) to strings

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.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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

Members
nsInstanceId
Required: Yes
Type: string

ID of the network instance.

tags
Type: Associative array of custom strings keys (TagKey) to strings

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.

Result Syntax

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

Result Details

Members
nsLcmOpOccId
Type: string

The identifier of the network operation.

tags
Type: Associative array of custom strings keys (TagKey) to strings

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.

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

Members
resourceArn
Required: Yes
Type: string

Resource ARN.

tagKeys
Required: Yes
Type: Array of strings

Tag keys.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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

Members
operationalState
Required: Yes
Type: string

Operational state of the function package.

vnfPkgId
Required: Yes
Type: string

ID of the function package.

Result Syntax

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

Result Details

Members
operationalState
Required: Yes
Type: string

Operational state of the function package.

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

Members
modifyVnfInfoData
Type: UpdateSolNetworkModify structure

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

Include this property only if the update type is MODIFY_VNF_INFORMATION.

nsInstanceId
Required: Yes
Type: string

ID of the network instance.

tags
Type: Associative array of custom strings keys (TagKey) to strings

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
Type: UpdateSolNetworkServiceData structure

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

Include this property only if the update type is UPDATE_NS.

updateType
Required: Yes
Type: string

The type of update.

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

  • Use the UPDATE_NS update type, to update the network instance to a new network service descriptor.

Result Syntax

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

Result Details

Members
nsLcmOpOccId
Type: string

The identifier of the network operation.

tags
Type: Associative array of custom strings keys (TagKey) to strings

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.

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

Members
nsdInfoId
Required: Yes
Type: string

ID of the network service descriptor in the network package.

nsdOperationalState
Required: Yes
Type: string

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

Result Syntax

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

Result Details

Members
nsdOperationalState
Required: Yes
Type: string

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

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

Members
contentType
Type: string

Function package content type.

file
Required: Yes
Type: blob (string|resource|Psr\Http\Message\StreamInterface)

Function package file.

vnfPkgId
Required: Yes
Type: string

Function package ID.

Result Syntax

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

Result Details

Members
id
Required: Yes
Type: string

Function package ID.

metadata
Required: Yes
Type: ValidateSolFunctionPackageContentMetadata structure

Function package metadata.

vnfProductName
Required: Yes
Type: string

Network function product name.

vnfProvider
Required: Yes
Type: string

Network function provider.

vnfdId
Required: Yes
Type: string

Function package descriptor ID.

vnfdVersion
Required: Yes
Type: string

Function package descriptor version.

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

Members
contentType
Type: string

Network package content type.

file
Required: Yes
Type: blob (string|resource|Psr\Http\Message\StreamInterface)

Network package file.

nsdInfoId
Required: Yes
Type: string

Network service descriptor file.

Result Syntax

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

Result Details

Members
arn
Required: Yes
Type: string

Network package ARN.

id
Required: Yes
Type: string

Network package ID.

metadata
Required: Yes
Type: ValidateSolNetworkPackageContentMetadata structure

Network package metadata.

nsdId
Required: Yes
Type: string

Network service descriptor ID.

nsdName
Required: Yes
Type: string

Network service descriptor name.

nsdVersion
Required: Yes
Type: string

Network service descriptor version.

vnfPkgIds
Required: Yes
Type: Array of strings

Function package IDs.

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.

Shapes

AccessDeniedException

Description

Insufficient permissions to make request.

Members
message
Required: Yes
Type: string

Document

Members

ErrorInfo

Description

Provides error information.

Members
cause
Type: string

Error cause.

details
Type: string

Error details.

FunctionArtifactMeta

Description

Metadata for function package artifacts.

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

Members
overrides
Type: Array of ToscaOverride structures

Lists of function package overrides.

GetSolFunctionInstanceMetadata

Description

The metadata of a network function instance.

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

Members
createdAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date that the resource was created.

lastModified
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date that the resource was last modified.

GetSolFunctionPackageMetadata

Description

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.

Members
createdAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date that the resource was created.

lastModified
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date that the resource was last modified.

vnfd
Type: FunctionArtifactMeta structure

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

GetSolInstantiatedVnfInfo

Description

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.

Members
vnfState
Type: string

State of the network function.

GetSolNetworkInstanceMetadata

Description

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.

Members
createdAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date that the resource was created.

lastModified
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date that the resource was last modified.

GetSolNetworkOperationMetadata

Description

Metadata related to a network operation occurrence.

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

Members
createdAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date that the resource was created.

instantiateMetadata
Type: InstantiateMetadata structure

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

lastModified
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date that the resource was last modified.

modifyVnfInfoMetadata
Type: ModifyVnfInfoMetadata structure

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.

updateNsMetadata
Type: UpdateNsMetadata structure

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.

GetSolNetworkOperationTaskDetails

Description

Gets the details of a network operation.

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

Members
taskContext
Type: Associative array of custom strings keys (String) to strings

Context for the network operation task.

taskEndTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

Task end time.

taskErrorDetails
Type: ErrorInfo structure

Task error details.

taskName
Type: string

Task name.

taskStartTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

Task start time.

taskStatus
Type: string

Task status.

GetSolNetworkPackageMetadata

Description

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.

Members
createdAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date that the resource was created.

lastModified
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date that the resource was last modified.

nsd
Type: NetworkArtifactMeta structure

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

GetSolVnfInfo

Description

Information about the network function.

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

Members
vnfState
Type: string

State of the network function instance.

vnfcResourceInfo
Type: Array of GetSolVnfcResourceInfo structures

Compute info used by the network function instance.

GetSolVnfcResourceInfo

Description

Details of resource associated with 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.

Members
metadata

The metadata of the network function compute.

GetSolVnfcResourceInfoMetadata

Description

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

Members
cluster
Type: string

Information about the cluster.

helmChart
Type: string

Information about the helm chart.

nodeGroup
Type: string

Information about the node group.

InstantiateMetadata

Description

Metadata related to the configuration properties used during instantiation of the network instance.

Members
additionalParamsForNs
Type: document (null|bool|string|numeric) or an (array|associative array) whose members are all valid documents

The configurable properties used during instantiation.

nsdInfoId
Required: Yes
Type: string

The network service descriptor used for instantiating the network instance.

InternalServerException

Description

Unexpected error occurred. Problem on the server.

Members
message
Required: Yes
Type: string

LcmOperationInfo

Description

Lifecycle management operation details on the network instance.

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

Members
nsLcmOpOccId
Required: Yes
Type: string

The identifier of the network operation.

ListSolFunctionInstanceInfo

Description

Lists information about a network function instance.

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

Members
arn
Required: Yes
Type: string

Network function instance ARN.

id
Required: Yes
Type: string

Network function instance ID.

instantiatedVnfInfo
Type: GetSolInstantiatedVnfInfo structure

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.

instantiationState
Required: Yes
Type: string

Network function instance instantiation state.

metadata
Required: Yes
Type: ListSolFunctionInstanceMetadata structure

Network function instance metadata.

nsInstanceId
Required: Yes
Type: string

Network instance ID.

vnfPkgId
Required: Yes
Type: string

Function package ID.

vnfPkgName
Type: string

Function package name.

ListSolFunctionInstanceMetadata

Description

Lists network function instance metadata.

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

Members
createdAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

When the network function instance was created.

lastModified
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

When the network function instance was last modified.

ListSolFunctionPackageInfo

Description

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

Members
arn
Required: Yes
Type: string

Function package ARN.

id
Required: Yes
Type: string

ID of the function package.

metadata

The metadata of the function package.

onboardingState
Required: Yes
Type: string

Onboarding state of the function package.

operationalState
Required: Yes
Type: string

Operational state of the function package.

usageState
Required: Yes
Type: string

Usage state of the function package.

vnfProductName
Type: string

The product name for the network function.

vnfProvider
Type: string

Provider of the function package and the function package descriptor.

vnfdId
Type: string

Identifies the function package and the function package descriptor.

vnfdVersion
Type: string

Identifies the version of the function package descriptor.

ListSolFunctionPackageMetadata

Description

Details for the function package metadata.

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.

Members
createdAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date that the resource was created.

lastModified
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date that the resource was last modified.

ListSolNetworkInstanceInfo

Description

Info about the specific 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.

Members
arn
Required: Yes
Type: string

Network instance ARN.

id
Required: Yes
Type: string

ID of the network instance.

metadata
Required: Yes
Type: ListSolNetworkInstanceMetadata structure

The metadata of the network instance.

nsInstanceDescription
Required: Yes
Type: string

Human-readable description of the network instance.

nsInstanceName
Required: Yes
Type: string

Human-readable name of the network instance.

nsState
Required: Yes
Type: string

The state of the network instance.

nsdId
Required: Yes
Type: string

ID of the network service descriptor in the network package.

nsdInfoId
Required: Yes
Type: string

ID of the network service descriptor in the network package.

ListSolNetworkInstanceMetadata

Description

Metadata details for 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.

Members
createdAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date that the resource was created.

lastModified
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date that the resource was last modified.

ListSolNetworkOperationsInfo

Description

Information parameters for a network operation.

Members
arn
Required: Yes
Type: string

Network operation ARN.

error
Type: ProblemDetails structure

Error related to this specific network operation.

id
Required: Yes
Type: string

ID of this network operation.

lcmOperationType
Required: Yes
Type: string

Type of lifecycle management network operation.

metadata

Metadata related to this network operation.

nsInstanceId
Required: Yes
Type: string

ID of the network instance related to this operation.

operationState
Required: Yes
Type: string

The state of the network operation.

updateType
Type: string

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

ListSolNetworkOperationsMetadata

Description

Metadata related to a network operation.

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

Members
createdAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date that the resource was created.

lastModified
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date that the resource was last modified.

nsdInfoId
Type: string

The network service descriptor id used for the operation.

Only present if the updateType is UPDATE_NS.

vnfInstanceId
Type: string

The network function id used for the operation.

Only present if the updateType is MODIFY_VNF_INFO.

ListSolNetworkPackageInfo

Description

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.

Members
arn
Required: Yes
Type: string

Network package ARN.

id
Required: Yes
Type: string

ID of the individual network package.

metadata
Required: Yes
Type: ListSolNetworkPackageMetadata structure

The metadata of the network package.

nsdDesigner
Type: string

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

nsdId
Type: string

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

nsdInvariantId
Type: string

Identifies a network service descriptor in a version independent manner.

nsdName
Type: string

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

nsdOnboardingState
Required: Yes
Type: string

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

nsdOperationalState
Required: Yes
Type: string

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

nsdUsageState
Required: Yes
Type: string

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

nsdVersion
Type: string

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

vnfPkgIds
Type: Array of strings

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

ListSolNetworkPackageMetadata

Description

Metadata related to 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.

Members
createdAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date that the resource was created.

lastModified
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date that the resource was last modified.

ModifyVnfInfoMetadata

Description

Metadata related to the configuration properties used during update of a specific network function in a network instance.

Members
vnfConfigurableProperties
Required: Yes
Type: document (null|bool|string|numeric) or an (array|associative array) whose members are all valid documents

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

vnfInstanceId
Required: Yes
Type: string

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

NetworkArtifactMeta

Description

Metadata for network package artifacts.

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

Members
overrides
Type: Array of ToscaOverride structures

Lists network package overrides.

ProblemDetails

Description

Details related to problems with AWS TNB resources.

Members
detail
Required: Yes
Type: string

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

title
Type: string

A human-readable title of the problem type.

PutSolFunctionPackageContentMetadata

Description

Update metadata in 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.

Members
vnfd
Type: FunctionArtifactMeta structure

Metadata for function package artifacts.

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

PutSolNetworkPackageContentMetadata

Description

Update metadata in 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.

Members
nsd
Type: NetworkArtifactMeta structure

Metadata for network package artifacts.

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

ResourceNotFoundException

Description

Request references a resource that doesn't exist.

Members
message
Required: Yes
Type: string

ServiceQuotaExceededException

Description

Service quotas have been exceeded.

Members
message
Required: Yes
Type: string

ThrottlingException

Description

Exception caused by throttling.

Members
message
Required: Yes
Type: string

ToscaOverride

Description

Overrides of the TOSCA node.

Members
defaultValue
Type: string

Default value for the override.

name
Type: string

Name of the TOSCA override.

UpdateNsMetadata

Description

Metadata related to the configuration properties used during update of a network instance.

Members
additionalParamsForNs
Type: document (null|bool|string|numeric) or an (array|associative array) whose members are all valid documents

The configurable properties used during update.

nsdInfoId
Required: Yes
Type: string

The network service descriptor used for updating the network instance.

UpdateSolNetworkModify

Description

Information parameters and/or the configurable properties for a network function.

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

Members
vnfConfigurableProperties
Required: Yes
Type: document (null|bool|string|numeric) or an (array|associative array) whose members are all valid documents

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

vnfInstanceId
Required: Yes
Type: string

ID of the network function instance.

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

UpdateSolNetworkServiceData

Description

Information parameters and/or the configurable properties for a network descriptor used for update.

Members
additionalParamsForNs
Type: document (null|bool|string|numeric) or an (array|associative array) whose members are all valid documents

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

nsdInfoId
Required: Yes
Type: string

ID of the network service descriptor.

ValidateSolFunctionPackageContentMetadata

Description

Validates function package content metadata.

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.

Members
vnfd
Type: FunctionArtifactMeta structure

Metadata for function package artifacts.

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

ValidateSolNetworkPackageContentMetadata

Description

Validates network package content metadata.

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.

Members
nsd
Type: NetworkArtifactMeta structure

Metadata for network package artifacts.

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

ValidationException

Description

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

Members
message
Required: Yes
Type: string