Package software.amazon.awssdk.services.privatenetworks

Interface PrivateNetworksClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface PrivateNetworksClient
extends AwsClient

Service client for accessing AWS Private 5G. This can be created using the static builder() method.

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	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
default AcknowledgeOrderReceiptResponse	acknowledgeOrderReceipt(Consumer<AcknowledgeOrderReceiptRequest.Builder> acknowledgeOrderReceiptRequest)	Acknowledges that the specified network order was received.
default AcknowledgeOrderReceiptResponse	acknowledgeOrderReceipt(AcknowledgeOrderReceiptRequest acknowledgeOrderReceiptRequest)	Acknowledges that the specified network order was received.
default ActivateDeviceIdentifierResponse	activateDeviceIdentifier(Consumer<ActivateDeviceIdentifierRequest.Builder> activateDeviceIdentifierRequest)	Activates the specified device identifier.
default ActivateDeviceIdentifierResponse	activateDeviceIdentifier(ActivateDeviceIdentifierRequest activateDeviceIdentifierRequest)	Activates the specified device identifier.
default ActivateNetworkSiteResponse	activateNetworkSite(Consumer<ActivateNetworkSiteRequest.Builder> activateNetworkSiteRequest)	Activates the specified network site.
default ActivateNetworkSiteResponse	activateNetworkSite(ActivateNetworkSiteRequest activateNetworkSiteRequest)	Activates the specified network site.
static PrivateNetworksClientBuilder	builder()	Create a builder that can be used to configure and create a PrivateNetworksClient.
default ConfigureAccessPointResponse	configureAccessPoint(Consumer<ConfigureAccessPointRequest.Builder> configureAccessPointRequest)	Configures the specified network resource.
default ConfigureAccessPointResponse	configureAccessPoint(ConfigureAccessPointRequest configureAccessPointRequest)	Configures the specified network resource.
static PrivateNetworksClient	create()	Create a PrivateNetworksClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateNetworkResponse	createNetwork(Consumer<CreateNetworkRequest.Builder> createNetworkRequest)	Creates a network.
default CreateNetworkResponse	createNetwork(CreateNetworkRequest createNetworkRequest)	Creates a network.
default CreateNetworkSiteResponse	createNetworkSite(Consumer<CreateNetworkSiteRequest.Builder> createNetworkSiteRequest)	Creates a network site.
default CreateNetworkSiteResponse	createNetworkSite(CreateNetworkSiteRequest createNetworkSiteRequest)	Creates a network site.
default DeactivateDeviceIdentifierResponse	deactivateDeviceIdentifier(Consumer<DeactivateDeviceIdentifierRequest.Builder> deactivateDeviceIdentifierRequest)	Deactivates the specified device identifier.
default DeactivateDeviceIdentifierResponse	deactivateDeviceIdentifier(DeactivateDeviceIdentifierRequest deactivateDeviceIdentifierRequest)	Deactivates the specified device identifier.
default DeleteNetworkResponse	deleteNetwork(Consumer<DeleteNetworkRequest.Builder> deleteNetworkRequest)	Deletes the specified network.
default DeleteNetworkResponse	deleteNetwork(DeleteNetworkRequest deleteNetworkRequest)	Deletes the specified network.
default DeleteNetworkSiteResponse	deleteNetworkSite(Consumer<DeleteNetworkSiteRequest.Builder> deleteNetworkSiteRequest)	Deletes the specified network site.
default DeleteNetworkSiteResponse	deleteNetworkSite(DeleteNetworkSiteRequest deleteNetworkSiteRequest)	Deletes the specified network site.
default GetDeviceIdentifierResponse	getDeviceIdentifier(Consumer<GetDeviceIdentifierRequest.Builder> getDeviceIdentifierRequest)	Gets the specified device identifier.
default GetDeviceIdentifierResponse	getDeviceIdentifier(GetDeviceIdentifierRequest getDeviceIdentifierRequest)	Gets the specified device identifier.
default GetNetworkResponse	getNetwork(Consumer<GetNetworkRequest.Builder> getNetworkRequest)	Gets the specified network.
default GetNetworkResponse	getNetwork(GetNetworkRequest getNetworkRequest)	Gets the specified network.
default GetNetworkResourceResponse	getNetworkResource(Consumer<GetNetworkResourceRequest.Builder> getNetworkResourceRequest)	Gets the specified network resource.
default GetNetworkResourceResponse	getNetworkResource(GetNetworkResourceRequest getNetworkResourceRequest)	Gets the specified network resource.
default GetNetworkSiteResponse	getNetworkSite(Consumer<GetNetworkSiteRequest.Builder> getNetworkSiteRequest)	Gets the specified network site.
default GetNetworkSiteResponse	getNetworkSite(GetNetworkSiteRequest getNetworkSiteRequest)	Gets the specified network site.
default GetOrderResponse	getOrder(Consumer<GetOrderRequest.Builder> getOrderRequest)	Gets the specified order.
default GetOrderResponse	getOrder(GetOrderRequest getOrderRequest)	Gets the specified order.
default ListDeviceIdentifiersResponse	listDeviceIdentifiers(Consumer<ListDeviceIdentifiersRequest.Builder> listDeviceIdentifiersRequest)	Lists device identifiers.
default ListDeviceIdentifiersResponse	listDeviceIdentifiers(ListDeviceIdentifiersRequest listDeviceIdentifiersRequest)	Lists device identifiers.
default ListDeviceIdentifiersIterable	listDeviceIdentifiersPaginator(Consumer<ListDeviceIdentifiersRequest.Builder> listDeviceIdentifiersRequest)	This is a variant of listDeviceIdentifiers(software.amazon.awssdk.services.privatenetworks.model.ListDeviceIdentifiersRequest) operation.
default ListDeviceIdentifiersIterable	listDeviceIdentifiersPaginator(ListDeviceIdentifiersRequest listDeviceIdentifiersRequest)	This is a variant of listDeviceIdentifiers(software.amazon.awssdk.services.privatenetworks.model.ListDeviceIdentifiersRequest) operation.
default ListNetworkResourcesResponse	listNetworkResources(Consumer<ListNetworkResourcesRequest.Builder> listNetworkResourcesRequest)	Lists network resources.
default ListNetworkResourcesResponse	listNetworkResources(ListNetworkResourcesRequest listNetworkResourcesRequest)	Lists network resources.
default ListNetworkResourcesIterable	listNetworkResourcesPaginator(Consumer<ListNetworkResourcesRequest.Builder> listNetworkResourcesRequest)	This is a variant of listNetworkResources(software.amazon.awssdk.services.privatenetworks.model.ListNetworkResourcesRequest) operation.
default ListNetworkResourcesIterable	listNetworkResourcesPaginator(ListNetworkResourcesRequest listNetworkResourcesRequest)	This is a variant of listNetworkResources(software.amazon.awssdk.services.privatenetworks.model.ListNetworkResourcesRequest) operation.
default ListNetworksResponse	listNetworks(Consumer<ListNetworksRequest.Builder> listNetworksRequest)	Lists networks.
default ListNetworksResponse	listNetworks(ListNetworksRequest listNetworksRequest)	Lists networks.
default ListNetworkSitesResponse	listNetworkSites(Consumer<ListNetworkSitesRequest.Builder> listNetworkSitesRequest)	Lists network sites.
default ListNetworkSitesResponse	listNetworkSites(ListNetworkSitesRequest listNetworkSitesRequest)	Lists network sites.
default ListNetworkSitesIterable	listNetworkSitesPaginator(Consumer<ListNetworkSitesRequest.Builder> listNetworkSitesRequest)	This is a variant of listNetworkSites(software.amazon.awssdk.services.privatenetworks.model.ListNetworkSitesRequest) operation.
default ListNetworkSitesIterable	listNetworkSitesPaginator(ListNetworkSitesRequest listNetworkSitesRequest)	This is a variant of listNetworkSites(software.amazon.awssdk.services.privatenetworks.model.ListNetworkSitesRequest) operation.
default ListNetworksIterable	listNetworksPaginator(Consumer<ListNetworksRequest.Builder> listNetworksRequest)	This is a variant of listNetworks(software.amazon.awssdk.services.privatenetworks.model.ListNetworksRequest) operation.
default ListNetworksIterable	listNetworksPaginator(ListNetworksRequest listNetworksRequest)	This is a variant of listNetworks(software.amazon.awssdk.services.privatenetworks.model.ListNetworksRequest) operation.
default ListOrdersResponse	listOrders(Consumer<ListOrdersRequest.Builder> listOrdersRequest)	Lists orders.
default ListOrdersResponse	listOrders(ListOrdersRequest listOrdersRequest)	Lists orders.
default ListOrdersIterable	listOrdersPaginator(Consumer<ListOrdersRequest.Builder> listOrdersRequest)	This is a variant of listOrders(software.amazon.awssdk.services.privatenetworks.model.ListOrdersRequest) operation.
default ListOrdersIterable	listOrdersPaginator(ListOrdersRequest listOrdersRequest)	This is a variant of listOrders(software.amazon.awssdk.services.privatenetworks.model.ListOrdersRequest) operation.
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)	Lists the tags for the specified resource.
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)	Lists the tags for the specified resource.
default PingResponse	ping(Consumer<PingRequest.Builder> pingRequest)	Checks the health of the service.
default PingResponse	ping(PingRequest pingRequest)	Checks the health of the service.
default PrivateNetworksServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default StartNetworkResourceUpdateResponse	startNetworkResourceUpdate(Consumer<StartNetworkResourceUpdateRequest.Builder> startNetworkResourceUpdateRequest)	Use this action to do the following tasks:
default StartNetworkResourceUpdateResponse	startNetworkResourceUpdate(StartNetworkResourceUpdateRequest startNetworkResourceUpdateRequest)	Use this action to do the following tasks:
default TagResourceResponse	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)	Adds tags to the specified resource.
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest)	Adds tags to the specified resource.
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)	Removes tags from the specified resource.
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest)	Removes tags from the specified resource.
default UpdateNetworkSiteResponse	updateNetworkSite(Consumer<UpdateNetworkSiteRequest.Builder> updateNetworkSiteRequest)	Updates the specified network site.
default UpdateNetworkSiteResponse	updateNetworkSite(UpdateNetworkSiteRequest updateNetworkSiteRequest)	Updates the specified network site.
default UpdateNetworkSitePlanResponse	updateNetworkSitePlan(Consumer<UpdateNetworkSitePlanRequest.Builder> updateNetworkSitePlanRequest)	Updates the specified network site plan.
default UpdateNetworkSitePlanResponse	updateNetworkSitePlan(UpdateNetworkSitePlanRequest updateNetworkSitePlanRequest)	Updates the specified network site plan.

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

