com.amazonaws.services.tnb

Interface AWSTnb

All Known Subinterfaces:

AWSTnbAsync

All Known Implementing Classes:

AbstractAWSTnb, AbstractAWSTnbAsync, AWSTnbAsyncClient, AWSTnbClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSTnb

Interface for accessing AWS Telco Network Builder.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSTnb instead.

Amazon Web Services Telco Network Builder (TNB) is a network automation service that helps you deploy and manage telecom networks. AWS TNB helps you with the lifecycle management of your telecommunication network functions throughout planning, deployment, and post-deployment activities.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CancelSolNetworkOperationResult	cancelSolNetworkOperation(CancelSolNetworkOperationRequest cancelSolNetworkOperationRequest) Cancels a network operation.
CreateSolFunctionPackageResult	createSolFunctionPackage(CreateSolFunctionPackageRequest createSolFunctionPackageRequest) Creates a function package.
CreateSolNetworkInstanceResult	createSolNetworkInstance(CreateSolNetworkInstanceRequest createSolNetworkInstanceRequest) Creates a network instance.
CreateSolNetworkPackageResult	createSolNetworkPackage(CreateSolNetworkPackageRequest createSolNetworkPackageRequest) Creates a network package.
DeleteSolFunctionPackageResult	deleteSolFunctionPackage(DeleteSolFunctionPackageRequest deleteSolFunctionPackageRequest) Deletes a function package.
DeleteSolNetworkInstanceResult	deleteSolNetworkInstance(DeleteSolNetworkInstanceRequest deleteSolNetworkInstanceRequest) Deletes a network instance.
DeleteSolNetworkPackageResult	deleteSolNetworkPackage(DeleteSolNetworkPackageRequest deleteSolNetworkPackageRequest) Deletes network package.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
GetSolFunctionInstanceResult	getSolFunctionInstance(GetSolFunctionInstanceRequest getSolFunctionInstanceRequest) Gets the details of a network function instance, including the instantiation state and metadata from the function package descriptor in the network function package.
GetSolFunctionPackageResult	getSolFunctionPackage(GetSolFunctionPackageRequest getSolFunctionPackageRequest) Gets the details of an individual function package, such as the operational state and whether the package is in use.
GetSolFunctionPackageContentResult	getSolFunctionPackageContent(GetSolFunctionPackageContentRequest getSolFunctionPackageContentRequest) Gets the contents of a function package.
GetSolFunctionPackageDescriptorResult	getSolFunctionPackageDescriptor(GetSolFunctionPackageDescriptorRequest getSolFunctionPackageDescriptorRequest) Gets a function package descriptor in a function package.
GetSolNetworkInstanceResult	getSolNetworkInstance(GetSolNetworkInstanceRequest getSolNetworkInstanceRequest) Gets the details of the network instance.
GetSolNetworkOperationResult	getSolNetworkOperation(GetSolNetworkOperationRequest getSolNetworkOperationRequest) Gets the details of a network operation, including the tasks involved in the network operation and the status of the tasks.
GetSolNetworkPackageResult	getSolNetworkPackage(GetSolNetworkPackageRequest getSolNetworkPackageRequest) Gets the details of a network package.
GetSolNetworkPackageContentResult	getSolNetworkPackageContent(GetSolNetworkPackageContentRequest getSolNetworkPackageContentRequest) Gets the contents of a network package.
GetSolNetworkPackageDescriptorResult	getSolNetworkPackageDescriptor(GetSolNetworkPackageDescriptorRequest getSolNetworkPackageDescriptorRequest) Gets the content of the network service descriptor.
InstantiateSolNetworkInstanceResult	instantiateSolNetworkInstance(InstantiateSolNetworkInstanceRequest instantiateSolNetworkInstanceRequest) Instantiates a network instance.
ListSolFunctionInstancesResult	listSolFunctionInstances(ListSolFunctionInstancesRequest listSolFunctionInstancesRequest) Lists network function instances.
ListSolFunctionPackagesResult	listSolFunctionPackages(ListSolFunctionPackagesRequest listSolFunctionPackagesRequest) Lists information about function packages.
ListSolNetworkInstancesResult	listSolNetworkInstances(ListSolNetworkInstancesRequest listSolNetworkInstancesRequest) Lists your network instances.
ListSolNetworkOperationsResult	listSolNetworkOperations(ListSolNetworkOperationsRequest listSolNetworkOperationsRequest) Lists details for a network operation, including when the operation started and the status of the operation.
ListSolNetworkPackagesResult	listSolNetworkPackages(ListSolNetworkPackagesRequest listSolNetworkPackagesRequest) Lists network packages.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists tags for AWS TNB resources.
PutSolFunctionPackageContentResult	putSolFunctionPackageContent(PutSolFunctionPackageContentRequest putSolFunctionPackageContentRequest) Uploads the contents of a function package.
PutSolNetworkPackageContentResult	putSolNetworkPackageContent(PutSolNetworkPackageContentRequest putSolNetworkPackageContentRequest) Uploads the contents of a network package.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) Tags an AWS TNB resource.
TerminateSolNetworkInstanceResult	terminateSolNetworkInstance(TerminateSolNetworkInstanceRequest terminateSolNetworkInstanceRequest) Terminates a network instance.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Untags an AWS TNB resource.
UpdateSolFunctionPackageResult	updateSolFunctionPackage(UpdateSolFunctionPackageRequest updateSolFunctionPackageRequest) Updates the operational state of function package.
UpdateSolNetworkInstanceResult	updateSolNetworkInstance(UpdateSolNetworkInstanceRequest updateSolNetworkInstanceRequest) Update a network instance.
UpdateSolNetworkPackageResult	updateSolNetworkPackage(UpdateSolNetworkPackageRequest updateSolNetworkPackageRequest) Updates the operational state of a network package.
ValidateSolFunctionPackageContentResult	validateSolFunctionPackageContent(ValidateSolFunctionPackageContentRequest validateSolFunctionPackageContentRequest) Validates function package content.
ValidateSolNetworkPackageContentResult	validateSolNetworkPackageContent(ValidateSolNetworkPackageContentRequest validateSolNetworkPackageContentRequest) Validates network package content.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

cancelSolNetworkOperation

CancelSolNetworkOperationResult cancelSolNetworkOperation(CancelSolNetworkOperationRequest cancelSolNetworkOperationRequest)

Cancels a network operation.

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

Parameters:

cancelSolNetworkOperationRequest -

Returns:

Result of the CancelSolNetworkOperation operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createSolFunctionPackage

CreateSolFunctionPackageResult createSolFunctionPackage(CreateSolFunctionPackageRequest createSolFunctionPackageRequest)

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.

Parameters:

createSolFunctionPackageRequest -

Returns:

Result of the CreateSolFunctionPackage operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createSolNetworkInstance

CreateSolNetworkInstanceResult createSolNetworkInstance(CreateSolNetworkInstanceRequest createSolNetworkInstanceRequest)

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.

Parameters:

createSolNetworkInstanceRequest -

Returns:

Result of the CreateSolNetworkInstance operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createSolNetworkPackage

CreateSolNetworkPackageResult createSolNetworkPackage(CreateSolNetworkPackageRequest createSolNetworkPackageRequest)

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.

Parameters:

createSolNetworkPackageRequest -

Returns:

Result of the CreateSolNetworkPackage operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteSolFunctionPackage

DeleteSolFunctionPackageResult deleteSolFunctionPackage(DeleteSolFunctionPackageRequest deleteSolFunctionPackageRequest)

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 .

Parameters:

deleteSolFunctionPackageRequest -

Returns:

Result of the DeleteSolFunctionPackage operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteSolNetworkInstance

DeleteSolNetworkInstanceResult deleteSolNetworkInstance(DeleteSolNetworkInstanceRequest deleteSolNetworkInstanceRequest)

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.

Parameters:

deleteSolNetworkInstanceRequest -

Returns:

Result of the DeleteSolNetworkInstance operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteSolNetworkPackage

DeleteSolNetworkPackageResult deleteSolNetworkPackage(DeleteSolNetworkPackageRequest deleteSolNetworkPackageRequest)

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.

Parameters:

deleteSolNetworkPackageRequest -

Returns:

Result of the DeleteSolNetworkPackage operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getSolFunctionInstance

GetSolFunctionInstanceResult getSolFunctionInstance(GetSolFunctionInstanceRequest getSolFunctionInstanceRequest)

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 .

Parameters:

getSolFunctionInstanceRequest -

Returns:

Result of the GetSolFunctionInstance operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getSolFunctionPackage

GetSolFunctionPackageResult getSolFunctionPackage(GetSolFunctionPackageRequest getSolFunctionPackageRequest)

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

Parameters:

getSolFunctionPackageRequest -

Returns:

Result of the GetSolFunctionPackage operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getSolFunctionPackageContent

GetSolFunctionPackageContentResult getSolFunctionPackageContent(GetSolFunctionPackageContentRequest getSolFunctionPackageContentRequest)

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.

Parameters:

getSolFunctionPackageContentRequest -

Returns:

Result of the GetSolFunctionPackageContent operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getSolFunctionPackageDescriptor

GetSolFunctionPackageDescriptorResult getSolFunctionPackageDescriptor(GetSolFunctionPackageDescriptorRequest getSolFunctionPackageDescriptorRequest)

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.

Parameters:

getSolFunctionPackageDescriptorRequest -

Returns:

Result of the GetSolFunctionPackageDescriptor operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getSolNetworkInstance

GetSolNetworkInstanceResult getSolNetworkInstance(GetSolNetworkInstanceRequest getSolNetworkInstanceRequest)

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.

Parameters:

getSolNetworkInstanceRequest -

Returns:

Result of the GetSolNetworkInstance operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getSolNetworkOperation

GetSolNetworkOperationResult getSolNetworkOperation(GetSolNetworkOperationRequest getSolNetworkOperationRequest)

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.

Parameters:

getSolNetworkOperationRequest -

Returns:

Result of the GetSolNetworkOperation operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getSolNetworkPackage

GetSolNetworkPackageResult getSolNetworkPackage(GetSolNetworkPackageRequest getSolNetworkPackageRequest)

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.

Parameters:

getSolNetworkPackageRequest -

Returns:

Result of the GetSolNetworkPackage operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getSolNetworkPackageContent

GetSolNetworkPackageContentResult getSolNetworkPackageContent(GetSolNetworkPackageContentRequest getSolNetworkPackageContentRequest)

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.

Parameters:

getSolNetworkPackageContentRequest -

Returns:

Result of the GetSolNetworkPackageContent operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getSolNetworkPackageDescriptor

GetSolNetworkPackageDescriptorResult getSolNetworkPackageDescriptor(GetSolNetworkPackageDescriptorRequest getSolNetworkPackageDescriptorRequest)

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.

Parameters:

getSolNetworkPackageDescriptorRequest -

Returns:

Result of the GetSolNetworkPackageDescriptor operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

instantiateSolNetworkInstance

InstantiateSolNetworkInstanceResult instantiateSolNetworkInstance(InstantiateSolNetworkInstanceRequest instantiateSolNetworkInstanceRequest)

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.

Parameters:

instantiateSolNetworkInstanceRequest -

Returns:

Result of the InstantiateSolNetworkInstance operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listSolFunctionInstances

ListSolFunctionInstancesResult listSolFunctionInstances(ListSolFunctionInstancesRequest listSolFunctionInstancesRequest)

Lists network function instances.

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

Parameters:

listSolFunctionInstancesRequest -

