AWSPrivate5GClient (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceClient
- - com.amazonaws.services.private5g.AWSPrivate5GClient

All Implemented Interfaces:

AWSPrivate5G

Direct Known Subclasses:

AWSPrivate5GAsyncClient
```
@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSPrivate5GClient
extends AmazonWebServiceClient
implements AWSPrivate5G
```
Client for accessing AWS Private 5G. All service calls made using this client are blocking, and will not return until the service call completes.

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.

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceClient
  LOGGING_AWS_REQUEST_METRIC
- Fields inherited from interface com.amazonaws.services.private5g.AWSPrivate5G
  ENDPOINT_PREFIX

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AcknowledgeOrderReceiptResult`	`acknowledgeOrderReceipt(AcknowledgeOrderReceiptRequest request)` Acknowledges that the specified network order was received.
`ActivateDeviceIdentifierResult`	`activateDeviceIdentifier(ActivateDeviceIdentifierRequest request)` Activates the specified device identifier.
`ActivateNetworkSiteResult`	`activateNetworkSite(ActivateNetworkSiteRequest request)` Activates the specified network site.
`static AWSPrivate5GClientBuilder`	`builder()`
`ConfigureAccessPointResult`	`configureAccessPoint(ConfigureAccessPointRequest request)` Configures the specified network resource.
`CreateNetworkResult`	`createNetwork(CreateNetworkRequest request)` Creates a network.
`CreateNetworkSiteResult`	`createNetworkSite(CreateNetworkSiteRequest request)` Creates a network site.
`DeactivateDeviceIdentifierResult`	`deactivateDeviceIdentifier(DeactivateDeviceIdentifierRequest request)` Deactivates the specified device identifier.
`DeleteNetworkResult`	`deleteNetwork(DeleteNetworkRequest request)` Deletes the specified network.
`DeleteNetworkSiteResult`	`deleteNetworkSite(DeleteNetworkSiteRequest request)` Deletes the specified network site.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
`GetDeviceIdentifierResult`	`getDeviceIdentifier(GetDeviceIdentifierRequest request)` Gets the specified device identifier.
`GetNetworkResult`	`getNetwork(GetNetworkRequest request)` Gets the specified network.
`GetNetworkResourceResult`	`getNetworkResource(GetNetworkResourceRequest request)` Gets the specified network resource.
`GetNetworkSiteResult`	`getNetworkSite(GetNetworkSiteRequest request)` Gets the specified network site.
`GetOrderResult`	`getOrder(GetOrderRequest request)` Gets the specified order.
`ListDeviceIdentifiersResult`	`listDeviceIdentifiers(ListDeviceIdentifiersRequest request)` Lists device identifiers.
`ListNetworkResourcesResult`	`listNetworkResources(ListNetworkResourcesRequest request)` Lists network resources.
`ListNetworksResult`	`listNetworks(ListNetworksRequest request)` Lists networks.
`ListNetworkSitesResult`	`listNetworkSites(ListNetworkSitesRequest request)` Lists network sites.
`ListOrdersResult`	`listOrders(ListOrdersRequest request)` Lists orders.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest request)` Lists the tags for the specified resource.
`PingResult`	`ping(PingRequest request)` Checks the health of the service.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`StartNetworkResourceUpdateResult`	`startNetworkResourceUpdate(StartNetworkResourceUpdateRequest request)` Use this action to do the following tasks:
`TagResourceResult`	`tagResource(TagResourceRequest request)` Adds tags to the specified resource.
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` Removes tags from the specified resource.
`UpdateNetworkSiteResult`	`updateNetworkSite(UpdateNetworkSiteRequest request)` Updates the specified network site.
`UpdateNetworkSitePlanResult`	`updateNetworkSitePlan(UpdateNetworkSitePlanRequest request)` Updates the specified network site plan.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - builder
```
public static AWSPrivate5GClientBuilder builder()
```
  - acknowledgeOrderReceipt
```
public AcknowledgeOrderReceiptResult acknowledgeOrderReceipt(AcknowledgeOrderReceiptRequest request)
```
    Acknowledges that the specified network order was received.
    
    Specified by:
    
    acknowledgeOrderReceipt in interface AWSPrivate5G
    
    Parameters:
    
    acknowledgeOrderReceiptRequest -
    
    Returns:
    
    Result of the AcknowledgeOrderReceipt operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource was not found.
    
    ValidationException - The request failed validation.
    
    InternalServerException - Information about an internal error.
    
    See Also:
    
    AWS API Documentation
  - activateDeviceIdentifier
```
public ActivateDeviceIdentifierResult activateDeviceIdentifier(ActivateDeviceIdentifierRequest request)
```
    Activates the specified device identifier.
    
    Specified by:
    
    activateDeviceIdentifier in interface AWSPrivate5G
    
    Parameters:
    
    activateDeviceIdentifierRequest -
    
    Returns:
    
    Result of the ActivateDeviceIdentifier operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource was not found.
    
    ValidationException - The request failed validation.
    
    InternalServerException - Information about an internal error.
    
    See Also:
    
    AWS API Documentation
  - activateNetworkSite
```
public ActivateNetworkSiteResult activateNetworkSite(ActivateNetworkSiteRequest request)
```
    Activates the specified network site.
    
    Specified by:
    
    activateNetworkSite in interface AWSPrivate5G
    
    Parameters:
    
    activateNetworkSiteRequest -
    
    Returns:
    
    Result of the ActivateNetworkSite operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource was not found.
    
    ValidationException - The request failed validation.
    
    InternalServerException - Information about an internal error.
    
    See Also:
    
    AWS API Documentation
  - configureAccessPoint
```
public ConfigureAccessPointResult configureAccessPoint(ConfigureAccessPointRequest request)
```
    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.
    
    Specified by:
    
    configureAccessPoint in interface AWSPrivate5G
    
    Parameters:
    
    configureAccessPointRequest -
    
    Returns:
    
    Result of the ConfigureAccessPoint operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource was not found.
    
    ValidationException - The request failed validation.
    
    InternalServerException - Information about an internal error.
    
    See Also:
    
    AWS API Documentation
  - createNetwork
```
public CreateNetworkResult createNetwork(CreateNetworkRequest request)
```
    Creates a network.
    
    Specified by:
    
    createNetwork in interface AWSPrivate5G
    
    Parameters:
    
    createNetworkRequest -
    
    Returns:
    
    Result of the CreateNetwork operation returned by the service.
    
    Throws:
    
    LimitExceededException - The limit was exceeded.
    
    ValidationException - The request failed validation.
    
    InternalServerException - Information about an internal error.
    
    See Also:
    
    AWS API Documentation
  - createNetworkSite
```
public CreateNetworkSiteResult createNetworkSite(CreateNetworkSiteRequest request)
```
    Creates a network site.
    
    Specified by:
    
    createNetworkSite in interface AWSPrivate5G
    
    Parameters:
    
    createNetworkSiteRequest -
    
    Returns:
    
    Result of the CreateNetworkSite operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource was not found.
    
    ValidationException - The request failed validation.
    
    InternalServerException - Information about an internal error.
    
    See Also:
    
    AWS API Documentation
  - deactivateDeviceIdentifier
```
public DeactivateDeviceIdentifierResult deactivateDeviceIdentifier(DeactivateDeviceIdentifierRequest request)
```
    Deactivates the specified device identifier.
    
    Specified by:
    
    deactivateDeviceIdentifier in interface AWSPrivate5G
    
    Parameters:
    
    deactivateDeviceIdentifierRequest -
    
    Returns:
    
    Result of the DeactivateDeviceIdentifier operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource was not found.
    
    ValidationException - The request failed validation.
    
    InternalServerException - Information about an internal error.
    
    See Also:
    
    AWS API Documentation
  - deleteNetwork
```
public DeleteNetworkResult deleteNetwork(DeleteNetworkRequest request)
```
    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.
    
    Specified by:
    
    deleteNetwork in interface AWSPrivate5G
    
    Parameters:
    
    deleteNetworkRequest -
    
    Returns:
    
    Result of the DeleteNetwork operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource was not found.
    
    AccessDeniedException - You do not have permission to perform this operation.
    
    ValidationException - The request failed validation.
    
    InternalServerException - Information about an internal error.
    
    See Also:
    
    AWS API Documentation
  - deleteNetworkSite
```
public DeleteNetworkSiteResult deleteNetworkSite(DeleteNetworkSiteRequest request)
```
    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.
    
    Specified by:
    
    deleteNetworkSite in interface AWSPrivate5G
    
    Parameters:
    
    deleteNetworkSiteRequest -
    
    Returns:
    
    Result of the DeleteNetworkSite operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource was not found.
    
    AccessDeniedException - You do not have permission to perform this operation.
    
    ValidationException - The request failed validation.
    
    InternalServerException - Information about an internal error.
    
    See Also:
    
    AWS API Documentation
  - getDeviceIdentifier
```
public GetDeviceIdentifierResult getDeviceIdentifier(GetDeviceIdentifierRequest request)
```
    Gets the specified device identifier.
    
    Specified by:
    
    getDeviceIdentifier in interface AWSPrivate5G
    
    Parameters:
    
    getDeviceIdentifierRequest -
    
    Returns:
    
    Result of the GetDeviceIdentifier operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource was not found.
    
    ValidationException - The request failed validation.
    
    InternalServerException - Information about an internal error.
    
    See Also:
    
    AWS API Documentation
  - getNetwork
```
public GetNetworkResult getNetwork(GetNetworkRequest request)
```
    Gets the specified network.
    
    Specified by:
    
    getNetwork in interface AWSPrivate5G
    
    Parameters:
    
    getNetworkRequest -
    
    Returns:
    
    Result of the GetNetwork operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource was not found.
    
    ValidationException - The request failed validation.
    
    InternalServerException - Information about an internal error.
    
    See Also:
    
    AWS API Documentation
  - getNetworkResource
```
public GetNetworkResourceResult getNetworkResource(GetNetworkResourceRequest request)
```
    Gets the specified network resource.
    
    Specified by:
    
    getNetworkResource in interface AWSPrivate5G
    
    Parameters:
    
    getNetworkResourceRequest -
    
    Returns:
    
    Result of the GetNetworkResource operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource was not found.
    
    ValidationException - The request failed validation.
    
    InternalServerException - Information about an internal error.
    
    See Also:
    
    AWS API Documentation
  - getNetworkSite
```
public GetNetworkSiteResult getNetworkSite(GetNetworkSiteRequest request)
```
    Gets the specified network site.
    
    Specified by:
    
    getNetworkSite in interface AWSPrivate5G
    
    Parameters:
    
    getNetworkSiteRequest -
    
    Returns:
    
    Result of the GetNetworkSite operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource was not found.
    
    ValidationException - The request failed validation.
    
    InternalServerException - Information about an internal error.
    
    See Also:
    
    AWS API Documentation
  - getOrder
```
public GetOrderResult getOrder(GetOrderRequest request)
```
    Gets the specified order.
    
    Specified by:
    
    getOrder in interface AWSPrivate5G
    
    Parameters:
    
    getOrderRequest -
    
    Returns:
    
    Result of the GetOrder operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource was not found.
    
    ValidationException - The request failed validation.
    
    InternalServerException - Information about an internal error.
    
    See Also:
    
    AWS API Documentation
  - listDeviceIdentifiers
```
public ListDeviceIdentifiersResult listDeviceIdentifiers(ListDeviceIdentifiersRequest request)
```
    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.
    
    Specified by:
    
    listDeviceIdentifiers in interface AWSPrivate5G
    
    Parameters:
    
    listDeviceIdentifiersRequest -
    
    Returns:
    
    Result of the ListDeviceIdentifiers operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource was not found.
    
    ValidationException - The request failed validation.
    
    InternalServerException - Information about an internal error.
    
    See Also:
    
    AWS API Documentation
  - listNetworkResources
```
public ListNetworkResourcesResult listNetworkResources(ListNetworkResourcesRequest request)
```
    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.
    
    Specified by:
    
    listNetworkResources in interface AWSPrivate5G
    
    Parameters:
    
    listNetworkResourcesRequest -
    
    Returns:
    
    Result of the ListNetworkResources operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource was not found.
    
    ValidationException - The request failed validation.
    
    InternalServerException - Information about an internal error.
    
    See Also:
    
    AWS API Documentation
  - listNetworkSites
```
public ListNetworkSitesResult listNetworkSites(ListNetworkSitesRequest request)
```
    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.
    
    Specified by:
    
    listNetworkSites in interface AWSPrivate5G
    
    Parameters:
    
    listNetworkSitesRequest -
    
    Returns:
    
    Result of the ListNetworkSites operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource was not found.
    
    ValidationException - The request failed validation.
    
    InternalServerException - Information about an internal error.
    
    See Also:
    
    AWS API Documentation
  - listNetworks
```
public ListNetworksResult listNetworks(ListNetworksRequest request)
```
    Lists networks. Add filters to your request to return a more specific list of results. Use filters to match the status of the network.
    
    Specified by:
    
    listNetworks in interface AWSPrivate5G
    
    Parameters:
    
    listNetworksRequest -
    
    Returns:
    
    Result of the ListNetworks operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource was not found.
    
    ValidationException - The request failed validation.
    
    InternalServerException - Information about an internal error.
    
    See Also:
    
    AWS API Documentation
  - listOrders
```
public ListOrdersResult listOrders(ListOrdersRequest request)
```
    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.
    
    Specified by:
    
    listOrders in interface AWSPrivate5G
    
    Parameters:
    
    listOrdersRequest -
    
    Returns:
    
    Result of the ListOrders operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource was not found.
    
    ValidationException - The request failed validation.
    
    InternalServerException - Information about an internal error.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Lists the tags for the specified resource.
    
    Specified by:
    
    listTagsForResource in interface AWSPrivate5G
    
    Parameters:
    
    listTagsForResourceRequest -
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource was not found.
    
    AccessDeniedException - You do not have permission to perform this operation.
    
    ValidationException - The request failed validation.
    
    InternalServerException - Information about an internal error.
    
    ThrottlingException - The request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - ping
```
public PingResult ping(PingRequest request)
```
    Checks the health of the service.
    
    Specified by:
    
    ping in interface AWSPrivate5G
    
    Parameters:
    
    pingRequest -
    
    Returns:
    
    Result of the Ping operation returned by the service.
    
    Throws:
    
    InternalServerException - Information about an internal error.
    
    See Also:
    
    AWS API Documentation
  - startNetworkResourceUpdate
```
public StartNetworkResourceUpdateResult startNetworkResourceUpdate(StartNetworkResourceUpdateRequest request)
```
    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.
    Specified by:
    
    startNetworkResourceUpdate in interface AWSPrivate5G
    
    Parameters:
    
    startNetworkResourceUpdateRequest -
    
    Returns:
    
    Result of the StartNetworkResourceUpdate operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource was not found.
    
    ValidationException - The request failed validation.
    
    InternalServerException - Information about an internal error.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Adds tags to the specified resource.
    
    Specified by:
    
    tagResource in interface AWSPrivate5G
    
    Parameters:
    
    tagResourceRequest -
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource was not found.
    
    AccessDeniedException - You do not have permission to perform this operation.
    
    ValidationException - The request failed validation.
    
    InternalServerException - Information about an internal error.
    
    ThrottlingException - The request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Removes tags from the specified resource.
    
    Specified by:
    
    untagResource in interface AWSPrivate5G
    
    Parameters:
    
    untagResourceRequest -
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource was not found.
    
    AccessDeniedException - You do not have permission to perform this operation.
    
    ValidationException - The request failed validation.
    
    InternalServerException - Information about an internal error.
    
    ThrottlingException - The request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - updateNetworkSite
```
public UpdateNetworkSiteResult updateNetworkSite(UpdateNetworkSiteRequest request)
```
    Updates the specified network site.
    
    Specified by:
    
    updateNetworkSite in interface AWSPrivate5G
    
    Parameters:
    
    updateNetworkSiteRequest -
    
    Returns:
    
    Result of the UpdateNetworkSite operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource was not found.
    
    ValidationException - The request failed validation.
    
    InternalServerException - Information about an internal error.
    
    See Also:
    
    AWS API Documentation
  - updateNetworkSitePlan
```
public UpdateNetworkSitePlanResult updateNetworkSitePlan(UpdateNetworkSitePlanRequest request)
```
    Updates the specified network site plan.
    
    Specified by:
    
    updateNetworkSitePlan in interface AWSPrivate5G
    
    Parameters:
    
    updateNetworkSitePlanRequest -
    
    Returns:
    
    Result of the UpdateNetworkSitePlan operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource was not found.
    
    ValidationException - The request failed validation.
    
    InternalServerException - Information about an internal error.
    
    See Also:
    
    AWS API Documentation
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AWSPrivate5G
    
    Parameters:
    
    request - The originally executed request
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.
  - shutdown
```
public void shutdown()
```
    Description copied from class: AmazonWebServiceClient
    
    Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AWSPrivate5G
    
    Overrides:
    
    shutdown in class AmazonWebServiceClient

AWS SDK for Java 1.x API Reference - 1.12.771

Class AWSPrivate5GClient

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

Fields inherited from interface com.amazonaws.services.private5g.AWSPrivate5G

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceClient

Methods inherited from class java.lang.Object

Method Detail

builder

acknowledgeOrderReceipt

activateDeviceIdentifier

activateNetworkSite

configureAccessPoint

createNetwork

createNetworkSite

deactivateDeviceIdentifier

deleteNetwork

deleteNetworkSite

getDeviceIdentifier

getNetwork

getNetworkResource

getNetworkSite

getOrder

listDeviceIdentifiers

listNetworkResources

listNetworkSites

listNetworks

listOrders

listTagsForResource

ping

startNetworkResourceUpdate

tagResource

untagResource

updateNetworkSite

updateNetworkSitePlan

getCachedResponseMetadata

shutdown