com.amazonaws.services.private5g.AWSPrivate5G Maven / Gradle / Ivy
Show all versions of aws-java-sdk-private5g Show documentation
/*
* Copyright 2019-2024 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.
*/
package com.amazonaws.services.private5g;
import javax.annotation.Generated;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.private5g.model.*;
/**
* Interface for accessing AWS Private 5G.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.private5g.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.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AWSPrivate5G {
/**
* 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 RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "private-networks";
/**
*
* Acknowledges that the specified network order was received.
*
*
* @param acknowledgeOrderReceiptRequest
* @return Result of the AcknowledgeOrderReceipt operation returned by the service.
* @throws ResourceNotFoundException
* The resource was not found.
* @throws ValidationException
* The request failed validation.
* @throws InternalServerException
* Information about an internal error.
* @sample AWSPrivate5G.AcknowledgeOrderReceipt
* @see AWS API Documentation
*/
AcknowledgeOrderReceiptResult acknowledgeOrderReceipt(AcknowledgeOrderReceiptRequest acknowledgeOrderReceiptRequest);
/**
*
* Activates the specified device identifier.
*
*
* @param activateDeviceIdentifierRequest
* @return Result of the ActivateDeviceIdentifier operation returned by the service.
* @throws ResourceNotFoundException
* The resource was not found.
* @throws ValidationException
* The request failed validation.
* @throws InternalServerException
* Information about an internal error.
* @sample AWSPrivate5G.ActivateDeviceIdentifier
* @see AWS API Documentation
*/
ActivateDeviceIdentifierResult activateDeviceIdentifier(ActivateDeviceIdentifierRequest activateDeviceIdentifierRequest);
/**
*
* Activates the specified network site.
*
*
* @param activateNetworkSiteRequest
* @return Result of the ActivateNetworkSite operation returned by the service.
* @throws ResourceNotFoundException
* The resource was not found.
* @throws ValidationException
* The request failed validation.
* @throws InternalServerException
* Information about an internal error.
* @sample AWSPrivate5G.ActivateNetworkSite
* @see AWS API Documentation
*/
ActivateNetworkSiteResult activateNetworkSite(ActivateNetworkSiteRequest activateNetworkSiteRequest);
/**
*
* 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.
*
*
* @param configureAccessPointRequest
* @return Result of the ConfigureAccessPoint operation returned by the service.
* @throws ResourceNotFoundException
* The resource was not found.
* @throws ValidationException
* The request failed validation.
* @throws InternalServerException
* Information about an internal error.
* @sample AWSPrivate5G.ConfigureAccessPoint
* @see AWS API Documentation
*/
ConfigureAccessPointResult configureAccessPoint(ConfigureAccessPointRequest configureAccessPointRequest);
/**
*
* Creates a network.
*
*
* @param createNetworkRequest
* @return Result of the CreateNetwork operation returned by the service.
* @throws LimitExceededException
* The limit was exceeded.
* @throws ValidationException
* The request failed validation.
* @throws InternalServerException
* Information about an internal error.
* @sample AWSPrivate5G.CreateNetwork
* @see AWS
* API Documentation
*/
CreateNetworkResult createNetwork(CreateNetworkRequest createNetworkRequest);
/**
*
* Creates a network site.
*
*
* @param createNetworkSiteRequest
* @return Result of the CreateNetworkSite operation returned by the service.
* @throws ResourceNotFoundException
* The resource was not found.
* @throws ValidationException
* The request failed validation.
* @throws InternalServerException
* Information about an internal error.
* @sample AWSPrivate5G.CreateNetworkSite
* @see AWS API Documentation
*/
CreateNetworkSiteResult createNetworkSite(CreateNetworkSiteRequest createNetworkSiteRequest);
/**
*
* Deactivates the specified device identifier.
*
*
* @param deactivateDeviceIdentifierRequest
* @return Result of the DeactivateDeviceIdentifier operation returned by the service.
* @throws ResourceNotFoundException
* The resource was not found.
* @throws ValidationException
* The request failed validation.
* @throws InternalServerException
* Information about an internal error.
* @sample AWSPrivate5G.DeactivateDeviceIdentifier
* @see AWS API Documentation
*/
DeactivateDeviceIdentifierResult deactivateDeviceIdentifier(DeactivateDeviceIdentifierRequest deactivateDeviceIdentifierRequest);
/**
*
* 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.
*
*
* @param deleteNetworkRequest
* @return Result of the DeleteNetwork operation returned by the service.
* @throws ResourceNotFoundException
* The resource was not found.
* @throws AccessDeniedException
* You do not have permission to perform this operation.
* @throws ValidationException
* The request failed validation.
* @throws InternalServerException
* Information about an internal error.
* @sample AWSPrivate5G.DeleteNetwork
* @see AWS
* API Documentation
*/
DeleteNetworkResult deleteNetwork(DeleteNetworkRequest deleteNetworkRequest);
/**
*
* 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.
*
*
* @param deleteNetworkSiteRequest
* @return Result of the DeleteNetworkSite operation returned by the service.
* @throws ResourceNotFoundException
* The resource was not found.
* @throws AccessDeniedException
* You do not have permission to perform this operation.
* @throws ValidationException
* The request failed validation.
* @throws InternalServerException
* Information about an internal error.
* @sample AWSPrivate5G.DeleteNetworkSite
* @see AWS API Documentation
*/
DeleteNetworkSiteResult deleteNetworkSite(DeleteNetworkSiteRequest deleteNetworkSiteRequest);
/**
*
* Gets the specified device identifier.
*
*
* @param getDeviceIdentifierRequest
* @return Result of the GetDeviceIdentifier operation returned by the service.
* @throws ResourceNotFoundException
* The resource was not found.
* @throws ValidationException
* The request failed validation.
* @throws InternalServerException
* Information about an internal error.
* @sample AWSPrivate5G.GetDeviceIdentifier
* @see AWS API Documentation
*/
GetDeviceIdentifierResult getDeviceIdentifier(GetDeviceIdentifierRequest getDeviceIdentifierRequest);
/**
*
* Gets the specified network.
*
*
* @param getNetworkRequest
* @return Result of the GetNetwork operation returned by the service.
* @throws ResourceNotFoundException
* The resource was not found.
* @throws ValidationException
* The request failed validation.
* @throws InternalServerException
* Information about an internal error.
* @sample AWSPrivate5G.GetNetwork
* @see AWS API
* Documentation
*/
GetNetworkResult getNetwork(GetNetworkRequest getNetworkRequest);
/**
*
* Gets the specified network resource.
*
*
* @param getNetworkResourceRequest
* @return Result of the GetNetworkResource operation returned by the service.
* @throws ResourceNotFoundException
* The resource was not found.
* @throws ValidationException
* The request failed validation.
* @throws InternalServerException
* Information about an internal error.
* @sample AWSPrivate5G.GetNetworkResource
* @see AWS API Documentation
*/
GetNetworkResourceResult getNetworkResource(GetNetworkResourceRequest getNetworkResourceRequest);
/**
*
* Gets the specified network site.
*
*
* @param getNetworkSiteRequest
* @return Result of the GetNetworkSite operation returned by the service.
* @throws ResourceNotFoundException
* The resource was not found.
* @throws ValidationException
* The request failed validation.
* @throws InternalServerException
* Information about an internal error.
* @sample AWSPrivate5G.GetNetworkSite
* @see AWS
* API Documentation
*/
GetNetworkSiteResult getNetworkSite(GetNetworkSiteRequest getNetworkSiteRequest);
/**
*
* Gets the specified order.
*
*
* @param getOrderRequest
* @return Result of the GetOrder operation returned by the service.
* @throws ResourceNotFoundException
* The resource was not found.
* @throws ValidationException
* The request failed validation.
* @throws InternalServerException
* Information about an internal error.
* @sample AWSPrivate5G.GetOrder
* @see AWS API
* Documentation
*/
GetOrderResult getOrder(GetOrderRequest getOrderRequest);
/**
*
* 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.
*
*
* @param listDeviceIdentifiersRequest
* @return Result of the ListDeviceIdentifiers operation returned by the service.
* @throws ResourceNotFoundException
* The resource was not found.
* @throws ValidationException
* The request failed validation.
* @throws InternalServerException
* Information about an internal error.
* @sample AWSPrivate5G.ListDeviceIdentifiers
* @see AWS API Documentation
*/
ListDeviceIdentifiersResult listDeviceIdentifiers(ListDeviceIdentifiersRequest listDeviceIdentifiersRequest);
/**
*
* 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.
*
*
* @param listNetworkResourcesRequest
* @return Result of the ListNetworkResources operation returned by the service.
* @throws ResourceNotFoundException
* The resource was not found.
* @throws ValidationException
* The request failed validation.
* @throws InternalServerException
* Information about an internal error.
* @sample AWSPrivate5G.ListNetworkResources
* @see AWS API Documentation
*/
ListNetworkResourcesResult listNetworkResources(ListNetworkResourcesRequest listNetworkResourcesRequest);
/**
*
* 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.
*
*
* @param listNetworkSitesRequest
* @return Result of the ListNetworkSites operation returned by the service.
* @throws ResourceNotFoundException
* The resource was not found.
* @throws ValidationException
* The request failed validation.
* @throws InternalServerException
* Information about an internal error.
* @sample AWSPrivate5G.ListNetworkSites
* @see AWS API Documentation
*/
ListNetworkSitesResult listNetworkSites(ListNetworkSitesRequest listNetworkSitesRequest);
/**
*
* Lists networks. Add filters to your request to return a more specific list of results. Use filters to match the
* status of the network.
*
*
* @param listNetworksRequest
* @return Result of the ListNetworks operation returned by the service.
* @throws ResourceNotFoundException
* The resource was not found.
* @throws ValidationException
* The request failed validation.
* @throws InternalServerException
* Information about an internal error.
* @sample AWSPrivate5G.ListNetworks
* @see AWS
* API Documentation
*/
ListNetworksResult listNetworks(ListNetworksRequest listNetworksRequest);
/**
*
* 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.
*
*
* @param listOrdersRequest
* @return Result of the ListOrders operation returned by the service.
* @throws ResourceNotFoundException
* The resource was not found.
* @throws ValidationException
* The request failed validation.
* @throws InternalServerException
* Information about an internal error.
* @sample AWSPrivate5G.ListOrders
* @see AWS API
* Documentation
*/
ListOrdersResult listOrders(ListOrdersRequest listOrdersRequest);
/**
*
* Lists the tags for the specified resource.
*
*
* @param listTagsForResourceRequest
* @return Result of the ListTagsForResource operation returned by the service.
* @throws ResourceNotFoundException
* The resource was not found.
* @throws AccessDeniedException
* You do not have permission to perform this operation.
* @throws ValidationException
* The request failed validation.
* @throws InternalServerException
* Information about an internal error.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @sample AWSPrivate5G.ListTagsForResource
* @see AWS API Documentation
*/
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* Checks the health of the service.
*
*
* @param pingRequest
* @return Result of the Ping operation returned by the service.
* @throws InternalServerException
* Information about an internal error.
* @sample AWSPrivate5G.Ping
* @see AWS API
* Documentation
*/
PingResult ping(PingRequest pingRequest);
/**
*
* 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.
*
*
* @param startNetworkResourceUpdateRequest
* @return Result of the StartNetworkResourceUpdate operation returned by the service.
* @throws ResourceNotFoundException
* The resource was not found.
* @throws ValidationException
* The request failed validation.
* @throws InternalServerException
* Information about an internal error.
* @sample AWSPrivate5G.StartNetworkResourceUpdate
* @see AWS API Documentation
*/
StartNetworkResourceUpdateResult startNetworkResourceUpdate(StartNetworkResourceUpdateRequest startNetworkResourceUpdateRequest);
/**
*
* Adds tags to the specified resource.
*
*
* @param tagResourceRequest
* @return Result of the TagResource operation returned by the service.
* @throws ResourceNotFoundException
* The resource was not found.
* @throws AccessDeniedException
* You do not have permission to perform this operation.
* @throws ValidationException
* The request failed validation.
* @throws InternalServerException
* Information about an internal error.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @sample AWSPrivate5G.TagResource
* @see AWS
* API Documentation
*/
TagResourceResult tagResource(TagResourceRequest tagResourceRequest);
/**
*
* Removes tags from the specified resource.
*
*
* @param untagResourceRequest
* @return Result of the UntagResource operation returned by the service.
* @throws ResourceNotFoundException
* The resource was not found.
* @throws AccessDeniedException
* You do not have permission to perform this operation.
* @throws ValidationException
* The request failed validation.
* @throws InternalServerException
* Information about an internal error.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @sample AWSPrivate5G.UntagResource
* @see AWS
* API Documentation
*/
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest);
/**
*
* Updates the specified network site.
*
*
* @param updateNetworkSiteRequest
* @return Result of the UpdateNetworkSite operation returned by the service.
* @throws ResourceNotFoundException
* The resource was not found.
* @throws ValidationException
* The request failed validation.
* @throws InternalServerException
* Information about an internal error.
* @sample AWSPrivate5G.UpdateNetworkSite
* @see AWS API Documentation
*/
UpdateNetworkSiteResult updateNetworkSite(UpdateNetworkSiteRequest updateNetworkSiteRequest);
/**
*
* Updates the specified network site plan.
*
*
* @param updateNetworkSitePlanRequest
* @return Result of the UpdateNetworkSitePlan operation returned by the service.
* @throws ResourceNotFoundException
* The resource was not found.
* @throws ValidationException
* The request failed validation.
* @throws InternalServerException
* Information about an internal error.
* @sample AWSPrivate5G.UpdateNetworkSitePlan
* @see AWS API Documentation
*/
UpdateNetworkSitePlanResult updateNetworkSitePlan(UpdateNetworkSitePlanRequest updateNetworkSitePlanRequest);
/**
* 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.
*/
void shutdown();
/**
* 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.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}