tnb/aws.sdk.kotlin.services.tnb/TnbClient

TnbClient

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.

Types

Builder

class Builder : AbstractSdkClientBuilder<TnbClient.Config, TnbClient.Config.Builder, TnbClient>

Companion

object Companion : AbstractAwsSdkClientFactory<TnbClient.Config, TnbClient.Config.Builder, TnbClient, TnbClient.Builder>

Config

class Config : AwsSdkClientConfig, CredentialsProviderConfig, HttpAuthConfig, HttpClientConfig, HttpEngineConfig, RetryClientConfig, RetryStrategyClientConfig, SdkClientConfig, TelemetryConfig

Properties

config

abstract override val config: TnbClient.Config

TnbClient's configuration

Functions

cancelSolNetworkOperation

abstract suspend fun cancelSolNetworkOperation(input: CancelSolNetworkOperationRequest): CancelSolNetworkOperationResponse

Cancels a network operation.

createSolFunctionPackage

abstract suspend fun createSolFunctionPackage(input: CreateSolFunctionPackageRequest = CreateSolFunctionPackageRequest { }): CreateSolFunctionPackageResponse

Creates a function package.

createSolNetworkInstance

abstract suspend fun createSolNetworkInstance(input: CreateSolNetworkInstanceRequest): CreateSolNetworkInstanceResponse

Creates a network instance.

createSolNetworkPackage

abstract suspend fun createSolNetworkPackage(input: CreateSolNetworkPackageRequest = CreateSolNetworkPackageRequest { }): CreateSolNetworkPackageResponse

Creates a network package.

deleteSolFunctionPackage

abstract suspend fun deleteSolFunctionPackage(input: DeleteSolFunctionPackageRequest): DeleteSolFunctionPackageResponse

Deletes a function package.

deleteSolNetworkInstance

abstract suspend fun deleteSolNetworkInstance(input: DeleteSolNetworkInstanceRequest): DeleteSolNetworkInstanceResponse

Deletes a network instance.

deleteSolNetworkPackage

abstract suspend fun deleteSolNetworkPackage(input: DeleteSolNetworkPackageRequest): DeleteSolNetworkPackageResponse

Deletes network package.

getSolFunctionInstance

abstract suspend fun getSolFunctionInstance(input: GetSolFunctionInstanceRequest): GetSolFunctionInstanceResponse

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

getSolFunctionPackage

abstract suspend fun getSolFunctionPackage(input: GetSolFunctionPackageRequest): GetSolFunctionPackageResponse

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

getSolFunctionPackageContent

abstract suspend fun getSolFunctionPackageContent(input: GetSolFunctionPackageContentRequest): GetSolFunctionPackageContentResponse

Gets the contents of a function package.

getSolFunctionPackageDescriptor

abstract suspend fun getSolFunctionPackageDescriptor(input: GetSolFunctionPackageDescriptorRequest): GetSolFunctionPackageDescriptorResponse

Gets a function package descriptor in a function package.

getSolNetworkInstance

abstract suspend fun getSolNetworkInstance(input: GetSolNetworkInstanceRequest): GetSolNetworkInstanceResponse

Gets the details of the network instance.

getSolNetworkOperation

abstract suspend fun getSolNetworkOperation(input: GetSolNetworkOperationRequest): GetSolNetworkOperationResponse

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

getSolNetworkPackage

abstract suspend fun getSolNetworkPackage(input: GetSolNetworkPackageRequest): GetSolNetworkPackageResponse

Gets the details of a network package.

getSolNetworkPackageContent

abstract suspend fun getSolNetworkPackageContent(input: GetSolNetworkPackageContentRequest): GetSolNetworkPackageContentResponse

Gets the contents of a network package.

getSolNetworkPackageDescriptor

abstract suspend fun getSolNetworkPackageDescriptor(input: GetSolNetworkPackageDescriptorRequest): GetSolNetworkPackageDescriptorResponse

Gets the content of the network service descriptor.

instantiateSolNetworkInstance

abstract suspend fun instantiateSolNetworkInstance(input: InstantiateSolNetworkInstanceRequest): InstantiateSolNetworkInstanceResponse

Instantiates a network instance.

listSolFunctionInstances

abstract suspend fun listSolFunctionInstances(input: ListSolFunctionInstancesRequest = ListSolFunctionInstancesRequest { }): ListSolFunctionInstancesResponse

