privatenetworks

package module
v1.9.4 Latest Latest
Warning

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

Go to latest
Published: Mar 29, 2024 License: Apache-2.0 Imports: 40 Imported by: 2

Documentation

Overview

Package privatenetworks provides the API client, operations, and parameter types for AWS Private 5G.

Amazon Web Services Private 5G is a managed service that makes it easy to deploy, operate, and scale your own private mobile network at your on-premises location. Private 5G provides the pre-configured hardware and software for mobile networks, helps automate setup, and scales capacity on demand to support additional devices as needed.

Index

Constants

View Source
const ServiceAPIVersion = "2021-12-03"
View Source
const ServiceID = "PrivateNetworks"

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.4.0

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

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

func WithSigV4SigningName added in v1.6.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.6.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 AcknowledgeOrderReceiptInput

type AcknowledgeOrderReceiptInput struct {

	// The Amazon Resource Name (ARN) of the order.
	//
	// This member is required.
	OrderArn *string
	// contains filtered or unexported fields
}

type AcknowledgeOrderReceiptOutput

type AcknowledgeOrderReceiptOutput struct {

	// Information about the order.
	//
	// This member is required.
	Order *types.Order

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

type ActivateDeviceIdentifierInput

type ActivateDeviceIdentifierInput struct {

	// The Amazon Resource Name (ARN) of the device identifier.
	//
	// This member is required.
	DeviceIdentifierArn *string

	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
	// the request. For more information, see How to ensure idempotency (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html)
	// .
	ClientToken *string
	// contains filtered or unexported fields
}

type ActivateDeviceIdentifierOutput

type ActivateDeviceIdentifierOutput struct {

	// Information about the device identifier.
	//
	// This member is required.
	DeviceIdentifier *types.DeviceIdentifier

	// The tags on the device identifier.
	Tags map[string]string

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

type ActivateNetworkSiteInput

type ActivateNetworkSiteInput struct {

	// The Amazon Resource Name (ARN) of the network site.
	//
	// This member is required.
	NetworkSiteArn *string

	// The shipping address of the network site.
	//
	// This member is required.
	ShippingAddress *types.Address

	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
	// the request. For more information, see How to ensure idempotency (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html)
	// .
	ClientToken *string

	// Determines the duration and renewal status of the commitment period for all
	// pending radio units. If you include commitmentConfiguration in the
	// ActivateNetworkSiteRequest action, you must specify the following:
	//   - The commitment period for the radio unit. You can choose a 60-day, 1-year,
	//   or 3-year period.
	//   - Whether you want your commitment period to automatically renew for one more
	//   year after your current commitment period expires.
	// For pricing, see Amazon Web Services Private 5G Pricing (http://aws.amazon.com/private5g/pricing)
	// . If you do not include commitmentConfiguration in the
	// ActivateNetworkSiteRequest action, the commitment period is set to 60-days.
	CommitmentConfiguration *types.CommitmentConfiguration
	// contains filtered or unexported fields
}

type ActivateNetworkSiteOutput

type ActivateNetworkSiteOutput struct {

	// Information about the network site.
	NetworkSite *types.NetworkSite

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

type AuthResolverParameters added in v1.6.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.6.2

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

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

type Client

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

Client provides the API client to make operations call for AWS Private 5G.

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) AcknowledgeOrderReceipt

func (c *Client) AcknowledgeOrderReceipt(ctx context.Context, params *AcknowledgeOrderReceiptInput, optFns ...func(*Options)) (*AcknowledgeOrderReceiptOutput, error)

Acknowledges that the specified network order was received.

func (*Client) ActivateDeviceIdentifier

func (c *Client) ActivateDeviceIdentifier(ctx context.Context, params *ActivateDeviceIdentifierInput, optFns ...func(*Options)) (*ActivateDeviceIdentifierOutput, error)

Activates the specified device identifier.

func (*Client) ActivateNetworkSite

func (c *Client) ActivateNetworkSite(ctx context.Context, params *ActivateNetworkSiteInput, optFns ...func(*Options)) (*ActivateNetworkSiteOutput, error)

Activates the specified network site.

func (*Client) ConfigureAccessPoint

func (c *Client) ConfigureAccessPoint(ctx context.Context, params *ConfigureAccessPointInput, optFns ...func(*Options)) (*ConfigureAccessPointOutput, error)

Configures the specified network resource. Use this action to specify the geographic position of the hardware. You must provide Certified Professional Installer (CPI) credentials in the request so that we can obtain spectrum grants. For more information, see Radio units (https://docs.aws.amazon.com/private-networks/latest/userguide/radio-units.html) in the Amazon Web Services Private 5G User Guide.

func (*Client) CreateNetwork

func (c *Client) CreateNetwork(ctx context.Context, params *CreateNetworkInput, optFns ...func(*Options)) (*CreateNetworkOutput, error)

Creates a network.

func (*Client) CreateNetworkSite

func (c *Client) CreateNetworkSite(ctx context.Context, params *CreateNetworkSiteInput, optFns ...func(*Options)) (*CreateNetworkSiteOutput, error)

Creates a network site.

func (*Client) DeactivateDeviceIdentifier

func (c *Client) DeactivateDeviceIdentifier(ctx context.Context, params *DeactivateDeviceIdentifierInput, optFns ...func(*Options)) (*DeactivateDeviceIdentifierOutput, error)

Deactivates the specified device identifier.

func (*Client) DeleteNetwork

func (c *Client) DeleteNetwork(ctx context.Context, params *DeleteNetworkInput, optFns ...func(*Options)) (*DeleteNetworkOutput, error)

Deletes the specified network. You must delete network sites before you delete the network. For more information, see DeleteNetworkSite (https://docs.aws.amazon.com/private-networks/latest/APIReference/API_DeleteNetworkSite.html) in the API Reference for Amazon Web Services Private 5G.

func (*Client) DeleteNetworkSite

func (c *Client) DeleteNetworkSite(ctx context.Context, params *DeleteNetworkSiteInput, optFns ...func(*Options)) (*DeleteNetworkSiteOutput, error)

Deletes the specified network site. Return the hardware after you delete the network site. You are responsible for minimum charges. For more information, see Hardware returns (https://docs.aws.amazon.com/private-networks/latest/userguide/hardware-maintenance.html) in the Amazon Web Services Private 5G User Guide.

func (*Client) GetDeviceIdentifier

func (c *Client) GetDeviceIdentifier(ctx context.Context, params *GetDeviceIdentifierInput, optFns ...func(*Options)) (*GetDeviceIdentifierOutput, error)

Gets the specified device identifier.

func (*Client) GetNetwork

func (c *Client) GetNetwork(ctx context.Context, params *GetNetworkInput, optFns ...func(*Options)) (*GetNetworkOutput, error)

Gets the specified network.

func (*Client) GetNetworkResource

func (c *Client) GetNetworkResource(ctx context.Context, params *GetNetworkResourceInput, optFns ...func(*Options)) (*GetNetworkResourceOutput, error)

Gets the specified network resource.

func (*Client) GetNetworkSite

func (c *Client) GetNetworkSite(ctx context.Context, params *GetNetworkSiteInput, optFns ...func(*Options)) (*GetNetworkSiteOutput, error)

Gets the specified network site.

func (*Client) GetOrder

func (c *Client) GetOrder(ctx context.Context, params *GetOrderInput, optFns ...func(*Options)) (*GetOrderOutput, error)

Gets the specified order.

func (*Client) ListDeviceIdentifiers

func (c *Client) ListDeviceIdentifiers(ctx context.Context, params *ListDeviceIdentifiersInput, optFns ...func(*Options)) (*ListDeviceIdentifiersOutput, error)

Lists device identifiers. Add filters to your request to return a more specific list of results. Use filters to match the Amazon Resource Name (ARN) of an order, the status of device identifiers, or the ARN of the traffic group. If you specify multiple filters, filters are joined with an OR, and the request returns results that match all of the specified filters.

func (*Client) ListNetworkResources

func (c *Client) ListNetworkResources(ctx context.Context, params *ListNetworkResourcesInput, optFns ...func(*Options)) (*ListNetworkResourcesOutput, error)

Lists network resources. Add filters to your request to return a more specific list of results. Use filters to match the Amazon Resource Name (ARN) of an order or the status of network resources. If you specify multiple filters, filters are joined with an OR, and the request returns results that match all of the specified filters.

func (*Client) ListNetworkSites

func (c *Client) ListNetworkSites(ctx context.Context, params *ListNetworkSitesInput, optFns ...func(*Options)) (*ListNetworkSitesOutput, error)

Lists network sites. Add filters to your request to return a more specific list of results. Use filters to match the status of the network site.

func (*Client) ListNetworks

func (c *Client) ListNetworks(ctx context.Context, params *ListNetworksInput, optFns ...func(*Options)) (*ListNetworksOutput, error)

Lists networks. Add filters to your request to return a more specific list of results. Use filters to match the status of the network.

func (*Client) ListOrders

func (c *Client) ListOrders(ctx context.Context, params *ListOrdersInput, optFns ...func(*Options)) (*ListOrdersOutput, error)

Lists orders. Add filters to your request to return a more specific list of results. Use filters to match the Amazon Resource Name (ARN) of the network site or the status of the order. If you specify multiple filters, filters are joined with an OR, and the request returns results that match all of the specified filters.

func (*Client) ListTagsForResource

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

Lists the tags for the specified resource.

func (*Client) Options added in v1.7.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) Ping

func (c *Client) Ping(ctx context.Context, params *PingInput, optFns ...func(*Options)) (*PingOutput, error)

Checks the health of the service.

func (*Client) StartNetworkResourceUpdate added in v1.2.0

func (c *Client) StartNetworkResourceUpdate(ctx context.Context, params *StartNetworkResourceUpdateInput, optFns ...func(*Options)) (*StartNetworkResourceUpdateOutput, error)

Use this action to do the following tasks:

  • Update the duration and renewal status of the commitment period for a radio unit. The update goes into effect immediately.
  • Request a replacement for a network resource.
  • Request that you return a network resource.

After you submit a request to replace or return a network resource, the status of the network resource changes to CREATING_SHIPPING_LABEL . The shipping label is available when the status of the network resource is PENDING_RETURN . After the network resource is successfully returned, its status changes to DELETED . For more information, see Return a radio unit (https://docs.aws.amazon.com/private-networks/latest/userguide/radio-units.html#return-radio-unit) .

func (*Client) TagResource

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

Adds tags to the specified resource.

func (*Client) UntagResource

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

Removes tags from the specified resource.

func (*Client) UpdateNetworkSite

func (c *Client) UpdateNetworkSite(ctx context.Context, params *UpdateNetworkSiteInput, optFns ...func(*Options)) (*UpdateNetworkSiteOutput, error)

Updates the specified network site.

func (*Client) UpdateNetworkSitePlan

func (c *Client) UpdateNetworkSitePlan(ctx context.Context, params *UpdateNetworkSitePlanInput, optFns ...func(*Options)) (*UpdateNetworkSitePlanOutput, error)

Updates the specified network site plan.

type ConfigureAccessPointInput

type ConfigureAccessPointInput struct {

	// The Amazon Resource Name (ARN) of the network resource.
	//
	// This member is required.
	AccessPointArn *string

	// A Base64 encoded string of the CPI certificate associated with the CPI user who
	// is certifying the coordinates of the network resource.
	CpiSecretKey *string

	// The CPI user ID of the CPI user who is certifying the coordinates of the
	// network resource.
	CpiUserId *string

	// The CPI password associated with the CPI certificate in cpiSecretKey .
	CpiUserPassword *string

	// The CPI user name of the CPI user who is certifying the coordinates of the
	// radio unit.
	CpiUsername *string

	// The position of the network resource.
	Position *types.Position
	// contains filtered or unexported fields
}

type ConfigureAccessPointOutput

type ConfigureAccessPointOutput struct {

	// Information about the network resource.
	//
	// This member is required.
	AccessPoint *types.NetworkResource

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

type CreateNetworkInput

type CreateNetworkInput struct {

	// The name of the network. You can't change the name after you create the network.
	//
	// This member is required.
	NetworkName *string

	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
	// the request. For more information, see How to ensure idempotency (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html)
	// .
	ClientToken *string

	// The description of the network.
	Description *string

	// The tags to apply to the network.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateNetworkOutput

type CreateNetworkOutput struct {

	// Information about the network.
	//
	// This member is required.
	Network *types.Network

	// The network tags.
	Tags map[string]string

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

type CreateNetworkSiteInput

type CreateNetworkSiteInput struct {

	// The Amazon Resource Name (ARN) of the network.
	//
	// This member is required.
	NetworkArn *string

	// The name of the site. You can't change the name after you create the site.
	//
	// This member is required.
	NetworkSiteName *string

	// The Availability Zone that is the parent of this site. You can't change the
	// Availability Zone after you create the site.
	AvailabilityZone *string

	// The ID of the Availability Zone that is the parent of this site. You can't
	// change the Availability Zone after you create the site.
	AvailabilityZoneId *string

	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
	// the request. For more information, see How to ensure idempotency (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html)
	// .
	ClientToken *string

	// The description of the site.
	Description *string

	// Information about the pending plan for this site.
	PendingPlan *types.SitePlan

	// The tags to apply to the network site.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateNetworkSiteOutput

type CreateNetworkSiteOutput struct {

	// Information about the network site.
	NetworkSite *types.NetworkSite

	// The network site tags.
	Tags map[string]string

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

type DeactivateDeviceIdentifierInput

type DeactivateDeviceIdentifierInput struct {

	// The Amazon Resource Name (ARN) of the device identifier.
	//
	// This member is required.
	DeviceIdentifierArn *string

	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
	// the request. For more information, see How to ensure idempotency (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html)
	// .
	ClientToken *string
	// contains filtered or unexported fields
}

type DeactivateDeviceIdentifierOutput

type DeactivateDeviceIdentifierOutput struct {

	// Information about the device identifier.
	//
	// This member is required.
	DeviceIdentifier *types.DeviceIdentifier

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

type DeleteNetworkInput

type DeleteNetworkInput struct {

	// The Amazon Resource Name (ARN) of the network.
	//
	// This member is required.
	NetworkArn *string

	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
	// the request. For more information, see How to ensure idempotency (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html)
	// .
	ClientToken *string
	// contains filtered or unexported fields
}

type DeleteNetworkOutput

type DeleteNetworkOutput struct {

	// Information about the network.
	//
	// This member is required.
	Network *types.Network

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

type DeleteNetworkSiteInput

type DeleteNetworkSiteInput struct {

	// The Amazon Resource Name (ARN) of the network site.
	//
	// This member is required.
	NetworkSiteArn *string

	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
	// the request. For more information, see How to ensure idempotency (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html)
	// .
	ClientToken *string
	// contains filtered or unexported fields
}

type DeleteNetworkSiteOutput

type DeleteNetworkSiteOutput struct {

	// Information about the network site.
	NetworkSite *types.NetworkSite

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

type EndpointParameters added in v1.4.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.4.0

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults added in v1.4.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.4.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.4.0

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetDeviceIdentifierInput

type GetDeviceIdentifierInput struct {

	// The Amazon Resource Name (ARN) of the device identifier.
	//
	// This member is required.
	DeviceIdentifierArn *string
	// contains filtered or unexported fields
}

type GetDeviceIdentifierOutput

type GetDeviceIdentifierOutput struct {

	// Information about the device identifier.
	DeviceIdentifier *types.DeviceIdentifier

	// The device identifier tags.
	Tags map[string]string

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

type GetNetworkInput

type GetNetworkInput struct {

	// The Amazon Resource Name (ARN) of the network.
	//
	// This member is required.
	NetworkArn *string
	// contains filtered or unexported fields
}

type GetNetworkOutput

type GetNetworkOutput struct {

	// Information about the network.
	//
	// This member is required.
	Network *types.Network

	// The network tags.
	Tags map[string]string

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

type GetNetworkResourceInput

type GetNetworkResourceInput struct {

	// The Amazon Resource Name (ARN) of the network resource.
	//
	// This member is required.
	NetworkResourceArn *string
	// contains filtered or unexported fields
}

type GetNetworkResourceOutput

type GetNetworkResourceOutput struct {

	// Information about the network resource.
	//
	// This member is required.
	NetworkResource *types.NetworkResource

	// The network resource tags.
	Tags map[string]string

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

type GetNetworkSiteInput

type GetNetworkSiteInput struct {

	// The Amazon Resource Name (ARN) of the network site.
	//
	// This member is required.
	NetworkSiteArn *string
	// contains filtered or unexported fields
}

type GetNetworkSiteOutput

type GetNetworkSiteOutput struct {

	// Information about the network site.
	NetworkSite *types.NetworkSite

	// The network site tags.
	Tags map[string]string

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

type GetOrderInput

type GetOrderInput struct {

	// The Amazon Resource Name (ARN) of the order.
	//
	// This member is required.
	OrderArn *string
	// contains filtered or unexported fields
}

type GetOrderOutput

type GetOrderOutput struct {

	// Information about the order.
	//
	// This member is required.
	Order *types.Order

	// The order tags.
	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 ListDeviceIdentifiersAPIClient

type ListDeviceIdentifiersAPIClient interface {
	ListDeviceIdentifiers(context.Context, *ListDeviceIdentifiersInput, ...func(*Options)) (*ListDeviceIdentifiersOutput, error)
}

ListDeviceIdentifiersAPIClient is a client that implements the ListDeviceIdentifiers operation.

type ListDeviceIdentifiersInput

type ListDeviceIdentifiersInput struct {

	// The Amazon Resource Name (ARN) of the network.
	//
	// This member is required.
	NetworkArn *string

	// The filters.
	//   - ORDER - The Amazon Resource Name (ARN) of the order.
	//   - STATUS - The status ( ACTIVE | INACTIVE ).
	//   - TRAFFIC_GROUP - The Amazon Resource Name (ARN) of the traffic group.
	// Filter values are case sensitive. If you specify multiple values for a filter,
	// the values are joined with an OR , and the request returns all results that
	// match any of the specified values.
	Filters map[string][]string

	// The maximum number of results to return.
	MaxResults *int32

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

type ListDeviceIdentifiersOutput

type ListDeviceIdentifiersOutput struct {

	// Information about the device identifiers.
	DeviceIdentifiers []types.DeviceIdentifier

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

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

type ListDeviceIdentifiersPaginator

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

ListDeviceIdentifiersPaginator is a paginator for ListDeviceIdentifiers

func NewListDeviceIdentifiersPaginator

NewListDeviceIdentifiersPaginator returns a new ListDeviceIdentifiersPaginator

func (*ListDeviceIdentifiersPaginator) HasMorePages

func (p *ListDeviceIdentifiersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDeviceIdentifiersPaginator) NextPage

NextPage retrieves the next ListDeviceIdentifiers page.

type ListDeviceIdentifiersPaginatorOptions

type ListDeviceIdentifiersPaginatorOptions struct {
	// The maximum number of results to return.
	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
}

ListDeviceIdentifiersPaginatorOptions is the paginator options for ListDeviceIdentifiers

type ListNetworkResourcesAPIClient

type ListNetworkResourcesAPIClient interface {
	ListNetworkResources(context.Context, *ListNetworkResourcesInput, ...func(*Options)) (*ListNetworkResourcesOutput, error)
}

ListNetworkResourcesAPIClient is a client that implements the ListNetworkResources operation.

type ListNetworkResourcesInput

type ListNetworkResourcesInput struct {

	// The Amazon Resource Name (ARN) of the network.
	//
	// This member is required.
	NetworkArn *string

	// The filters.
	//   - ORDER - The Amazon Resource Name (ARN) of the order.
	//   - STATUS - The status ( AVAILABLE | DELETED | DELETING | PENDING |
	//   PENDING_RETURN | PROVISIONING | SHIPPED ).
	// Filter values are case sensitive. If you specify multiple values for a filter,
	// the values are joined with an OR , and the request returns all results that
	// match any of the specified values.
	Filters map[string][]string

	// The maximum number of results to return.
	MaxResults *int32

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

type ListNetworkResourcesOutput

type ListNetworkResourcesOutput struct {

	// Information about network resources.
	NetworkResources []types.NetworkResource

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

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

type ListNetworkResourcesPaginator

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

ListNetworkResourcesPaginator is a paginator for ListNetworkResources

func NewListNetworkResourcesPaginator

NewListNetworkResourcesPaginator returns a new ListNetworkResourcesPaginator

func (*ListNetworkResourcesPaginator) HasMorePages

func (p *ListNetworkResourcesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListNetworkResourcesPaginator) NextPage

NextPage retrieves the next ListNetworkResources page.

type ListNetworkResourcesPaginatorOptions

type ListNetworkResourcesPaginatorOptions struct {
	// The maximum number of results to return.
	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
}

ListNetworkResourcesPaginatorOptions is the paginator options for ListNetworkResources

type ListNetworkSitesAPIClient

type ListNetworkSitesAPIClient interface {
	ListNetworkSites(context.Context, *ListNetworkSitesInput, ...func(*Options)) (*ListNetworkSitesOutput, error)
}

ListNetworkSitesAPIClient is a client that implements the ListNetworkSites operation.

type ListNetworkSitesInput

type ListNetworkSitesInput struct {

	// The Amazon Resource Name (ARN) of the network.
	//
	// This member is required.
	NetworkArn *string

	// The filters. Add filters to your request to return a more specific list of
	// results. Use filters to match the status of the network sites.
	//   - STATUS - The status ( AVAILABLE | CREATED | DELETED | DEPROVISIONING |
	//   PROVISIONING ).
	// Filter values are case sensitive. If you specify multiple values for a filter,
	// the values are joined with an OR , and the request returns all results that
	// match any of the specified values.
	Filters map[string][]string

	// The maximum number of results to return.
	MaxResults *int32

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

type ListNetworkSitesOutput

type ListNetworkSitesOutput struct {

	// Information about the network sites.
	NetworkSites []types.NetworkSite

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

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

type ListNetworkSitesPaginator

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

ListNetworkSitesPaginator is a paginator for ListNetworkSites

func NewListNetworkSitesPaginator

func NewListNetworkSitesPaginator(client ListNetworkSitesAPIClient, params *ListNetworkSitesInput, optFns ...func(*ListNetworkSitesPaginatorOptions)) *ListNetworkSitesPaginator

NewListNetworkSitesPaginator returns a new ListNetworkSitesPaginator

func (*ListNetworkSitesPaginator) HasMorePages

func (p *ListNetworkSitesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListNetworkSitesPaginator) NextPage

func (p *ListNetworkSitesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListNetworkSitesOutput, error)

NextPage retrieves the next ListNetworkSites page.

type ListNetworkSitesPaginatorOptions

type ListNetworkSitesPaginatorOptions struct {
	// The maximum number of results to return.
	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
}

ListNetworkSitesPaginatorOptions is the paginator options for ListNetworkSites

type ListNetworksAPIClient

type ListNetworksAPIClient interface {
	ListNetworks(context.Context, *ListNetworksInput, ...func(*Options)) (*ListNetworksOutput, error)
}

ListNetworksAPIClient is a client that implements the ListNetworks operation.

type ListNetworksInput

type ListNetworksInput struct {

	// The filters.
	//   - STATUS - The status ( AVAILABLE | CREATED | DELETED | DEPROVISIONING |
	//   PROVISIONING ).
	// Filter values are case sensitive. If you specify multiple values for a filter,
	// the values are joined with an OR , and the request returns all results that
	// match any of the specified values.
	Filters map[string][]string

	// The maximum number of results to return.
	MaxResults *int32

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

type ListNetworksOutput

type ListNetworksOutput struct {

	// The networks.
	Networks []types.Network

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

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

type ListNetworksPaginator

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

ListNetworksPaginator is a paginator for ListNetworks

func NewListNetworksPaginator

func NewListNetworksPaginator(client ListNetworksAPIClient, params *ListNetworksInput, optFns ...func(*ListNetworksPaginatorOptions)) *ListNetworksPaginator

NewListNetworksPaginator returns a new ListNetworksPaginator

func (*ListNetworksPaginator) HasMorePages

func (p *ListNetworksPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListNetworksPaginator) NextPage

func (p *ListNetworksPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListNetworksOutput, error)

NextPage retrieves the next ListNetworks page.

type ListNetworksPaginatorOptions

type ListNetworksPaginatorOptions struct {
	// The maximum number of results to return.
	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
}

ListNetworksPaginatorOptions is the paginator options for ListNetworks

type ListOrdersAPIClient

type ListOrdersAPIClient interface {
	ListOrders(context.Context, *ListOrdersInput, ...func(*Options)) (*ListOrdersOutput, error)
}

ListOrdersAPIClient is a client that implements the ListOrders operation.

type ListOrdersInput

type ListOrdersInput struct {

	// The Amazon Resource Name (ARN) of the network.
	//
	// This member is required.
	NetworkArn *string

	// The filters.
	//   - NETWORK_SITE - The Amazon Resource Name (ARN) of the network site.
	//   - STATUS - The status ( ACKNOWLEDGING | ACKNOWLEDGED | UNACKNOWLEDGED ).
	// Filter values are case sensitive. If you specify multiple values for a filter,
	// the values are joined with an OR , and the request returns all results that
	// match any of the specified values.
	Filters map[string][]string

	// The maximum number of results to return.
	MaxResults *int32

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

type ListOrdersOutput

type ListOrdersOutput struct {

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

	// Information about the orders.
	Orders []types.Order

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

type ListOrdersPaginator

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

ListOrdersPaginator is a paginator for ListOrders

func NewListOrdersPaginator

func NewListOrdersPaginator(client ListOrdersAPIClient, params *ListOrdersInput, optFns ...func(*ListOrdersPaginatorOptions)) *ListOrdersPaginator

NewListOrdersPaginator returns a new ListOrdersPaginator

func (*ListOrdersPaginator) HasMorePages

func (p *ListOrdersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListOrdersPaginator) NextPage

func (p *ListOrdersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListOrdersOutput, error)

NextPage retrieves the next ListOrders page.

type ListOrdersPaginatorOptions

type ListOrdersPaginatorOptions struct {
	// The maximum number of results to return.
	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
}

ListOrdersPaginatorOptions is the paginator options for ListOrders

type ListTagsForResourceInput

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput

type ListTagsForResourceOutput struct {

	// The resource tags.
	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 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 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.6.2

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

type PingInput

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

type PingOutput

type PingOutput struct {

	// Information about the health of the service.
	Status *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 (*ResolveEndpoint) ID

func (*ResolveEndpoint) ID() string

type StartNetworkResourceUpdateInput added in v1.2.0

type StartNetworkResourceUpdateInput struct {

	// The Amazon Resource Name (ARN) of the network resource.
	//
	// This member is required.
	NetworkResourceArn *string

	// The update type.
	//   - REPLACE - Submits a request to replace a defective radio unit. We provide a
	//   shipping label that you can use for the return process and we ship a replacement
	//   radio unit to you.
	//   - RETURN - Submits a request to return a radio unit that you no longer need.
	//   We provide a shipping label that you can use for the return process.
	//   - COMMITMENT - Submits a request to change or renew the commitment period. If
	//   you choose this value, then you must set commitmentConfiguration (https://docs.aws.amazon.com/private-networks/latest/APIReference/API_StartNetworkResourceUpdate.html#privatenetworks-StartNetworkResourceUpdate-request-commitmentConfiguration)
	//   .
	//
	// This member is required.
	UpdateType types.UpdateType

	// Use this action to extend and automatically renew the commitment period for the
	// radio unit. You can do the following:
	//   - Change a 60-day commitment to a 1-year or 3-year commitment. The change is
	//   immediate and the hourly rate decreases to the rate for the new commitment
	//   period.
	//   - Change a 1-year commitment to a 3-year commitment. The change is immediate
	//   and the hourly rate decreases to the rate for the 3-year commitment period.
	//   - Set a 1-year commitment to automatically renew for an additional 1 year.
	//   The hourly rate for the additional year will continue to be the same as your
	//   existing 1-year rate.
	//   - Set a 3-year commitment to automatically renew for an additional 1 year.
	//   The hourly rate for the additional year will continue to be the same as your
	//   existing 3-year rate.
	//   - Turn off a previously-enabled automatic renewal on a 1-year or 3-year
	//   commitment. You cannot use the automatic-renewal option for a 60-day commitment.
	//
	// For pricing, see Amazon Web Services Private 5G Pricing (http://aws.amazon.com/private5g/pricing)
	// .
	CommitmentConfiguration *types.CommitmentConfiguration

	// The reason for the return. Providing a reason for a return is optional.
	ReturnReason *string

	// The shipping address. If you don't provide a shipping address when replacing or
	// returning a network resource, we use the address from the original order for the
	// network resource.
	ShippingAddress *types.Address
	// contains filtered or unexported fields
}

type StartNetworkResourceUpdateOutput added in v1.2.0

type StartNetworkResourceUpdateOutput struct {

	// The network resource.
	NetworkResource *types.NetworkResource

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

type TagResourceInput

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource.
	//
	// This member is required.
	ResourceArn *string

	// The tags to add to the resource.
	//
	// 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 UntagResourceInput

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource.
	//
	// This member is required.
	ResourceArn *string

	// The 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 UpdateNetworkSiteInput

type UpdateNetworkSiteInput struct {

	// The Amazon Resource Name (ARN) of the network site.
	//
	// This member is required.
	NetworkSiteArn *string

	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
	// the request. For more information, see How to ensure idempotency (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html)
	// .
	ClientToken *string

	// The description.
	Description *string
	// contains filtered or unexported fields
}

type UpdateNetworkSiteOutput

type UpdateNetworkSiteOutput struct {

	// Information about the network site.
	NetworkSite *types.NetworkSite

	// The network site tags.
	Tags map[string]string

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

type UpdateNetworkSitePlanInput

type UpdateNetworkSitePlanInput struct {

	// The Amazon Resource Name (ARN) of the network site.
	//
	// This member is required.
	NetworkSiteArn *string

	// The pending plan.
	//
	// This member is required.
	PendingPlan *types.SitePlan

	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
	// the request. For more information, see How to ensure idempotency (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html)
	// .
	ClientToken *string
	// contains filtered or unexported fields
}

type UpdateNetworkSitePlanOutput

type UpdateNetworkSitePlanOutput struct {

	// Information about the network site.
	NetworkSite *types.NetworkSite

	// The network site tags.
	Tags map[string]string

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

Directories

Path Synopsis
internal

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL