AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Interface for accessing Private5G

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.

Inheritance Hierarchy

Amazon.Private5G.IAmazonPrivate5G

Namespace: Amazon.Private5G
Assembly: AWSSDK.Private5G.dll
Version: 3.x.y.z

Syntax

C#
public interface IAmazonPrivate5G
         IAmazonService, IDisposable

The IAmazonPrivate5G type exposes the following members

Properties

NameTypeDescription
Public Property Paginators Amazon.Private5G.Model.IPrivate5GPaginatorFactory

Paginators for the service

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method AcknowledgeOrderReceipt(AcknowledgeOrderReceiptRequest)

Acknowledges that the specified network order was received.

Public Method AcknowledgeOrderReceiptAsync(AcknowledgeOrderReceiptRequest, CancellationToken)

Acknowledges that the specified network order was received.

Public Method ActivateDeviceIdentifier(ActivateDeviceIdentifierRequest)

Activates the specified device identifier.

Public Method ActivateDeviceIdentifierAsync(ActivateDeviceIdentifierRequest, CancellationToken)

Activates the specified device identifier.

Public Method ActivateNetworkSite(ActivateNetworkSiteRequest)

Activates the specified network site.

Public Method ActivateNetworkSiteAsync(ActivateNetworkSiteRequest, CancellationToken)

Activates the specified network site.

Public Method ConfigureAccessPoint(ConfigureAccessPointRequest)

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 in the Amazon Web Services Private 5G User Guide.

Public Method ConfigureAccessPointAsync(ConfigureAccessPointRequest, CancellationToken)

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 in the Amazon Web Services Private 5G User Guide.

Public Method CreateNetwork(CreateNetworkRequest)

Creates a network.

Public Method CreateNetworkAsync(CreateNetworkRequest, CancellationToken)

Creates a network.

Public Method CreateNetworkSite(CreateNetworkSiteRequest)

Creates a network site.

Public Method CreateNetworkSiteAsync(CreateNetworkSiteRequest, CancellationToken)

Creates a network site.

Public Method DeactivateDeviceIdentifier(DeactivateDeviceIdentifierRequest)

Deactivates the specified device identifier.

Public Method DeactivateDeviceIdentifierAsync(DeactivateDeviceIdentifierRequest, CancellationToken)

Deactivates the specified device identifier.

Public Method DeleteNetwork(DeleteNetworkRequest)

Deletes the specified network. You must delete network sites before you delete the network. For more information, see DeleteNetworkSite in the API Reference for Amazon Web Services Private 5G.

Public Method DeleteNetworkAsync(DeleteNetworkRequest, CancellationToken)

Deletes the specified network. You must delete network sites before you delete the network. For more information, see DeleteNetworkSite in the API Reference for Amazon Web Services Private 5G.

Public Method DeleteNetworkSite(DeleteNetworkSiteRequest)

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 in the Amazon Web Services Private 5G User Guide.

Public Method DeleteNetworkSiteAsync(DeleteNetworkSiteRequest, CancellationToken)

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 in the Amazon Web Services Private 5G User Guide.

Public Method DetermineServiceOperationEndpoint(AmazonWebServiceRequest)

Returns the endpoint that will be used for a particular request.

Public Method GetDeviceIdentifier(GetDeviceIdentifierRequest)

Gets the specified device identifier.

Public Method GetDeviceIdentifierAsync(GetDeviceIdentifierRequest, CancellationToken)

Gets the specified device identifier.

Public Method GetNetwork(GetNetworkRequest)

Gets the specified network.

Public Method GetNetworkAsync(GetNetworkRequest, CancellationToken)

Gets the specified network.

Public Method GetNetworkResource(GetNetworkResourceRequest)

Gets the specified network resource.

Public Method GetNetworkResourceAsync(GetNetworkResourceRequest, CancellationToken)

Gets the specified network resource.

Public Method GetNetworkSite(GetNetworkSiteRequest)

Gets the specified network site.

Public Method GetNetworkSiteAsync(GetNetworkSiteRequest, CancellationToken)

Gets the specified network site.

Public Method GetOrder(GetOrderRequest)

Gets the specified order.

Public Method GetOrderAsync(GetOrderRequest, CancellationToken)

Gets the specified order.

Public Method ListDeviceIdentifiers(ListDeviceIdentifiersRequest)

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.

Public Method ListDeviceIdentifiersAsync(ListDeviceIdentifiersRequest, CancellationToken)

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.

Public Method ListNetworkResources(ListNetworkResourcesRequest)

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.

Public Method ListNetworkResourcesAsync(ListNetworkResourcesRequest, CancellationToken)

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.

Public Method ListNetworks(ListNetworksRequest)

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

Public Method ListNetworksAsync(ListNetworksRequest, CancellationToken)

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

Public Method ListNetworkSites(ListNetworkSitesRequest)

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.

Public Method ListNetworkSitesAsync(ListNetworkSitesRequest, CancellationToken)

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.

Public Method ListOrders(ListOrdersRequest)

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.

Public Method ListOrdersAsync(ListOrdersRequest, CancellationToken)

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.

Public Method ListTagsForResource(ListTagsForResourceRequest)

Lists the tags for the specified resource.

Public Method ListTagsForResourceAsync(ListTagsForResourceRequest, CancellationToken)

Lists the tags for the specified resource.

Public Method Ping(PingRequest)

Checks the health of the service.

Public Method PingAsync(PingRequest, CancellationToken)

Checks the health of the service.

Public Method StartNetworkResourceUpdate(StartNetworkResourceUpdateRequest)

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.

Public Method StartNetworkResourceUpdateAsync(StartNetworkResourceUpdateRequest, CancellationToken)

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.

Public Method TagResource(TagResourceRequest)

Adds tags to the specified resource.

Public Method TagResourceAsync(TagResourceRequest, CancellationToken)

Adds tags to the specified resource.

Public Method UntagResource(UntagResourceRequest)

Removes tags from the specified resource.

Public Method UntagResourceAsync(UntagResourceRequest, CancellationToken)

Removes tags from the specified resource.

Public Method UpdateNetworkSite(UpdateNetworkSiteRequest)

Updates the specified network site.

Public Method UpdateNetworkSiteAsync(UpdateNetworkSiteRequest, CancellationToken)

Updates the specified network site.

Public Method UpdateNetworkSitePlan(UpdateNetworkSitePlanRequest)

Updates the specified network site plan.

Public Method UpdateNetworkSitePlanAsync(UpdateNetworkSitePlanRequest, CancellationToken)

Updates the specified network site plan.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5