com.amazonaws.services.private5g

Interface AWSPrivate5G

All Known Subinterfaces:

AWSPrivate5GAsync

All Known Implementing Classes:

AbstractAWSPrivate5G, AbstractAWSPrivate5GAsync, AWSPrivate5GAsyncClient, AWSPrivate5GClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSPrivate5G

Interface for accessing AWS Private 5G.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSPrivate5G instead.

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

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
AcknowledgeOrderReceiptResult	acknowledgeOrderReceipt(AcknowledgeOrderReceiptRequest acknowledgeOrderReceiptRequest) Acknowledges that the specified network order was received.
ActivateDeviceIdentifierResult	activateDeviceIdentifier(ActivateDeviceIdentifierRequest activateDeviceIdentifierRequest) Activates the specified device identifier.
ActivateNetworkSiteResult	activateNetworkSite(ActivateNetworkSiteRequest activateNetworkSiteRequest) Activates the specified network site.
ConfigureAccessPointResult	configureAccessPoint(ConfigureAccessPointRequest configureAccessPointRequest) Configures the specified network resource.
CreateNetworkResult	createNetwork(CreateNetworkRequest createNetworkRequest) Creates a network.
CreateNetworkSiteResult	createNetworkSite(CreateNetworkSiteRequest createNetworkSiteRequest) Creates a network site.
DeactivateDeviceIdentifierResult	deactivateDeviceIdentifier(DeactivateDeviceIdentifierRequest deactivateDeviceIdentifierRequest) Deactivates the specified device identifier.
DeleteNetworkResult	deleteNetwork(DeleteNetworkRequest deleteNetworkRequest) Deletes the specified network.
DeleteNetworkSiteResult	deleteNetworkSite(DeleteNetworkSiteRequest deleteNetworkSiteRequest) 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 getDeviceIdentifierRequest) Gets the specified device identifier.
GetNetworkResult	getNetwork(GetNetworkRequest getNetworkRequest) Gets the specified network.
GetNetworkResourceResult	getNetworkResource(GetNetworkResourceRequest getNetworkResourceRequest) Gets the specified network resource.
GetNetworkSiteResult	getNetworkSite(GetNetworkSiteRequest getNetworkSiteRequest) Gets the specified network site.
GetOrderResult	getOrder(GetOrderRequest getOrderRequest) Gets the specified order.
ListDeviceIdentifiersResult	listDeviceIdentifiers(ListDeviceIdentifiersRequest listDeviceIdentifiersRequest) Lists device identifiers.
ListNetworkResourcesResult	listNetworkResources(ListNetworkResourcesRequest listNetworkResourcesRequest) Lists network resources.
ListNetworksResult	listNetworks(ListNetworksRequest listNetworksRequest) Lists networks.
ListNetworkSitesResult	listNetworkSites(ListNetworkSitesRequest listNetworkSitesRequest) Lists network sites.
ListOrdersResult	listOrders(ListOrdersRequest listOrdersRequest) Lists orders.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags for the specified resource.
PingResult	ping(PingRequest pingRequest) Checks the health of the service.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) Adds tags to the specified resource.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Removes tags from the specified resource.
UpdateNetworkSiteResult	updateNetworkSite(UpdateNetworkSiteRequest updateNetworkSiteRequest) Updates the specified network site.
UpdateNetworkSitePlanResult	updateNetworkSitePlan(UpdateNetworkSitePlanRequest updateNetworkSitePlanRequest) Updates the specified network site plan.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

acknowledgeOrderReceipt

AcknowledgeOrderReceiptResult acknowledgeOrderReceipt(AcknowledgeOrderReceiptRequest acknowledgeOrderReceiptRequest)

Acknowledges that the specified network order was received.

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

ActivateDeviceIdentifierResult activateDeviceIdentifier(ActivateDeviceIdentifierRequest activateDeviceIdentifierRequest)

Activates the specified device identifier.

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

ActivateNetworkSiteResult activateNetworkSite(ActivateNetworkSiteRequest activateNetworkSiteRequest)

Activates the specified network site.

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

ConfigureAccessPointResult configureAccessPoint(ConfigureAccessPointRequest 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.

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

CreateNetworkResult createNetwork(CreateNetworkRequest createNetworkRequest)

Creates a network.

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

CreateNetworkSiteResult createNetworkSite(CreateNetworkSiteRequest createNetworkSiteRequest)

Creates a network site.

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

DeactivateDeviceIdentifierResult deactivateDeviceIdentifier(DeactivateDeviceIdentifierRequest deactivateDeviceIdentifierRequest)

Deactivates the specified device identifier.

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

DeleteNetworkResult deleteNetwork(DeleteNetworkRequest 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.

Parameters:

deleteNetworkRequest -

Returns:

Result of the DeleteNetwork 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

deleteNetworkSite

DeleteNetworkSiteResult deleteNetworkSite(DeleteNetworkSiteRequest 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.

Parameters:

deleteNetworkSiteRequest -

Returns:

Result of the DeleteNetworkSite 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

getDeviceIdentifier

GetDeviceIdentifierResult getDeviceIdentifier(GetDeviceIdentifierRequest getDeviceIdentifierRequest)

Gets the specified device identifier.

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

GetNetworkResult getNetwork(GetNetworkRequest getNetworkRequest)

Gets the specified network.

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

GetNetworkResourceResult getNetworkResource(GetNetworkResourceRequest getNetworkResourceRequest)

Gets the specified network resource.

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

GetNetworkSiteResult getNetworkSite(GetNetworkSiteRequest getNetworkSiteRequest)

Gets the specified network site.

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

GetOrderResult getOrder(GetOrderRequest getOrderRequest)

Gets the specified order.

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

ListDeviceIdentifiersResult listDeviceIdentifiers(ListDeviceIdentifiersRequest 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.

  <p>If you specify multiple filters, filters are joined with an OR, and the request 
 

returns results that match all of the specified filters.

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

ListNetworkResourcesResult listNetworkResources(ListNetworkResourcesRequest 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.

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

ListNetworkSitesResult listNetworkSites(ListNetworkSitesRequest 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.

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

ListNetworksResult listNetworks(ListNetworksRequest 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.

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

ListOrdersResult listOrders(ListOrdersRequest 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.

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

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

Lists the tags for the specified resource.

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

PingResult ping(PingRequest pingRequest)

Checks the health of the service.

Parameters:

pingRequest -

Returns:

Result of the Ping operation returned by the service.

Throws:

InternalServerException - Information about an internal error.

See Also:

AWS API Documentation

tagResource

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

Adds tags to the specified resource.

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

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

Removes tags from the specified resource.

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

UpdateNetworkSiteResult updateNetworkSite(UpdateNetworkSiteRequest updateNetworkSiteRequest)

Updates the specified network site.

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

UpdateNetworkSitePlanResult updateNetworkSitePlan(UpdateNetworkSitePlanRequest updateNetworkSitePlanRequest)

Updates the specified network site plan.

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

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

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 a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.