privatenetworks/aws.sdk.kotlin.services.privatenetworks/PrivateNetworksClient

PrivateNetworksClient

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.

Types

Builder

class Builder : AbstractSdkClientBuilder<PrivateNetworksClient.Config, PrivateNetworksClient.Config.Builder, PrivateNetworksClient>

Companion

object Companion : AbstractAwsSdkClientFactory<PrivateNetworksClient.Config, PrivateNetworksClient.Config.Builder, PrivateNetworksClient, PrivateNetworksClient.Builder>

Config

class Config : AwsSdkClientConfig, CredentialsProviderConfig, HttpAuthConfig, HttpClientConfig, HttpEngineConfig, RetryClientConfig, RetryStrategyClientConfig, SdkClientConfig, TelemetryConfig

Properties

config

abstract override val config: PrivateNetworksClient.Config

PrivateNetworksClient's configuration

Functions

acknowledgeOrderReceipt

abstract suspend fun acknowledgeOrderReceipt(input: AcknowledgeOrderReceiptRequest): AcknowledgeOrderReceiptResponse

Acknowledges that the specified network order was received.

activateDeviceIdentifier

abstract suspend fun activateDeviceIdentifier(input: ActivateDeviceIdentifierRequest): ActivateDeviceIdentifierResponse

Activates the specified device identifier.

activateNetworkSite

abstract suspend fun activateNetworkSite(input: ActivateNetworkSiteRequest): ActivateNetworkSiteResponse

Activates the specified network site.

configureAccessPoint

abstract suspend fun configureAccessPoint(input: ConfigureAccessPointRequest): ConfigureAccessPointResponse

Configures the specified network resource.

createNetwork

abstract suspend fun createNetwork(input: CreateNetworkRequest): CreateNetworkResponse

Creates a network.

createNetworkSite

abstract suspend fun createNetworkSite(input: CreateNetworkSiteRequest): CreateNetworkSiteResponse

Creates a network site.

deactivateDeviceIdentifier

abstract suspend fun deactivateDeviceIdentifier(input: DeactivateDeviceIdentifierRequest): DeactivateDeviceIdentifierResponse

Deactivates the specified device identifier.

deleteNetwork

abstract suspend fun deleteNetwork(input: DeleteNetworkRequest): 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.

deleteNetworkSite

abstract suspend fun deleteNetworkSite(input: DeleteNetworkSiteRequest): 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.

getDeviceIdentifier

abstract suspend fun getDeviceIdentifier(input: GetDeviceIdentifierRequest): GetDeviceIdentifierResponse

Gets the specified device identifier.

getNetwork

abstract suspend fun getNetwork(input: GetNetworkRequest): GetNetworkResponse

Gets the specified network.

getNetworkResource

abstract suspend fun getNetworkResource(input: GetNetworkResourceRequest): GetNetworkResourceResponse

Gets the specified network resource.

getNetworkSite

abstract suspend fun getNetworkSite(input: GetNetworkSiteRequest): GetNetworkSiteResponse

Gets the specified network site.

getOrder

abstract suspend fun getOrder(input: GetOrderRequest): GetOrderResponse

Gets the specified order.

listDeviceIdentifiers

abstract suspend fun listDeviceIdentifiers(input: ListDeviceIdentifiersRequest): 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.

listNetworkResources

abstract suspend fun listNetworkResources(input: ListNetworkResourcesRequest): 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.

listNetworks

abstract suspend fun listNetworks(input: ListNetworksRequest = ListNetworksRequest { }): 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.

listNetworkSites

abstract suspend fun listNetworkSites(input: ListNetworkSitesRequest): 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.

listOrders

abstract suspend fun listOrders(input: ListOrdersRequest): 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.

listTagsForResource

abstract suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse

Lists the tags for the specified resource.

ping

abstract suspend fun ping(input: PingRequest = PingRequest { }): PingResponse

Checks the health of the service.

startNetworkResourceUpdate