acknowledgeOrderReceipt

default AcknowledgeOrderReceiptResponse acknowledgeOrderReceipt(AcknowledgeOrderReceiptRequest acknowledgeOrderReceiptRequest)
                                                         throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
PrivateNetworksException

Acknowledges that the specified network order was received.

Parameters:

acknowledgeOrderReceiptRequest -

Returns:

Result of the AcknowledgeOrderReceipt operation returned by the service.

See Also:

• AWS API Documentation

acknowledgeOrderReceipt

default AcknowledgeOrderReceiptResponse acknowledgeOrderReceipt(Consumer<AcknowledgeOrderReceiptRequest.Builder> acknowledgeOrderReceiptRequest)
                                                         throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
PrivateNetworksException

Acknowledges that the specified network order was received.

This is a convenience which creates an instance of the AcknowledgeOrderReceiptRequest.Builder avoiding the need to create one manually via AcknowledgeOrderReceiptRequest.builder()

Parameters:

acknowledgeOrderReceiptRequest - A Consumer that will call methods on AcknowledgeOrderReceiptRequest.Builder to create a request.

Returns:

Result of the AcknowledgeOrderReceipt operation returned by the service.

See Also:

• AWS API Documentation

activateDeviceIdentifier

default ActivateDeviceIdentifierResponse activateDeviceIdentifier(ActivateDeviceIdentifierRequest activateDeviceIdentifierRequest)
                                                           throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
PrivateNetworksException

Activates the specified device identifier.

Parameters:

activateDeviceIdentifierRequest -

Returns:

Result of the ActivateDeviceIdentifier operation returned by the service.

See Also:

• AWS API Documentation

activateDeviceIdentifier

default ActivateDeviceIdentifierResponse activateDeviceIdentifier(Consumer<ActivateDeviceIdentifierRequest.Builder> activateDeviceIdentifierRequest)
                                                           throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
PrivateNetworksException

Activates the specified device identifier.

This is a convenience which creates an instance of the ActivateDeviceIdentifierRequest.Builder avoiding the need to create one manually via ActivateDeviceIdentifierRequest.builder()

Parameters:

activateDeviceIdentifierRequest - A Consumer that will call methods on ActivateDeviceIdentifierRequest.Builder to create a request.

Returns:

Result of the ActivateDeviceIdentifier operation returned by the service.

See Also:

• AWS API Documentation

activateNetworkSite

default ActivateNetworkSiteResponse activateNetworkSite(ActivateNetworkSiteRequest activateNetworkSiteRequest)
                                                 throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
PrivateNetworksException

Activates the specified network site.

Parameters:

activateNetworkSiteRequest -

Returns:

Result of the ActivateNetworkSite operation returned by the service.

See Also:

• AWS API Documentation

activateNetworkSite

default ActivateNetworkSiteResponse activateNetworkSite(Consumer<ActivateNetworkSiteRequest.Builder> activateNetworkSiteRequest)
                                                 throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
PrivateNetworksException

Activates the specified network site.

This is a convenience which creates an instance of the ActivateNetworkSiteRequest.Builder avoiding the need to create one manually via ActivateNetworkSiteRequest.builder()

Parameters:

activateNetworkSiteRequest - A Consumer that will call methods on ActivateNetworkSiteRequest.Builder to create a request.

Returns:

Result of the ActivateNetworkSite operation returned by the service.

See Also:

• AWS API Documentation

configureAccessPoint

default ConfigureAccessPointResponse configureAccessPoint(ConfigureAccessPointRequest configureAccessPointRequest)
                                                   throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
PrivateNetworksException

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.

See Also:

• AWS API Documentation

configureAccessPoint

default ConfigureAccessPointResponse configureAccessPoint(Consumer<ConfigureAccessPointRequest.Builder> configureAccessPointRequest)
                                                   throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
PrivateNetworksException

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.

This is a convenience which creates an instance of the ConfigureAccessPointRequest.Builder avoiding the need to create one manually via ConfigureAccessPointRequest.builder()

Parameters:

configureAccessPointRequest - A Consumer that will call methods on ConfigureAccessPointRequest.Builder to create a request.

Returns:

Result of the ConfigureAccessPoint operation returned by the service.

See Also:

• AWS API Documentation

createNetwork

default CreateNetworkResponse createNetwork(CreateNetworkRequest createNetworkRequest)
                                     throws LimitExceededException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
PrivateNetworksException

Creates a network.

Parameters:

createNetworkRequest -

Returns:

Result of the CreateNetwork operation returned by the service.

See Also:

• AWS API Documentation

createNetwork

default CreateNetworkResponse createNetwork(Consumer<CreateNetworkRequest.Builder> createNetworkRequest)
                                     throws LimitExceededException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
PrivateNetworksException

Creates a network.

This is a convenience which creates an instance of the CreateNetworkRequest.Builder avoiding the need to create one manually via CreateNetworkRequest.builder()

Parameters:

createNetworkRequest - A Consumer that will call methods on CreateNetworkRequest.Builder to create a request.

Returns:

Result of the CreateNetwork operation returned by the service.

See Also:

• AWS API Documentation

createNetworkSite

default CreateNetworkSiteResponse createNetworkSite(CreateNetworkSiteRequest createNetworkSiteRequest)
                                             throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
PrivateNetworksException

Creates a network site.

Parameters:

createNetworkSiteRequest -

Returns:

Result of the CreateNetworkSite operation returned by the service.

See Also:

• AWS API Documentation

createNetworkSite

default CreateNetworkSiteResponse createNetworkSite(Consumer<CreateNetworkSiteRequest.Builder> createNetworkSiteRequest)
                                             throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
PrivateNetworksException

Creates a network site.

