tnb

package module
v1.13.14 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 31, 2025 License: Apache-2.0 Imports: 45 Imported by: 6

Documentation

Overview

Package tnb provides the API client, operations, and parameter types for AWS Telco Network Builder. 

Amazon Web Services Telco Network Builder (TNB) is a network automation

service that helps you deploy and manage telecom networks. AWS TNB helps you with the lifecycle management of your telecommunication network functions throughout planning, deployment, and post-deployment activities.

Index

Constants

View Source 
const ServiceAPIVersion = "2008-10-21"
View Source 
const ServiceID = "tnb"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions 

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver deprecated 

func WithEndpointResolver(v EndpointResolver) func(*Options)

Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint.

To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.

func WithEndpointResolverV2 added in v1.2.0 

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.

func WithSigV4SigningName added in v1.5.2 

func WithSigV4SigningName(name string) func(*Options)

WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.

func WithSigV4SigningRegion added in v1.5.2 

func WithSigV4SigningRegion(region string) func(*Options)

WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.

Types

type AuthResolverParameters added in v1.5.2 

type AuthResolverParameters struct {
	// The name of the operation being invoked.
	Operation string

	// The region in which the operation is being invoked.
	Region string
}

AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.

type AuthSchemeResolver added in v1.5.2 

type AuthSchemeResolver interface {
	ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}

AuthSchemeResolver returns a set of possible authentication options for an operation.

type CancelSolNetworkOperationInput 

type CancelSolNetworkOperationInput struct {

	// The identifier of the network operation.
	//
	// This member is required.
	NsLcmOpOccId *string
	// contains filtered or unexported fields
}

type CancelSolNetworkOperationOutput 

type CancelSolNetworkOperationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type Client 

type Client struct {
	// contains filtered or unexported fields
}

Client provides the API client to make operations call for AWS Telco Network Builder.

func New 

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig 

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) CancelSolNetworkOperation 

func (c *Client) CancelSolNetworkOperation(ctx context.Context, params *CancelSolNetworkOperationInput, optFns ...func(*Options)) (*CancelSolNetworkOperationOutput, error)

Cancels a network operation.

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

func (*Client) CreateSolFunctionPackage 

func (c *Client) CreateSolFunctionPackage(ctx context.Context, params *CreateSolFunctionPackageInput, optFns ...func(*Options)) (*CreateSolFunctionPackageOutput, error)

Creates a function package.

A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network. For more information, see Function packagesin the Amazon Web Services Telco Network Builder User Guide.

Creating a function package is the first step for creating a network in AWS TNB. This request creates an empty container with an ID. The next step is to upload the actual CSAR zip file into that empty container. To upload function package content, see PutSolFunctionPackageContent.

func (*Client) CreateSolNetworkInstance 

func (c *Client) CreateSolNetworkInstance(ctx context.Context, params *CreateSolNetworkInstanceInput, optFns ...func(*Options)) (*CreateSolNetworkInstanceOutput, error)

Creates a network instance.

A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed. Creating a network instance is the third step after creating a network package. For more information about network instances, Network instancesin the Amazon Web Services Telco Network Builder User Guide.

Once you create a network instance, you can instantiate it. To instantiate a network, see InstantiateSolNetworkInstance.

func (*Client) CreateSolNetworkPackage 

func (c *Client) CreateSolNetworkPackage(ctx context.Context, params *CreateSolNetworkPackageInput, optFns ...func(*Options)) (*CreateSolNetworkPackageOutput, error)

Creates a network package.

A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on. For more information, see Network instancesin the Amazon Web Services Telco Network Builder User Guide.

A network package consists of a network service descriptor (NSD) file (required) and any additional files (optional), such as scripts specific to your needs. For example, if you have multiple function packages in your network package, you can use the NSD to define which network functions should run in certain VPCs, subnets, or EKS clusters.

This request creates an empty network package container with an ID. Once you create a network package, you can upload the network package content using PutSolNetworkPackageContent.

func (*Client) DeleteSolFunctionPackage 

func (c *Client) DeleteSolFunctionPackage(ctx context.Context, params *DeleteSolFunctionPackageInput, optFns ...func(*Options)) (*DeleteSolFunctionPackageOutput, error)

Deletes a function package.

A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.

To delete a function package, the package must be in a disabled state. To disable a function package, see UpdateSolFunctionPackage.

func (*Client) DeleteSolNetworkInstance 

func (c *Client) DeleteSolNetworkInstance(ctx context.Context, params *DeleteSolNetworkInstanceInput, optFns ...func(*Options)) (*DeleteSolNetworkInstanceOutput, error)

Deletes a network instance.

A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.

To delete a network instance, the instance must be in a stopped or terminated state. To terminate a network instance, see TerminateSolNetworkInstance.

func (*Client) DeleteSolNetworkPackage 

func (c *Client) DeleteSolNetworkPackage(ctx context.Context, params *DeleteSolNetworkPackageInput, optFns ...func(*Options)) (*DeleteSolNetworkPackageOutput, error)

Deletes network package.

A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.

To delete a network package, the package must be in a disable state. To disable a network package, see UpdateSolNetworkPackage.

func (*Client) GetSolFunctionInstance 

func (c *Client) GetSolFunctionInstance(ctx context.Context, params *GetSolFunctionInstanceInput, optFns ...func(*Options)) (*GetSolFunctionInstanceOutput, error)

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

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

func (*Client) GetSolFunctionPackage 

func (c *Client) GetSolFunctionPackage(ctx context.Context, params *GetSolFunctionPackageInput, optFns ...func(*Options)) (*GetSolFunctionPackageOutput, error)

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