Returns:

Result of the ListSolFunctionInstances operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listSolFunctionPackages

ListSolFunctionPackagesResult listSolFunctionPackages(ListSolFunctionPackagesRequest listSolFunctionPackagesRequest)

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.

Parameters:

listSolFunctionPackagesRequest -

Returns:

Result of the ListSolFunctionPackages operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listSolNetworkInstances

ListSolNetworkInstancesResult listSolNetworkInstances(ListSolNetworkInstancesRequest listSolNetworkInstancesRequest)

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.

Parameters:

listSolNetworkInstancesRequest -

Returns:

Result of the ListSolNetworkInstances operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listSolNetworkOperations

ListSolNetworkOperationsResult listSolNetworkOperations(ListSolNetworkOperationsRequest listSolNetworkOperationsRequest)

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.

Parameters:

listSolNetworkOperationsRequest -

Returns:

Result of the ListSolNetworkOperations operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listSolNetworkPackages

ListSolNetworkPackagesResult listSolNetworkPackages(ListSolNetworkPackagesRequest listSolNetworkPackagesRequest)

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.

Parameters:

listSolNetworkPackagesRequest -

Returns:

Result of the ListSolNetworkPackages operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listTagsForResource

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

Lists tags for AWS TNB resources.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

putSolFunctionPackageContent

PutSolFunctionPackageContentResult putSolFunctionPackageContent(PutSolFunctionPackageContentRequest putSolFunctionPackageContentRequest)

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.

Parameters:

putSolFunctionPackageContentRequest -

Returns:

Result of the PutSolFunctionPackageContent operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

putSolNetworkPackageContent

PutSolNetworkPackageContentResult putSolNetworkPackageContent(PutSolNetworkPackageContentRequest putSolNetworkPackageContentRequest)

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.

Parameters:

putSolNetworkPackageContentRequest -

Returns:

Result of the PutSolNetworkPackageContent operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

tagResource

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

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.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

terminateSolNetworkInstance

TerminateSolNetworkInstanceResult terminateSolNetworkInstance(TerminateSolNetworkInstanceRequest terminateSolNetworkInstanceRequest)

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.

Parameters:

terminateSolNetworkInstanceRequest -

Returns:

Result of the TerminateSolNetworkInstance operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

untagResource

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

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.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

updateSolFunctionPackage

UpdateSolFunctionPackageResult updateSolFunctionPackage(UpdateSolFunctionPackageRequest updateSolFunctionPackageRequest)

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.

Parameters:

updateSolFunctionPackageRequest -

Returns:

Result of the UpdateSolFunctionPackage operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

updateSolNetworkInstance

UpdateSolNetworkInstanceResult updateSolNetworkInstance(UpdateSolNetworkInstanceRequest updateSolNetworkInstanceRequest)

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.

Parameters:

updateSolNetworkInstanceRequest -

Returns:

Result of the UpdateSolNetworkInstance operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

updateSolNetworkPackage

UpdateSolNetworkPackageResult updateSolNetworkPackage(UpdateSolNetworkPackageRequest updateSolNetworkPackageRequest)

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.

Parameters:

updateSolNetworkPackageRequest -

Returns:

Result of the UpdateSolNetworkPackage operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

validateSolFunctionPackageContent

ValidateSolFunctionPackageContentResult validateSolFunctionPackageContent(ValidateSolFunctionPackageContentRequest validateSolFunctionPackageContentRequest)

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.

Parameters:

validateSolFunctionPackageContentRequest -

Returns:

Result of the ValidateSolFunctionPackageContent operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

validateSolNetworkPackageContent

ValidateSolNetworkPackageContentResult validateSolNetworkPackageContent(ValidateSolNetworkPackageContentRequest validateSolNetworkPackageContentRequest)

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.

Parameters:

validateSolNetworkPackageContentRequest -

Returns:

Result of the ValidateSolNetworkPackageContent operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.