This is a convenience which creates an instance of the CreateNetworkSiteRequest.Builder avoiding the need to create one manually via CreateNetworkSiteRequest.builder()

Parameters:

createNetworkSiteRequest - A Consumer that will call methods on CreateNetworkSiteRequest.Builder to create a request.

Returns:

Result of the CreateNetworkSite operation returned by the service.

See Also:

• AWS API Documentation

deactivateDeviceIdentifier

default DeactivateDeviceIdentifierResponse deactivateDeviceIdentifier(DeactivateDeviceIdentifierRequest deactivateDeviceIdentifierRequest)
                                                               throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
PrivateNetworksException

Deactivates the specified device identifier.

Parameters:

deactivateDeviceIdentifierRequest -

Returns:

Result of the DeactivateDeviceIdentifier operation returned by the service.

See Also:

• AWS API Documentation

deactivateDeviceIdentifier

default DeactivateDeviceIdentifierResponse deactivateDeviceIdentifier(Consumer<DeactivateDeviceIdentifierRequest.Builder> deactivateDeviceIdentifierRequest)
                                                               throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
PrivateNetworksException

Deactivates the specified device identifier.

This is a convenience which creates an instance of the DeactivateDeviceIdentifierRequest.Builder avoiding the need to create one manually via DeactivateDeviceIdentifierRequest.builder()

Parameters:

deactivateDeviceIdentifierRequest - A Consumer that will call methods on DeactivateDeviceIdentifierRequest.Builder to create a request.

Returns:

Result of the DeactivateDeviceIdentifier operation returned by the service.

See Also:

• AWS API Documentation

deleteNetwork

default DeleteNetworkResponse deleteNetwork(DeleteNetworkRequest deleteNetworkRequest)
                                     throws ResourceNotFoundException,
AccessDeniedException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
PrivateNetworksException

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.

See Also:

• AWS API Documentation

deleteNetwork

default DeleteNetworkResponse deleteNetwork(Consumer<DeleteNetworkRequest.Builder> deleteNetworkRequest)
                                     throws ResourceNotFoundException,
AccessDeniedException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
PrivateNetworksException

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.

This is a convenience which creates an instance of the DeleteNetworkRequest.Builder avoiding the need to create one manually via DeleteNetworkRequest.builder()

Parameters:

deleteNetworkRequest - A Consumer that will call methods on DeleteNetworkRequest.Builder to create a request.

Returns:

Result of the DeleteNetwork operation returned by the service.

See Also:

• AWS API Documentation

deleteNetworkSite

default DeleteNetworkSiteResponse deleteNetworkSite(DeleteNetworkSiteRequest deleteNetworkSiteRequest)
                                             throws ResourceNotFoundException,
AccessDeniedException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
PrivateNetworksException

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.

See Also:

• AWS API Documentation

deleteNetworkSite

default DeleteNetworkSiteResponse deleteNetworkSite(Consumer<DeleteNetworkSiteRequest.Builder> deleteNetworkSiteRequest)
                                             throws ResourceNotFoundException,
AccessDeniedException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
PrivateNetworksException

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.

This is a convenience which creates an instance of the DeleteNetworkSiteRequest.Builder avoiding the need to create one manually via DeleteNetworkSiteRequest.builder()

Parameters:

deleteNetworkSiteRequest - A Consumer that will call methods on DeleteNetworkSiteRequest.Builder to create a request.

Returns:

Result of the DeleteNetworkSite operation returned by the service.

See Also:

• AWS API Documentation

getDeviceIdentifier

default GetDeviceIdentifierResponse getDeviceIdentifier(GetDeviceIdentifierRequest getDeviceIdentifierRequest)
                                                 throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
PrivateNetworksException

Gets the specified device identifier.

Parameters:

getDeviceIdentifierRequest -

Returns:

Result of the GetDeviceIdentifier operation returned by the service.

See Also:

• AWS API Documentation

getDeviceIdentifier

default GetDeviceIdentifierResponse getDeviceIdentifier(Consumer<GetDeviceIdentifierRequest.Builder> getDeviceIdentifierRequest)
                                                 throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
PrivateNetworksException

Gets the specified device identifier.

This is a convenience which creates an instance of the GetDeviceIdentifierRequest.Builder avoiding the need to create one manually via GetDeviceIdentifierRequest.builder()

Parameters:

getDeviceIdentifierRequest - A Consumer that will call methods on GetDeviceIdentifierRequest.Builder to create a request.

Returns:

Result of the GetDeviceIdentifier operation returned by the service.

See Also:

• AWS API Documentation

getNetwork

default GetNetworkResponse getNetwork(GetNetworkRequest getNetworkRequest)
                               throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
PrivateNetworksException

Gets the specified network.

Parameters:

getNetworkRequest -

Returns:

Result of the GetNetwork operation returned by the service.

See Also:

• AWS API Documentation

getNetwork

default GetNetworkResponse getNetwork(Consumer<GetNetworkRequest.Builder> getNetworkRequest)
                               throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
PrivateNetworksException

Gets the specified network.

This is a convenience which creates an instance of the GetNetworkRequest.Builder avoiding the need to create one manually via GetNetworkRequest.builder()

Parameters:

getNetworkRequest - A Consumer that will call methods on GetNetworkRequest.Builder to create a request.

Returns:

Result of the GetNetwork operation returned by the service.

See Also:

• AWS API Documentation

getNetworkResource

default GetNetworkResourceResponse getNetworkResource(GetNetworkResourceRequest getNetworkResourceRequest)
                                               throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