A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network..

func (*Client) GetSolFunctionPackageContent 

func (c *Client) GetSolFunctionPackageContent(ctx context.Context, params *GetSolFunctionPackageContentInput, optFns ...func(*Options)) (*GetSolFunctionPackageContentOutput, error)

Gets the contents of a function package.

A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.

func (*Client) GetSolFunctionPackageDescriptor 

func (c *Client) GetSolFunctionPackageDescriptor(ctx context.Context, params *GetSolFunctionPackageDescriptorInput, optFns ...func(*Options)) (*GetSolFunctionPackageDescriptorOutput, error)

Gets a function package descriptor in a function package.

A function package descriptor is a .yaml file in a function package that uses the TOSCA standard to describe how the network function in the function package should run on your network.

A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.

func (*Client) GetSolNetworkInstance 

func (c *Client) GetSolNetworkInstance(ctx context.Context, params *GetSolNetworkInstanceInput, optFns ...func(*Options)) (*GetSolNetworkInstanceOutput, error)

Gets the details of the network instance.

A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.

func (*Client) GetSolNetworkOperation 

func (c *Client) GetSolNetworkOperation(ctx context.Context, params *GetSolNetworkOperationInput, optFns ...func(*Options)) (*GetSolNetworkOperationOutput, error)

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

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

func (*Client) GetSolNetworkPackage 

func (c *Client) GetSolNetworkPackage(ctx context.Context, params *GetSolNetworkPackageInput, optFns ...func(*Options)) (*GetSolNetworkPackageOutput, error)

Gets the details of a network package.

A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.

func (*Client) GetSolNetworkPackageContent 

func (c *Client) GetSolNetworkPackageContent(ctx context.Context, params *GetSolNetworkPackageContentInput, optFns ...func(*Options)) (*GetSolNetworkPackageContentOutput, error)

Gets the contents of a network package.

A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.

func (*Client) GetSolNetworkPackageDescriptor 

func (c *Client) GetSolNetworkPackageDescriptor(ctx context.Context, params *GetSolNetworkPackageDescriptorInput, optFns ...func(*Options)) (*GetSolNetworkPackageDescriptorOutput, error)

Gets the content of the network service descriptor.

A network service descriptor is a .yaml file in a network package that uses the TOSCA standard to describe the network functions you want to deploy and the Amazon Web Services infrastructure you want to deploy the network functions on.

func (*Client) InstantiateSolNetworkInstance 

func (c *Client) InstantiateSolNetworkInstance(ctx context.Context, params *InstantiateSolNetworkInstanceInput, optFns ...func(*Options)) (*InstantiateSolNetworkInstanceOutput, error)

Instantiates a network instance.

A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.

Before you can instantiate a network instance, you have to create a network instance. For more information, see CreateSolNetworkInstance.

func (*Client) ListSolFunctionInstances 

func (c *Client) ListSolFunctionInstances(ctx context.Context, params *ListSolFunctionInstancesInput, optFns ...func(*Options)) (*ListSolFunctionInstancesOutput, error)

Lists network function instances.

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

func (*Client) ListSolFunctionPackages 

func (c *Client) ListSolFunctionPackages(ctx context.Context, params *ListSolFunctionPackagesInput, optFns ...func(*Options)) (*ListSolFunctionPackagesOutput, error)

Lists information about function packages.

A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.

func (*Client) ListSolNetworkInstances 

func (c *Client) ListSolNetworkInstances(ctx context.Context, params *ListSolNetworkInstancesInput, optFns ...func(*Options)) (*ListSolNetworkInstancesOutput, error)

Lists your network instances.

A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.

func (*Client) ListSolNetworkOperations 

func (c *Client) ListSolNetworkOperations(ctx context.Context, params *ListSolNetworkOperationsInput, optFns ...func(*Options)) (*ListSolNetworkOperationsOutput, error)

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

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

func (*Client) ListSolNetworkPackages 

func (c *Client) ListSolNetworkPackages(ctx context.Context, params *ListSolNetworkPackagesInput, optFns ...func(*Options)) (*ListSolNetworkPackagesOutput, error)

Lists network packages.

A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.

func (*Client) ListTagsForResource 

func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

Lists tags for AWS TNB resources.

func (*Client) Options added in v1.6.0 

func (c *Client) Options() Options

Options returns a copy of the client configuration.

Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.

func (*Client) PutSolFunctionPackageContent 

func (c *Client) PutSolFunctionPackageContent(ctx context.Context, params *PutSolFunctionPackageContentInput, optFns ...func(*Options)) (*PutSolFunctionPackageContentOutput, error)

Uploads the contents of a function package.

A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.

func (*Client) PutSolNetworkPackageContent 

func (c *Client) PutSolNetworkPackageContent(ctx context.Context, params *PutSolNetworkPackageContentInput, optFns ...func(*Options)) (*PutSolNetworkPackageContentOutput, error)

Uploads the contents of a network package.

A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.

func (*Client) TagResource 

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

Tags an AWS TNB resource.

A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.

func (*Client) TerminateSolNetworkInstance 

func (c *Client) TerminateSolNetworkInstance(ctx context.Context, params *TerminateSolNetworkInstanceInput, optFns ...func(*Options)) (*TerminateSolNetworkInstanceOutput, error)

Terminates a network instance.

A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.

You must terminate a network instance before you can delete it.

func (*Client) UntagResource 

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

Untags an AWS TNB resource.

A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.

func (*Client) UpdateSolFunctionPackage 

func (c *Client) UpdateSolFunctionPackage(ctx context.Context, params *UpdateSolFunctionPackageInput, optFns ...func(*Options)) (*UpdateSolFunctionPackageOutput, error)

Updates the operational state of function package.

A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.

func (*Client) UpdateSolNetworkInstance 

func (c *Client) UpdateSolNetworkInstance(ctx context.Context, params *UpdateSolNetworkInstanceInput, optFns ...func(*Options)) (*UpdateSolNetworkInstanceOutput, error)

Update a network instance.

A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.

Choose the updateType parameter to target the necessary update of the network instance.

func (*Client) UpdateSolNetworkPackage 

func (c *Client) UpdateSolNetworkPackage(ctx context.Context, params *UpdateSolNetworkPackageInput, optFns ...func(*Options)) (*UpdateSolNetworkPackageOutput, error)

Updates the operational state of a network package.

A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.

A network service descriptor is a .yaml file in a network package that uses the TOSCA standard to describe the network functions you want to deploy and the Amazon Web Services infrastructure you want to deploy the network functions on.

func (*Client) ValidateSolFunctionPackageContent 

func (c *Client) ValidateSolFunctionPackageContent(ctx context.Context, params *ValidateSolFunctionPackageContentInput, optFns ...func(*Options)) (*ValidateSolFunctionPackageContentOutput, error)

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

A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.

func (*Client) ValidateSolNetworkPackageContent 

func (c *Client) ValidateSolNetworkPackageContent(ctx context.Context, params *ValidateSolNetworkPackageContentInput, optFns ...func(*Options)) (*ValidateSolNetworkPackageContentOutput, error)

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

A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.

type CreateSolFunctionPackageInput 

