TelcoNetworkBuilderClient#
Index > TelcoNetworkBuilder > TelcoNetworkBuilderClient
Auto-generated documentation for TelcoNetworkBuilder type annotations stubs module mypy-boto3-tnb.
TelcoNetworkBuilderClient#
Type annotations and code completion for boto3.client("tnb")
.
boto3 documentation
# TelcoNetworkBuilderClient usage example
from boto3.session import Session
from mypy_boto3_tnb.client import TelcoNetworkBuilderClient
def get_tnb_client() -> TelcoNetworkBuilderClient:
return Session().client("tnb")
Exceptions#
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("tnb").exceptions
structure.
# Exceptions.exceptions usage example
client = boto3.client("tnb")
try:
do_something(client)
except (
client.exceptions.AccessDeniedException,
client.exceptions.ClientError,
client.exceptions.InternalServerException,
client.exceptions.ResourceNotFoundException,
client.exceptions.ServiceQuotaExceededException,
client.exceptions.ThrottlingException,
client.exceptions.ValidationException,
) as e:
print(e)
# Exceptions.exceptions type checking example
from mypy_boto3_tnb.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
...
Methods#
can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("tnb").can_paginate
method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...
cancel_sol_network_operation#
Cancels a network operation.
Type annotations and code completion for boto3.client("tnb").cancel_sol_network_operation
method.
boto3 documentation
# cancel_sol_network_operation method definition
def cancel_sol_network_operation(
self,
*,
nsLcmOpOccId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# cancel_sol_network_operation method usage example with argument unpacking
kwargs: CancelSolNetworkOperationInputRequestTypeDef = { # (1)
"nsLcmOpOccId": ...,
}
parent.cancel_sol_network_operation(**kwargs)
close#
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("tnb").close
method.
boto3 documentation
# close method definition
def close(
self,
) -> None:
...
create_sol_function_package#
Creates a function package.
Type annotations and code completion for boto3.client("tnb").create_sol_function_package
method.
boto3 documentation
# create_sol_function_package method definition
def create_sol_function_package(
self,
*,
tags: Mapping[str, str] = ...,
) -> CreateSolFunctionPackageOutputTypeDef: # (1)
...
# create_sol_function_package method usage example with argument unpacking
kwargs: CreateSolFunctionPackageInputRequestTypeDef = { # (1)
"tags": ...,
}
parent.create_sol_function_package(**kwargs)
create_sol_network_instance#
Creates a network instance.
Type annotations and code completion for boto3.client("tnb").create_sol_network_instance
method.
boto3 documentation
# create_sol_network_instance method definition
def create_sol_network_instance(
self,
*,
nsName: str,
nsdInfoId: str,
nsDescription: str = ...,
tags: Mapping[str, str] = ...,
) -> CreateSolNetworkInstanceOutputTypeDef: # (1)
...
# create_sol_network_instance method usage example with argument unpacking
kwargs: CreateSolNetworkInstanceInputRequestTypeDef = { # (1)
"nsName": ...,
"nsdInfoId": ...,
}
parent.create_sol_network_instance(**kwargs)
create_sol_network_package#
Creates a network package.
Type annotations and code completion for boto3.client("tnb").create_sol_network_package
method.
boto3 documentation
# create_sol_network_package method definition
def create_sol_network_package(
self,
*,
tags: Mapping[str, str] = ...,
) -> CreateSolNetworkPackageOutputTypeDef: # (1)
...
# create_sol_network_package method usage example with argument unpacking
kwargs: CreateSolNetworkPackageInputRequestTypeDef = { # (1)
"tags": ...,
}
parent.create_sol_network_package(**kwargs)
delete_sol_function_package#
Deletes a function package.
Type annotations and code completion for boto3.client("tnb").delete_sol_function_package
method.
boto3 documentation
# delete_sol_function_package method definition
def delete_sol_function_package(
self,
*,
vnfPkgId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_sol_function_package method usage example with argument unpacking
kwargs: DeleteSolFunctionPackageInputRequestTypeDef = { # (1)
"vnfPkgId": ...,
}
parent.delete_sol_function_package(**kwargs)
delete_sol_network_instance#
Deletes a network instance.
Type annotations and code completion for boto3.client("tnb").delete_sol_network_instance
method.
boto3 documentation
# delete_sol_network_instance method definition
def delete_sol_network_instance(
self,
*,
nsInstanceId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_sol_network_instance method usage example with argument unpacking
kwargs: DeleteSolNetworkInstanceInputRequestTypeDef = { # (1)
"nsInstanceId": ...,
}
parent.delete_sol_network_instance(**kwargs)
delete_sol_network_package#
Deletes network package.
Type annotations and code completion for boto3.client("tnb").delete_sol_network_package
method.
boto3 documentation
# delete_sol_network_package method definition
def delete_sol_network_package(
self,
*,
nsdInfoId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_sol_network_package method usage example with argument unpacking
kwargs: DeleteSolNetworkPackageInputRequestTypeDef = { # (1)
"nsdInfoId": ...,
}
parent.delete_sol_network_package(**kwargs)
generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("tnb").generate_presigned_url
method.
boto3 documentation
# generate_presigned_url method definition
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
get_sol_function_instance#
Gets the details of a network function instance, including the instantiation state and metadata from the function package descriptor in the network function package.
Type annotations and code completion for boto3.client("tnb").get_sol_function_instance
method.
boto3 documentation
# get_sol_function_instance method definition
def get_sol_function_instance(
self,
*,
vnfInstanceId: str,
) -> GetSolFunctionInstanceOutputTypeDef: # (1)
...
# get_sol_function_instance method usage example with argument unpacking
kwargs: GetSolFunctionInstanceInputRequestTypeDef = { # (1)
"vnfInstanceId": ...,
}
parent.get_sol_function_instance(**kwargs)
get_sol_function_package#
Gets the details of an individual function package, such as the operational state and whether the package is in use.
Type annotations and code completion for boto3.client("tnb").get_sol_function_package
method.
boto3 documentation
# get_sol_function_package method definition
def get_sol_function_package(
self,
*,
vnfPkgId: str,
) -> GetSolFunctionPackageOutputTypeDef: # (1)
...
# get_sol_function_package method usage example with argument unpacking
kwargs: GetSolFunctionPackageInputRequestTypeDef = { # (1)
"vnfPkgId": ...,
}
parent.get_sol_function_package(**kwargs)
get_sol_function_package_content#
Gets the contents of a function package.
Type annotations and code completion for boto3.client("tnb").get_sol_function_package_content
method.
boto3 documentation
# get_sol_function_package_content method definition
def get_sol_function_package_content(
self,
*,
accept: PackageContentTypeType, # (1)
vnfPkgId: str,
) -> GetSolFunctionPackageContentOutputTypeDef: # (2)
...
# get_sol_function_package_content method usage example with argument unpacking
kwargs: GetSolFunctionPackageContentInputRequestTypeDef = { # (1)
"accept": ...,
"vnfPkgId": ...,
}
parent.get_sol_function_package_content(**kwargs)
get_sol_function_package_descriptor#
Gets a function package descriptor in a function package.
Type annotations and code completion for boto3.client("tnb").get_sol_function_package_descriptor
method.
boto3 documentation
# get_sol_function_package_descriptor method definition
def get_sol_function_package_descriptor(
self,
*,
accept: DescriptorContentTypeType, # (1)
vnfPkgId: str,
) -> GetSolFunctionPackageDescriptorOutputTypeDef: # (2)
...
# get_sol_function_package_descriptor method usage example with argument unpacking
kwargs: GetSolFunctionPackageDescriptorInputRequestTypeDef = { # (1)
"accept": ...,
"vnfPkgId": ...,
}
parent.get_sol_function_package_descriptor(**kwargs)
get_sol_network_instance#
Gets the details of the network instance.
Type annotations and code completion for boto3.client("tnb").get_sol_network_instance
method.
boto3 documentation
# get_sol_network_instance method definition
def get_sol_network_instance(
self,
*,
nsInstanceId: str,
) -> GetSolNetworkInstanceOutputTypeDef: # (1)
...
# get_sol_network_instance method usage example with argument unpacking
kwargs: GetSolNetworkInstanceInputRequestTypeDef = { # (1)
"nsInstanceId": ...,
}
parent.get_sol_network_instance(**kwargs)
get_sol_network_operation#
Gets the details of a network operation, including the tasks involved in the network operation and the status of the tasks.
Type annotations and code completion for boto3.client("tnb").get_sol_network_operation
method.
boto3 documentation
# get_sol_network_operation method definition
def get_sol_network_operation(
self,
*,
nsLcmOpOccId: str,
) -> GetSolNetworkOperationOutputTypeDef: # (1)
...
# get_sol_network_operation method usage example with argument unpacking
kwargs: GetSolNetworkOperationInputRequestTypeDef = { # (1)
"nsLcmOpOccId": ...,
}
parent.get_sol_network_operation(**kwargs)
get_sol_network_package#
Gets the details of a network package.
Type annotations and code completion for boto3.client("tnb").get_sol_network_package
method.
boto3 documentation
# get_sol_network_package method definition
def get_sol_network_package(
self,
*,
nsdInfoId: str,
) -> GetSolNetworkPackageOutputTypeDef: # (1)
...
# get_sol_network_package method usage example with argument unpacking
kwargs: GetSolNetworkPackageInputRequestTypeDef = { # (1)
"nsdInfoId": ...,
}
parent.get_sol_network_package(**kwargs)
get_sol_network_package_content#
Gets the contents of a network package.
Type annotations and code completion for boto3.client("tnb").get_sol_network_package_content
method.
boto3 documentation
# get_sol_network_package_content method definition
def get_sol_network_package_content(
self,
*,
accept: PackageContentTypeType, # (1)
nsdInfoId: str,
) -> GetSolNetworkPackageContentOutputTypeDef: # (2)
...
# get_sol_network_package_content method usage example with argument unpacking
kwargs: GetSolNetworkPackageContentInputRequestTypeDef = { # (1)
"accept": ...,
"nsdInfoId": ...,
}
parent.get_sol_network_package_content(**kwargs)
get_sol_network_package_descriptor#
Gets the content of the network service descriptor.
Type annotations and code completion for boto3.client("tnb").get_sol_network_package_descriptor
method.
boto3 documentation
# get_sol_network_package_descriptor method definition
def get_sol_network_package_descriptor(
self,
*,
nsdInfoId: str,
) -> GetSolNetworkPackageDescriptorOutputTypeDef: # (1)
...
# get_sol_network_package_descriptor method usage example with argument unpacking
kwargs: GetSolNetworkPackageDescriptorInputRequestTypeDef = { # (1)
"nsdInfoId": ...,
}
parent.get_sol_network_package_descriptor(**kwargs)
instantiate_sol_network_instance#
Instantiates a network instance.
Type annotations and code completion for boto3.client("tnb").instantiate_sol_network_instance
method.
boto3 documentation
# instantiate_sol_network_instance method definition
def instantiate_sol_network_instance(
self,
*,
nsInstanceId: str,
additionalParamsForNs: Mapping[str, Any] = ...,
dryRun: bool = ...,
tags: Mapping[str, str] = ...,
) -> InstantiateSolNetworkInstanceOutputTypeDef: # (1)
...
# instantiate_sol_network_instance method usage example with argument unpacking
kwargs: InstantiateSolNetworkInstanceInputRequestTypeDef = { # (1)
"nsInstanceId": ...,
}
parent.instantiate_sol_network_instance(**kwargs)
list_sol_function_instances#
Lists network function instances.
Type annotations and code completion for boto3.client("tnb").list_sol_function_instances
method.
boto3 documentation
# list_sol_function_instances method definition
def list_sol_function_instances(
self,
*,
maxResults: int = ...,
nextToken: str = ...,
) -> ListSolFunctionInstancesOutputTypeDef: # (1)
...
# list_sol_function_instances method usage example with argument unpacking
kwargs: ListSolFunctionInstancesInputRequestTypeDef = { # (1)
"maxResults": ...,
}
parent.list_sol_function_instances(**kwargs)
list_sol_function_packages#
Lists information about function packages.
Type annotations and code completion for boto3.client("tnb").list_sol_function_packages
method.
boto3 documentation
# list_sol_function_packages method definition
def list_sol_function_packages(
self,
*,
maxResults: int = ...,
nextToken: str = ...,
) -> ListSolFunctionPackagesOutputTypeDef: # (1)
...
# list_sol_function_packages method usage example with argument unpacking
kwargs: ListSolFunctionPackagesInputRequestTypeDef = { # (1)
"maxResults": ...,
}
parent.list_sol_function_packages(**kwargs)
list_sol_network_instances#
Lists your network instances.
Type annotations and code completion for boto3.client("tnb").list_sol_network_instances
method.
boto3 documentation
# list_sol_network_instances method definition
def list_sol_network_instances(
self,
*,
maxResults: int = ...,
nextToken: str = ...,
) -> ListSolNetworkInstancesOutputTypeDef: # (1)
...
# list_sol_network_instances method usage example with argument unpacking
kwargs: ListSolNetworkInstancesInputRequestTypeDef = { # (1)
"maxResults": ...,
}
parent.list_sol_network_instances(**kwargs)
list_sol_network_operations#
Lists details for a network operation, including when the operation started and the status of the operation.
Type annotations and code completion for boto3.client("tnb").list_sol_network_operations
method.
boto3 documentation
# list_sol_network_operations method definition
def list_sol_network_operations(
self,
*,
maxResults: int = ...,
nextToken: str = ...,
nsInstanceId: str = ...,
) -> ListSolNetworkOperationsOutputTypeDef: # (1)
...
# list_sol_network_operations method usage example with argument unpacking
kwargs: ListSolNetworkOperationsInputRequestTypeDef = { # (1)
"maxResults": ...,
}
parent.list_sol_network_operations(**kwargs)
list_sol_network_packages#
Lists network packages.
Type annotations and code completion for boto3.client("tnb").list_sol_network_packages
method.
boto3 documentation
# list_sol_network_packages method definition
def list_sol_network_packages(
self,
*,
maxResults: int = ...,
nextToken: str = ...,
) -> ListSolNetworkPackagesOutputTypeDef: # (1)
...
# list_sol_network_packages method usage example with argument unpacking
kwargs: ListSolNetworkPackagesInputRequestTypeDef = { # (1)
"maxResults": ...,
}
parent.list_sol_network_packages(**kwargs)
list_tags_for_resource#
Lists tags for AWS TNB resources.
Type annotations and code completion for boto3.client("tnb").list_tags_for_resource
method.
boto3 documentation
# list_tags_for_resource method definition
def list_tags_for_resource(
self,
*,
resourceArn: str,
) -> ListTagsForResourceOutputTypeDef: # (1)
...
# list_tags_for_resource method usage example with argument unpacking
kwargs: ListTagsForResourceInputRequestTypeDef = { # (1)
"resourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
put_sol_function_package_content#
Uploads the contents of a function package.
Type annotations and code completion for boto3.client("tnb").put_sol_function_package_content
method.
boto3 documentation
# put_sol_function_package_content method definition
def put_sol_function_package_content(
self,
*,
file: BlobTypeDef,
vnfPkgId: str,
contentType: PackageContentTypeType = ..., # (1)
) -> PutSolFunctionPackageContentOutputTypeDef: # (2)
...
# put_sol_function_package_content method usage example with argument unpacking
kwargs: PutSolFunctionPackageContentInputRequestTypeDef = { # (1)
"file": ...,
"vnfPkgId": ...,
}
parent.put_sol_function_package_content(**kwargs)
put_sol_network_package_content#
Uploads the contents of a network package.
Type annotations and code completion for boto3.client("tnb").put_sol_network_package_content
method.
boto3 documentation
# put_sol_network_package_content method definition
def put_sol_network_package_content(
self,
*,
file: BlobTypeDef,
nsdInfoId: str,
contentType: PackageContentTypeType = ..., # (1)
) -> PutSolNetworkPackageContentOutputTypeDef: # (2)
...
# put_sol_network_package_content method usage example with argument unpacking
kwargs: PutSolNetworkPackageContentInputRequestTypeDef = { # (1)
"file": ...,
"nsdInfoId": ...,
}
parent.put_sol_network_package_content(**kwargs)
tag_resource#
Tags an AWS TNB resource.
Type annotations and code completion for boto3.client("tnb").tag_resource
method.
boto3 documentation
# tag_resource method definition
def tag_resource(
self,
*,
resourceArn: str,
tags: Mapping[str, str],
) -> Dict[str, Any]:
...
# tag_resource method usage example with argument unpacking
kwargs: TagResourceInputRequestTypeDef = { # (1)
"resourceArn": ...,
"tags": ...,
}
parent.tag_resource(**kwargs)
terminate_sol_network_instance#
Terminates a network instance.
Type annotations and code completion for boto3.client("tnb").terminate_sol_network_instance
method.
boto3 documentation
# terminate_sol_network_instance method definition
def terminate_sol_network_instance(
self,
*,
nsInstanceId: str,
tags: Mapping[str, str] = ...,
) -> TerminateSolNetworkInstanceOutputTypeDef: # (1)
...
# terminate_sol_network_instance method usage example with argument unpacking
kwargs: TerminateSolNetworkInstanceInputRequestTypeDef = { # (1)
"nsInstanceId": ...,
}
parent.terminate_sol_network_instance(**kwargs)
untag_resource#
Untags an AWS TNB resource.
Type annotations and code completion for boto3.client("tnb").untag_resource
method.
boto3 documentation
# untag_resource method definition
def untag_resource(
self,
*,
resourceArn: str,
tagKeys: Sequence[str],
) -> Dict[str, Any]:
...
# untag_resource method usage example with argument unpacking
kwargs: UntagResourceInputRequestTypeDef = { # (1)
"resourceArn": ...,
"tagKeys": ...,
}
parent.untag_resource(**kwargs)
update_sol_function_package#
Updates the operational state of function package.
Type annotations and code completion for boto3.client("tnb").update_sol_function_package
method.
boto3 documentation
# update_sol_function_package method definition
def update_sol_function_package(
self,
*,
operationalState: OperationalStateType, # (1)
vnfPkgId: str,
) -> UpdateSolFunctionPackageOutputTypeDef: # (2)
...
# update_sol_function_package method usage example with argument unpacking
kwargs: UpdateSolFunctionPackageInputRequestTypeDef = { # (1)
"operationalState": ...,
"vnfPkgId": ...,
}
parent.update_sol_function_package(**kwargs)
update_sol_network_instance#
Update a network instance.
Type annotations and code completion for boto3.client("tnb").update_sol_network_instance
method.
boto3 documentation
# update_sol_network_instance method definition
def update_sol_network_instance(
self,
*,
nsInstanceId: str,
updateType: UpdateSolNetworkTypeType, # (1)
modifyVnfInfoData: UpdateSolNetworkModifyTypeDef = ..., # (2)
tags: Mapping[str, str] = ...,
updateNs: UpdateSolNetworkServiceDataTypeDef = ..., # (3)
) -> UpdateSolNetworkInstanceOutputTypeDef: # (4)
...
- See UpdateSolNetworkTypeType
- See UpdateSolNetworkModifyTypeDef
- See UpdateSolNetworkServiceDataTypeDef
- See UpdateSolNetworkInstanceOutputTypeDef
# update_sol_network_instance method usage example with argument unpacking
kwargs: UpdateSolNetworkInstanceInputRequestTypeDef = { # (1)
"nsInstanceId": ...,
"updateType": ...,
}
parent.update_sol_network_instance(**kwargs)
update_sol_network_package#
Updates the operational state of a network package.
Type annotations and code completion for boto3.client("tnb").update_sol_network_package
method.
boto3 documentation
# update_sol_network_package method definition
def update_sol_network_package(
self,
*,
nsdInfoId: str,
nsdOperationalState: NsdOperationalStateType, # (1)
) -> UpdateSolNetworkPackageOutputTypeDef: # (2)
...
# update_sol_network_package method usage example with argument unpacking
kwargs: UpdateSolNetworkPackageInputRequestTypeDef = { # (1)
"nsdInfoId": ...,
"nsdOperationalState": ...,
}
parent.update_sol_network_package(**kwargs)
validate_sol_function_package_content#
Validates function package content.
Type annotations and code completion for boto3.client("tnb").validate_sol_function_package_content
method.
boto3 documentation
# validate_sol_function_package_content method definition
def validate_sol_function_package_content(
self,
*,
file: BlobTypeDef,
vnfPkgId: str,
contentType: PackageContentTypeType = ..., # (1)
) -> ValidateSolFunctionPackageContentOutputTypeDef: # (2)
...
# validate_sol_function_package_content method usage example with argument unpacking
kwargs: ValidateSolFunctionPackageContentInputRequestTypeDef = { # (1)
"file": ...,
"vnfPkgId": ...,
}
parent.validate_sol_function_package_content(**kwargs)
validate_sol_network_package_content#
Validates network package content.
Type annotations and code completion for boto3.client("tnb").validate_sol_network_package_content
method.
boto3 documentation
# validate_sol_network_package_content method definition
def validate_sol_network_package_content(
self,
*,
file: BlobTypeDef,
nsdInfoId: str,
contentType: PackageContentTypeType = ..., # (1)
) -> ValidateSolNetworkPackageContentOutputTypeDef: # (2)
...
# validate_sol_network_package_content method usage example with argument unpacking
kwargs: ValidateSolNetworkPackageContentInputRequestTypeDef = { # (1)
"file": ...,
"nsdInfoId": ...,
}
parent.validate_sol_network_package_content(**kwargs)
get_paginator#
Type annotations and code completion for boto3.client("tnb").get_paginator
method with overloads.
client.get_paginator("list_sol_function_instances")
-> ListSolFunctionInstancesPaginatorclient.get_paginator("list_sol_function_packages")
-> ListSolFunctionPackagesPaginatorclient.get_paginator("list_sol_network_instances")
-> ListSolNetworkInstancesPaginatorclient.get_paginator("list_sol_network_operations")
-> ListSolNetworkOperationsPaginatorclient.get_paginator("list_sol_network_packages")
-> ListSolNetworkPackagesPaginator