PrivateNetworksException

Gets the specified network resource.

Parameters:

getNetworkResourceRequest -

Returns:

Result of the GetNetworkResource operation returned by the service.

See Also:

• AWS API Documentation

getNetworkResource

default GetNetworkResourceResponse getNetworkResource(Consumer<GetNetworkResourceRequest.Builder> getNetworkResourceRequest)
                                               throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
PrivateNetworksException

Gets the specified network resource.

This is a convenience which creates an instance of the GetNetworkResourceRequest.Builder avoiding the need to create one manually via GetNetworkResourceRequest.builder()

Parameters:

getNetworkResourceRequest - A Consumer that will call methods on GetNetworkResourceRequest.Builder to create a request.

Returns:

Result of the GetNetworkResource operation returned by the service.

See Also:

• AWS API Documentation

getNetworkSite

default GetNetworkSiteResponse getNetworkSite(GetNetworkSiteRequest getNetworkSiteRequest)
                                       throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
PrivateNetworksException

Gets the specified network site.

Parameters:

getNetworkSiteRequest -

Returns:

Result of the GetNetworkSite operation returned by the service.

See Also:

• AWS API Documentation

getNetworkSite

default GetNetworkSiteResponse getNetworkSite(Consumer<GetNetworkSiteRequest.Builder> getNetworkSiteRequest)
                                       throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
PrivateNetworksException

Gets the specified network site.

This is a convenience which creates an instance of the GetNetworkSiteRequest.Builder avoiding the need to create one manually via GetNetworkSiteRequest.builder()

Parameters:

getNetworkSiteRequest - A Consumer that will call methods on GetNetworkSiteRequest.Builder to create a request.

Returns:

Result of the GetNetworkSite operation returned by the service.

See Also:

• AWS API Documentation

getOrder

default GetOrderResponse getOrder(GetOrderRequest getOrderRequest)
                           throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
PrivateNetworksException

Gets the specified order.

Parameters:

getOrderRequest -

Returns:

Result of the GetOrder operation returned by the service.

See Also:

• AWS API Documentation

getOrder

default GetOrderResponse getOrder(Consumer<GetOrderRequest.Builder> getOrderRequest)
                           throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
PrivateNetworksException

Gets the specified order.

This is a convenience which creates an instance of the GetOrderRequest.Builder avoiding the need to create one manually via GetOrderRequest.builder()

Parameters:

getOrderRequest - A Consumer that will call methods on GetOrderRequest.Builder to create a request.

Returns:

Result of the GetOrder operation returned by the service.

See Also:

• AWS API Documentation

listDeviceIdentifiers

default ListDeviceIdentifiersResponse listDeviceIdentifiers(ListDeviceIdentifiersRequest listDeviceIdentifiersRequest)
                                                     throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
PrivateNetworksException

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.

Parameters:

listDeviceIdentifiersRequest -

Returns:

Result of the ListDeviceIdentifiers operation returned by the service.

See Also:

• AWS API Documentation

listDeviceIdentifiers

default ListDeviceIdentifiersResponse listDeviceIdentifiers(Consumer<ListDeviceIdentifiersRequest.Builder> listDeviceIdentifiersRequest)
                                                     throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
PrivateNetworksException

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.

This is a convenience which creates an instance of the ListDeviceIdentifiersRequest.Builder avoiding the need to create one manually via ListDeviceIdentifiersRequest.builder()

Parameters:

listDeviceIdentifiersRequest - A Consumer that will call methods on ListDeviceIdentifiersRequest.Builder to create a request.

Returns:

Result of the ListDeviceIdentifiers operation returned by the service.

See Also:

• AWS API Documentation

listDeviceIdentifiersPaginator

default ListDeviceIdentifiersIterable listDeviceIdentifiersPaginator(ListDeviceIdentifiersRequest listDeviceIdentifiersRequest)
                                                              throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
PrivateNetworksException