abstract suspend fun startNetworkResourceUpdate(input: StartNetworkResourceUpdateRequest): StartNetworkResourceUpdateResponse

Use this action to do the following tasks:

tagResource

abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Adds tags to the specified resource.

untagResource

abstract suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse

Removes tags from the specified resource.

updateNetworkSite

abstract suspend fun updateNetworkSite(input: UpdateNetworkSiteRequest): UpdateNetworkSiteResponse

Updates the specified network site.

updateNetworkSitePlan

abstract suspend fun updateNetworkSitePlan(input: UpdateNetworkSitePlanRequest): UpdateNetworkSitePlanResponse

Updates the specified network site plan.

Inherited functions

acknowledgeOrderReceipt

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

Acknowledges that the specified network order was received.

activateDeviceIdentifier

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

Activates the specified device identifier.

activateNetworkSite

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

Activates the specified network site.

expect abstract fun close()

configureAccessPoint

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

Configures the specified network resource.

createNetwork

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

Creates a network.

createNetworkSite

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

Creates a network site.

deactivateDeviceIdentifier

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

Deactivates the specified device identifier.

deleteNetwork

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.

deleteNetworkSite

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

getDeviceIdentifier

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

Gets the specified device identifier.

getNetwork

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

Gets the specified network.

getNetworkResource

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

Gets the specified network resource.

getNetworkSite

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

Gets the specified network site.

getOrder

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

Gets the specified order.

listDeviceIdentifiers

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

listDeviceIdentifiersPaginated

fun PrivateNetworksClient.listDeviceIdentifiersPaginated(initialRequest: ListDeviceIdentifiersRequest): Flow<ListDeviceIdentifiersResponse>

fun PrivateNetworksClient.listDeviceIdentifiersPaginated(block: ListDeviceIdentifiersRequest.Builder.() -> Unit): Flow<ListDeviceIdentifiersResponse>

Paginate over ListDeviceIdentifiersResponse results.

listNetworkResources

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.

listNetworkResourcesPaginated

fun PrivateNetworksClient.listNetworkResourcesPaginated(initialRequest: ListNetworkResourcesRequest): Flow<ListNetworkResourcesResponse>

fun PrivateNetworksClient.listNetworkResourcesPaginated(block: ListNetworkResourcesRequest.Builder.() -> Unit): Flow<ListNetworkResourcesResponse>

Paginate over ListNetworkResourcesResponse results.

listNetworks

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.

listNetworkSites

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.

listNetworkSitesPaginated

fun PrivateNetworksClient.listNetworkSitesPaginated(initialRequest: ListNetworkSitesRequest): Flow<ListNetworkSitesResponse>

fun PrivateNetworksClient.listNetworkSitesPaginated(block: ListNetworkSitesRequest.Builder.() -> Unit): Flow<ListNetworkSitesResponse>

Paginate over ListNetworkSitesResponse results.

listNetworksPaginated

fun PrivateNetworksClient.listNetworksPaginated(initialRequest: ListNetworksRequest = ListNetworksRequest { }): Flow<ListNetworksResponse>

fun PrivateNetworksClient.listNetworksPaginated(block: ListNetworksRequest.Builder.() -> Unit): Flow<ListNetworksResponse>

Paginate over ListNetworksResponse results.

listOrders

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.

listOrdersPaginated

fun PrivateNetworksClient.listOrdersPaginated(initialRequest: ListOrdersRequest): Flow<ListOrdersResponse>

fun PrivateNetworksClient.listOrdersPaginated(block: ListOrdersRequest.Builder.() -> Unit): Flow<ListOrdersResponse>

Paginate over ListOrdersResponse results.

listTagsForResource

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

Lists the tags for the specified resource.

ping

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

Checks the health of the service.

startNetworkResourceUpdate

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

Use this action to do the following tasks:

tagResource

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

Adds tags to the specified resource.

untagResource

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

Removes tags from the specified resource.

updateNetworkSite

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

Updates the specified network site.

updateNetworkSitePlan

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

Updates the specified network site plan.

withConfig

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.