Lists network function instances.

listSolFunctionPackages

abstract suspend fun listSolFunctionPackages(input: ListSolFunctionPackagesRequest = ListSolFunctionPackagesRequest { }): ListSolFunctionPackagesResponse

Lists information about function packages.

listSolNetworkInstances

abstract suspend fun listSolNetworkInstances(input: ListSolNetworkInstancesRequest = ListSolNetworkInstancesRequest { }): ListSolNetworkInstancesResponse

Lists your network instances.

listSolNetworkOperations

abstract suspend fun listSolNetworkOperations(input: ListSolNetworkOperationsRequest = ListSolNetworkOperationsRequest { }): ListSolNetworkOperationsResponse

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

listSolNetworkPackages

abstract suspend fun listSolNetworkPackages(input: ListSolNetworkPackagesRequest = ListSolNetworkPackagesRequest { }): ListSolNetworkPackagesResponse

Lists network packages.

listTagsForResource

abstract suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse

Lists tags for AWS TNB resources.

putSolFunctionPackageContent

abstract suspend fun putSolFunctionPackageContent(input: PutSolFunctionPackageContentRequest): PutSolFunctionPackageContentResponse

Uploads the contents of a function package.

putSolNetworkPackageContent

abstract suspend fun putSolNetworkPackageContent(input: PutSolNetworkPackageContentRequest): PutSolNetworkPackageContentResponse

Uploads the contents of a network package.

tagResource

abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Tags an AWS TNB resource.

terminateSolNetworkInstance

abstract suspend fun terminateSolNetworkInstance(input: TerminateSolNetworkInstanceRequest): TerminateSolNetworkInstanceResponse

Terminates a network instance.

untagResource

abstract suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse

Untags an AWS TNB resource.

updateSolFunctionPackage

abstract suspend fun updateSolFunctionPackage(input: UpdateSolFunctionPackageRequest): UpdateSolFunctionPackageResponse

Updates the operational state of function package.

updateSolNetworkInstance

abstract suspend fun updateSolNetworkInstance(input: UpdateSolNetworkInstanceRequest): UpdateSolNetworkInstanceResponse

Update a network instance.

updateSolNetworkPackage

abstract suspend fun updateSolNetworkPackage(input: UpdateSolNetworkPackageRequest): UpdateSolNetworkPackageResponse

Updates the operational state of a network package.

validateSolFunctionPackageContent

abstract suspend fun validateSolFunctionPackageContent(input: ValidateSolFunctionPackageContentRequest): ValidateSolFunctionPackageContentResponse

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

validateSolNetworkPackageContent

abstract suspend fun validateSolNetworkPackageContent(input: ValidateSolNetworkPackageContentRequest): ValidateSolNetworkPackageContentResponse

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

Inherited functions

cancelSolNetworkOperation

inline suspend fun TnbClient.cancelSolNetworkOperation(crossinline block: CancelSolNetworkOperationRequest.Builder.() -> Unit): CancelSolNetworkOperationResponse

Cancels a network operation.

expect abstract fun close()

createSolFunctionPackage

inline suspend fun TnbClient.createSolFunctionPackage(crossinline block: CreateSolFunctionPackageRequest.Builder.() -> Unit): CreateSolFunctionPackageResponse

Creates a function package.

createSolNetworkInstance

inline suspend fun TnbClient.createSolNetworkInstance(crossinline block: CreateSolNetworkInstanceRequest.Builder.() -> Unit): CreateSolNetworkInstanceResponse

Creates a network instance.

createSolNetworkPackage

inline suspend fun TnbClient.createSolNetworkPackage(crossinline block: CreateSolNetworkPackageRequest.Builder.() -> Unit): CreateSolNetworkPackageResponse

Creates a network package.

deleteSolFunctionPackage

inline suspend fun TnbClient.deleteSolFunctionPackage(crossinline block: DeleteSolFunctionPackageRequest.Builder.() -> Unit): DeleteSolFunctionPackageResponse

Deletes a function package.

deleteSolNetworkInstance

inline suspend fun TnbClient.deleteSolNetworkInstance(crossinline block: DeleteSolNetworkInstanceRequest.Builder.() -> Unit): DeleteSolNetworkInstanceResponse

Deletes a network instance.

deleteSolNetworkPackage

inline suspend fun TnbClient.deleteSolNetworkPackage(crossinline block: DeleteSolNetworkPackageRequest.Builder.() -> Unit): DeleteSolNetworkPackageResponse

Deletes network package.

getSolFunctionInstance

inline suspend fun TnbClient.getSolFunctionInstance(crossinline block: GetSolFunctionInstanceRequest.Builder.() -> Unit): GetSolFunctionInstanceResponse

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

getSolFunctionPackage

inline suspend fun TnbClient.getSolFunctionPackage(crossinline block: GetSolFunctionPackageRequest.Builder.() -> Unit): GetSolFunctionPackageResponse

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

getSolFunctionPackageContent

inline suspend fun TnbClient.getSolFunctionPackageContent(crossinline block: GetSolFunctionPackageContentRequest.Builder.() -> Unit): GetSolFunctionPackageContentResponse

Gets the contents of a function package.

getSolFunctionPackageDescriptor

inline suspend fun TnbClient.getSolFunctionPackageDescriptor(crossinline block: GetSolFunctionPackageDescriptorRequest.Builder.() -> Unit): GetSolFunctionPackageDescriptorResponse

Gets a function package descriptor in a function package.

getSolNetworkInstance

inline suspend fun TnbClient.getSolNetworkInstance(crossinline block: GetSolNetworkInstanceRequest.Builder.() -> Unit): GetSolNetworkInstanceResponse

Gets the details of the network instance.

getSolNetworkOperation

inline suspend fun TnbClient.getSolNetworkOperation(crossinline block: GetSolNetworkOperationRequest.Builder.() -> Unit): GetSolNetworkOperationResponse

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

getSolNetworkPackage

inline suspend fun TnbClient.getSolNetworkPackage(crossinline block: GetSolNetworkPackageRequest.Builder.() -> Unit): GetSolNetworkPackageResponse

Gets the details of a network package.

getSolNetworkPackageContent

inline suspend fun TnbClient.getSolNetworkPackageContent(crossinline block: GetSolNetworkPackageContentRequest.Builder.() -> Unit): GetSolNetworkPackageContentResponse

Gets the contents of a network package.

getSolNetworkPackageDescriptor

inline suspend fun TnbClient.getSolNetworkPackageDescriptor(crossinline block: GetSolNetworkPackageDescriptorRequest.Builder.() -> Unit): GetSolNetworkPackageDescriptorResponse

Gets the content of the network service descriptor.

instantiateSolNetworkInstance

inline suspend fun TnbClient.instantiateSolNetworkInstance(crossinline block: InstantiateSolNetworkInstanceRequest.Builder.() -> Unit): InstantiateSolNetworkInstanceResponse

Instantiates a network instance.

listSolFunctionInstances

inline suspend fun TnbClient.listSolFunctionInstances(crossinline block: ListSolFunctionInstancesRequest.Builder.() -> Unit): ListSolFunctionInstancesResponse

Lists network function instances.

listSolFunctionInstancesPaginated

fun TnbClient.listSolFunctionInstancesPaginated(initialRequest: ListSolFunctionInstancesRequest = ListSolFunctionInstancesRequest { }): Flow<ListSolFunctionInstancesResponse>

fun TnbClient.listSolFunctionInstancesPaginated(block: ListSolFunctionInstancesRequest.Builder.() -> Unit): Flow<ListSolFunctionInstancesResponse>

Paginate over ListSolFunctionInstancesResponse results.

listSolFunctionPackages

inline suspend fun TnbClient.listSolFunctionPackages(crossinline block: ListSolFunctionPackagesRequest.Builder.() -> Unit): ListSolFunctionPackagesResponse

Lists information about function packages.

listSolFunctionPackagesPaginated

fun TnbClient.listSolFunctionPackagesPaginated(initialRequest: ListSolFunctionPackagesRequest = ListSolFunctionPackagesRequest { }): Flow<ListSolFunctionPackagesResponse>

fun TnbClient.listSolFunctionPackagesPaginated(block: ListSolFunctionPackagesRequest.Builder.() -> Unit): Flow<ListSolFunctionPackagesResponse>

Paginate over ListSolFunctionPackagesResponse results.

listSolNetworkInstances

inline suspend fun TnbClient.listSolNetworkInstances(crossinline block: ListSolNetworkInstancesRequest.Builder.() -> Unit): ListSolNetworkInstancesResponse

Lists your network instances.

listSolNetworkInstancesPaginated

fun TnbClient.listSolNetworkInstancesPaginated(initialRequest: ListSolNetworkInstancesRequest = ListSolNetworkInstancesRequest { }): Flow<ListSolNetworkInstancesResponse>

fun TnbClient.listSolNetworkInstancesPaginated(block: ListSolNetworkInstancesRequest.Builder.() -> Unit): Flow<ListSolNetworkInstancesResponse>

Paginate over ListSolNetworkInstancesResponse results.

listSolNetworkOperations

inline suspend fun TnbClient.listSolNetworkOperations(crossinline block: ListSolNetworkOperationsRequest.Builder.() -> Unit): ListSolNetworkOperationsResponse

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

listSolNetworkOperationsPaginated

fun TnbClient.listSolNetworkOperationsPaginated(initialRequest: ListSolNetworkOperationsRequest = ListSolNetworkOperationsRequest { }): Flow<ListSolNetworkOperationsResponse>

fun TnbClient.listSolNetworkOperationsPaginated(block: ListSolNetworkOperationsRequest.Builder.() -> Unit): Flow<ListSolNetworkOperationsResponse>

Paginate over ListSolNetworkOperationsResponse results.

listSolNetworkPackages

inline suspend fun TnbClient.listSolNetworkPackages(crossinline block: ListSolNetworkPackagesRequest.Builder.() -> Unit): ListSolNetworkPackagesResponse

Lists network packages.

listSolNetworkPackagesPaginated

fun TnbClient.listSolNetworkPackagesPaginated(initialRequest: ListSolNetworkPackagesRequest = ListSolNetworkPackagesRequest { }): Flow<ListSolNetworkPackagesResponse>

fun TnbClient.listSolNetworkPackagesPaginated(block: ListSolNetworkPackagesRequest.Builder.() -> Unit): Flow<ListSolNetworkPackagesResponse>

Paginate over ListSolNetworkPackagesResponse results.

listTagsForResource

inline suspend fun TnbClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

Lists tags for AWS TNB resources.

putSolFunctionPackageContent

inline suspend fun TnbClient.putSolFunctionPackageContent(crossinline block: PutSolFunctionPackageContentRequest.Builder.() -> Unit): PutSolFunctionPackageContentResponse

Uploads the contents of a function package.

putSolNetworkPackageContent

inline suspend fun TnbClient.putSolNetworkPackageContent(crossinline block: PutSolNetworkPackageContentRequest.Builder.() -> Unit): PutSolNetworkPackageContentResponse

Uploads the contents of a network package.

tagResource

inline suspend fun TnbClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Tags an AWS TNB resource.

terminateSolNetworkInstance

inline suspend fun TnbClient.terminateSolNetworkInstance(crossinline block: TerminateSolNetworkInstanceRequest.Builder.() -> Unit): TerminateSolNetworkInstanceResponse

Terminates a network instance.

untagResource

inline suspend fun TnbClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Untags an AWS TNB resource.

updateSolFunctionPackage

inline suspend fun TnbClient.updateSolFunctionPackage(crossinline block: UpdateSolFunctionPackageRequest.Builder.() -> Unit): UpdateSolFunctionPackageResponse

Updates the operational state of function package.

updateSolNetworkInstance

inline suspend fun TnbClient.updateSolNetworkInstance(crossinline block: UpdateSolNetworkInstanceRequest.Builder.() -> Unit): UpdateSolNetworkInstanceResponse

Update a network instance.

updateSolNetworkPackage

inline suspend fun TnbClient.updateSolNetworkPackage(crossinline block: UpdateSolNetworkPackageRequest.Builder.() -> Unit): UpdateSolNetworkPackageResponse

Updates the operational state of a network package.

validateSolFunctionPackageContent

inline suspend fun TnbClient.validateSolFunctionPackageContent(crossinline block: ValidateSolFunctionPackageContentRequest.Builder.() -> Unit): ValidateSolFunctionPackageContentResponse

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

validateSolNetworkPackageContent

inline suspend fun TnbClient.validateSolNetworkPackageContent(crossinline block: ValidateSolNetworkPackageContentRequest.Builder.() -> Unit): ValidateSolNetworkPackageContentResponse

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

withConfig

fun TnbClient.withConfig(block: TnbClient.Config.Builder.() -> Unit): TnbClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.