This is a variant of listDeviceIdentifiers(software.amazon.awssdk.services.privatenetworks.model.ListDeviceIdentifiersRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.privatenetworks.paginators.ListDeviceIdentifiersIterable responses = client.listDeviceIdentifiersPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.privatenetworks.paginators.ListDeviceIdentifiersIterable responses = client
             .listDeviceIdentifiersPaginator(request);
     for (software.amazon.awssdk.services.privatenetworks.model.ListDeviceIdentifiersResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.privatenetworks.paginators.ListDeviceIdentifiersIterable responses = client.listDeviceIdentifiersPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listDeviceIdentifiers(software.amazon.awssdk.services.privatenetworks.model.ListDeviceIdentifiersRequest) operation.

Parameters:

listDeviceIdentifiersRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listDeviceIdentifiersPaginator

default ListDeviceIdentifiersIterable listDeviceIdentifiersPaginator(Consumer<ListDeviceIdentifiersRequest.Builder> listDeviceIdentifiersRequest)
                                                              throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
PrivateNetworksException

This is a variant of listDeviceIdentifiers(software.amazon.awssdk.services.privatenetworks.model.ListDeviceIdentifiersRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.privatenetworks.paginators.ListDeviceIdentifiersIterable responses = client.listDeviceIdentifiersPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.privatenetworks.paginators.ListDeviceIdentifiersIterable responses = client
             .listDeviceIdentifiersPaginator(request);
     for (software.amazon.awssdk.services.privatenetworks.model.ListDeviceIdentifiersResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.privatenetworks.paginators.ListDeviceIdentifiersIterable responses = client.listDeviceIdentifiersPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listDeviceIdentifiers(software.amazon.awssdk.services.privatenetworks.model.ListDeviceIdentifiersRequest) operation.

This is a convenience which creates an instance of the ListDeviceIdentifiersRequest.Builder avoiding the need to create one manually via ListDeviceIdentifiersRequest.builder()

Parameters:

listDeviceIdentifiersRequest - A Consumer that will call methods on ListDeviceIdentifiersRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listNetworkResources

default ListNetworkResourcesResponse listNetworkResources(ListNetworkResourcesRequest listNetworkResourcesRequest)
                                                   throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
PrivateNetworksException

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.

See Also:

• AWS API Documentation

listNetworkResources

default ListNetworkResourcesResponse listNetworkResources(Consumer<ListNetworkResourcesRequest.Builder> listNetworkResourcesRequest)
                                                   throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
PrivateNetworksException

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.

This is a convenience which creates an instance of the ListNetworkResourcesRequest.Builder avoiding the need to create one manually via ListNetworkResourcesRequest.builder()

Parameters:

listNetworkResourcesRequest - A Consumer that will call methods on ListNetworkResourcesRequest.Builder to create a request.

Returns:

Result of the ListNetworkResources operation returned by the service.

See Also:

• AWS API Documentation

listNetworkResourcesPaginator

default ListNetworkResourcesIterable listNetworkResourcesPaginator(ListNetworkResourcesRequest listNetworkResourcesRequest)
                                                            throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
PrivateNetworksException

This is a variant of listNetworkResources(software.amazon.awssdk.services.privatenetworks.model.ListNetworkResourcesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.privatenetworks.paginators.ListNetworkResourcesIterable responses = client.listNetworkResourcesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.privatenetworks.paginators.ListNetworkResourcesIterable responses = client
             .listNetworkResourcesPaginator(request);
     for (software.amazon.awssdk.services.privatenetworks.model.ListNetworkResourcesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.privatenetworks.paginators.ListNetworkResourcesIterable responses = client.listNetworkResourcesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listNetworkResources(software.amazon.awssdk.services.privatenetworks.model.ListNetworkResourcesRequest) operation.

Parameters:

listNetworkResourcesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listNetworkResourcesPaginator

default ListNetworkResourcesIterable listNetworkResourcesPaginator(Consumer<ListNetworkResourcesRequest.Builder> listNetworkResourcesRequest)
                                                            throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
PrivateNetworksException

This is a variant of listNetworkResources(software.amazon.awssdk.services.privatenetworks.model.ListNetworkResourcesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.privatenetworks.paginators.ListNetworkResourcesIterable responses = client.listNetworkResourcesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.privatenetworks.paginators.ListNetworkResourcesIterable responses = client
             .listNetworkResourcesPaginator(request);
     for (software.amazon.awssdk.services.privatenetworks.model.ListNetworkResourcesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.privatenetworks.paginators.ListNetworkResourcesIterable responses = client.listNetworkResourcesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listNetworkResources(software.amazon.awssdk.services.privatenetworks.model.ListNetworkResourcesRequest) operation.

This is a convenience which creates an instance of the ListNetworkResourcesRequest.Builder avoiding the need to create one manually via ListNetworkResourcesRequest.builder()

Parameters:

listNetworkResourcesRequest - A Consumer that will call methods on ListNetworkResourcesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listNetworkSites

default ListNetworkSitesResponse listNetworkSites(ListNetworkSitesRequest listNetworkSitesRequest)
                                           throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
PrivateNetworksException

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.

See Also:

• AWS API Documentation

listNetworkSites

default ListNetworkSitesResponse listNetworkSites(Consumer<ListNetworkSitesRequest.Builder> listNetworkSitesRequest)
                                           throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
PrivateNetworksException

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.

This is a convenience which creates an instance of the ListNetworkSitesRequest.Builder avoiding the need to create one manually via ListNetworkSitesRequest.builder()

Parameters:

listNetworkSitesRequest - A Consumer that will call methods on ListNetworkSitesRequest.Builder to create a request.

Returns:

Result of the ListNetworkSites operation returned by the service.

See Also:

• AWS API Documentation

listNetworkSitesPaginator

default ListNetworkSitesIterable listNetworkSitesPaginator(ListNetworkSitesRequest listNetworkSitesRequest)
                                                    throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
PrivateNetworksException

This is a variant of listNetworkSites(software.amazon.awssdk.services.privatenetworks.model.ListNetworkSitesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.privatenetworks.paginators.ListNetworkSitesIterable responses = client.listNetworkSitesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.privatenetworks.paginators.ListNetworkSitesIterable responses = client
             .listNetworkSitesPaginator(request);
     for (software.amazon.awssdk.services.privatenetworks.model.ListNetworkSitesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.privatenetworks.paginators.ListNetworkSitesIterable responses = client.listNetworkSitesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listNetworkSites(software.amazon.awssdk.services.privatenetworks.model.ListNetworkSitesRequest) operation.

Parameters:

listNetworkSitesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listNetworkSitesPaginator

default ListNetworkSitesIterable listNetworkSitesPaginator(Consumer<ListNetworkSitesRequest.Builder> listNetworkSitesRequest)
                                                    throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
PrivateNetworksException

This is a variant of listNetworkSites(software.amazon.awssdk.services.privatenetworks.model.ListNetworkSitesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.privatenetworks.paginators.ListNetworkSitesIterable responses = client.listNetworkSitesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.privatenetworks.paginators.ListNetworkSitesIterable responses = client
             .listNetworkSitesPaginator(request);
     for (software.amazon.awssdk.services.privatenetworks.model.ListNetworkSitesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.privatenetworks.paginators.ListNetworkSitesIterable responses = client.listNetworkSitesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listNetworkSites(software.amazon.awssdk.services.privatenetworks.model.ListNetworkSitesRequest) operation.

This is a convenience which creates an instance of the ListNetworkSitesRequest.Builder avoiding the need to create one manually via ListNetworkSitesRequest.builder()

Parameters:

listNetworkSitesRequest - A Consumer that will call methods on ListNetworkSitesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listNetworks

default ListNetworksResponse listNetworks(ListNetworksRequest listNetworksRequest)
                                   throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
PrivateNetworksException

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.

See Also:

• AWS API Documentation

listNetworks

default ListNetworksResponse listNetworks(Consumer<ListNetworksRequest.Builder> listNetworksRequest)
                                   throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
PrivateNetworksException

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

This is a convenience which creates an instance of the ListNetworksRequest.Builder avoiding the need to create one manually via ListNetworksRequest.builder()

Parameters:

listNetworksRequest - A Consumer that will call methods on ListNetworksRequest.Builder to create a request.

Returns:

Result of the ListNetworks operation returned by the service.

See Also:

• AWS API Documentation

listNetworksPaginator

default ListNetworksIterable listNetworksPaginator(ListNetworksRequest listNetworksRequest)
                                            throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
PrivateNetworksException

This is a variant of listNetworks(software.amazon.awssdk.services.privatenetworks.model.ListNetworksRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.privatenetworks.paginators.ListNetworksIterable responses = client.listNetworksPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.privatenetworks.paginators.ListNetworksIterable responses = client
             .listNetworksPaginator(request);
     for (software.amazon.awssdk.services.privatenetworks.model.ListNetworksResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.privatenetworks.paginators.ListNetworksIterable responses = client.listNetworksPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listNetworks(software.amazon.awssdk.services.privatenetworks.model.ListNetworksRequest) operation.

Parameters:

listNetworksRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listNetworksPaginator

default ListNetworksIterable listNetworksPaginator(Consumer<ListNetworksRequest.Builder> listNetworksRequest)
                                            throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
PrivateNetworksException

This is a variant of listNetworks(software.amazon.awssdk.services.privatenetworks.model.ListNetworksRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.privatenetworks.paginators.ListNetworksIterable responses = client.listNetworksPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.privatenetworks.paginators.ListNetworksIterable responses = client
             .listNetworksPaginator(request);
     for (software.amazon.awssdk.services.privatenetworks.model.ListNetworksResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.privatenetworks.paginators.ListNetworksIterable responses = client.listNetworksPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listNetworks(software.amazon.awssdk.services.privatenetworks.model.ListNetworksRequest) operation.

This is a convenience which creates an instance of the ListNetworksRequest.Builder avoiding the need to create one manually via ListNetworksRequest.builder()

Parameters:

listNetworksRequest - A Consumer that will call methods on ListNetworksRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listOrders

default ListOrdersResponse listOrders(ListOrdersRequest listOrdersRequest)
                               throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
PrivateNetworksException

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.

See Also:

• AWS API Documentation

listOrders

default ListOrdersResponse listOrders(Consumer<ListOrdersRequest.Builder> listOrdersRequest)
                               throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
PrivateNetworksException

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.

This is a convenience which creates an instance of the ListOrdersRequest.Builder avoiding the need to create one manually via ListOrdersRequest.builder()

Parameters:

listOrdersRequest - A Consumer that will call methods on ListOrdersRequest.Builder to create a request.

Returns:

Result of the ListOrders operation returned by the service.

See Also:

• AWS API Documentation

listOrdersPaginator

default ListOrdersIterable listOrdersPaginator(ListOrdersRequest listOrdersRequest)
                                        throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
PrivateNetworksException

This is a variant of listOrders(software.amazon.awssdk.services.privatenetworks.model.ListOrdersRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.privatenetworks.paginators.ListOrdersIterable responses = client.listOrdersPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.privatenetworks.paginators.ListOrdersIterable responses = client.listOrdersPaginator(request);
     for (software.amazon.awssdk.services.privatenetworks.model.ListOrdersResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.privatenetworks.paginators.ListOrdersIterable responses = client.listOrdersPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listOrders(software.amazon.awssdk.services.privatenetworks.model.ListOrdersRequest) operation.

Parameters:

listOrdersRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listOrdersPaginator

default ListOrdersIterable listOrdersPaginator(Consumer<ListOrdersRequest.Builder> listOrdersRequest)
                                        throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
PrivateNetworksException

This is a variant of listOrders(software.amazon.awssdk.services.privatenetworks.model.ListOrdersRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.privatenetworks.paginators.ListOrdersIterable responses = client.listOrdersPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.privatenetworks.paginators.ListOrdersIterable responses = client.listOrdersPaginator(request);
     for (software.amazon.awssdk.services.privatenetworks.model.ListOrdersResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.privatenetworks.paginators.ListOrdersIterable responses = client.listOrdersPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listOrders(software.amazon.awssdk.services.privatenetworks.model.ListOrdersRequest) operation.

This is a convenience which creates an instance of the ListOrdersRequest.Builder avoiding the need to create one manually via ListOrdersRequest.builder()

Parameters:

listOrdersRequest - A Consumer that will call methods on ListOrdersRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws ResourceNotFoundException,
AccessDeniedException,
ValidationException,
InternalServerException,
ThrottlingException,
AwsServiceException,
SdkClientException,
PrivateNetworksException

Lists the tags for the specified resource.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
                                                 throws ResourceNotFoundException,
AccessDeniedException,
ValidationException,
InternalServerException,
ThrottlingException,
AwsServiceException,
SdkClientException,
PrivateNetworksException

Lists the tags for the specified resource.

This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

Parameters:

listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

ping

default PingResponse ping(PingRequest pingRequest)
                   throws InternalServerException,
AwsServiceException,
SdkClientException,
PrivateNetworksException

Checks the health of the service.

Parameters:

pingRequest -

Returns:

Result of the Ping operation returned by the service.

See Also:

• AWS API Documentation

ping

default PingResponse ping(Consumer<PingRequest.Builder> pingRequest)
                   throws InternalServerException,
AwsServiceException,
SdkClientException,
PrivateNetworksException

Checks the health of the service.

This is a convenience which creates an instance of the PingRequest.Builder avoiding the need to create one manually via PingRequest.builder()

Parameters:

pingRequest - A Consumer that will call methods on PingRequest.Builder to create a request.

Returns:

Result of the Ping operation returned by the service.

See Also:

• AWS API Documentation

startNetworkResourceUpdate

default StartNetworkResourceUpdateResponse startNetworkResourceUpdate(StartNetworkResourceUpdateRequest startNetworkResourceUpdateRequest)
                                                               throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
PrivateNetworksException

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.

Parameters:

startNetworkResourceUpdateRequest -

Returns:

Result of the StartNetworkResourceUpdate operation returned by the service.

See Also:

• AWS API Documentation

startNetworkResourceUpdate

default StartNetworkResourceUpdateResponse startNetworkResourceUpdate(Consumer<StartNetworkResourceUpdateRequest.Builder> startNetworkResourceUpdateRequest)
                                                               throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
PrivateNetworksException

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.

This is a convenience which creates an instance of the StartNetworkResourceUpdateRequest.Builder avoiding the need to create one manually via StartNetworkResourceUpdateRequest.builder()

Parameters:

startNetworkResourceUpdateRequest - A Consumer that will call methods on StartNetworkResourceUpdateRequest.Builder to create a request.

Returns:

Result of the StartNetworkResourceUpdate operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws ResourceNotFoundException,
AccessDeniedException,
ValidationException,
InternalServerException,
ThrottlingException,
AwsServiceException,
SdkClientException,
PrivateNetworksException

Adds tags to the specified resource.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws ResourceNotFoundException,
AccessDeniedException,
ValidationException,
InternalServerException,
ThrottlingException,
AwsServiceException,
SdkClientException,
PrivateNetworksException

Adds tags to the specified resource.

This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()

Parameters:

tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws ResourceNotFoundException,
AccessDeniedException,
ValidationException,
InternalServerException,
ThrottlingException,
AwsServiceException,
SdkClientException,
PrivateNetworksException

Removes tags from the specified resource.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
                                     throws ResourceNotFoundException,
AccessDeniedException,
ValidationException,
InternalServerException,
ThrottlingException,
AwsServiceException,
SdkClientException,
PrivateNetworksException

Removes tags from the specified resource.

This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

Parameters:

untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

updateNetworkSite

default UpdateNetworkSiteResponse updateNetworkSite(UpdateNetworkSiteRequest updateNetworkSiteRequest)
                                             throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
PrivateNetworksException

Updates the specified network site.

Parameters:

updateNetworkSiteRequest -

Returns:

Result of the UpdateNetworkSite operation returned by the service.

See Also:

• AWS API Documentation

updateNetworkSite

default UpdateNetworkSiteResponse updateNetworkSite(Consumer<UpdateNetworkSiteRequest.Builder> updateNetworkSiteRequest)
                                             throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
PrivateNetworksException

Updates the specified network site.

This is a convenience which creates an instance of the UpdateNetworkSiteRequest.Builder avoiding the need to create one manually via UpdateNetworkSiteRequest.builder()

Parameters:

updateNetworkSiteRequest - A Consumer that will call methods on UpdateNetworkSiteRequest.Builder to create a request.

Returns:

Result of the UpdateNetworkSite operation returned by the service.

See Also:

• AWS API Documentation

updateNetworkSitePlan

default UpdateNetworkSitePlanResponse updateNetworkSitePlan(UpdateNetworkSitePlanRequest updateNetworkSitePlanRequest)
                                                     throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
PrivateNetworksException

Updates the specified network site plan.

Parameters:

updateNetworkSitePlanRequest -

Returns:

Result of the UpdateNetworkSitePlan operation returned by the service.

See Also:

• AWS API Documentation

updateNetworkSitePlan

default UpdateNetworkSitePlanResponse updateNetworkSitePlan(Consumer<UpdateNetworkSitePlanRequest.Builder> updateNetworkSitePlanRequest)
                                                     throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
PrivateNetworksException

Updates the specified network site plan.

This is a convenience which creates an instance of the UpdateNetworkSitePlanRequest.Builder avoiding the need to create one manually via UpdateNetworkSitePlanRequest.builder()

Parameters:

updateNetworkSitePlanRequest - A Consumer that will call methods on UpdateNetworkSitePlanRequest.Builder to create a request.

Returns:

Result of the UpdateNetworkSitePlan operation returned by the service.

See Also:

• AWS API Documentation

create

static PrivateNetworksClient create()

Create a PrivateNetworksClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static PrivateNetworksClientBuilder builder()

Create a builder that can be used to configure and create a PrivateNetworksClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default PrivateNetworksServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration