privatenetworks/aws.sdk.kotlin.services.privatenetworks

Package-level declarations

Types

Link copied to clipboard
interface PrivateNetworksClient : SdkClient

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.

Properties

Link copied to clipboard
const val SdkVersion: String
Link copied to clipboard
Link copied to clipboard
const val ServiceId: String

Functions

Link copied to clipboard
inline suspend fun PrivateNetworksClient.acknowledgeOrderReceipt(crossinline block: AcknowledgeOrderReceiptRequest.Builder.() -> Unit): AcknowledgeOrderReceiptResponse

Acknowledges that the specified network order was received.

Link copied to clipboard
inline suspend fun PrivateNetworksClient.activateDeviceIdentifier(crossinline block: ActivateDeviceIdentifierRequest.Builder.() -> Unit): ActivateDeviceIdentifierResponse

Activates the specified device identifier.

Link copied to clipboard
inline suspend fun PrivateNetworksClient.activateNetworkSite(crossinline block: ActivateNetworkSiteRequest.Builder.() -> Unit): ActivateNetworkSiteResponse

Activates the specified network site.

Link copied to clipboard
inline suspend fun PrivateNetworksClient.configureAccessPoint(crossinline block: ConfigureAccessPointRequest.Builder.() -> Unit): ConfigureAccessPointResponse

Configures the specified network resource.

Link copied to clipboard
inline suspend fun PrivateNetworksClient.createNetwork(crossinline block: CreateNetworkRequest.Builder.() -> Unit): CreateNetworkResponse

Creates a network.

Link copied to clipboard
inline suspend fun PrivateNetworksClient.createNetworkSite(crossinline block: CreateNetworkSiteRequest.Builder.() -> Unit): CreateNetworkSiteResponse

Creates a network site.

Link copied to clipboard
inline suspend fun PrivateNetworksClient.deactivateDeviceIdentifier(crossinline block: DeactivateDeviceIdentifierRequest.Builder.() -> Unit): DeactivateDeviceIdentifierResponse

Deactivates the specified device identifier.

Link copied to clipboard
inline suspend fun PrivateNetworksClient.deleteNetwork(crossinline block: DeleteNetworkRequest.Builder.() -> Unit): DeleteNetworkResponse

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.

Link copied to clipboard
inline suspend fun PrivateNetworksClient.deleteNetworkSite(crossinline block: DeleteNetworkSiteRequest.Builder.() -> Unit): DeleteNetworkSiteResponse

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.

Link copied to clipboard
inline suspend fun PrivateNetworksClient.getDeviceIdentifier(crossinline block: GetDeviceIdentifierRequest.Builder.() -> Unit): GetDeviceIdentifierResponse

Gets the specified device identifier.

Link copied to clipboard
inline suspend fun PrivateNetworksClient.getNetwork(crossinline block: GetNetworkRequest.Builder.() -> Unit): GetNetworkResponse

Gets the specified network.

Link copied to clipboard
inline suspend fun PrivateNetworksClient.getNetworkResource(crossinline block: GetNetworkResourceRequest.Builder.() -> Unit): GetNetworkResourceResponse

Gets the specified network resource.

Link copied to clipboard
inline suspend fun PrivateNetworksClient.getNetworkSite(crossinline block: GetNetworkSiteRequest.Builder.() -> Unit): GetNetworkSiteResponse

Gets the specified network site.

Link copied to clipboard
inline suspend fun PrivateNetworksClient.getOrder(crossinline block: GetOrderRequest.Builder.() -> Unit): GetOrderResponse

Gets the specified order.

Link copied to clipboard
inline suspend fun PrivateNetworksClient.listDeviceIdentifiers(crossinline block: ListDeviceIdentifiersRequest.Builder.() -> Unit): ListDeviceIdentifiersResponse

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.

Link copied to clipboard
inline suspend fun PrivateNetworksClient.listNetworkResources(crossinline block: ListNetworkResourcesRequest.Builder.() -> Unit): ListNetworkResourcesResponse

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.

Link copied to clipboard
inline suspend fun PrivateNetworksClient.listNetworks(crossinline block: ListNetworksRequest.Builder.() -> Unit): ListNetworksResponse

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

Link copied to clipboard
inline suspend fun PrivateNetworksClient.listNetworkSites(crossinline block: ListNetworkSitesRequest.Builder.() -> Unit): ListNetworkSitesResponse

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.

Link copied to clipboard
inline suspend fun PrivateNetworksClient.listOrders(crossinline block: ListOrdersRequest.Builder.() -> Unit): ListOrdersResponse

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.

Link copied to clipboard
inline suspend fun PrivateNetworksClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

Lists the tags for the specified resource.

Link copied to clipboard
inline suspend fun PrivateNetworksClient.ping(crossinline block: PingRequest.Builder.() -> Unit): PingResponse

Checks the health of the service.

Link copied to clipboard
inline suspend fun PrivateNetworksClient.startNetworkResourceUpdate(crossinline block: StartNetworkResourceUpdateRequest.Builder.() -> Unit): StartNetworkResourceUpdateResponse

Use this action to do the following tasks:

Link copied to clipboard
inline suspend fun PrivateNetworksClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Adds tags to the specified resource.

Link copied to clipboard
inline suspend fun PrivateNetworksClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Removes tags from the specified resource.

Link copied to clipboard
inline suspend fun PrivateNetworksClient.updateNetworkSite(crossinline block: UpdateNetworkSiteRequest.Builder.() -> Unit): UpdateNetworkSiteResponse

Updates the specified network site.

Link copied to clipboard
inline suspend fun PrivateNetworksClient.updateNetworkSitePlan(crossinline block: UpdateNetworkSitePlanRequest.Builder.() -> Unit): UpdateNetworkSitePlanResponse

Updates the specified network site plan.

Link copied to clipboard
fun PrivateNetworksClient.withConfig(block: PrivateNetworksClient.Config.Builder.() -> Unit): PrivateNetworksClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.