Struct aws_sdk_tnb::client::Client
source · pub struct Client { /* private fields */ }
Expand description
Client for AWS Telco Network Builder
Client for invoking operations on AWS Telco Network Builder. Each operation on AWS Telco Network Builder is a method on this
this struct. .send()
MUST be invoked on the generated operations to dispatch the request to the service.
§Constructing a Client
A Config
is required to construct a client. For most use cases, the aws-config
crate should be used to automatically resolve this config using
aws_config::load_from_env()
, since this will resolve an SdkConfig
which can be shared
across multiple different AWS SDK clients. This config resolution process can be customized
by calling aws_config::from_env()
instead, which returns a ConfigLoader
that uses
the builder pattern to customize the default config.
In the simplest case, creating a client looks as follows:
let config = aws_config::load_from_env().await;
let client = aws_sdk_tnb::Client::new(&config);
Occasionally, SDKs may have additional service-specific values that can be set on the Config
that
is absent from SdkConfig
, or slightly different settings for a specific client may be desired.
The Config
struct implements From<&SdkConfig>
, so setting these specific settings can be
done as follows:
let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_tnb::config::Builder::from(&sdk_config)
.some_service_specific_setting("value")
.build();
See the aws-config
docs and Config
for more information on customizing configuration.
Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.
§Using the Client
A client has a function for every operation that can be performed by the service.
For example, the CancelSolNetworkOperation
operation has
a Client::cancel_sol_network_operation
, function which returns a builder for that operation.
The fluent builder ultimately has a send()
function that returns an async future that
returns a result, as illustrated below:
let result = client.cancel_sol_network_operation()
.ns_lcm_op_occ_id("example")
.send()
.await;
The underlying HTTP requests that get made by this can be modified with the customize_operation
function on the fluent builder. See the customize
module for more
information.
Implementations§
source§impl Client
impl Client
sourcepub fn cancel_sol_network_operation(
&self
) -> CancelSolNetworkOperationFluentBuilder
pub fn cancel_sol_network_operation( &self ) -> CancelSolNetworkOperationFluentBuilder
Constructs a fluent builder for the CancelSolNetworkOperation
operation.
- The fluent builder is configurable:
ns_lcm_op_occ_id(impl Into<String>)
/set_ns_lcm_op_occ_id(Option<String>)
:
required: trueThe identifier of the network operation.
- On success, responds with
CancelSolNetworkOperationOutput
- On failure, responds with
SdkError<CancelSolNetworkOperationError>
source§impl Client
impl Client
sourcepub fn create_sol_function_package(
&self
) -> CreateSolFunctionPackageFluentBuilder
pub fn create_sol_function_package( &self ) -> CreateSolFunctionPackageFluentBuilder
Constructs a fluent builder for the CreateSolFunctionPackage
operation.
- The fluent builder is configurable:
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseA 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.
- On success, responds with
CreateSolFunctionPackageOutput
with field(s):id(String)
:ID of the function package.
arn(String)
:Function package ARN.
onboarding_state(OnboardingState)
:Onboarding state of the function package.
operational_state(OperationalState)
:Operational state of the function package.
usage_state(UsageState)
:Usage state of the function package.
tags(Option<HashMap::<String, String>>)
: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.
- On failure, responds with
SdkError<CreateSolFunctionPackageError>
source§impl Client
impl Client
sourcepub fn create_sol_network_instance(
&self
) -> CreateSolNetworkInstanceFluentBuilder
pub fn create_sol_network_instance( &self ) -> CreateSolNetworkInstanceFluentBuilder
Constructs a fluent builder for the CreateSolNetworkInstance
operation.
- The fluent builder is configurable:
nsd_info_id(impl Into<String>)
/set_nsd_info_id(Option<String>)
:
required: trueID for network service descriptor.
ns_name(impl Into<String>)
/set_ns_name(Option<String>)
:
required: trueNetwork instance name.
ns_description(impl Into<String>)
/set_ns_description(Option<String>)
:
required: falseNetwork instance description.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseA 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.
- On success, responds with
CreateSolNetworkInstanceOutput
with field(s):id(String)
:Network instance ID.
arn(String)
:Network instance ARN.
nsd_info_id(String)
:Network service descriptor ID.
ns_instance_name(String)
:Network instance name.
tags(Option<HashMap::<String, String>>)
: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.
- On failure, responds with
SdkError<CreateSolNetworkInstanceError>
source§impl Client
impl Client
sourcepub fn create_sol_network_package(&self) -> CreateSolNetworkPackageFluentBuilder
pub fn create_sol_network_package(&self) -> CreateSolNetworkPackageFluentBuilder
Constructs a fluent builder for the CreateSolNetworkPackage
operation.
- The fluent builder is configurable:
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseA 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.
- On success, responds with
CreateSolNetworkPackageOutput
with field(s):id(String)
:ID of the network package.
arn(String)
:Network package ARN.
nsd_onboarding_state(NsdOnboardingState)
:Onboarding state of the network service descriptor in the network package.
nsd_operational_state(NsdOperationalState)
:Operational state of the network service descriptor in the network package.
nsd_usage_state(NsdUsageState)
:Usage state of the network service descriptor in the network package.
tags(Option<HashMap::<String, String>>)
: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.
- On failure, responds with
SdkError<CreateSolNetworkPackageError>
source§impl Client
impl Client
sourcepub fn delete_sol_function_package(
&self
) -> DeleteSolFunctionPackageFluentBuilder
pub fn delete_sol_function_package( &self ) -> DeleteSolFunctionPackageFluentBuilder
Constructs a fluent builder for the DeleteSolFunctionPackage
operation.
- The fluent builder is configurable:
vnf_pkg_id(impl Into<String>)
/set_vnf_pkg_id(Option<String>)
:
required: trueID of the function package.
- On success, responds with
DeleteSolFunctionPackageOutput
- On failure, responds with
SdkError<DeleteSolFunctionPackageError>
source§impl Client
impl Client
sourcepub fn delete_sol_network_instance(
&self
) -> DeleteSolNetworkInstanceFluentBuilder
pub fn delete_sol_network_instance( &self ) -> DeleteSolNetworkInstanceFluentBuilder
Constructs a fluent builder for the DeleteSolNetworkInstance
operation.
- The fluent builder is configurable:
ns_instance_id(impl Into<String>)
/set_ns_instance_id(Option<String>)
:
required: trueNetwork instance ID.
- On success, responds with
DeleteSolNetworkInstanceOutput
- On failure, responds with
SdkError<DeleteSolNetworkInstanceError>
source§impl Client
impl Client
sourcepub fn delete_sol_network_package(&self) -> DeleteSolNetworkPackageFluentBuilder
pub fn delete_sol_network_package(&self) -> DeleteSolNetworkPackageFluentBuilder
Constructs a fluent builder for the DeleteSolNetworkPackage
operation.
- The fluent builder is configurable:
nsd_info_id(impl Into<String>)
/set_nsd_info_id(Option<String>)
:
required: trueID of the network service descriptor in the network package.
- On success, responds with
DeleteSolNetworkPackageOutput
- On failure, responds with
SdkError<DeleteSolNetworkPackageError>
source§impl Client
impl Client
sourcepub fn get_sol_function_instance(&self) -> GetSolFunctionInstanceFluentBuilder
pub fn get_sol_function_instance(&self) -> GetSolFunctionInstanceFluentBuilder
Constructs a fluent builder for the GetSolFunctionInstance
operation.
- The fluent builder is configurable:
vnf_instance_id(impl Into<String>)
/set_vnf_instance_id(Option<String>)
:
required: trueID of the network function.
- On success, responds with
GetSolFunctionInstanceOutput
with field(s):id(String)
:Network function instance ID.
arn(String)
:Network function instance ARN.
ns_instance_id(String)
:Network instance ID.
vnf_pkg_id(String)
:Function package ID.
vnfd_id(String)
:Function package descriptor ID.
vnf_provider(Option<String>)
:Network function provider.
vnf_product_name(Option<String>)
:Network function product name.
vnfd_version(Option<String>)
:Function package descriptor version.
instantiation_state(VnfInstantiationState)
:Network function instantiation state.
instantiated_vnf_info(Option<GetSolVnfInfo>)
:Information about the network function.
A network function instance is a function in a function package .
metadata(Option<GetSolFunctionInstanceMetadata>)
:The metadata of a network function instance.
A network function instance is a function in a function package .
tags(Option<HashMap::<String, String>>)
: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.
- On failure, responds with
SdkError<GetSolFunctionInstanceError>
source§impl Client
impl Client
sourcepub fn get_sol_function_package(&self) -> GetSolFunctionPackageFluentBuilder
pub fn get_sol_function_package(&self) -> GetSolFunctionPackageFluentBuilder
Constructs a fluent builder for the GetSolFunctionPackage
operation.
- The fluent builder is configurable:
vnf_pkg_id(impl Into<String>)
/set_vnf_pkg_id(Option<String>)
:
required: trueID of the function package.
- On success, responds with
GetSolFunctionPackageOutput
with field(s):id(String)
:Function package ID.
arn(String)
:Function package ARN.
onboarding_state(OnboardingState)
:Function package onboarding state.
operational_state(OperationalState)
:Function package operational state.
usage_state(UsageState)
:Function package usage state.
vnfd_id(Option<String>)
:Function package descriptor ID.
vnf_provider(Option<String>)
:Network function provider.
vnf_product_name(Option<String>)
:Network function product name.
vnfd_version(Option<String>)
:Function package descriptor version.
metadata(Option<GetSolFunctionPackageMetadata>)
: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.
tags(Option<HashMap::<String, String>>)
: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.
- On failure, responds with
SdkError<GetSolFunctionPackageError>
source§impl Client
impl Client
sourcepub fn get_sol_function_package_content(
&self
) -> GetSolFunctionPackageContentFluentBuilder
pub fn get_sol_function_package_content( &self ) -> GetSolFunctionPackageContentFluentBuilder
Constructs a fluent builder for the GetSolFunctionPackageContent
operation.
- The fluent builder is configurable:
vnf_pkg_id(impl Into<String>)
/set_vnf_pkg_id(Option<String>)
:
required: trueID of the function package.
accept(PackageContentType)
/set_accept(Option<PackageContentType>)
:
required: trueThe format of the package that you want to download from the function packages.
- On success, responds with
GetSolFunctionPackageContentOutput
with field(s):content_type(Option<PackageContentType>)
:Indicates the media type of the resource.
package_content(Option<Blob>)
:Contents of the function package.
- On failure, responds with
SdkError<GetSolFunctionPackageContentError>
source§impl Client
impl Client
sourcepub fn get_sol_function_package_descriptor(
&self
) -> GetSolFunctionPackageDescriptorFluentBuilder
pub fn get_sol_function_package_descriptor( &self ) -> GetSolFunctionPackageDescriptorFluentBuilder
Constructs a fluent builder for the GetSolFunctionPackageDescriptor
operation.
- The fluent builder is configurable:
vnf_pkg_id(impl Into<String>)
/set_vnf_pkg_id(Option<String>)
:
required: trueID of the function package.
accept(DescriptorContentType)
/set_accept(Option<DescriptorContentType>)
:
required: trueIndicates which content types, expressed as MIME types, the client is able to understand.
- On success, responds with
GetSolFunctionPackageDescriptorOutput
with field(s):content_type(Option<DescriptorContentType>)
:Indicates the media type of the resource.
vnfd(Option<Blob>)
:Contents of the function package descriptor.
- On failure, responds with
SdkError<GetSolFunctionPackageDescriptorError>
source§impl Client
impl Client
sourcepub fn get_sol_network_instance(&self) -> GetSolNetworkInstanceFluentBuilder
pub fn get_sol_network_instance(&self) -> GetSolNetworkInstanceFluentBuilder
Constructs a fluent builder for the GetSolNetworkInstance
operation.
- The fluent builder is configurable:
ns_instance_id(impl Into<String>)
/set_ns_instance_id(Option<String>)
:
required: trueID of the network instance.
- On success, responds with
GetSolNetworkInstanceOutput
with field(s):id(String)
:Network instance ID.
arn(String)
:Network instance ARN.
ns_instance_name(String)
:Network instance name.
ns_instance_description(String)
:Network instance description.
nsd_id(String)
:Network service descriptor ID.
nsd_info_id(String)
:Network service descriptor info ID.
ns_state(Option<NsState>)
:Network instance state.
lcm_op_info(Option<LcmOperationInfo>)
:Lifecycle management operation details on the network instance.
Lifecycle management operations are deploy, update, or delete operations.
metadata(Option<GetSolNetworkInstanceMetadata>)
: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.
tags(Option<HashMap::<String, String>>)
: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.
- On failure, responds with
SdkError<GetSolNetworkInstanceError>
source§impl Client
impl Client
sourcepub fn get_sol_network_operation(&self) -> GetSolNetworkOperationFluentBuilder
pub fn get_sol_network_operation(&self) -> GetSolNetworkOperationFluentBuilder
Constructs a fluent builder for the GetSolNetworkOperation
operation.
- The fluent builder is configurable:
ns_lcm_op_occ_id(impl Into<String>)
/set_ns_lcm_op_occ_id(Option<String>)
:
required: trueThe identifier of the network operation.
- On success, responds with
GetSolNetworkOperationOutput
with field(s):id(Option<String>)
:ID of this network operation occurrence.
arn(String)
:Network operation ARN.
operation_state(Option<NsLcmOperationState>)
:The state of the network operation.
ns_instance_id(Option<String>)
:ID of the network operation instance.
lcm_operation_type(Option<LcmOperationType>)
:Type of the operation represented by this occurrence.
error(Option<ProblemDetails>)
:Error related to this specific network operation occurrence.
metadata(Option<GetSolNetworkOperationMetadata>)
:Metadata of this network operation occurrence.
tasks(Option<Vec::<GetSolNetworkOperationTaskDetails>>)
:All tasks associated with this operation occurrence.
tags(Option<HashMap::<String, String>>)
: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.
- On failure, responds with
SdkError<GetSolNetworkOperationError>
source§impl Client
impl Client
sourcepub fn get_sol_network_package(&self) -> GetSolNetworkPackageFluentBuilder
pub fn get_sol_network_package(&self) -> GetSolNetworkPackageFluentBuilder
Constructs a fluent builder for the GetSolNetworkPackage
operation.
- The fluent builder is configurable:
nsd_info_id(impl Into<String>)
/set_nsd_info_id(Option<String>)
:
required: trueID of the network service descriptor in the network package.
- On success, responds with
GetSolNetworkPackageOutput
with field(s):id(String)
:Network package ID.
arn(String)
:Network package ARN.
nsd_onboarding_state(NsdOnboardingState)
:Network service descriptor onboarding state.
nsd_operational_state(NsdOperationalState)
:Network service descriptor operational state.
nsd_usage_state(NsdUsageState)
:Network service descriptor usage state.
nsd_id(String)
:Network service descriptor ID.
nsd_name(String)
:Network service descriptor name.
nsd_version(String)
:Network service descriptor version.
vnf_pkg_ids(Vec::<String>)
:Identifies the function package for the function package descriptor referenced by the onboarded network package.
metadata(Option<GetSolNetworkPackageMetadata>)
: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.
tags(Option<HashMap::<String, String>>)
: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.
- On failure, responds with
SdkError<GetSolNetworkPackageError>
source§impl Client
impl Client
sourcepub fn get_sol_network_package_content(
&self
) -> GetSolNetworkPackageContentFluentBuilder
pub fn get_sol_network_package_content( &self ) -> GetSolNetworkPackageContentFluentBuilder
Constructs a fluent builder for the GetSolNetworkPackageContent
operation.
- The fluent builder is configurable:
nsd_info_id(impl Into<String>)
/set_nsd_info_id(Option<String>)
:
required: trueID of the network service descriptor in the network package.
accept(PackageContentType)
/set_accept(Option<PackageContentType>)
:
required: trueThe format of the package you want to download from the network package.
- On success, responds with
GetSolNetworkPackageContentOutput
with field(s):content_type(Option<PackageContentType>)
:Indicates the media type of the resource.
nsd_content(Option<Blob>)
:Content of the network service descriptor in the network package.
- On failure, responds with
SdkError<GetSolNetworkPackageContentError>
source§impl Client
impl Client
sourcepub fn get_sol_network_package_descriptor(
&self
) -> GetSolNetworkPackageDescriptorFluentBuilder
pub fn get_sol_network_package_descriptor( &self ) -> GetSolNetworkPackageDescriptorFluentBuilder
Constructs a fluent builder for the GetSolNetworkPackageDescriptor
operation.
- The fluent builder is configurable:
nsd_info_id(impl Into<String>)
/set_nsd_info_id(Option<String>)
:
required: trueID of the network service descriptor in the network package.
- On success, responds with
GetSolNetworkPackageDescriptorOutput
with field(s):content_type(Option<DescriptorContentType>)
:Indicates the media type of the resource.
nsd(Option<Blob>)
:Contents of the network service descriptor in the network package.
- On failure, responds with
SdkError<GetSolNetworkPackageDescriptorError>
source§impl Client
impl Client
sourcepub fn instantiate_sol_network_instance(
&self
) -> InstantiateSolNetworkInstanceFluentBuilder
pub fn instantiate_sol_network_instance( &self ) -> InstantiateSolNetworkInstanceFluentBuilder
Constructs a fluent builder for the InstantiateSolNetworkInstance
operation.
- The fluent builder is configurable:
ns_instance_id(impl Into<String>)
/set_ns_instance_id(Option<String>)
:
required: trueID of the network instance.
dry_run(bool)
/set_dry_run(Option<bool>)
:
required: falseA 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 isUnauthorizedOperation
.additional_params_for_ns(Document)
/set_additional_params_for_ns(Option<Document>)
:
required: falseProvides values for the configurable properties.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseA 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 transferred to the network operation that is created. Use tags to search and filter your resources or track your Amazon Web Services costs.
- On success, responds with
InstantiateSolNetworkInstanceOutput
with field(s):ns_lcm_op_occ_id(String)
:The identifier of the network operation.
tags(Option<HashMap::<String, String>>)
: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 transferred to the network operation that is created. Use tags to search and filter your resources or track your Amazon Web Services costs.
- On failure, responds with
SdkError<InstantiateSolNetworkInstanceError>
source§impl Client
impl Client
sourcepub fn list_sol_function_instances(
&self
) -> ListSolFunctionInstancesFluentBuilder
pub fn list_sol_function_instances( &self ) -> ListSolFunctionInstancesFluentBuilder
Constructs a fluent builder for the ListSolFunctionInstances
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to include in the response.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe token for the next page of results.
- On success, responds with
ListSolFunctionInstancesOutput
with field(s):next_token(Option<String>)
:The token to use to retrieve the next page of results. This value is
null
when there are no more results to return.function_instances(Option<Vec::<ListSolFunctionInstanceInfo>>)
:Network function instances.
- On failure, responds with
SdkError<ListSolFunctionInstancesError>
source§impl Client
impl Client
sourcepub fn list_sol_function_packages(&self) -> ListSolFunctionPackagesFluentBuilder
pub fn list_sol_function_packages(&self) -> ListSolFunctionPackagesFluentBuilder
Constructs a fluent builder for the ListSolFunctionPackages
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to include in the response.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe token for the next page of results.
- On success, responds with
ListSolFunctionPackagesOutput
with field(s):next_token(Option<String>)
:The token to use to retrieve the next page of results. This value is
null
when there are no more results to return.function_packages(Vec::<ListSolFunctionPackageInfo>)
: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.
- On failure, responds with
SdkError<ListSolFunctionPackagesError>
source§impl Client
impl Client
sourcepub fn list_sol_network_instances(&self) -> ListSolNetworkInstancesFluentBuilder
pub fn list_sol_network_instances(&self) -> ListSolNetworkInstancesFluentBuilder
Constructs a fluent builder for the ListSolNetworkInstances
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to include in the response.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe token for the next page of results.
- On success, responds with
ListSolNetworkInstancesOutput
with field(s):next_token(Option<String>)
:The token to use to retrieve the next page of results. This value is
null
when there are no more results to return.network_instances(Option<Vec::<ListSolNetworkInstanceInfo>>)
:Lists network instances.
- On failure, responds with
SdkError<ListSolNetworkInstancesError>
source§impl Client
impl Client
sourcepub fn list_sol_network_operations(
&self
) -> ListSolNetworkOperationsFluentBuilder
pub fn list_sol_network_operations( &self ) -> ListSolNetworkOperationsFluentBuilder
Constructs a fluent builder for the ListSolNetworkOperations
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to include in the response.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe token for the next page of results.
- On success, responds with
ListSolNetworkOperationsOutput
with field(s):next_token(Option<String>)
:The token to use to retrieve the next page of results. This value is
null
when there are no more results to return.network_operations(Option<Vec::<ListSolNetworkOperationsInfo>>)
:Lists network operation occurrences. Lifecycle management operations are deploy, update, or delete operations.
- On failure, responds with
SdkError<ListSolNetworkOperationsError>
source§impl Client
impl Client
sourcepub fn list_sol_network_packages(&self) -> ListSolNetworkPackagesFluentBuilder
pub fn list_sol_network_packages(&self) -> ListSolNetworkPackagesFluentBuilder
Constructs a fluent builder for the ListSolNetworkPackages
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to include in the response.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe token for the next page of results.
- On success, responds with
ListSolNetworkPackagesOutput
with field(s):next_token(Option<String>)
:The token to use to retrieve the next page of results. This value is
null
when there are no more results to return.network_packages(Vec::<ListSolNetworkPackageInfo>)
: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.
- On failure, responds with
SdkError<ListSolNetworkPackagesError>
source§impl Client
impl Client
Constructs a fluent builder for the ListTagsForResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueResource ARN.
- On success, responds with
ListTagsForResourceOutput
with field(s):tags(HashMap::<String, String>)
: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.
- On failure, responds with
SdkError<ListTagsForResourceError>
source§impl Client
impl Client
sourcepub fn put_sol_function_package_content(
&self
) -> PutSolFunctionPackageContentFluentBuilder
pub fn put_sol_function_package_content( &self ) -> PutSolFunctionPackageContentFluentBuilder
Constructs a fluent builder for the PutSolFunctionPackageContent
operation.
- The fluent builder is configurable:
vnf_pkg_id(impl Into<String>)
/set_vnf_pkg_id(Option<String>)
:
required: trueFunction package ID.
content_type(PackageContentType)
/set_content_type(Option<PackageContentType>)
:
required: falseFunction package content type.
file(Blob)
/set_file(Option<Blob>)
:
required: trueFunction package file.
- On success, responds with
PutSolFunctionPackageContentOutput
with field(s):id(String)
:Function package ID.
vnfd_id(String)
:Function package descriptor ID.
vnf_product_name(String)
:Function product name.
vnf_provider(String)
:Function provider.
vnfd_version(String)
:Function package descriptor version.
metadata(Option<PutSolFunctionPackageContentMetadata>)
:Function package metadata.
- On failure, responds with
SdkError<PutSolFunctionPackageContentError>
source§impl Client
impl Client
sourcepub fn put_sol_network_package_content(
&self
) -> PutSolNetworkPackageContentFluentBuilder
pub fn put_sol_network_package_content( &self ) -> PutSolNetworkPackageContentFluentBuilder
Constructs a fluent builder for the PutSolNetworkPackageContent
operation.
- The fluent builder is configurable:
nsd_info_id(impl Into<String>)
/set_nsd_info_id(Option<String>)
:
required: trueNetwork service descriptor info ID.
content_type(PackageContentType)
/set_content_type(Option<PackageContentType>)
:
required: falseNetwork package content type.
file(Blob)
/set_file(Option<Blob>)
:
required: trueNetwork package file.
- On success, responds with
PutSolNetworkPackageContentOutput
with field(s):id(String)
:Network package ID.
arn(String)
:Network package ARN.
nsd_id(String)
:Network service descriptor ID.
nsd_name(String)
:Network service descriptor name.
nsd_version(String)
:Network service descriptor version.
vnf_pkg_ids(Vec::<String>)
:Function package IDs.
metadata(Option<PutSolNetworkPackageContentMetadata>)
:Network package metadata.
- On failure, responds with
SdkError<PutSolNetworkPackageContentError>
source§impl Client
impl Client
sourcepub fn tag_resource(&self) -> TagResourceFluentBuilder
pub fn tag_resource(&self) -> TagResourceFluentBuilder
Constructs a fluent builder for the TagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueResource ARN.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: trueA 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.
- On success, responds with
TagResourceOutput
- On failure, responds with
SdkError<TagResourceError>
source§impl Client
impl Client
sourcepub fn terminate_sol_network_instance(
&self
) -> TerminateSolNetworkInstanceFluentBuilder
pub fn terminate_sol_network_instance( &self ) -> TerminateSolNetworkInstanceFluentBuilder
Constructs a fluent builder for the TerminateSolNetworkInstance
operation.
- The fluent builder is configurable:
ns_instance_id(impl Into<String>)
/set_ns_instance_id(Option<String>)
:
required: trueID of the network instance.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseA 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 transferred to the network operation that is created. Use tags to search and filter your resources or track your Amazon Web Services costs.
- On success, responds with
TerminateSolNetworkInstanceOutput
with field(s):ns_lcm_op_occ_id(Option<String>)
:The identifier of the network operation.
tags(Option<HashMap::<String, String>>)
: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 transferred to the network operation that is created. Use tags to search and filter your resources or track your Amazon Web Services costs.
- On failure, responds with
SdkError<TerminateSolNetworkInstanceError>
source§impl Client
impl Client
sourcepub fn untag_resource(&self) -> UntagResourceFluentBuilder
pub fn untag_resource(&self) -> UntagResourceFluentBuilder
Constructs a fluent builder for the UntagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueResource ARN.
tag_keys(impl Into<String>)
/set_tag_keys(Option<Vec::<String>>)
:
required: trueTag keys.
- On success, responds with
UntagResourceOutput
- On failure, responds with
SdkError<UntagResourceError>
source§impl Client
impl Client
sourcepub fn update_sol_function_package(
&self
) -> UpdateSolFunctionPackageFluentBuilder
pub fn update_sol_function_package( &self ) -> UpdateSolFunctionPackageFluentBuilder
Constructs a fluent builder for the UpdateSolFunctionPackage
operation.
- The fluent builder is configurable:
vnf_pkg_id(impl Into<String>)
/set_vnf_pkg_id(Option<String>)
:
required: trueID of the function package.
operational_state(OperationalState)
/set_operational_state(Option<OperationalState>)
:
required: trueOperational state of the function package.
- On success, responds with
UpdateSolFunctionPackageOutput
with field(s):operational_state(OperationalState)
:Operational state of the function package.
- On failure, responds with
SdkError<UpdateSolFunctionPackageError>
source§impl Client
impl Client
sourcepub fn update_sol_network_instance(
&self
) -> UpdateSolNetworkInstanceFluentBuilder
pub fn update_sol_network_instance( &self ) -> UpdateSolNetworkInstanceFluentBuilder
Constructs a fluent builder for the UpdateSolNetworkInstance
operation.
- The fluent builder is configurable:
ns_instance_id(impl Into<String>)
/set_ns_instance_id(Option<String>)
:
required: trueID of the network instance.
update_type(UpdateSolNetworkType)
/set_update_type(Option<UpdateSolNetworkType>)
:
required: trueThe type of update.
modify_vnf_info_data(UpdateSolNetworkModify)
/set_modify_vnf_info_data(Option<UpdateSolNetworkModify>)
:
required: falseIdentifies the network function information parameters and/or the configurable properties of the network function to be modified.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseA 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 transferred to the network operation that is created. Use tags to search and filter your resources or track your Amazon Web Services costs.
- On success, responds with
UpdateSolNetworkInstanceOutput
with field(s):ns_lcm_op_occ_id(Option<String>)
:The identifier of the network operation.
tags(Option<HashMap::<String, String>>)
: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 transferred to the network operation that is created. Use tags to search and filter your resources or track your Amazon Web Services costs.
- On failure, responds with
SdkError<UpdateSolNetworkInstanceError>
source§impl Client
impl Client
sourcepub fn update_sol_network_package(&self) -> UpdateSolNetworkPackageFluentBuilder
pub fn update_sol_network_package(&self) -> UpdateSolNetworkPackageFluentBuilder
Constructs a fluent builder for the UpdateSolNetworkPackage
operation.
- The fluent builder is configurable:
nsd_info_id(impl Into<String>)
/set_nsd_info_id(Option<String>)
:
required: trueID of the network service descriptor in the network package.
nsd_operational_state(NsdOperationalState)
/set_nsd_operational_state(Option<NsdOperationalState>)
:
required: trueOperational state of the network service descriptor in the network package.
- On success, responds with
UpdateSolNetworkPackageOutput
with field(s):nsd_operational_state(NsdOperationalState)
:Operational state of the network service descriptor in the network package.
- On failure, responds with
SdkError<UpdateSolNetworkPackageError>
source§impl Client
impl Client
sourcepub fn validate_sol_function_package_content(
&self
) -> ValidateSolFunctionPackageContentFluentBuilder
pub fn validate_sol_function_package_content( &self ) -> ValidateSolFunctionPackageContentFluentBuilder
Constructs a fluent builder for the ValidateSolFunctionPackageContent
operation.
- The fluent builder is configurable:
vnf_pkg_id(impl Into<String>)
/set_vnf_pkg_id(Option<String>)
:
required: trueFunction package ID.
content_type(PackageContentType)
/set_content_type(Option<PackageContentType>)
:
required: falseFunction package content type.
file(Blob)
/set_file(Option<Blob>)
:
required: trueFunction package file.
- On success, responds with
ValidateSolFunctionPackageContentOutput
with field(s):id(String)
:Function package ID.
vnfd_id(String)
:Function package descriptor ID.
vnf_product_name(String)
:Network function product name.
vnf_provider(String)
:Network function provider.
vnfd_version(String)
:Function package descriptor version.
metadata(Option<ValidateSolFunctionPackageContentMetadata>)
:Function package metadata.
- On failure, responds with
SdkError<ValidateSolFunctionPackageContentError>
source§impl Client
impl Client
sourcepub fn validate_sol_network_package_content(
&self
) -> ValidateSolNetworkPackageContentFluentBuilder
pub fn validate_sol_network_package_content( &self ) -> ValidateSolNetworkPackageContentFluentBuilder
Constructs a fluent builder for the ValidateSolNetworkPackageContent
operation.
- The fluent builder is configurable:
nsd_info_id(impl Into<String>)
/set_nsd_info_id(Option<String>)
:
required: trueNetwork service descriptor file.
content_type(PackageContentType)
/set_content_type(Option<PackageContentType>)
:
required: falseNetwork package content type.
file(Blob)
/set_file(Option<Blob>)
:
required: trueNetwork package file.
- On success, responds with
ValidateSolNetworkPackageContentOutput
with field(s):id(String)
:Network package ID.
arn(String)
:Network package ARN.
nsd_id(String)
:Network service descriptor ID.
nsd_name(String)
:Network service descriptor name.
nsd_version(String)
:Network service descriptor version.
vnf_pkg_ids(Vec::<String>)
:Function package IDs.
metadata(Option<ValidateSolNetworkPackageContentMetadata>)
:Network package metadata.
- On failure, responds with
SdkError<ValidateSolNetworkPackageContentError>
source§impl Client
impl Client
sourcepub fn from_conf(conf: Config) -> Self
pub fn from_conf(conf: Config) -> Self
Creates a new client from the service Config
.
§Panics
This method will panic in the following cases:
- Retries or timeouts are enabled without a
sleep_impl
configured. - Identity caching is enabled without a
sleep_impl
andtime_source
configured. - No
behavior_version
is provided.
The panic message for each of these will have instructions on how to resolve them.
source§impl Client
impl Client
sourcepub fn new(sdk_config: &SdkConfig) -> Self
pub fn new(sdk_config: &SdkConfig) -> Self
Creates a new client from an SDK Config.
§Panics
- This method will panic if the
sdk_config
is missing an async sleep implementation. If you experience this panic, set thesleep_impl
on the Config passed into this function to fix it. - This method will panic if the
sdk_config
is missing an HTTP connector. If you experience this panic, set thehttp_connector
on the Config passed into this function to fix it. - This method will panic if no
BehaviorVersion
is provided. If you experience this panic, setbehavior_version
on the Config or enable thebehavior-version-latest
Cargo feature.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for Client
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more