type CreateSolFunctionPackageInput struct {

	// 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.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateSolFunctionPackageOutput 

type CreateSolFunctionPackageOutput struct {

	// Function package ARN.
	//
	// This member is required.
	Arn *string

	// ID of the function package.
	//
	// This member is required.
	Id *string

	// Onboarding state of the function package.
	//
	// This member is required.
	OnboardingState types.OnboardingState

	// Operational state of the function package.
	//
	// This member is required.
	OperationalState types.OperationalState

	// Usage state of the function package.
	//
	// This member is required.
	UsageState types.UsageState

	// 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.
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateSolNetworkInstanceInput 

type CreateSolNetworkInstanceInput struct {

	// Network instance name.
	//
	// This member is required.
	NsName *string

	// ID for network service descriptor.
	//
	// This member is required.
	NsdInfoId *string

	// Network instance description.
	NsDescription *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.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateSolNetworkInstanceOutput 

type CreateSolNetworkInstanceOutput struct {

	// Network instance ARN.
	//
	// This member is required.
	Arn *string

	// Network instance ID.
	//
	// This member is required.
	Id *string

	// Network instance name.
	//
	// This member is required.
	NsInstanceName *string

	// Network service descriptor ID.
	//
	// This member is required.
	NsdInfoId *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.
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateSolNetworkPackageInput 

type CreateSolNetworkPackageInput struct {

	// 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.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateSolNetworkPackageOutput 

type CreateSolNetworkPackageOutput struct {

	// Network package ARN.
	//
	// This member is required.
	Arn *string

	// ID of the network package.
	//
	// This member is required.
	Id *string

	// Onboarding state of the network service descriptor in the network package.
	//
	// This member is required.
	NsdOnboardingState types.NsdOnboardingState

	// Operational state of the network service descriptor in the network package.
	//
	// This member is required.
	NsdOperationalState types.NsdOperationalState

	// Usage state of the network service descriptor in the network package.
	//
	// This member is required.
	NsdUsageState types.NsdUsageState

	// 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.
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteSolFunctionPackageInput 

type DeleteSolFunctionPackageInput struct {

	// ID of the function package.
	//
	// This member is required.
	VnfPkgId *string
	// contains filtered or unexported fields
}

type DeleteSolFunctionPackageOutput 

type DeleteSolFunctionPackageOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteSolNetworkInstanceInput 

type DeleteSolNetworkInstanceInput struct {

	// Network instance ID.
	//
	// This member is required.
	NsInstanceId *string
	// contains filtered or unexported fields
}

type DeleteSolNetworkInstanceOutput 

type DeleteSolNetworkInstanceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteSolNetworkPackageInput 

type DeleteSolNetworkPackageInput struct {

	// ID of the network service descriptor in the network package.
	//
	// This member is required.
	NsdInfoId *string
	// contains filtered or unexported fields
}

type DeleteSolNetworkPackageOutput 

type DeleteSolNetworkPackageOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type EndpointParameters added in v1.2.0 

type EndpointParameters struct {
	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string

	// When true, use the dual-stack endpoint. If the configured endpoint does not
	// support dual-stack, dispatching the request MAY return an error.
	//
	// Defaults to
	// false if no value is provided.
	//
	// AWS::UseDualStack
	UseDualStack *bool

	// When true, send this request to the FIPS-compliant regional endpoint. If the
	// configured endpoint does not have a FIPS compliant endpoint, dispatching the
	// request will return an error.
	//
	// Defaults to false if no value is
	// provided.
	//
	// AWS::UseFIPS
	UseFIPS *bool

	// Override the endpoint used to send this request
	//
	// Parameter is
	// required.
	//
	// SDK::Endpoint
	Endpoint *string
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired added in v1.2.0 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults added in v1.2.0 

func (p EndpointParameters) WithDefaults() EndpointParameters

WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.

type EndpointResolver 

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL 

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc 

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint 

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 added in v1.2.0 

type EndpointResolverV2 interface {
	// ResolveEndpoint attempts to resolve the endpoint with the provided options,
	// returning the endpoint if found. Otherwise an error is returned.
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 added in v1.2.0 

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetSolFunctionInstanceInput 

type GetSolFunctionInstanceInput struct {

	// ID of the network function.
	//
	// This member is required.
	VnfInstanceId *string
	// contains filtered or unexported fields
}

type GetSolFunctionInstanceOutput 

type GetSolFunctionInstanceOutput struct {

	// Network function instance ARN.
	//
	// This member is required.
	Arn *string

	// Network function instance ID.
	//
	// This member is required.
	Id *string

	// Network function instantiation state.
	//
	// This member is required.
	InstantiationState types.VnfInstantiationState

	// The metadata of a network function instance.
	//
	// A network function instance is a function in a function package .
	//
	// This member is required.
	Metadata *types.GetSolFunctionInstanceMetadata

	// Network instance ID.
	//
	// This member is required.
	NsInstanceId *string

	// Function package ID.
	//
	// This member is required.
	VnfPkgId *string

	// Function package descriptor ID.
	//
	// This member is required.
	VnfdId *string

	// Information about the network function.
	//
	// A network function instance is a function in a function package .
	InstantiatedVnfInfo *types.GetSolVnfInfo

	// 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.
	Tags map[string]string

	// Network function product name.
	VnfProductName *string

	// Network function provider.
	VnfProvider *string

	// Function package descriptor version.
	VnfdVersion *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetSolFunctionPackageContentInput 

type GetSolFunctionPackageContentInput struct {

	// The format of the package that you want to download from the function packages.
	//
	// This member is required.
	Accept types.PackageContentType

	// ID of the function package.
	//
	// This member is required.
	VnfPkgId *string
	// contains filtered or unexported fields
}

type GetSolFunctionPackageContentOutput 

type GetSolFunctionPackageContentOutput struct {

	// Indicates the media type of the resource.
	ContentType types.PackageContentType

	// Contents of the function package.
	PackageContent []byte

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetSolFunctionPackageDescriptorInput 

type GetSolFunctionPackageDescriptorInput struct {

	// Indicates which content types, expressed as MIME types, the client is able to
	// understand.
	//
	// This member is required.
	Accept types.DescriptorContentType

	// ID of the function package.
	//
	// This member is required.
	VnfPkgId *string
	// contains filtered or unexported fields
}

type GetSolFunctionPackageDescriptorOutput 

type GetSolFunctionPackageDescriptorOutput struct {

	// Indicates the media type of the resource.
	ContentType types.DescriptorContentType

	// Contents of the function package descriptor.
	Vnfd []byte

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetSolFunctionPackageInput 

type GetSolFunctionPackageInput struct {

	// ID of the function package.
	//
	// This member is required.
	VnfPkgId *string
	// contains filtered or unexported fields
}

type GetSolFunctionPackageOutput 

type GetSolFunctionPackageOutput struct {

	// Function package ARN.
	//
	// This member is required.
	Arn *string

	// Function package ID.
	//
	// This member is required.
	Id *string

	// Function package onboarding state.
	//
	// This member is required.
	OnboardingState types.OnboardingState

	// Function package operational state.
	//
	// This member is required.
	OperationalState types.OperationalState

	// Function package usage state.
	//
	// This member is required.
	UsageState types.UsageState

	// 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.
	Metadata *types.GetSolFunctionPackageMetadata

	// 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.
	Tags map[string]string

	// Network function product name.
	VnfProductName *string

	// Network function provider.
	VnfProvider *string

	// Function package descriptor ID.
	VnfdId *string

	// Function package descriptor version.
	VnfdVersion *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetSolNetworkInstanceInput 

type GetSolNetworkInstanceInput struct {

	// ID of the network instance.
	//
	// This member is required.
	NsInstanceId *string
	// contains filtered or unexported fields
}

type GetSolNetworkInstanceOutput 

type GetSolNetworkInstanceOutput struct {

	// Network instance ARN.
	//
	// This member is required.
	Arn *string

	// Network instance ID.
	//
	// This member is required.
	Id *string

	// 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.
	//
	// This member is required.
	Metadata *types.GetSolNetworkInstanceMetadata

	// Network instance description.
	//
	// This member is required.
	NsInstanceDescription *string

	// Network instance name.
	//
	// This member is required.
	NsInstanceName *string

	// Network service descriptor ID.
	//
	// This member is required.
	NsdId *string

	// Network service descriptor info ID.
	//
	// This member is required.
	NsdInfoId *string

	// Lifecycle management operation details on the network instance.
	//
	// Lifecycle management operations are deploy, update, or delete operations.
	LcmOpInfo *types.LcmOperationInfo

	// Network instance state.
	NsState types.NsState

	// 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.
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetSolNetworkOperationInput 

type GetSolNetworkOperationInput struct {

	// The identifier of the network operation.
	//
	// This member is required.
	NsLcmOpOccId *string
	// contains filtered or unexported fields
}

type GetSolNetworkOperationOutput 

type GetSolNetworkOperationOutput struct {

	// Network operation ARN.
	//
	// This member is required.
	Arn *string

	// Error related to this specific network operation occurrence.
	Error *types.ProblemDetails

	// ID of this network operation occurrence.
	Id *string

	// Type of the operation represented by this occurrence.
	LcmOperationType types.LcmOperationType

	// Metadata of this network operation occurrence.
	Metadata *types.GetSolNetworkOperationMetadata

	// ID of the network operation instance.
	NsInstanceId *string

	// The state of the network operation.
	OperationState types.NsLcmOperationState

	// 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.
	Tags map[string]string

	// All tasks associated with this operation occurrence.
	Tasks []types.GetSolNetworkOperationTaskDetails

	// Type of the update. Only present if the network operation lcmOperationType is
	// UPDATE .
	UpdateType types.UpdateSolNetworkType

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetSolNetworkPackageContentInput 

type GetSolNetworkPackageContentInput struct {

	// The format of the package you want to download from the network package.
	//
	// This member is required.
	Accept types.PackageContentType

	// ID of the network service descriptor in the network package.
	//
	// This member is required.
	NsdInfoId *string
	// contains filtered or unexported fields
}

type GetSolNetworkPackageContentOutput 

type GetSolNetworkPackageContentOutput struct {

	// Indicates the media type of the resource.
	ContentType types.PackageContentType

	// Content of the network service descriptor in the network package.
	NsdContent []byte

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetSolNetworkPackageDescriptorInput 

type GetSolNetworkPackageDescriptorInput struct {

	// ID of the network service descriptor in the network package.
	//
	// This member is required.
	NsdInfoId *string
	// contains filtered or unexported fields
}

type GetSolNetworkPackageDescriptorOutput 

type GetSolNetworkPackageDescriptorOutput struct {

	// Indicates the media type of the resource.
	ContentType types.DescriptorContentType

	// Contents of the network service descriptor in the network package.
	Nsd []byte

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetSolNetworkPackageInput 

type GetSolNetworkPackageInput struct {

	// ID of the network service descriptor in the network package.
	//
	// This member is required.
	NsdInfoId *string
	// contains filtered or unexported fields
}

type GetSolNetworkPackageOutput 

type GetSolNetworkPackageOutput struct {

	// Network package ARN.
	//
	// This member is required.
	Arn *string

	// Network package ID.
	//
	// This member is required.
	Id *string

	// 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.
	//
	// This member is required.
	Metadata *types.GetSolNetworkPackageMetadata

	// Network service descriptor ID.
	//
	// This member is required.
	NsdId *string

	// Network service descriptor name.
	//
	// This member is required.
	NsdName *string

	// Network service descriptor onboarding state.
	//
	// This member is required.
	NsdOnboardingState types.NsdOnboardingState

	// Network service descriptor operational state.
	//
	// This member is required.
	NsdOperationalState types.NsdOperationalState

	// Network service descriptor usage state.
	//
	// This member is required.
	NsdUsageState types.NsdUsageState

	// Network service descriptor version.
	//
	// This member is required.
	NsdVersion *string

	// Identifies the function package for the function package descriptor referenced
	// by the onboarded network package.
	//
	// This member is required.
	VnfPkgIds []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.
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type HTTPClient 

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4 

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type InstantiateSolNetworkInstanceInput 

type InstantiateSolNetworkInstanceInput struct {

	// ID of the network instance.
	//
	// This member is required.
	NsInstanceId *string

	// Provides values for the configurable properties.
	AdditionalParamsForNs document.Interface

	// 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 .
	DryRun *bool

	// 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.
	Tags map[string]string
	// contains filtered or unexported fields
}

type InstantiateSolNetworkInstanceOutput 

type InstantiateSolNetworkInstanceOutput struct {

	// The identifier of the network operation.
	//
	// This member is required.
	NsLcmOpOccId *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
	// 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.
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListSolFunctionInstancesAPIClient 

type ListSolFunctionInstancesAPIClient interface {
	ListSolFunctionInstances(context.Context, *ListSolFunctionInstancesInput, ...func(*Options)) (*ListSolFunctionInstancesOutput, error)
}

ListSolFunctionInstancesAPIClient is a client that implements the ListSolFunctionInstances operation.

type ListSolFunctionInstancesInput 

type ListSolFunctionInstancesInput struct {

	// The maximum number of results to include in the response.
	MaxResults *int32

	// The token for the next page of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListSolFunctionInstancesOutput 

type ListSolFunctionInstancesOutput struct {

	// Network function instances.
	FunctionInstances []types.ListSolFunctionInstanceInfo

	// The token to use to retrieve the next page of results. This value is null when
	// there are no more results to return.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListSolFunctionInstancesPaginator 

type ListSolFunctionInstancesPaginator struct {
	// contains filtered or unexported fields
}

ListSolFunctionInstancesPaginator is a paginator for ListSolFunctionInstances

func NewListSolFunctionInstancesPaginator 

func NewListSolFunctionInstancesPaginator(client ListSolFunctionInstancesAPIClient, params *ListSolFunctionInstancesInput, optFns ...func(*ListSolFunctionInstancesPaginatorOptions)) *ListSolFunctionInstancesPaginator

NewListSolFunctionInstancesPaginator returns a new ListSolFunctionInstancesPaginator

func (*ListSolFunctionInstancesPaginator) HasMorePages 

func (p *ListSolFunctionInstancesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListSolFunctionInstancesPaginator) NextPage 

func (p *ListSolFunctionInstancesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSolFunctionInstancesOutput, error)

NextPage retrieves the next ListSolFunctionInstances page.

type ListSolFunctionInstancesPaginatorOptions 

type ListSolFunctionInstancesPaginatorOptions struct {
	// The maximum number of results to include in the response.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListSolFunctionInstancesPaginatorOptions is the paginator options for ListSolFunctionInstances

type ListSolFunctionPackagesAPIClient 

type ListSolFunctionPackagesAPIClient interface {
	ListSolFunctionPackages(context.Context, *ListSolFunctionPackagesInput, ...func(*Options)) (*ListSolFunctionPackagesOutput, error)
}

ListSolFunctionPackagesAPIClient is a client that implements the ListSolFunctionPackages operation.

type ListSolFunctionPackagesInput 

type ListSolFunctionPackagesInput struct {

	// The maximum number of results to include in the response.
	MaxResults *int32

	// The token for the next page of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListSolFunctionPackagesOutput 

type ListSolFunctionPackagesOutput struct {

	// 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.
	//
	// This member is required.
	FunctionPackages []types.ListSolFunctionPackageInfo

	// The token to use to retrieve the next page of results. This value is null when
	// there are no more results to return.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListSolFunctionPackagesPaginator 

type ListSolFunctionPackagesPaginator struct {
	// contains filtered or unexported fields
}

ListSolFunctionPackagesPaginator is a paginator for ListSolFunctionPackages

func NewListSolFunctionPackagesPaginator 

func NewListSolFunctionPackagesPaginator(client ListSolFunctionPackagesAPIClient, params *ListSolFunctionPackagesInput, optFns ...func(*ListSolFunctionPackagesPaginatorOptions)) *ListSolFunctionPackagesPaginator

NewListSolFunctionPackagesPaginator returns a new ListSolFunctionPackagesPaginator

func (*ListSolFunctionPackagesPaginator) HasMorePages 

func (p *ListSolFunctionPackagesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListSolFunctionPackagesPaginator) NextPage 

func (p *ListSolFunctionPackagesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSolFunctionPackagesOutput, error)

NextPage retrieves the next ListSolFunctionPackages page.

type ListSolFunctionPackagesPaginatorOptions 

type ListSolFunctionPackagesPaginatorOptions struct {
	// The maximum number of results to include in the response.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListSolFunctionPackagesPaginatorOptions is the paginator options for ListSolFunctionPackages

type ListSolNetworkInstancesAPIClient 

type ListSolNetworkInstancesAPIClient interface {
	ListSolNetworkInstances(context.Context, *ListSolNetworkInstancesInput, ...func(*Options)) (*ListSolNetworkInstancesOutput, error)
}

ListSolNetworkInstancesAPIClient is a client that implements the ListSolNetworkInstances operation.

type ListSolNetworkInstancesInput 

type ListSolNetworkInstancesInput struct {

	// The maximum number of results to include in the response.
	MaxResults *int32

	// The token for the next page of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListSolNetworkInstancesOutput 

type ListSolNetworkInstancesOutput struct {

	// Lists network instances.
	NetworkInstances []types.ListSolNetworkInstanceInfo

	// The token to use to retrieve the next page of results. This value is null when
	// there are no more results to return.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListSolNetworkInstancesPaginator 

type ListSolNetworkInstancesPaginator struct {
	// contains filtered or unexported fields
}

ListSolNetworkInstancesPaginator is a paginator for ListSolNetworkInstances

func NewListSolNetworkInstancesPaginator 

func NewListSolNetworkInstancesPaginator(client ListSolNetworkInstancesAPIClient, params *ListSolNetworkInstancesInput, optFns ...func(*ListSolNetworkInstancesPaginatorOptions)) *ListSolNetworkInstancesPaginator

NewListSolNetworkInstancesPaginator returns a new ListSolNetworkInstancesPaginator

func (*ListSolNetworkInstancesPaginator) HasMorePages 

func (p *ListSolNetworkInstancesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListSolNetworkInstancesPaginator) NextPage 

func (p *ListSolNetworkInstancesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSolNetworkInstancesOutput, error)

NextPage retrieves the next ListSolNetworkInstances page.

type ListSolNetworkInstancesPaginatorOptions 

type ListSolNetworkInstancesPaginatorOptions struct {
	// The maximum number of results to include in the response.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListSolNetworkInstancesPaginatorOptions is the paginator options for ListSolNetworkInstances

type ListSolNetworkOperationsAPIClient 

type ListSolNetworkOperationsAPIClient interface {
	ListSolNetworkOperations(context.Context, *ListSolNetworkOperationsInput, ...func(*Options)) (*ListSolNetworkOperationsOutput, error)
}

ListSolNetworkOperationsAPIClient is a client that implements the ListSolNetworkOperations operation.

type ListSolNetworkOperationsInput 

type ListSolNetworkOperationsInput struct {

	// The maximum number of results to include in the response.
	MaxResults *int32

	// The token for the next page of results.
	NextToken *string

	// Network instance id filter, to retrieve network operations associated to a
	// network instance.
	NsInstanceId *string
	// contains filtered or unexported fields
}

type ListSolNetworkOperationsOutput 

type ListSolNetworkOperationsOutput struct {

	// Lists network operation occurrences. Lifecycle management operations are
	// deploy, update, or delete operations.
	NetworkOperations []types.ListSolNetworkOperationsInfo

	// The token to use to retrieve the next page of results. This value is null when
	// there are no more results to return.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListSolNetworkOperationsPaginator 

type ListSolNetworkOperationsPaginator struct {
	// contains filtered or unexported fields
}

ListSolNetworkOperationsPaginator is a paginator for ListSolNetworkOperations

func NewListSolNetworkOperationsPaginator 

func NewListSolNetworkOperationsPaginator(client ListSolNetworkOperationsAPIClient, params *ListSolNetworkOperationsInput, optFns ...func(*ListSolNetworkOperationsPaginatorOptions)) *ListSolNetworkOperationsPaginator

NewListSolNetworkOperationsPaginator returns a new ListSolNetworkOperationsPaginator

func (*ListSolNetworkOperationsPaginator) HasMorePages 

func (p *ListSolNetworkOperationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListSolNetworkOperationsPaginator) NextPage 

func (p *ListSolNetworkOperationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSolNetworkOperationsOutput, error)

NextPage retrieves the next ListSolNetworkOperations page.

type ListSolNetworkOperationsPaginatorOptions 

type ListSolNetworkOperationsPaginatorOptions struct {
	// The maximum number of results to include in the response.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListSolNetworkOperationsPaginatorOptions is the paginator options for ListSolNetworkOperations

type ListSolNetworkPackagesAPIClient 

type ListSolNetworkPackagesAPIClient interface {
	ListSolNetworkPackages(context.Context, *ListSolNetworkPackagesInput, ...func(*Options)) (*ListSolNetworkPackagesOutput, error)
}

ListSolNetworkPackagesAPIClient is a client that implements the ListSolNetworkPackages operation.

type ListSolNetworkPackagesInput 

type ListSolNetworkPackagesInput struct {

	// The maximum number of results to include in the response.
	MaxResults *int32

	// The token for the next page of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListSolNetworkPackagesOutput 

type ListSolNetworkPackagesOutput struct {

	// 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.
	//
	// This member is required.
	NetworkPackages []types.ListSolNetworkPackageInfo

	// The token to use to retrieve the next page of results. This value is null when
	// there are no more results to return.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListSolNetworkPackagesPaginator 

type ListSolNetworkPackagesPaginator struct {
	// contains filtered or unexported fields
}

ListSolNetworkPackagesPaginator is a paginator for ListSolNetworkPackages

func NewListSolNetworkPackagesPaginator 

func NewListSolNetworkPackagesPaginator(client ListSolNetworkPackagesAPIClient, params *ListSolNetworkPackagesInput, optFns ...func(*ListSolNetworkPackagesPaginatorOptions)) *ListSolNetworkPackagesPaginator

NewListSolNetworkPackagesPaginator returns a new ListSolNetworkPackagesPaginator

func (*ListSolNetworkPackagesPaginator) HasMorePages 

func (p *ListSolNetworkPackagesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListSolNetworkPackagesPaginator) NextPage 

func (p *ListSolNetworkPackagesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSolNetworkPackagesOutput, error)

NextPage retrieves the next ListSolNetworkPackages page.

type ListSolNetworkPackagesPaginatorOptions 

type ListSolNetworkPackagesPaginatorOptions struct {
	// The maximum number of results to include in the response.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListSolNetworkPackagesPaginatorOptions is the paginator options for ListSolNetworkPackages

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// Resource ARN.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// 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.
	//
	// This member is required.
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type Options 

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// The optional application specific identifier appended to the User-Agent header.
	AppID string

	// This endpoint will be given as input to an EndpointResolverV2. It is used for
	// providing a custom base endpoint that is subject to modifications by the
	// processing EndpointResolverV2.
	BaseEndpoint *string

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	//
	// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
	// value for this field will likely prevent you from using any endpoint-related
	// service features released after the introduction of EndpointResolverV2 and
	// BaseEndpoint.
	//
	// To migrate an EndpointResolver implementation that uses a custom endpoint, set
	// the client option BaseEndpoint instead.
	EndpointResolver EndpointResolver

	// Resolves the endpoint used for a particular service operation. This should be
	// used over the deprecated EndpointResolver.
	EndpointResolverV2 EndpointResolverV2

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The client meter provider.
	MeterProvider metrics.MeterProvider

	// The region to send requests to. (Required)
	Region string

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts.
	//
	// If specified in an operation call's functional options with a value that is
	// different than the constructed client's Options, the Client's Retryer will be
	// wrapped to use the operation's specific RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified.
	//
	// When creating a new API Clients this member will only be used if the Retryer
	// Options member is nil. This value will be ignored if Retryer is not nil.
	//
	// Currently does not support per operation call overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

	// The client tracer provider.
	TracerProvider tracing.TracerProvider

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient

	// The auth scheme resolver which determines how to authenticate for each
	// operation.
	AuthSchemeResolver AuthSchemeResolver

	// The list of auth schemes supported by the client.
	AuthSchemes []smithyhttp.AuthScheme
	// contains filtered or unexported fields
}

func (Options) Copy 

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

func (Options) GetIdentityResolver added in v1.5.2 

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver

type PutSolFunctionPackageContentInput 

type PutSolFunctionPackageContentInput struct {

	// Function package file.
	//
	// This member is required.
	File []byte

	// Function package ID.
	//
	// This member is required.
	VnfPkgId *string

	// Function package content type.
	ContentType types.PackageContentType
	// contains filtered or unexported fields
}

type PutSolFunctionPackageContentOutput 

type PutSolFunctionPackageContentOutput struct {

	// Function package ID.
	//
	// This member is required.
	Id *string

	// Function package metadata.
	//
	// This member is required.
	Metadata *types.PutSolFunctionPackageContentMetadata

	// Function product name.
	//
	// This member is required.
	VnfProductName *string

	// Function provider.
	//
	// This member is required.
	VnfProvider *string

	// Function package descriptor ID.
	//
	// This member is required.
	VnfdId *string

	// Function package descriptor version.
	//
	// This member is required.
	VnfdVersion *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type PutSolNetworkPackageContentInput 

type PutSolNetworkPackageContentInput struct {

	// Network package file.
	//
	// This member is required.
	File []byte

	// Network service descriptor info ID.
	//
	// This member is required.
	NsdInfoId *string

	// Network package content type.
	ContentType types.PackageContentType
	// contains filtered or unexported fields
}

type PutSolNetworkPackageContentOutput 

type PutSolNetworkPackageContentOutput struct {

	// Network package ARN.
	//
	// This member is required.
	Arn *string

	// Network package ID.
	//
	// This member is required.
	Id *string

	// Network package metadata.
	//
	// This member is required.
	Metadata *types.PutSolNetworkPackageContentMetadata

	// Network service descriptor ID.
	//
	// This member is required.
	NsdId *string

	// Network service descriptor name.
	//
	// This member is required.
	NsdName *string

	// Network service descriptor version.
	//
	// This member is required.
	NsdVersion *string

	// Function package IDs.
	//
	// This member is required.
	VnfPkgIds []string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize 

func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
	out middleware.SerializeOutput, metadata middleware.Metadata, err error,
)

func (*ResolveEndpoint) ID 

func (*ResolveEndpoint) ID() string

type TagResourceInput 

type TagResourceInput struct {

	// Resource ARN.
	//
	// This member is required.
	ResourceArn *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.
	//
	// This member is required.
	Tags map[string]string
	// contains filtered or unexported fields
}

type TagResourceOutput 

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type TerminateSolNetworkInstanceInput 

type TerminateSolNetworkInstanceInput struct {

	// ID of the network instance.
	//
	// This member is required.
	NsInstanceId *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
	// 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.
	Tags map[string]string
	// contains filtered or unexported fields
}

type TerminateSolNetworkInstanceOutput 

type TerminateSolNetworkInstanceOutput struct {

	// The identifier of the network operation.
	NsLcmOpOccId *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
	// 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.
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UntagResourceInput 

type UntagResourceInput struct {

	// Resource ARN.
	//
	// This member is required.
	ResourceArn *string

	// Tag keys.
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

type UntagResourceOutput 

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateSolFunctionPackageInput 

type UpdateSolFunctionPackageInput struct {

	// Operational state of the function package.
	//
	// This member is required.
	OperationalState types.OperationalState

	// ID of the function package.
	//
	// This member is required.
	VnfPkgId *string
	// contains filtered or unexported fields
}

type UpdateSolFunctionPackageOutput 

type UpdateSolFunctionPackageOutput struct {

	// Operational state of the function package.
	//
	// This member is required.
	OperationalState types.OperationalState

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateSolNetworkInstanceInput 

type UpdateSolNetworkInstanceInput struct {

	// ID of the network instance.
	//
	// This member is required.
	NsInstanceId *string

	// 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.
	//
	// This member is required.
	UpdateType types.UpdateSolNetworkType

	// 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 .
	ModifyVnfInfoData *types.UpdateSolNetworkModify

	// 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.
	Tags map[string]string

	// 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 .
	UpdateNs *types.UpdateSolNetworkServiceData
	// contains filtered or unexported fields
}

type UpdateSolNetworkInstanceOutput 

type UpdateSolNetworkInstanceOutput struct {

	// The identifier of the network operation.
	NsLcmOpOccId *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
	// 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.
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateSolNetworkPackageInput 

type UpdateSolNetworkPackageInput struct {

	// ID of the network service descriptor in the network package.
	//
	// This member is required.
	NsdInfoId *string

	// Operational state of the network service descriptor in the network package.
	//
	// This member is required.
	NsdOperationalState types.NsdOperationalState
	// contains filtered or unexported fields
}

type UpdateSolNetworkPackageOutput 

type UpdateSolNetworkPackageOutput struct {

	// Operational state of the network service descriptor in the network package.
	//
	// This member is required.
	NsdOperationalState types.NsdOperationalState

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ValidateSolFunctionPackageContentInput 

type ValidateSolFunctionPackageContentInput struct {

	// Function package file.
	//
	// This member is required.
	File []byte

	// Function package ID.
	//
	// This member is required.
	VnfPkgId *string

	// Function package content type.
	ContentType types.PackageContentType
	// contains filtered or unexported fields
}

type ValidateSolFunctionPackageContentOutput 

type ValidateSolFunctionPackageContentOutput struct {

	// Function package ID.
	//
	// This member is required.
	Id *string

	// Function package metadata.
	//
	// This member is required.
	Metadata *types.ValidateSolFunctionPackageContentMetadata

	// Network function product name.
	//
	// This member is required.
	VnfProductName *string

	// Network function provider.
	//
	// This member is required.
	VnfProvider *string

	// Function package descriptor ID.
	//
	// This member is required.
	VnfdId *string

	// Function package descriptor version.
	//
	// This member is required.
	VnfdVersion *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ValidateSolNetworkPackageContentInput 

type ValidateSolNetworkPackageContentInput struct {

	// Network package file.
	//
	// This member is required.
	File []byte

	// Network service descriptor file.
	//
	// This member is required.
	NsdInfoId *string

	// Network package content type.
	ContentType types.PackageContentType
	// contains filtered or unexported fields
}

type ValidateSolNetworkPackageContentOutput 

type ValidateSolNetworkPackageContentOutput struct {

	// Network package ARN.
	//
	// This member is required.
	Arn *string

	// Network package ID.
	//
	// This member is required.
	Id *string

	// Network package metadata.
	//
	// This member is required.
	Metadata *types.ValidateSolNetworkPackageContentMetadata

	// Network service descriptor ID.
	//
	// This member is required.
	NsdId *string

	// Network service descriptor name.
	//
	// This member is required.
	NsdName *string

	// Network service descriptor version.
	//
	// This member is required.
	NsdVersion *string

	// Function package IDs.
	//
	// This member is required.
	VnfPkgIds []string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Source Files

View all Source files

Directories

Path Synopsis
Package document implements encoding and decoding of open-content that has a JSON-like data model.
 Package document implements encoding and decoding of open-content that has a JSON-like data model.
internal
document
endpoints

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.