import type { DocumentType as __DocumentType } from "@smithy/types"; import type { DescriptorContentType, LcmOperationType, NsdOnboardingState, NsdOperationalState, NsdUsageState, NsLcmOperationState, NsState, OnboardingState, OperationalState, PackageContentType, TaskStatus, UpdateSolNetworkType, UsageState, VnfInstantiationState, VnfOperationalState } from "./enums"; /** * @public */ export interface CancelSolNetworkOperationInput { /** *
The identifier of the network operation.
* @public */ nsLcmOpOccId: string | undefined; } /** * @public */ export interface CreateSolFunctionPackageInput { /** *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.
* @public */ tags?: RecordID of the function package.
* @public */ id: string | undefined; /** *Function package ARN.
* @public */ arn: string | undefined; /** *Onboarding state of the function package.
* @public */ onboardingState: OnboardingState | undefined; /** *Operational state of the function package.
* @public */ operationalState: OperationalState | undefined; /** *Usage state of the function package.
* @public */ usageState: UsageState | undefined; /** *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.
* @public */ tags?: RecordID for network service descriptor.
* @public */ nsdInfoId: string | undefined; /** *Network instance name.
* @public */ nsName: string | undefined; /** *Network instance description.
* @public */ nsDescription?: string | undefined; /** *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.
* @public */ tags?: RecordNetwork instance ID.
* @public */ id: string | undefined; /** *Network instance ARN.
* @public */ arn: string | undefined; /** *Network service descriptor ID.
* @public */ nsdInfoId: string | undefined; /** *Network instance name.
* @public */ nsInstanceName: string | undefined; /** *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.
* @public */ tags?: RecordA 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.
* @public */ tags?: RecordID of the network package.
* @public */ id: string | undefined; /** *Network package ARN.
* @public */ arn: string | undefined; /** *Onboarding state of the network service descriptor in the network package.
* @public */ nsdOnboardingState: NsdOnboardingState | undefined; /** *Operational state of the network service descriptor in the network package.
* @public */ nsdOperationalState: NsdOperationalState | undefined; /** *Usage state of the network service descriptor in the network package.
* @public */ nsdUsageState: NsdUsageState | undefined; /** *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.
* @public */ tags?: RecordID of the function package.
* @public */ vnfPkgId: string | undefined; } /** * @public */ export interface DeleteSolNetworkInstanceInput { /** *Network instance ID.
* @public */ nsInstanceId: string | undefined; } /** * @public */ export interface DeleteSolNetworkPackageInput { /** *ID of the network service descriptor in the network package.
* @public */ nsdInfoId: string | undefined; } /** *Provides error information.
* @public */ export interface ErrorInfo { /** *Error cause.
* @public */ cause?: string | undefined; /** *Error details.
* @public */ details?: string | undefined; } /** *Overrides of the TOSCA node.
* @public */ export interface ToscaOverride { /** *Name of the TOSCA override.
* @public */ name?: string | undefined; /** *Default value for the override.
* @public */ defaultValue?: string | undefined; } /** *Metadata for function package artifacts.
*Artifacts are the contents of the package descriptor file and the state of the package.
* @public */ export interface FunctionArtifactMeta { /** *Lists of function package overrides.
* @public */ overrides?: ToscaOverride[] | undefined; } /** * @public */ export interface GetSolFunctionInstanceInput { /** *ID of the network function.
* @public */ vnfInstanceId: string | undefined; } /** *The metadata of a network function.
*A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.
* @public */ export interface GetSolVnfcResourceInfoMetadata { /** *Information about the node group.
* @public */ nodeGroup?: string | undefined; /** *Information about the cluster.
* @public */ cluster?: string | undefined; /** *Information about the helm chart.
* @public */ helmChart?: string | undefined; } /** *Details of resource associated with a network function.
*A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.
* @public */ export interface GetSolVnfcResourceInfo { /** *The metadata of the network function compute.
* @public */ metadata?: GetSolVnfcResourceInfoMetadata | undefined; } /** *Information about the network function.
*A network function instance is a function in a function package .
* @public */ export interface GetSolVnfInfo { /** *State of the network function instance.
* @public */ vnfState?: VnfOperationalState | undefined; /** *Compute info used by the network function instance.
* @public */ vnfcResourceInfo?: GetSolVnfcResourceInfo[] | undefined; } /** *The metadata of a network function instance.
*A network function instance is a function in a function package .
* @public */ export interface GetSolFunctionInstanceMetadata { /** *The date that the resource was created.
* @public */ createdAt: Date | undefined; /** *The date that the resource was last modified.
* @public */ lastModified: Date | undefined; } /** * @public */ export interface GetSolFunctionInstanceOutput { /** *Network function instance ID.
* @public */ id: string | undefined; /** *Network function instance ARN.
* @public */ arn: string | undefined; /** *Network instance ID.
* @public */ nsInstanceId: string | undefined; /** *Function package ID.
* @public */ vnfPkgId: string | undefined; /** *Function package descriptor ID.
* @public */ vnfdId: string | undefined; /** *Network function provider.
* @public */ vnfProvider?: string | undefined; /** *Network function product name.
* @public */ vnfProductName?: string | undefined; /** *Function package descriptor version.
* @public */ vnfdVersion?: string | undefined; /** *Network function instantiation state.
* @public */ instantiationState: VnfInstantiationState | undefined; /** *Information about the network function.
*A network function instance is a function in a function package .
* @public */ instantiatedVnfInfo?: GetSolVnfInfo | undefined; /** *The metadata of a network function instance.
*A network function instance is a function in a function package .
* @public */ metadata: GetSolFunctionInstanceMetadata | undefined; /** *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.
* @public */ tags?: RecordID of the function package.
* @public */ vnfPkgId: string | undefined; } /** *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.
* @public */ export interface GetSolFunctionPackageMetadata { /** *Metadata related to the function package descriptor of the function package.
* @public */ vnfd?: FunctionArtifactMeta | undefined; /** *The date that the resource was created.
* @public */ createdAt: Date | undefined; /** *The date that the resource was last modified.
* @public */ lastModified: Date | undefined; } /** * @public */ export interface GetSolFunctionPackageOutput { /** *Function package ID.
* @public */ id: string | undefined; /** *Function package ARN.
* @public */ arn: string | undefined; /** *Function package onboarding state.
* @public */ onboardingState: OnboardingState | undefined; /** *Function package operational state.
* @public */ operationalState: OperationalState | undefined; /** *Function package usage state.
* @public */ usageState: UsageState | undefined; /** *Function package descriptor ID.
* @public */ vnfdId?: string | undefined; /** *Network function provider.
* @public */ vnfProvider?: string | undefined; /** *Network function product name.
* @public */ vnfProductName?: string | undefined; /** *Function package descriptor version.
* @public */ vnfdVersion?: string | undefined; /** *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.
* @public */ metadata?: GetSolFunctionPackageMetadata | undefined; /** *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.
* @public */ tags?: RecordID of the function package.
* @public */ vnfPkgId: string | undefined; /** *The format of the package that you want to download from the function packages.
* @public */ accept: PackageContentType | undefined; } /** * @public */ export interface GetSolFunctionPackageContentOutput { /** *Indicates the media type of the resource.
* @public */ contentType?: PackageContentType | undefined; /** *Contents of the function package.
* @public */ packageContent?: Uint8Array | undefined; } /** * @public */ export interface GetSolFunctionPackageDescriptorInput { /** *ID of the function package.
* @public */ vnfPkgId: string | undefined; /** *Indicates which content types, expressed as MIME types, the client is able to * understand.
* @public */ accept: DescriptorContentType | undefined; } /** * @public */ export interface GetSolFunctionPackageDescriptorOutput { /** *Indicates the media type of the resource.
* @public */ contentType?: DescriptorContentType | undefined; /** *Contents of the function package descriptor.
* @public */ vnfd?: Uint8Array | undefined; } /** *Information about a network function.
*A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.
* @public */ export interface GetSolInstantiatedVnfInfo { /** *State of the network function.
* @public */ vnfState?: VnfOperationalState | undefined; } /** * @public */ export interface GetSolNetworkInstanceInput { /** *ID of the network instance.
* @public */ nsInstanceId: string | undefined; } /** *Lifecycle management operation details on the network instance.
*Lifecycle management operations are deploy, update, or delete operations.
* @public */ export interface LcmOperationInfo { /** *The identifier of the network operation.
* @public */ nsLcmOpOccId: string | undefined; } /** *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.
* @public */ export interface GetSolNetworkInstanceMetadata { /** *The date that the resource was created.
* @public */ createdAt: Date | undefined; /** *The date that the resource was last modified.
* @public */ lastModified: Date | undefined; } /** * @public */ export interface GetSolNetworkInstanceOutput { /** *Network instance ID.
* @public */ id: string | undefined; /** *Network instance ARN.
* @public */ arn: string | undefined; /** *Network instance name.
* @public */ nsInstanceName: string | undefined; /** *Network instance description.
* @public */ nsInstanceDescription: string | undefined; /** *Network service descriptor ID.
* @public */ nsdId: string | undefined; /** *Network service descriptor info ID.
* @public */ nsdInfoId: string | undefined; /** *Network instance state.
* @public */ nsState?: NsState | undefined; /** *Lifecycle management operation details on the network instance.
*Lifecycle management operations are deploy, update, or delete operations.
* @public */ lcmOpInfo?: LcmOperationInfo | undefined; /** *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.
* @public */ metadata: GetSolNetworkInstanceMetadata | undefined; /** *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.
* @public */ tags?: RecordThe identifier of the network operation.
* @public */ nsLcmOpOccId: string | undefined; } /** *Details related to problems with AWS TNB resources.
* @public */ export interface ProblemDetails { /** *A human-readable explanation specific to this occurrence of the problem.
* @public */ detail: string | undefined; /** *A human-readable title of the problem type.
* @public */ title?: string | undefined; } /** *Metadata related to the configuration properties used during instantiation of the network instance.
* @public */ export interface InstantiateMetadata { /** *The network service descriptor used for instantiating the network instance.
* @public */ nsdInfoId: string | undefined; /** *The configurable properties used during instantiation.
* @public */ additionalParamsForNs?: __DocumentType | undefined; } /** *Metadata related to the configuration properties used during update of a specific * network function in a network instance.
* @public */ export interface ModifyVnfInfoMetadata { /** *The network function instance that was updated in the network instance.
* @public */ vnfInstanceId: string | undefined; /** *The configurable properties used during update of the network function instance.
* @public */ vnfConfigurableProperties: __DocumentType | undefined; } /** *Metadata related to the configuration properties used during update of a network instance.
* @public */ export interface UpdateNsMetadata { /** *The network service descriptor used for updating the network instance.
* @public */ nsdInfoId: string | undefined; /** *The configurable properties used during update.
* @public */ additionalParamsForNs?: __DocumentType | undefined; } /** *Metadata related to a network operation occurrence.
*A network operation is any operation that is done to your network, such as network instance instantiation or termination.
* @public */ export interface GetSolNetworkOperationMetadata { /** *Metadata related to the network operation occurrence for network instance updates.
* This is populated only if the lcmOperationType is UPDATE and the
* updateType is UPDATE_NS.
Metadata related to the network operation occurrence for network function updates in a network instance.
* This is populated only if the lcmOperationType is UPDATE and the
* updateType is MODIFY_VNF_INFORMATION.
Metadata related to the network operation occurrence for network instantiation.
* This is populated only if the lcmOperationType is INSTANTIATE.
The date that the resource was created.
* @public */ createdAt: Date | undefined; /** *The date that the resource was last modified.
* @public */ lastModified: Date | undefined; } /** *Gets the details of a network operation.
*A network operation is any operation that is done to your network, such as network instance instantiation or termination.
* @public */ export interface GetSolNetworkOperationTaskDetails { /** *Task name.
* @public */ taskName?: string | undefined; /** *Context for the network operation task.
* @public */ taskContext?: RecordTask error details.
* @public */ taskErrorDetails?: ErrorInfo | undefined; /** *Task status.
* @public */ taskStatus?: TaskStatus | undefined; /** *Task start time.
* @public */ taskStartTime?: Date | undefined; /** *Task end time.
* @public */ taskEndTime?: Date | undefined; } /** * @public */ export interface GetSolNetworkOperationOutput { /** *ID of this network operation occurrence.
* @public */ id?: string | undefined; /** *Network operation ARN.
* @public */ arn: string | undefined; /** *The state of the network operation.
* @public */ operationState?: NsLcmOperationState | undefined; /** *ID of the network operation instance.
* @public */ nsInstanceId?: string | undefined; /** *Type of the operation represented by this occurrence.
* @public */ lcmOperationType?: LcmOperationType | undefined; /** *Type of the update. Only present if the network operation
* lcmOperationType is UPDATE.
Error related to this specific network operation occurrence.
* @public */ error?: ProblemDetails | undefined; /** *Metadata of this network operation occurrence.
* @public */ metadata?: GetSolNetworkOperationMetadata | undefined; /** *All tasks associated with this operation occurrence.
* @public */ tasks?: GetSolNetworkOperationTaskDetails[] | undefined; /** *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.
* @public */ tags?: RecordID of the network service descriptor in the network package.
* @public */ nsdInfoId: string | undefined; } /** *Metadata for network package artifacts.
*Artifacts are the contents of the package descriptor file and the state of the package.
* @public */ export interface NetworkArtifactMeta { /** *Lists network package overrides.
* @public */ overrides?: ToscaOverride[] | undefined; } /** *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.
* @public */ export interface GetSolNetworkPackageMetadata { /** *Metadata related to the onboarded network service descriptor in the network * package.
* @public */ nsd?: NetworkArtifactMeta | undefined; /** *The date that the resource was created.
* @public */ createdAt: Date | undefined; /** *The date that the resource was last modified.
* @public */ lastModified: Date | undefined; } /** * @public */ export interface GetSolNetworkPackageOutput { /** *Network package ID.
* @public */ id: string | undefined; /** *Network package ARN.
* @public */ arn: string | undefined; /** *Network service descriptor onboarding state.
* @public */ nsdOnboardingState: NsdOnboardingState | undefined; /** *Network service descriptor operational state.
* @public */ nsdOperationalState: NsdOperationalState | undefined; /** *Network service descriptor usage state.
* @public */ nsdUsageState: NsdUsageState | undefined; /** *Network service descriptor ID.
* @public */ nsdId: string | undefined; /** *Network service descriptor name.
* @public */ nsdName: string | undefined; /** *Network service descriptor version.
* @public */ nsdVersion: string | undefined; /** *Identifies the function package for the function package descriptor referenced by the * onboarded network package.
* @public */ vnfPkgIds: string[] | undefined; /** *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.
* @public */ metadata: GetSolNetworkPackageMetadata | undefined; /** *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.
* @public */ tags?: RecordID of the network service descriptor in the network package.
* @public */ nsdInfoId: string | undefined; /** *The format of the package you want to download from the network package.
* @public */ accept: PackageContentType | undefined; } /** * @public */ export interface GetSolNetworkPackageContentOutput { /** *Indicates the media type of the resource.
* @public */ contentType?: PackageContentType | undefined; /** *Content of the network service descriptor in the network package.
* @public */ nsdContent?: Uint8Array | undefined; } /** * @public */ export interface GetSolNetworkPackageDescriptorInput { /** *ID of the network service descriptor in the network package.
* @public */ nsdInfoId: string | undefined; } /** * @public */ export interface GetSolNetworkPackageDescriptorOutput { /** *Indicates the media type of the resource.
* @public */ contentType?: DescriptorContentType | undefined; /** *Contents of the network service descriptor in the network package.
* @public */ nsd?: Uint8Array | undefined; } /** * @public */ export interface InstantiateSolNetworkInstanceInput { /** *ID of the network instance.
* @public */ nsInstanceId: string | undefined; /** *A check for whether you have the required permissions for the action without actually making the request
* and provides an error response. If you have the required permissions, the error response is DryRunOperation.
* Otherwise, it is UnauthorizedOperation.
Provides values for the configurable properties.
* @public */ additionalParamsForNs?: __DocumentType | undefined; /** *A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are only applied to the network operation that is created. These tags are not applied to the network instance. Use tags to search and filter your resources or track your Amazon Web Services costs.
* @public */ tags?: RecordThe identifier of the network operation.
* @public */ nsLcmOpOccId: string | undefined; /** *A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are only applied to the network operation that is created. These tags are not applied to the network instance. Use tags to search and filter your resources or track your Amazon Web Services costs.
* @public */ tags?: RecordLists network function instance metadata.
*A network function instance is a function in a function package .
* @public */ export interface ListSolFunctionInstanceMetadata { /** *When the network function instance was created.
* @public */ createdAt: Date | undefined; /** *When the network function instance was last modified.
* @public */ lastModified: Date | undefined; } /** *Lists information about a network function instance.
*A network function instance is a function in a function package .
* @public */ export interface ListSolFunctionInstanceInfo { /** *Network function instance ID.
* @public */ id: string | undefined; /** *Network function instance ARN.
* @public */ arn: string | undefined; /** *Network instance ID.
* @public */ nsInstanceId: string | undefined; /** *Function package ID.
* @public */ vnfPkgId: string | undefined; /** *Function package name.
* @public */ vnfPkgName?: string | undefined; /** *Network function instance instantiation state.
* @public */ instantiationState: VnfInstantiationState | undefined; /** *Information about a network function.
*A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.
* @public */ instantiatedVnfInfo?: GetSolInstantiatedVnfInfo | undefined; /** *Network function instance metadata.
* @public */ metadata: ListSolFunctionInstanceMetadata | undefined; } /** * @public */ export interface ListSolFunctionInstancesInput { /** *The maximum number of results to include in the response.
* @public */ maxResults?: number | undefined; /** *The token for the next page of results.
* @public */ nextToken?: string | undefined; } /** * @public */ export interface ListSolFunctionInstancesOutput { /** *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Network function instances.
* @public */ functionInstances?: ListSolFunctionInstanceInfo[] | undefined; } /** *Details for the function package metadata.
*A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.
* @public */ export interface ListSolFunctionPackageMetadata { /** *The date that the resource was created.
* @public */ createdAt: Date | undefined; /** *The date that the resource was last modified.
* @public */ lastModified: Date | undefined; } /** *Information about a function package.
*A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.
* @public */ export interface ListSolFunctionPackageInfo { /** *ID of the function package.
* @public */ id: string | undefined; /** *Function package ARN.
* @public */ arn: string | undefined; /** *Onboarding state of the function package.
* @public */ onboardingState: OnboardingState | undefined; /** *Operational state of the function package.
* @public */ operationalState: OperationalState | undefined; /** *Usage state of the function package.
* @public */ usageState: UsageState | undefined; /** *Identifies the function package and the function package descriptor.
* @public */ vnfdId?: string | undefined; /** *Provider of the function package and the function package descriptor.
* @public */ vnfProvider?: string | undefined; /** *The product name for the network function.
* @public */ vnfProductName?: string | undefined; /** *Identifies the version of the function package descriptor.
* @public */ vnfdVersion?: string | undefined; /** *The metadata of the function package.
* @public */ metadata?: ListSolFunctionPackageMetadata | undefined; } /** * @public */ export interface ListSolFunctionPackagesInput { /** *The maximum number of results to include in the response.
* @public */ maxResults?: number | undefined; /** *The token for the next page of results.
* @public */ nextToken?: string | undefined; } /** * @public */ export interface ListSolFunctionPackagesOutput { /** *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. 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.
* @public */ functionPackages: ListSolFunctionPackageInfo[] | undefined; } /** *Metadata details for a network instance.
*A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.
* @public */ export interface ListSolNetworkInstanceMetadata { /** *The date that the resource was created.
* @public */ createdAt: Date | undefined; /** *The date that the resource was last modified.
* @public */ lastModified: Date | undefined; } /** *Info about the specific network instance.
*A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.
* @public */ export interface ListSolNetworkInstanceInfo { /** *ID of the network instance.
* @public */ id: string | undefined; /** *Network instance ARN.
* @public */ arn: string | undefined; /** *Human-readable name of the network instance.
* @public */ nsInstanceName: string | undefined; /** *Human-readable description of the network instance.
* @public */ nsInstanceDescription: string | undefined; /** *ID of the network service descriptor in the network package.
* @public */ nsdId: string | undefined; /** *ID of the network service descriptor in the network package.
* @public */ nsdInfoId: string | undefined; /** *The state of the network instance.
* @public */ nsState: NsState | undefined; /** *The metadata of the network instance.
* @public */ metadata: ListSolNetworkInstanceMetadata | undefined; } /** * @public */ export interface ListSolNetworkInstancesInput { /** *The maximum number of results to include in the response.
* @public */ maxResults?: number | undefined; /** *The token for the next page of results.
* @public */ nextToken?: string | undefined; } /** * @public */ export interface ListSolNetworkInstancesOutput { /** *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Lists network instances.
* @public */ networkInstances?: ListSolNetworkInstanceInfo[] | undefined; } /** * @public */ export interface ListSolNetworkOperationsInput { /** *Network instance id filter, to retrieve network operations associated to a network instance.
* @public */ nsInstanceId?: string | undefined; /** *The maximum number of results to include in the response.
* @public */ maxResults?: number | undefined; /** *The token for the next page of results.
* @public */ nextToken?: string | undefined; } /** *Metadata related to a network operation.
*A network operation is any operation that is done to your network, such as network instance instantiation or termination.
* @public */ export interface ListSolNetworkOperationsMetadata { /** *The network service descriptor id used for the operation.
*Only present if the updateType is UPDATE_NS.
The network function id used for the operation.
*Only present if the updateType is MODIFY_VNF_INFO.
The date that the resource was created.
* @public */ createdAt: Date | undefined; /** *The date that the resource was last modified.
* @public */ lastModified: Date | undefined; } /** *Information parameters for a network operation.
* @public */ export interface ListSolNetworkOperationsInfo { /** *ID of this network operation.
* @public */ id: string | undefined; /** *Network operation ARN.
* @public */ arn: string | undefined; /** *The state of the network operation.
* @public */ operationState: NsLcmOperationState | undefined; /** *ID of the network instance related to this operation.
* @public */ nsInstanceId: string | undefined; /** *Type of lifecycle management network operation.
* @public */ lcmOperationType: LcmOperationType | undefined; /** *Type of the update. Only present if the network operation lcmOperationType is UPDATE.
Error related to this specific network operation.
* @public */ error?: ProblemDetails | undefined; /** *Metadata related to this network operation.
* @public */ metadata?: ListSolNetworkOperationsMetadata | undefined; } /** * @public */ export interface ListSolNetworkOperationsOutput { /** *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Lists network operation occurrences. Lifecycle management operations are deploy, update, or delete operations.
* @public */ networkOperations?: ListSolNetworkOperationsInfo[] | undefined; } /** *Metadata related to a network package.
*A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.
* @public */ export interface ListSolNetworkPackageMetadata { /** *The date that the resource was created.
* @public */ createdAt: Date | undefined; /** *The date that the resource was last modified.
* @public */ lastModified: Date | undefined; } /** *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.
* @public */ export interface ListSolNetworkPackageInfo { /** *ID of the individual network package.
* @public */ id: string | undefined; /** *Network package ARN.
* @public */ arn: string | undefined; /** *Onboarding state of the network service descriptor in the network package.
* @public */ nsdOnboardingState: NsdOnboardingState | undefined; /** *Operational state of the network service descriptor in the network package.
* @public */ nsdOperationalState: NsdOperationalState | undefined; /** *Usage state of the network service descriptor in the network package.
* @public */ nsdUsageState: NsdUsageState | undefined; /** *ID of the network service descriptor on which the network package is based.
* @public */ nsdId?: string | undefined; /** *Name of the onboarded network service descriptor in the network package.
* @public */ nsdName?: string | undefined; /** *Version of the onboarded network service descriptor in the network package.
* @public */ nsdVersion?: string | undefined; /** *Designer of the onboarded network service descriptor in the network package.
* @public */ nsdDesigner?: string | undefined; /** *Identifies a network service descriptor in a version independent manner.
* @public */ nsdInvariantId?: string | undefined; /** *Identifies the function package for the function package descriptor referenced by the * onboarded network package.
* @public */ vnfPkgIds?: string[] | undefined; /** *The metadata of the network package.
* @public */ metadata: ListSolNetworkPackageMetadata | undefined; } /** * @public */ export interface ListSolNetworkPackagesInput { /** *The maximum number of results to include in the response.
* @public */ maxResults?: number | undefined; /** *The token for the next page of results.
* @public */ nextToken?: string | undefined; } /** * @public */ export interface ListSolNetworkPackagesOutput { /** *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. 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.
* @public */ networkPackages: ListSolNetworkPackageInfo[] | undefined; } /** * @public */ export interface ListTagsForResourceInput { /** *Resource ARN.
* @public */ resourceArn: string | undefined; } /** * @public */ export interface ListTagsForResourceOutput { /** *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.
* @public */ tags: RecordFunction package ID.
* @public */ vnfPkgId: string | undefined; /** *Function package content type.
* @public */ contentType?: PackageContentType | undefined; /** *Function package file.
* @public */ file: Uint8Array | undefined; } /** *Update metadata in a function package.
*A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.
* @public */ export interface PutSolFunctionPackageContentMetadata { /** *Metadata for function package artifacts.
*Artifacts are the contents of the package descriptor file and the state of the package.
* @public */ vnfd?: FunctionArtifactMeta | undefined; } /** * @public */ export interface PutSolFunctionPackageContentOutput { /** *Function package ID.
* @public */ id: string | undefined; /** *Function package descriptor ID.
* @public */ vnfdId: string | undefined; /** *Function product name.
* @public */ vnfProductName: string | undefined; /** *Function provider.
* @public */ vnfProvider: string | undefined; /** *Function package descriptor version.
* @public */ vnfdVersion: string | undefined; /** *Function package metadata.
* @public */ metadata: PutSolFunctionPackageContentMetadata | undefined; } /** * @public */ export interface PutSolNetworkPackageContentInput { /** *Network service descriptor info ID.
* @public */ nsdInfoId: string | undefined; /** *Network package content type.
* @public */ contentType?: PackageContentType | undefined; /** *Network package file.
* @public */ file: Uint8Array | undefined; } /** *Update metadata in a network package.
*A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.
* @public */ export interface PutSolNetworkPackageContentMetadata { /** *Metadata for network package artifacts.
*Artifacts are the contents of the package descriptor file and the state of the package.
* @public */ nsd?: NetworkArtifactMeta | undefined; } /** * @public */ export interface PutSolNetworkPackageContentOutput { /** *Network package ID.
* @public */ id: string | undefined; /** *Network package ARN.
* @public */ arn: string | undefined; /** *Network service descriptor ID.
* @public */ nsdId: string | undefined; /** *Network service descriptor name.
* @public */ nsdName: string | undefined; /** *Network service descriptor version.
* @public */ nsdVersion: string | undefined; /** *Function package IDs.
* @public */ vnfPkgIds: string[] | undefined; /** *Network package metadata.
* @public */ metadata: PutSolNetworkPackageContentMetadata | undefined; } /** * @public */ export interface TagResourceInput { /** *Resource ARN.
* @public */ resourceArn: string | undefined; /** *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.
* @public */ tags: RecordID of the network instance.
* @public */ nsInstanceId: string | undefined; /** *A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are only applied to the network operation that is created. These tags are not applied to the network instance. Use tags to search and filter your resources or track your Amazon Web Services costs.
* @public */ tags?: RecordThe identifier of the network operation.
* @public */ nsLcmOpOccId?: string | undefined; /** *A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are only applied to the network operation that is created. These tags are not applied to the network instance. Use tags to search and filter your resources or track your Amazon Web Services costs.
* @public */ tags?: RecordResource ARN.
* @public */ resourceArn: string | undefined; /** *Tag keys.
* @public */ tagKeys: string[] | undefined; } /** * @public */ export interface UntagResourceOutput { } /** * @public */ export interface UpdateSolFunctionPackageInput { /** *ID of the function package.
* @public */ vnfPkgId: string | undefined; /** *Operational state of the function package.
* @public */ operationalState: OperationalState | undefined; } /** * @public */ export interface UpdateSolFunctionPackageOutput { /** *Operational state of the function package.
* @public */ operationalState: OperationalState | undefined; } /** *Information parameters and/or the configurable properties for a network function.
*A network function instance is a function in a function package .
* @public */ export interface UpdateSolNetworkModify { /** *ID of the network function instance.
*A network function instance is a function in a function package .
* @public */ vnfInstanceId: string | undefined; /** *Provides values for the configurable properties declared in the function package * descriptor.
* @public */ vnfConfigurableProperties: __DocumentType | undefined; } /** *Information parameters and/or the configurable properties for a network descriptor used for update.
* @public */ export interface UpdateSolNetworkServiceData { /** *ID of the network service descriptor.
* @public */ nsdInfoId: string | undefined; /** *Values for the configurable properties declared in the network service descriptor.
* @public */ additionalParamsForNs?: __DocumentType | undefined; } /** * @public */ export interface UpdateSolNetworkInstanceInput { /** *ID of the network instance.
* @public */ nsInstanceId: string | undefined; /** *The type of update.
*Use the MODIFY_VNF_INFORMATION update type, to update a specific network function
* configuration, in the network instance.
Use the UPDATE_NS update type, to update the network instance to a
* new network service descriptor.
Identifies the network function information parameters and/or the configurable * properties of the network function to be modified.
*Include this property only if the update type is MODIFY_VNF_INFORMATION.
Identifies the network service descriptor and the configurable * properties of the descriptor, to be used for the update.
*Include this property only if the update type is UPDATE_NS.
A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are only applied to the network operation that is created. These tags are not applied to the network instance. Use tags to search and filter your resources or track your Amazon Web Services costs.
* @public */ tags?: RecordThe identifier of the network operation.
* @public */ nsLcmOpOccId?: string | undefined; /** *A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are only applied to the network operation that is created. These tags are not applied to the network instance. Use tags to search and filter your resources or track your Amazon Web Services costs.
* @public */ tags?: RecordID of the network service descriptor in the network package.
* @public */ nsdInfoId: string | undefined; /** *Operational state of the network service descriptor in the network package.
* @public */ nsdOperationalState: NsdOperationalState | undefined; } /** * @public */ export interface UpdateSolNetworkPackageOutput { /** *Operational state of the network service descriptor in the network package.
* @public */ nsdOperationalState: NsdOperationalState | undefined; } /** * @public */ export interface ValidateSolFunctionPackageContentInput { /** *Function package ID.
* @public */ vnfPkgId: string | undefined; /** *Function package content type.
* @public */ contentType?: PackageContentType | undefined; /** *Function package file.
* @public */ file: Uint8Array | undefined; } /** *Validates function package content metadata.
*A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.
* @public */ export interface ValidateSolFunctionPackageContentMetadata { /** *Metadata for function package artifacts.
*Artifacts are the contents of the package descriptor file and the state of the package.
* @public */ vnfd?: FunctionArtifactMeta | undefined; } /** * @public */ export interface ValidateSolFunctionPackageContentOutput { /** *Function package ID.
* @public */ id: string | undefined; /** *Function package descriptor ID.
* @public */ vnfdId: string | undefined; /** *Network function product name.
* @public */ vnfProductName: string | undefined; /** *Network function provider.
* @public */ vnfProvider: string | undefined; /** *Function package descriptor version.
* @public */ vnfdVersion: string | undefined; /** *Function package metadata.
* @public */ metadata: ValidateSolFunctionPackageContentMetadata | undefined; } /** * @public */ export interface ValidateSolNetworkPackageContentInput { /** *Network service descriptor file.
* @public */ nsdInfoId: string | undefined; /** *Network package content type.
* @public */ contentType?: PackageContentType | undefined; /** *Network package file.
* @public */ file: Uint8Array | undefined; } /** *Validates network package content metadata.
*A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.
* @public */ export interface ValidateSolNetworkPackageContentMetadata { /** *Metadata for network package artifacts.
*Artifacts are the contents of the package descriptor file and the state of the package.
* @public */ nsd?: NetworkArtifactMeta | undefined; } /** * @public */ export interface ValidateSolNetworkPackageContentOutput { /** *Network package ID.
* @public */ id: string | undefined; /** *Network package ARN.
* @public */ arn: string | undefined; /** *Network service descriptor ID.
* @public */ nsdId: string | undefined; /** *Network service descriptor name.
* @public */ nsdName: string | undefined; /** *Network service descriptor version.
* @public */ nsdVersion: string | undefined; /** *Function package IDs.
* @public */ vnfPkgIds: string[] | undefined; /** *Network package metadata.
* @public */ metadata: ValidateSolNetworkPackageContentMetadata | undefined; }