/* * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ /* * Do not modify this file. This file is generated from the privatenetworks-2021-12-03.normal.json service model. */ using System; using System.Threading; using System.Threading.Tasks; using System.Collections.Generic; using Amazon.Runtime; using Amazon.Private5G.Model; namespace Amazon.Private5G { ///

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

public partial interface IAmazonPrivate5G : IAmazonService, IDisposable { #if AWS_ASYNC_ENUMERABLES_API ///

/// Paginators for the service ///

IPrivate5GPaginatorFactory Paginators { get; } #endif #region AcknowledgeOrderReceipt ///

/// Acknowledges that the specified network order was received. ///

/// Container for the necessary parameters to execute the AcknowledgeOrderReceipt service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the AcknowledgeOrderReceipt service method, as returned by Private5G. /// /// Information about an internal error. /// /// /// The resource was not found. /// /// /// The request failed validation. /// /// REST API Reference for AcknowledgeOrderReceipt Operation Task AcknowledgeOrderReceiptAsync(AcknowledgeOrderReceiptRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ActivateDeviceIdentifier ///

/// Activates the specified device identifier. ///

/// Container for the necessary parameters to execute the ActivateDeviceIdentifier service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ActivateDeviceIdentifier service method, as returned by Private5G. /// /// Information about an internal error. /// /// /// The resource was not found. /// /// /// The request failed validation. /// /// REST API Reference for ActivateDeviceIdentifier Operation Task ActivateDeviceIdentifierAsync(ActivateDeviceIdentifierRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ActivateNetworkSite ///

/// Activates the specified network site. ///

/// Container for the necessary parameters to execute the ActivateNetworkSite service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ActivateNetworkSite service method, as returned by Private5G. /// /// Information about an internal error. /// /// /// The resource was not found. /// /// /// The request failed validation. /// /// REST API Reference for ActivateNetworkSite Operation Task ActivateNetworkSiteAsync(ActivateNetworkSiteRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ConfigureAccessPoint ///

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

/// Container for the necessary parameters to execute the ConfigureAccessPoint service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ConfigureAccessPoint service method, as returned by Private5G. /// /// Information about an internal error. /// /// /// The resource was not found. /// /// /// The request failed validation. /// /// REST API Reference for ConfigureAccessPoint Operation Task ConfigureAccessPointAsync(ConfigureAccessPointRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region CreateNetwork ///

/// Creates a network. ///

/// Container for the necessary parameters to execute the CreateNetwork service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the CreateNetwork service method, as returned by Private5G. /// /// Information about an internal error. /// /// /// The limit was exceeded. /// /// /// The request failed validation. /// /// REST API Reference for CreateNetwork Operation Task CreateNetworkAsync(CreateNetworkRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region CreateNetworkSite ///

/// Creates a network site. ///

/// Container for the necessary parameters to execute the CreateNetworkSite service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the CreateNetworkSite service method, as returned by Private5G. /// /// Information about an internal error. /// /// /// The resource was not found. /// /// /// The request failed validation. /// /// REST API Reference for CreateNetworkSite Operation Task CreateNetworkSiteAsync(CreateNetworkSiteRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DeactivateDeviceIdentifier ///

/// Deactivates the specified device identifier. ///

/// Container for the necessary parameters to execute the DeactivateDeviceIdentifier service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeactivateDeviceIdentifier service method, as returned by Private5G. /// /// Information about an internal error. /// /// /// The resource was not found. /// /// /// The request failed validation. /// /// REST API Reference for DeactivateDeviceIdentifier Operation Task DeactivateDeviceIdentifierAsync(DeactivateDeviceIdentifierRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DeleteNetwork ///

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

/// Container for the necessary parameters to execute the DeleteNetwork service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteNetwork service method, as returned by Private5G. /// /// You do not have permission to perform this operation. /// /// /// Information about an internal error. /// /// /// The resource was not found. /// /// /// The request failed validation. /// /// REST API Reference for DeleteNetwork Operation Task DeleteNetworkAsync(DeleteNetworkRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DeleteNetworkSite ///

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

/// Container for the necessary parameters to execute the DeleteNetworkSite service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteNetworkSite service method, as returned by Private5G. /// /// You do not have permission to perform this operation. /// /// /// Information about an internal error. /// /// /// The resource was not found. /// /// /// The request failed validation. /// /// REST API Reference for DeleteNetworkSite Operation Task DeleteNetworkSiteAsync(DeleteNetworkSiteRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetDeviceIdentifier ///

/// Gets the specified device identifier. ///

/// Container for the necessary parameters to execute the GetDeviceIdentifier service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetDeviceIdentifier service method, as returned by Private5G. /// /// Information about an internal error. /// /// /// The resource was not found. /// /// /// The request failed validation. /// /// REST API Reference for GetDeviceIdentifier Operation Task GetDeviceIdentifierAsync(GetDeviceIdentifierRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetNetwork ///

/// Gets the specified network. ///

/// Container for the necessary parameters to execute the GetNetwork service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetNetwork service method, as returned by Private5G. /// /// Information about an internal error. /// /// /// The resource was not found. /// /// /// The request failed validation. /// /// REST API Reference for GetNetwork Operation Task GetNetworkAsync(GetNetworkRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetNetworkResource ///

/// Gets the specified network resource. ///

/// Container for the necessary parameters to execute the GetNetworkResource service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetNetworkResource service method, as returned by Private5G. /// /// Information about an internal error. /// /// /// The resource was not found. /// /// /// The request failed validation. /// /// REST API Reference for GetNetworkResource Operation Task GetNetworkResourceAsync(GetNetworkResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetNetworkSite ///

/// Gets the specified network site. ///

/// Container for the necessary parameters to execute the GetNetworkSite service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetNetworkSite service method, as returned by Private5G. /// /// Information about an internal error. /// /// /// The resource was not found. /// /// /// The request failed validation. /// /// REST API Reference for GetNetworkSite Operation Task GetNetworkSiteAsync(GetNetworkSiteRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetOrder ///

/// Gets the specified order. ///

/// Container for the necessary parameters to execute the GetOrder service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetOrder service method, as returned by Private5G. /// /// Information about an internal error. /// /// /// The resource was not found. /// /// /// The request failed validation. /// /// REST API Reference for GetOrder Operation Task GetOrderAsync(GetOrderRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ListDeviceIdentifiers ///

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

/// Container for the necessary parameters to execute the ListDeviceIdentifiers service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ListDeviceIdentifiers service method, as returned by Private5G. /// /// Information about an internal error. /// /// /// The resource was not found. /// /// /// The request failed validation. /// /// REST API Reference for ListDeviceIdentifiers Operation Task ListDeviceIdentifiersAsync(ListDeviceIdentifiersRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ListNetworkResources ///

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

/// Container for the necessary parameters to execute the ListNetworkResources service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ListNetworkResources service method, as returned by Private5G. /// /// Information about an internal error. /// /// /// The resource was not found. /// /// /// The request failed validation. /// /// REST API Reference for ListNetworkResources Operation Task ListNetworkResourcesAsync(ListNetworkResourcesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ListNetworks ///

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

/// Container for the necessary parameters to execute the ListNetworks service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ListNetworks service method, as returned by Private5G. /// /// Information about an internal error. /// /// /// The resource was not found. /// /// /// The request failed validation. /// /// REST API Reference for ListNetworks Operation Task ListNetworksAsync(ListNetworksRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ListNetworkSites ///

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

/// Container for the necessary parameters to execute the ListNetworkSites service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ListNetworkSites service method, as returned by Private5G. /// /// Information about an internal error. /// /// /// The resource was not found. /// /// /// The request failed validation. /// /// REST API Reference for ListNetworkSites Operation Task ListNetworkSitesAsync(ListNetworkSitesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ListOrders ///

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

/// Container for the necessary parameters to execute the ListOrders service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ListOrders service method, as returned by Private5G. /// /// Information about an internal error. /// /// /// The resource was not found. /// /// /// The request failed validation. /// /// REST API Reference for ListOrders Operation Task ListOrdersAsync(ListOrdersRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ListTagsForResource ///

/// Lists the tags for the specified resource. ///

/// Container for the necessary parameters to execute the ListTagsForResource service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ListTagsForResource service method, as returned by Private5G. /// /// You do not have permission to perform this operation. /// /// /// Information about an internal error. /// /// /// The resource was not found. /// /// /// The request was denied due to request throttling. /// /// /// The request failed validation. /// /// REST API Reference for ListTagsForResource Operation Task ListTagsForResourceAsync(ListTagsForResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region Ping ///

/// Checks the health of the service. ///

/// Container for the necessary parameters to execute the Ping service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the Ping service method, as returned by Private5G. /// /// Information about an internal error. /// /// REST API Reference for Ping Operation Task PingAsync(PingRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region StartNetworkResourceUpdate ///

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

/// Container for the necessary parameters to execute the StartNetworkResourceUpdate service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the StartNetworkResourceUpdate service method, as returned by Private5G. /// /// Information about an internal error. /// /// /// The resource was not found. /// /// /// The request failed validation. /// /// REST API Reference for StartNetworkResourceUpdate Operation Task StartNetworkResourceUpdateAsync(StartNetworkResourceUpdateRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region TagResource ///

/// Adds tags to the specified resource. ///

/// Container for the necessary parameters to execute the TagResource service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the TagResource service method, as returned by Private5G. /// /// You do not have permission to perform this operation. /// /// /// Information about an internal error. /// /// /// The resource was not found. /// /// /// The request was denied due to request throttling. /// /// /// The request failed validation. /// /// REST API Reference for TagResource Operation Task TagResourceAsync(TagResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region UntagResource ///

/// Removes tags from the specified resource. ///

/// Container for the necessary parameters to execute the UntagResource service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the UntagResource service method, as returned by Private5G. /// /// You do not have permission to perform this operation. /// /// /// Information about an internal error. /// /// /// The resource was not found. /// /// /// The request was denied due to request throttling. /// /// /// The request failed validation. /// /// REST API Reference for UntagResource Operation Task UntagResourceAsync(UntagResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region UpdateNetworkSite ///

/// Updates the specified network site. ///

/// Container for the necessary parameters to execute the UpdateNetworkSite service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the UpdateNetworkSite service method, as returned by Private5G. /// /// Information about an internal error. /// /// /// The resource was not found. /// /// /// The request failed validation. /// /// REST API Reference for UpdateNetworkSite Operation Task UpdateNetworkSiteAsync(UpdateNetworkSiteRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region UpdateNetworkSitePlan ///

/// Updates the specified network site plan. ///

/// Container for the necessary parameters to execute the UpdateNetworkSitePlan service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the UpdateNetworkSitePlan service method, as returned by Private5G. /// /// Information about an internal error. /// /// /// The resource was not found. /// /// /// The request failed validation. /// /// REST API Reference for UpdateNetworkSitePlan Operation Task UpdateNetworkSitePlanAsync(UpdateNetworkSitePlanRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion } }