Interface OutpostsAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any
invalid reference
SdkAsyncHttpClient
Amazon Web Services Outposts is a fully managed service that extends Amazon Web Services infrastructure, APIs, and tools to customer premises. By providing local access to Amazon Web Services managed infrastructure, Amazon Web Services Outposts enables customers to build and run applications on premises using the same programming interfaces as in Amazon Web Services Regions, while using local compute and storage resources for lower latency and local data processing needs.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionstatic OutpostsAsyncClientBuilder
builder()
Create a builder that can be used to configure and create aOutpostsAsyncClient
.cancelCapacityTask
(Consumer<CancelCapacityTaskRequest.Builder> cancelCapacityTaskRequest) Cancels the capacity task.cancelCapacityTask
(CancelCapacityTaskRequest cancelCapacityTaskRequest) Cancels the capacity task.default CompletableFuture
<CancelOrderResponse> cancelOrder
(Consumer<CancelOrderRequest.Builder> cancelOrderRequest) Cancels the specified order for an Outpost.default CompletableFuture
<CancelOrderResponse> cancelOrder
(CancelOrderRequest cancelOrderRequest) Cancels the specified order for an Outpost.static OutpostsAsyncClient
create()
Create aOutpostsAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CompletableFuture
<CreateOrderResponse> createOrder
(Consumer<CreateOrderRequest.Builder> createOrderRequest) Creates an order for an Outpost.default CompletableFuture
<CreateOrderResponse> createOrder
(CreateOrderRequest createOrderRequest) Creates an order for an Outpost.default CompletableFuture
<CreateOutpostResponse> createOutpost
(Consumer<CreateOutpostRequest.Builder> createOutpostRequest) Creates an Outpost.default CompletableFuture
<CreateOutpostResponse> createOutpost
(CreateOutpostRequest createOutpostRequest) Creates an Outpost.default CompletableFuture
<CreateSiteResponse> createSite
(Consumer<CreateSiteRequest.Builder> createSiteRequest) Creates a site for an Outpost.default CompletableFuture
<CreateSiteResponse> createSite
(CreateSiteRequest createSiteRequest) Creates a site for an Outpost.default CompletableFuture
<DeleteOutpostResponse> deleteOutpost
(Consumer<DeleteOutpostRequest.Builder> deleteOutpostRequest) Deletes the specified Outpost.default CompletableFuture
<DeleteOutpostResponse> deleteOutpost
(DeleteOutpostRequest deleteOutpostRequest) Deletes the specified Outpost.default CompletableFuture
<DeleteSiteResponse> deleteSite
(Consumer<DeleteSiteRequest.Builder> deleteSiteRequest) Deletes the specified site.default CompletableFuture
<DeleteSiteResponse> deleteSite
(DeleteSiteRequest deleteSiteRequest) Deletes the specified site.default CompletableFuture
<GetCapacityTaskResponse> getCapacityTask
(Consumer<GetCapacityTaskRequest.Builder> getCapacityTaskRequest) Gets details of the specified capacity task.default CompletableFuture
<GetCapacityTaskResponse> getCapacityTask
(GetCapacityTaskRequest getCapacityTaskRequest) Gets details of the specified capacity task.default CompletableFuture
<GetCatalogItemResponse> getCatalogItem
(Consumer<GetCatalogItemRequest.Builder> getCatalogItemRequest) Gets information about the specified catalog item.default CompletableFuture
<GetCatalogItemResponse> getCatalogItem
(GetCatalogItemRequest getCatalogItemRequest) Gets information about the specified catalog item.default CompletableFuture
<GetConnectionResponse> getConnection
(Consumer<GetConnectionRequest.Builder> getConnectionRequest) default CompletableFuture
<GetConnectionResponse> getConnection
(GetConnectionRequest getConnectionRequest) default CompletableFuture
<GetOrderResponse> getOrder
(Consumer<GetOrderRequest.Builder> getOrderRequest) Gets information about the specified order.default CompletableFuture
<GetOrderResponse> getOrder
(GetOrderRequest getOrderRequest) Gets information about the specified order.default CompletableFuture
<GetOutpostResponse> getOutpost
(Consumer<GetOutpostRequest.Builder> getOutpostRequest) Gets information about the specified Outpost.default CompletableFuture
<GetOutpostResponse> getOutpost
(GetOutpostRequest getOutpostRequest) Gets information about the specified Outpost.getOutpostInstanceTypes
(Consumer<GetOutpostInstanceTypesRequest.Builder> getOutpostInstanceTypesRequest) Gets the instance types for the specified Outpost.getOutpostInstanceTypes
(GetOutpostInstanceTypesRequest getOutpostInstanceTypesRequest) Gets the instance types for the specified Outpost.default GetOutpostInstanceTypesPublisher
getOutpostInstanceTypesPaginator
(Consumer<GetOutpostInstanceTypesRequest.Builder> getOutpostInstanceTypesRequest) This is a variant ofgetOutpostInstanceTypes(software.amazon.awssdk.services.outposts.model.GetOutpostInstanceTypesRequest)
operation.default GetOutpostInstanceTypesPublisher
getOutpostInstanceTypesPaginator
(GetOutpostInstanceTypesRequest getOutpostInstanceTypesRequest) This is a variant ofgetOutpostInstanceTypes(software.amazon.awssdk.services.outposts.model.GetOutpostInstanceTypesRequest)
operation.getOutpostSupportedInstanceTypes
(Consumer<GetOutpostSupportedInstanceTypesRequest.Builder> getOutpostSupportedInstanceTypesRequest) Gets the instance types that an Outpost can support inInstanceTypeCapacity
.getOutpostSupportedInstanceTypes
(GetOutpostSupportedInstanceTypesRequest getOutpostSupportedInstanceTypesRequest) Gets the instance types that an Outpost can support inInstanceTypeCapacity
.getOutpostSupportedInstanceTypesPaginator
(Consumer<GetOutpostSupportedInstanceTypesRequest.Builder> getOutpostSupportedInstanceTypesRequest) This is a variant ofgetOutpostSupportedInstanceTypes(software.amazon.awssdk.services.outposts.model.GetOutpostSupportedInstanceTypesRequest)
operation.getOutpostSupportedInstanceTypesPaginator
(GetOutpostSupportedInstanceTypesRequest getOutpostSupportedInstanceTypesRequest) This is a variant ofgetOutpostSupportedInstanceTypes(software.amazon.awssdk.services.outposts.model.GetOutpostSupportedInstanceTypesRequest)
operation.default CompletableFuture
<GetSiteResponse> getSite
(Consumer<GetSiteRequest.Builder> getSiteRequest) Gets information about the specified Outpost site.default CompletableFuture
<GetSiteResponse> getSite
(GetSiteRequest getSiteRequest) Gets information about the specified Outpost site.default CompletableFuture
<GetSiteAddressResponse> getSiteAddress
(Consumer<GetSiteAddressRequest.Builder> getSiteAddressRequest) Gets the site address of the specified site.default CompletableFuture
<GetSiteAddressResponse> getSiteAddress
(GetSiteAddressRequest getSiteAddressRequest) Gets the site address of the specified site.default CompletableFuture
<ListAssetsResponse> listAssets
(Consumer<ListAssetsRequest.Builder> listAssetsRequest) Lists the hardware assets for the specified Outpost.default CompletableFuture
<ListAssetsResponse> listAssets
(ListAssetsRequest listAssetsRequest) Lists the hardware assets for the specified Outpost.default ListAssetsPublisher
listAssetsPaginator
(Consumer<ListAssetsRequest.Builder> listAssetsRequest) This is a variant oflistAssets(software.amazon.awssdk.services.outposts.model.ListAssetsRequest)
operation.default ListAssetsPublisher
listAssetsPaginator
(ListAssetsRequest listAssetsRequest) This is a variant oflistAssets(software.amazon.awssdk.services.outposts.model.ListAssetsRequest)
operation.listCapacityTasks
(Consumer<ListCapacityTasksRequest.Builder> listCapacityTasksRequest) Lists the capacity tasks for your Amazon Web Services account.listCapacityTasks
(ListCapacityTasksRequest listCapacityTasksRequest) Lists the capacity tasks for your Amazon Web Services account.default ListCapacityTasksPublisher
listCapacityTasksPaginator
(Consumer<ListCapacityTasksRequest.Builder> listCapacityTasksRequest) This is a variant oflistCapacityTasks(software.amazon.awssdk.services.outposts.model.ListCapacityTasksRequest)
operation.default ListCapacityTasksPublisher
listCapacityTasksPaginator
(ListCapacityTasksRequest listCapacityTasksRequest) This is a variant oflistCapacityTasks(software.amazon.awssdk.services.outposts.model.ListCapacityTasksRequest)
operation.listCatalogItems
(Consumer<ListCatalogItemsRequest.Builder> listCatalogItemsRequest) Lists the items in the catalog.listCatalogItems
(ListCatalogItemsRequest listCatalogItemsRequest) Lists the items in the catalog.default ListCatalogItemsPublisher
listCatalogItemsPaginator
(Consumer<ListCatalogItemsRequest.Builder> listCatalogItemsRequest) This is a variant oflistCatalogItems(software.amazon.awssdk.services.outposts.model.ListCatalogItemsRequest)
operation.default ListCatalogItemsPublisher
listCatalogItemsPaginator
(ListCatalogItemsRequest listCatalogItemsRequest) This is a variant oflistCatalogItems(software.amazon.awssdk.services.outposts.model.ListCatalogItemsRequest)
operation.default CompletableFuture
<ListOrdersResponse> listOrders
(Consumer<ListOrdersRequest.Builder> listOrdersRequest) Lists the Outpost orders for your Amazon Web Services account.default CompletableFuture
<ListOrdersResponse> listOrders
(ListOrdersRequest listOrdersRequest) Lists the Outpost orders for your Amazon Web Services account.default ListOrdersPublisher
listOrdersPaginator
(Consumer<ListOrdersRequest.Builder> listOrdersRequest) This is a variant oflistOrders(software.amazon.awssdk.services.outposts.model.ListOrdersRequest)
operation.default ListOrdersPublisher
listOrdersPaginator
(ListOrdersRequest listOrdersRequest) This is a variant oflistOrders(software.amazon.awssdk.services.outposts.model.ListOrdersRequest)
operation.default CompletableFuture
<ListOutpostsResponse> listOutposts
(Consumer<ListOutpostsRequest.Builder> listOutpostsRequest) Lists the Outposts for your Amazon Web Services account.default CompletableFuture
<ListOutpostsResponse> listOutposts
(ListOutpostsRequest listOutpostsRequest) Lists the Outposts for your Amazon Web Services account.default ListOutpostsPublisher
listOutpostsPaginator
(Consumer<ListOutpostsRequest.Builder> listOutpostsRequest) This is a variant oflistOutposts(software.amazon.awssdk.services.outposts.model.ListOutpostsRequest)
operation.default ListOutpostsPublisher
listOutpostsPaginator
(ListOutpostsRequest listOutpostsRequest) This is a variant oflistOutposts(software.amazon.awssdk.services.outposts.model.ListOutpostsRequest)
operation.default CompletableFuture
<ListSitesResponse> listSites
(Consumer<ListSitesRequest.Builder> listSitesRequest) Lists the Outpost sites for your Amazon Web Services account.default CompletableFuture
<ListSitesResponse> listSites
(ListSitesRequest listSitesRequest) Lists the Outpost sites for your Amazon Web Services account.default ListSitesPublisher
listSitesPaginator
(Consumer<ListSitesRequest.Builder> listSitesRequest) This is a variant oflistSites(software.amazon.awssdk.services.outposts.model.ListSitesRequest)
operation.default ListSitesPublisher
listSitesPaginator
(ListSitesRequest listSitesRequest) This is a variant oflistSites(software.amazon.awssdk.services.outposts.model.ListSitesRequest)
operation.listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags for the specified resource.listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags for the specified resource.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstartCapacityTask
(Consumer<StartCapacityTaskRequest.Builder> startCapacityTaskRequest) Starts the specified capacity task.startCapacityTask
(StartCapacityTaskRequest startCapacityTaskRequest) Starts the specified capacity task.default CompletableFuture
<StartConnectionResponse> startConnection
(Consumer<StartConnectionRequest.Builder> startConnectionRequest) default CompletableFuture
<StartConnectionResponse> startConnection
(StartConnectionRequest startConnectionRequest) default CompletableFuture
<TagResourceResponse> tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds tags to the specified resource.default CompletableFuture
<TagResourceResponse> tagResource
(TagResourceRequest tagResourceRequest) Adds tags to the specified resource.default CompletableFuture
<UntagResourceResponse> untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes tags from the specified resource.default CompletableFuture
<UntagResourceResponse> untagResource
(UntagResourceRequest untagResourceRequest) Removes tags from the specified resource.default CompletableFuture
<UpdateOutpostResponse> updateOutpost
(Consumer<UpdateOutpostRequest.Builder> updateOutpostRequest) Updates an Outpost.default CompletableFuture
<UpdateOutpostResponse> updateOutpost
(UpdateOutpostRequest updateOutpostRequest) Updates an Outpost.default CompletableFuture
<UpdateSiteResponse> updateSite
(Consumer<UpdateSiteRequest.Builder> updateSiteRequest) Updates the specified site.default CompletableFuture
<UpdateSiteResponse> updateSite
(UpdateSiteRequest updateSiteRequest) Updates the specified site.updateSiteAddress
(Consumer<UpdateSiteAddressRequest.Builder> updateSiteAddressRequest) Updates the address of the specified site.updateSiteAddress
(UpdateSiteAddressRequest updateSiteAddressRequest) Updates the address of the specified site.updateSiteRackPhysicalProperties
(Consumer<UpdateSiteRackPhysicalPropertiesRequest.Builder> updateSiteRackPhysicalPropertiesRequest) Update the physical and logistical details for a rack at a site.updateSiteRackPhysicalProperties
(UpdateSiteRackPhysicalPropertiesRequest updateSiteRackPhysicalPropertiesRequest) Update the physical and logistical details for a rack at a site.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
cancelCapacityTask
default CompletableFuture<CancelCapacityTaskResponse> cancelCapacityTask(CancelCapacityTaskRequest cancelCapacityTaskRequest) Cancels the capacity task.
- Parameters:
cancelCapacityTaskRequest
-- Returns:
- A Java Future containing the result of the CancelCapacityTask operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException A parameter is not valid.
- AccessDeniedException You do not have permission to perform this operation.
- NotFoundException The specified request is not valid.
- ConflictException Updating or deleting this resource can cause an inconsistent state.
- InternalServerException An internal error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
cancelCapacityTask
default CompletableFuture<CancelCapacityTaskResponse> cancelCapacityTask(Consumer<CancelCapacityTaskRequest.Builder> cancelCapacityTaskRequest) Cancels the capacity task.
This is a convenience which creates an instance of the
CancelCapacityTaskRequest.Builder
avoiding the need to create one manually viaCancelCapacityTaskRequest.builder()
- Parameters:
cancelCapacityTaskRequest
- AConsumer
that will call methods onCancelCapacityTaskRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CancelCapacityTask operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException A parameter is not valid.
- AccessDeniedException You do not have permission to perform this operation.
- NotFoundException The specified request is not valid.
- ConflictException Updating or deleting this resource can cause an inconsistent state.
- InternalServerException An internal error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
cancelOrder
Cancels the specified order for an Outpost.
- Parameters:
cancelOrderRequest
-- Returns:
- A Java Future containing the result of the CancelOrder operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException A parameter is not valid.
- ConflictException Updating or deleting this resource can cause an inconsistent state.
- AccessDeniedException You do not have permission to perform this operation.
- NotFoundException The specified request is not valid.
- InternalServerException An internal error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
cancelOrder
default CompletableFuture<CancelOrderResponse> cancelOrder(Consumer<CancelOrderRequest.Builder> cancelOrderRequest) Cancels the specified order for an Outpost.
This is a convenience which creates an instance of the
CancelOrderRequest.Builder
avoiding the need to create one manually viaCancelOrderRequest.builder()
- Parameters:
cancelOrderRequest
- AConsumer
that will call methods onCancelOrderRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CancelOrder operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException A parameter is not valid.
- ConflictException Updating or deleting this resource can cause an inconsistent state.
- AccessDeniedException You do not have permission to perform this operation.
- NotFoundException The specified request is not valid.
- InternalServerException An internal error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createOrder
Creates an order for an Outpost.
- Parameters:
createOrderRequest
-- Returns:
- A Java Future containing the result of the CreateOrder operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException A parameter is not valid.
- ConflictException Updating or deleting this resource can cause an inconsistent state.
- AccessDeniedException You do not have permission to perform this operation.
- NotFoundException The specified request is not valid.
- InternalServerException An internal error has occurred.
- ServiceQuotaExceededException You have exceeded a service quota.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createOrder
default CompletableFuture<CreateOrderResponse> createOrder(Consumer<CreateOrderRequest.Builder> createOrderRequest) Creates an order for an Outpost.
This is a convenience which creates an instance of the
CreateOrderRequest.Builder
avoiding the need to create one manually viaCreateOrderRequest.builder()
- Parameters:
createOrderRequest
- AConsumer
that will call methods onCreateOrderRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateOrder operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException A parameter is not valid.
- ConflictException Updating or deleting this resource can cause an inconsistent state.
- AccessDeniedException You do not have permission to perform this operation.
- NotFoundException The specified request is not valid.
- InternalServerException An internal error has occurred.
- ServiceQuotaExceededException You have exceeded a service quota.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createOutpost
default CompletableFuture<CreateOutpostResponse> createOutpost(CreateOutpostRequest createOutpostRequest) Creates an Outpost.
You can specify either an Availability one or an AZ ID.
- Parameters:
createOutpostRequest
-- Returns:
- A Java Future containing the result of the CreateOutpost operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException A parameter is not valid.
- ConflictException Updating or deleting this resource can cause an inconsistent state.
- NotFoundException The specified request is not valid.
- AccessDeniedException You do not have permission to perform this operation.
- InternalServerException An internal error has occurred.
- ServiceQuotaExceededException You have exceeded a service quota.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createOutpost
default CompletableFuture<CreateOutpostResponse> createOutpost(Consumer<CreateOutpostRequest.Builder> createOutpostRequest) Creates an Outpost.
You can specify either an Availability one or an AZ ID.
This is a convenience which creates an instance of the
CreateOutpostRequest.Builder
avoiding the need to create one manually viaCreateOutpostRequest.builder()
- Parameters:
createOutpostRequest
- AConsumer
that will call methods onCreateOutpostRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateOutpost operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException A parameter is not valid.
- ConflictException Updating or deleting this resource can cause an inconsistent state.
- NotFoundException The specified request is not valid.
- AccessDeniedException You do not have permission to perform this operation.
- InternalServerException An internal error has occurred.
- ServiceQuotaExceededException You have exceeded a service quota.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createSite
Creates a site for an Outpost.
- Parameters:
createSiteRequest
-- Returns:
- A Java Future containing the result of the CreateSite operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException A parameter is not valid.
- ConflictException Updating or deleting this resource can cause an inconsistent state.
- AccessDeniedException You do not have permission to perform this operation.
- InternalServerException An internal error has occurred.
- ServiceQuotaExceededException You have exceeded a service quota.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createSite
default CompletableFuture<CreateSiteResponse> createSite(Consumer<CreateSiteRequest.Builder> createSiteRequest) Creates a site for an Outpost.
This is a convenience which creates an instance of the
CreateSiteRequest.Builder
avoiding the need to create one manually viaCreateSiteRequest.builder()
- Parameters:
createSiteRequest
- AConsumer
that will call methods onCreateSiteRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateSite operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException A parameter is not valid.
- ConflictException Updating or deleting this resource can cause an inconsistent state.
- AccessDeniedException You do not have permission to perform this operation.
- InternalServerException An internal error has occurred.
- ServiceQuotaExceededException You have exceeded a service quota.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteOutpost
default CompletableFuture<DeleteOutpostResponse> deleteOutpost(DeleteOutpostRequest deleteOutpostRequest) Deletes the specified Outpost.
- Parameters:
deleteOutpostRequest
-- Returns:
- A Java Future containing the result of the DeleteOutpost operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException A parameter is not valid.
- ConflictException Updating or deleting this resource can cause an inconsistent state.
- NotFoundException The specified request is not valid.
- AccessDeniedException You do not have permission to perform this operation.
- InternalServerException An internal error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteOutpost
default CompletableFuture<DeleteOutpostResponse> deleteOutpost(Consumer<DeleteOutpostRequest.Builder> deleteOutpostRequest) Deletes the specified Outpost.
This is a convenience which creates an instance of the
DeleteOutpostRequest.Builder
avoiding the need to create one manually viaDeleteOutpostRequest.builder()
- Parameters:
deleteOutpostRequest
- AConsumer
that will call methods onDeleteOutpostRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteOutpost operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException A parameter is not valid.
- ConflictException Updating or deleting this resource can cause an inconsistent state.
- NotFoundException The specified request is not valid.
- AccessDeniedException You do not have permission to perform this operation.
- InternalServerException An internal error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteSite
Deletes the specified site.
- Parameters:
deleteSiteRequest
-- Returns:
- A Java Future containing the result of the DeleteSite operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException A parameter is not valid.
- ConflictException Updating or deleting this resource can cause an inconsistent state.
- NotFoundException The specified request is not valid.
- AccessDeniedException You do not have permission to perform this operation.
- InternalServerException An internal error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteSite
default CompletableFuture<DeleteSiteResponse> deleteSite(Consumer<DeleteSiteRequest.Builder> deleteSiteRequest) Deletes the specified site.
This is a convenience which creates an instance of the
DeleteSiteRequest.Builder
avoiding the need to create one manually viaDeleteSiteRequest.builder()
- Parameters:
deleteSiteRequest
- AConsumer
that will call methods onDeleteSiteRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteSite operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException A parameter is not valid.
- ConflictException Updating or deleting this resource can cause an inconsistent state.
- NotFoundException The specified request is not valid.
- AccessDeniedException You do not have permission to perform this operation.
- InternalServerException An internal error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getCapacityTask
default CompletableFuture<GetCapacityTaskResponse> getCapacityTask(GetCapacityTaskRequest getCapacityTaskRequest) Gets details of the specified capacity task.
- Parameters:
getCapacityTaskRequest
-- Returns:
- A Java Future containing the result of the GetCapacityTask operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException A parameter is not valid.
- AccessDeniedException You do not have permission to perform this operation.
- NotFoundException The specified request is not valid.
- InternalServerException An internal error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getCapacityTask
default CompletableFuture<GetCapacityTaskResponse> getCapacityTask(Consumer<GetCapacityTaskRequest.Builder> getCapacityTaskRequest) Gets details of the specified capacity task.
This is a convenience which creates an instance of the
GetCapacityTaskRequest.Builder
avoiding the need to create one manually viaGetCapacityTaskRequest.builder()
- Parameters:
getCapacityTaskRequest
- AConsumer
that will call methods onGetCapacityTaskRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetCapacityTask operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException A parameter is not valid.
- AccessDeniedException You do not have permission to perform this operation.
- NotFoundException The specified request is not valid.
- InternalServerException An internal error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getCatalogItem
default CompletableFuture<GetCatalogItemResponse> getCatalogItem(GetCatalogItemRequest getCatalogItemRequest) Gets information about the specified catalog item.
- Parameters:
getCatalogItemRequest
-- Returns:
- A Java Future containing the result of the GetCatalogItem operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException A parameter is not valid.
- NotFoundException The specified request is not valid.
- InternalServerException An internal error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getCatalogItem
default CompletableFuture<GetCatalogItemResponse> getCatalogItem(Consumer<GetCatalogItemRequest.Builder> getCatalogItemRequest) Gets information about the specified catalog item.
This is a convenience which creates an instance of the
GetCatalogItemRequest.Builder
avoiding the need to create one manually viaGetCatalogItemRequest.builder()
- Parameters:
getCatalogItemRequest
- AConsumer
that will call methods onGetCatalogItemRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetCatalogItem operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException A parameter is not valid.
- NotFoundException The specified request is not valid.
- InternalServerException An internal error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getConnection
default CompletableFuture<GetConnectionResponse> getConnection(GetConnectionRequest getConnectionRequest) Amazon Web Services uses this action to install Outpost servers.
Gets information about the specified connection.
Use CloudTrail to monitor this action or Amazon Web Services managed policy for Amazon Web Services Outposts to secure it. For more information, see Amazon Web Services managed policies for Amazon Web Services Outposts and Logging Amazon Web Services Outposts API calls with Amazon Web Services CloudTrail in the Amazon Web Services Outposts User Guide.
- Parameters:
getConnectionRequest
-- Returns:
- A Java Future containing the result of the GetConnection operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have permission to perform this operation.
- ValidationException A parameter is not valid.
- NotFoundException The specified request is not valid.
- InternalServerException An internal error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getConnection
default CompletableFuture<GetConnectionResponse> getConnection(Consumer<GetConnectionRequest.Builder> getConnectionRequest) Amazon Web Services uses this action to install Outpost servers.
Gets information about the specified connection.
Use CloudTrail to monitor this action or Amazon Web Services managed policy for Amazon Web Services Outposts to secure it. For more information, see Amazon Web Services managed policies for Amazon Web Services Outposts and Logging Amazon Web Services Outposts API calls with Amazon Web Services CloudTrail in the Amazon Web Services Outposts User Guide.
This is a convenience which creates an instance of the
GetConnectionRequest.Builder
avoiding the need to create one manually viaGetConnectionRequest.builder()
- Parameters:
getConnectionRequest
- AConsumer
that will call methods onGetConnectionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetConnection operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have permission to perform this operation.
- ValidationException A parameter is not valid.
- NotFoundException The specified request is not valid.
- InternalServerException An internal error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getOrder
Gets information about the specified order.
- Parameters:
getOrderRequest
-- Returns:
- A Java Future containing the result of the GetOrder operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException A parameter is not valid.
- NotFoundException The specified request is not valid.
- InternalServerException An internal error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getOrder
default CompletableFuture<GetOrderResponse> getOrder(Consumer<GetOrderRequest.Builder> getOrderRequest) Gets information about the specified order.
This is a convenience which creates an instance of the
GetOrderRequest.Builder
avoiding the need to create one manually viaGetOrderRequest.builder()
- Parameters:
getOrderRequest
- AConsumer
that will call methods onGetOrderRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetOrder operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException A parameter is not valid.
- NotFoundException The specified request is not valid.
- InternalServerException An internal error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getOutpost
Gets information about the specified Outpost.
- Parameters:
getOutpostRequest
-- Returns:
- A Java Future containing the result of the GetOutpost operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException A parameter is not valid.
- NotFoundException The specified request is not valid.
- AccessDeniedException You do not have permission to perform this operation.
- InternalServerException An internal error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getOutpost
default CompletableFuture<GetOutpostResponse> getOutpost(Consumer<GetOutpostRequest.Builder> getOutpostRequest) Gets information about the specified Outpost.
This is a convenience which creates an instance of the
GetOutpostRequest.Builder
avoiding the need to create one manually viaGetOutpostRequest.builder()
- Parameters:
getOutpostRequest
- AConsumer
that will call methods onGetOutpostRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetOutpost operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException A parameter is not valid.
- NotFoundException The specified request is not valid.
- AccessDeniedException You do not have permission to perform this operation.
- InternalServerException An internal error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getOutpostInstanceTypes
default CompletableFuture<GetOutpostInstanceTypesResponse> getOutpostInstanceTypes(GetOutpostInstanceTypesRequest getOutpostInstanceTypesRequest) Gets the instance types for the specified Outpost.
- Parameters:
getOutpostInstanceTypesRequest
-- Returns:
- A Java Future containing the result of the GetOutpostInstanceTypes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException A parameter is not valid.
- NotFoundException The specified request is not valid.
- AccessDeniedException You do not have permission to perform this operation.
- InternalServerException An internal error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getOutpostInstanceTypes
default CompletableFuture<GetOutpostInstanceTypesResponse> getOutpostInstanceTypes(Consumer<GetOutpostInstanceTypesRequest.Builder> getOutpostInstanceTypesRequest) Gets the instance types for the specified Outpost.
This is a convenience which creates an instance of the
GetOutpostInstanceTypesRequest.Builder
avoiding the need to create one manually viaGetOutpostInstanceTypesRequest.builder()
- Parameters:
getOutpostInstanceTypesRequest
- AConsumer
that will call methods onGetOutpostInstanceTypesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetOutpostInstanceTypes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException A parameter is not valid.
- NotFoundException The specified request is not valid.
- AccessDeniedException You do not have permission to perform this operation.
- InternalServerException An internal error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getOutpostInstanceTypesPaginator
default GetOutpostInstanceTypesPublisher getOutpostInstanceTypesPaginator(GetOutpostInstanceTypesRequest getOutpostInstanceTypesRequest) This is a variant of
getOutpostInstanceTypes(software.amazon.awssdk.services.outposts.model.GetOutpostInstanceTypesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.outposts.paginators.GetOutpostInstanceTypesPublisher publisher = client.getOutpostInstanceTypesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.outposts.paginators.GetOutpostInstanceTypesPublisher publisher = client.getOutpostInstanceTypesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.outposts.model.GetOutpostInstanceTypesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.outposts.model.GetOutpostInstanceTypesResponse response) { //... }; });
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
getOutpostInstanceTypes(software.amazon.awssdk.services.outposts.model.GetOutpostInstanceTypesRequest)
operation.- Parameters:
getOutpostInstanceTypesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException A parameter is not valid.
- NotFoundException The specified request is not valid.
- AccessDeniedException You do not have permission to perform this operation.
- InternalServerException An internal error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getOutpostInstanceTypesPaginator
default GetOutpostInstanceTypesPublisher getOutpostInstanceTypesPaginator(Consumer<GetOutpostInstanceTypesRequest.Builder> getOutpostInstanceTypesRequest) This is a variant of
getOutpostInstanceTypes(software.amazon.awssdk.services.outposts.model.GetOutpostInstanceTypesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.outposts.paginators.GetOutpostInstanceTypesPublisher publisher = client.getOutpostInstanceTypesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.outposts.paginators.GetOutpostInstanceTypesPublisher publisher = client.getOutpostInstanceTypesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.outposts.model.GetOutpostInstanceTypesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.outposts.model.GetOutpostInstanceTypesResponse response) { //... }; });
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
getOutpostInstanceTypes(software.amazon.awssdk.services.outposts.model.GetOutpostInstanceTypesRequest)
operation.
This is a convenience which creates an instance of the
GetOutpostInstanceTypesRequest.Builder
avoiding the need to create one manually viaGetOutpostInstanceTypesRequest.builder()
- Parameters:
getOutpostInstanceTypesRequest
- AConsumer
that will call methods onGetOutpostInstanceTypesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException A parameter is not valid.
- NotFoundException The specified request is not valid.
- AccessDeniedException You do not have permission to perform this operation.
- InternalServerException An internal error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getOutpostSupportedInstanceTypes
default CompletableFuture<GetOutpostSupportedInstanceTypesResponse> getOutpostSupportedInstanceTypes(GetOutpostSupportedInstanceTypesRequest getOutpostSupportedInstanceTypesRequest) Gets the instance types that an Outpost can support in
InstanceTypeCapacity
. This will generally include instance types that are not currently configured and therefore cannot be launched with the current Outpost capacity configuration.- Parameters:
getOutpostSupportedInstanceTypesRequest
-- Returns:
- A Java Future containing the result of the GetOutpostSupportedInstanceTypes operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException A parameter is not valid.
- AccessDeniedException You do not have permission to perform this operation.
- NotFoundException The specified request is not valid.
- InternalServerException An internal error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getOutpostSupportedInstanceTypes
default CompletableFuture<GetOutpostSupportedInstanceTypesResponse> getOutpostSupportedInstanceTypes(Consumer<GetOutpostSupportedInstanceTypesRequest.Builder> getOutpostSupportedInstanceTypesRequest) Gets the instance types that an Outpost can support in
InstanceTypeCapacity
. This will generally include instance types that are not currently configured and therefore cannot be launched with the current Outpost capacity configuration.
This is a convenience which creates an instance of the
GetOutpostSupportedInstanceTypesRequest.Builder
avoiding the need to create one manually viaGetOutpostSupportedInstanceTypesRequest.builder()
- Parameters:
getOutpostSupportedInstanceTypesRequest
- AConsumer
that will call methods onGetOutpostSupportedInstanceTypesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetOutpostSupportedInstanceTypes operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException A parameter is not valid.
- AccessDeniedException You do not have permission to perform this operation.
- NotFoundException The specified request is not valid.
- InternalServerException An internal error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getOutpostSupportedInstanceTypesPaginator
default GetOutpostSupportedInstanceTypesPublisher getOutpostSupportedInstanceTypesPaginator(GetOutpostSupportedInstanceTypesRequest getOutpostSupportedInstanceTypesRequest) This is a variant of
getOutpostSupportedInstanceTypes(software.amazon.awssdk.services.outposts.model.GetOutpostSupportedInstanceTypesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.outposts.paginators.GetOutpostSupportedInstanceTypesPublisher publisher = client.getOutpostSupportedInstanceTypesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.outposts.paginators.GetOutpostSupportedInstanceTypesPublisher publisher = client.getOutpostSupportedInstanceTypesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.outposts.model.GetOutpostSupportedInstanceTypesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.outposts.model.GetOutpostSupportedInstanceTypesResponse response) { //... }; });
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
getOutpostSupportedInstanceTypes(software.amazon.awssdk.services.outposts.model.GetOutpostSupportedInstanceTypesRequest)
operation.- Parameters:
getOutpostSupportedInstanceTypesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException A parameter is not valid.
- AccessDeniedException You do not have permission to perform this operation.
- NotFoundException The specified request is not valid.
- InternalServerException An internal error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getOutpostSupportedInstanceTypesPaginator
default GetOutpostSupportedInstanceTypesPublisher getOutpostSupportedInstanceTypesPaginator(Consumer<GetOutpostSupportedInstanceTypesRequest.Builder> getOutpostSupportedInstanceTypesRequest) This is a variant of
getOutpostSupportedInstanceTypes(software.amazon.awssdk.services.outposts.model.GetOutpostSupportedInstanceTypesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.outposts.paginators.GetOutpostSupportedInstanceTypesPublisher publisher = client.getOutpostSupportedInstanceTypesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.outposts.paginators.GetOutpostSupportedInstanceTypesPublisher publisher = client.getOutpostSupportedInstanceTypesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.outposts.model.GetOutpostSupportedInstanceTypesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.outposts.model.GetOutpostSupportedInstanceTypesResponse response) { //... }; });
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
getOutpostSupportedInstanceTypes(software.amazon.awssdk.services.outposts.model.GetOutpostSupportedInstanceTypesRequest)
operation.
This is a convenience which creates an instance of the
GetOutpostSupportedInstanceTypesRequest.Builder
avoiding the need to create one manually viaGetOutpostSupportedInstanceTypesRequest.builder()
- Parameters:
getOutpostSupportedInstanceTypesRequest
- AConsumer
that will call methods onGetOutpostSupportedInstanceTypesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException A parameter is not valid.
- AccessDeniedException You do not have permission to perform this operation.
- NotFoundException The specified request is not valid.
- InternalServerException An internal error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSite
Gets information about the specified Outpost site.
- Parameters:
getSiteRequest
-- Returns:
- A Java Future containing the result of the GetSite operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException A parameter is not valid.
- NotFoundException The specified request is not valid.
- AccessDeniedException You do not have permission to perform this operation.
- InternalServerException An internal error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSite
Gets information about the specified Outpost site.
This is a convenience which creates an instance of the
GetSiteRequest.Builder
avoiding the need to create one manually viaGetSiteRequest.builder()
- Parameters:
getSiteRequest
- AConsumer
that will call methods onGetSiteRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetSite operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException A parameter is not valid.
- NotFoundException The specified request is not valid.
- AccessDeniedException You do not have permission to perform this operation.
- InternalServerException An internal error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSiteAddress
default CompletableFuture<GetSiteAddressResponse> getSiteAddress(GetSiteAddressRequest getSiteAddressRequest) Gets the site address of the specified site.
- Parameters:
getSiteAddressRequest
-- Returns:
- A Java Future containing the result of the GetSiteAddress operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException A parameter is not valid.
- AccessDeniedException You do not have permission to perform this operation.
- NotFoundException The specified request is not valid.
- InternalServerException An internal error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSiteAddress
default CompletableFuture<GetSiteAddressResponse> getSiteAddress(Consumer<GetSiteAddressRequest.Builder> getSiteAddressRequest) Gets the site address of the specified site.
This is a convenience which creates an instance of the
GetSiteAddressRequest.Builder
avoiding the need to create one manually viaGetSiteAddressRequest.builder()
- Parameters:
getSiteAddressRequest
- AConsumer
that will call methods onGetSiteAddressRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetSiteAddress operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException A parameter is not valid.
- AccessDeniedException You do not have permission to perform this operation.
- NotFoundException The specified request is not valid.
- InternalServerException An internal error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAssets
Lists the hardware assets for the specified Outpost.
Use filters to return specific results. If you specify multiple filters, the results include only the resources that match all of the specified filters. For a filter where you can specify multiple values, the results include items that match any of the values that you specify for the filter.
- Parameters:
listAssetsRequest
-- Returns:
- A Java Future containing the result of the ListAssets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException A parameter is not valid.
- AccessDeniedException You do not have permission to perform this operation.
- NotFoundException The specified request is not valid.
- InternalServerException An internal error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAssets
default CompletableFuture<ListAssetsResponse> listAssets(Consumer<ListAssetsRequest.Builder> listAssetsRequest) Lists the hardware assets for the specified Outpost.
Use filters to return specific results. If you specify multiple filters, the results include only the resources that match all of the specified filters. For a filter where you can specify multiple values, the results include items that match any of the values that you specify for the filter.
This is a convenience which creates an instance of the
ListAssetsRequest.Builder
avoiding the need to create one manually viaListAssetsRequest.builder()
- Parameters:
listAssetsRequest
- AConsumer
that will call methods onListAssetsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListAssets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException A parameter is not valid.
- AccessDeniedException You do not have permission to perform this operation.
- NotFoundException The specified request is not valid.
- InternalServerException An internal error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAssetsPaginator
This is a variant of
listAssets(software.amazon.awssdk.services.outposts.model.ListAssetsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.outposts.paginators.ListAssetsPublisher publisher = client.listAssetsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.outposts.paginators.ListAssetsPublisher publisher = client.listAssetsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.outposts.model.ListAssetsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.outposts.model.ListAssetsResponse response) { //... }; });
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
listAssets(software.amazon.awssdk.services.outposts.model.ListAssetsRequest)
operation.- Parameters:
listAssetsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException A parameter is not valid.
- AccessDeniedException You do not have permission to perform this operation.
- NotFoundException The specified request is not valid.
- InternalServerException An internal error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAssetsPaginator
default ListAssetsPublisher listAssetsPaginator(Consumer<ListAssetsRequest.Builder> listAssetsRequest) This is a variant of
listAssets(software.amazon.awssdk.services.outposts.model.ListAssetsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.outposts.paginators.ListAssetsPublisher publisher = client.listAssetsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.outposts.paginators.ListAssetsPublisher publisher = client.listAssetsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.outposts.model.ListAssetsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.outposts.model.ListAssetsResponse response) { //... }; });
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
listAssets(software.amazon.awssdk.services.outposts.model.ListAssetsRequest)
operation.
This is a convenience which creates an instance of the
ListAssetsRequest.Builder
avoiding the need to create one manually viaListAssetsRequest.builder()
- Parameters:
listAssetsRequest
- AConsumer
that will call methods onListAssetsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException A parameter is not valid.
- AccessDeniedException You do not have permission to perform this operation.
- NotFoundException The specified request is not valid.
- InternalServerException An internal error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCapacityTasks
default CompletableFuture<ListCapacityTasksResponse> listCapacityTasks(ListCapacityTasksRequest listCapacityTasksRequest) Lists the capacity tasks for your Amazon Web Services account.
Use filters to return specific results. If you specify multiple filters, the results include only the resources that match all of the specified filters. For a filter where you can specify multiple values, the results include items that match any of the values that you specify for the filter.
- Parameters:
listCapacityTasksRequest
-- Returns:
- A Java Future containing the result of the ListCapacityTasks operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException A parameter is not valid.
- AccessDeniedException You do not have permission to perform this operation.
- NotFoundException The specified request is not valid.
- InternalServerException An internal error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCapacityTasks
default CompletableFuture<ListCapacityTasksResponse> listCapacityTasks(Consumer<ListCapacityTasksRequest.Builder> listCapacityTasksRequest) Lists the capacity tasks for your Amazon Web Services account.
Use filters to return specific results. If you specify multiple filters, the results include only the resources that match all of the specified filters. For a filter where you can specify multiple values, the results include items that match any of the values that you specify for the filter.
This is a convenience which creates an instance of the
ListCapacityTasksRequest.Builder
avoiding the need to create one manually viaListCapacityTasksRequest.builder()
- Parameters:
listCapacityTasksRequest
- AConsumer
that will call methods onListCapacityTasksRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListCapacityTasks operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException A parameter is not valid.
- AccessDeniedException You do not have permission to perform this operation.
- NotFoundException The specified request is not valid.
- InternalServerException An internal error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCapacityTasksPaginator
default ListCapacityTasksPublisher listCapacityTasksPaginator(ListCapacityTasksRequest listCapacityTasksRequest) This is a variant of
listCapacityTasks(software.amazon.awssdk.services.outposts.model.ListCapacityTasksRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.outposts.paginators.ListCapacityTasksPublisher publisher = client.listCapacityTasksPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.outposts.paginators.ListCapacityTasksPublisher publisher = client.listCapacityTasksPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.outposts.model.ListCapacityTasksResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.outposts.model.ListCapacityTasksResponse response) { //... }; });
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
listCapacityTasks(software.amazon.awssdk.services.outposts.model.ListCapacityTasksRequest)
operation.- Parameters:
listCapacityTasksRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException A parameter is not valid.
- AccessDeniedException You do not have permission to perform this operation.
- NotFoundException The specified request is not valid.
- InternalServerException An internal error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCapacityTasksPaginator
default ListCapacityTasksPublisher listCapacityTasksPaginator(Consumer<ListCapacityTasksRequest.Builder> listCapacityTasksRequest) This is a variant of
listCapacityTasks(software.amazon.awssdk.services.outposts.model.ListCapacityTasksRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.outposts.paginators.ListCapacityTasksPublisher publisher = client.listCapacityTasksPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.outposts.paginators.ListCapacityTasksPublisher publisher = client.listCapacityTasksPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.outposts.model.ListCapacityTasksResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.outposts.model.ListCapacityTasksResponse response) { //... }; });
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
listCapacityTasks(software.amazon.awssdk.services.outposts.model.ListCapacityTasksRequest)
operation.
This is a convenience which creates an instance of the
ListCapacityTasksRequest.Builder
avoiding the need to create one manually viaListCapacityTasksRequest.builder()
- Parameters:
listCapacityTasksRequest
- AConsumer
that will call methods onListCapacityTasksRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException A parameter is not valid.
- AccessDeniedException You do not have permission to perform this operation.
- NotFoundException The specified request is not valid.
- InternalServerException An internal error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCatalogItems
default CompletableFuture<ListCatalogItemsResponse> listCatalogItems(ListCatalogItemsRequest listCatalogItemsRequest) Lists the items in the catalog.
Use filters to return specific results. If you specify multiple filters, the results include only the resources that match all of the specified filters. For a filter where you can specify multiple values, the results include items that match any of the values that you specify for the filter.
- Parameters:
listCatalogItemsRequest
-- Returns:
- A Java Future containing the result of the ListCatalogItems operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException A parameter is not valid.
- NotFoundException The specified request is not valid.
- InternalServerException An internal error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCatalogItems
default CompletableFuture<ListCatalogItemsResponse> listCatalogItems(Consumer<ListCatalogItemsRequest.Builder> listCatalogItemsRequest) Lists the items in the catalog.
Use filters to return specific results. If you specify multiple filters, the results include only the resources that match all of the specified filters. For a filter where you can specify multiple values, the results include items that match any of the values that you specify for the filter.
This is a convenience which creates an instance of the
ListCatalogItemsRequest.Builder
avoiding the need to create one manually viaListCatalogItemsRequest.builder()
- Parameters:
listCatalogItemsRequest
- AConsumer
that will call methods onListCatalogItemsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListCatalogItems operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException A parameter is not valid.
- NotFoundException The specified request is not valid.
- InternalServerException An internal error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCatalogItemsPaginator
default ListCatalogItemsPublisher listCatalogItemsPaginator(ListCatalogItemsRequest listCatalogItemsRequest) This is a variant of
listCatalogItems(software.amazon.awssdk.services.outposts.model.ListCatalogItemsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.outposts.paginators.ListCatalogItemsPublisher publisher = client.listCatalogItemsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.outposts.paginators.ListCatalogItemsPublisher publisher = client.listCatalogItemsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.outposts.model.ListCatalogItemsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.outposts.model.ListCatalogItemsResponse response) { //... }; });
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
listCatalogItems(software.amazon.awssdk.services.outposts.model.ListCatalogItemsRequest)
operation.- Parameters:
listCatalogItemsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException A parameter is not valid.
- NotFoundException The specified request is not valid.
- InternalServerException An internal error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCatalogItemsPaginator
default ListCatalogItemsPublisher listCatalogItemsPaginator(Consumer<ListCatalogItemsRequest.Builder> listCatalogItemsRequest) This is a variant of
listCatalogItems(software.amazon.awssdk.services.outposts.model.ListCatalogItemsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.outposts.paginators.ListCatalogItemsPublisher publisher = client.listCatalogItemsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.outposts.paginators.ListCatalogItemsPublisher publisher = client.listCatalogItemsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.outposts.model.ListCatalogItemsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.outposts.model.ListCatalogItemsResponse response) { //... }; });
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
listCatalogItems(software.amazon.awssdk.services.outposts.model.ListCatalogItemsRequest)
operation.
This is a convenience which creates an instance of the
ListCatalogItemsRequest.Builder
avoiding the need to create one manually viaListCatalogItemsRequest.builder()
- Parameters:
listCatalogItemsRequest
- AConsumer
that will call methods onListCatalogItemsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException A parameter is not valid.
- NotFoundException The specified request is not valid.
- InternalServerException An internal error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listOrders
Lists the Outpost orders for your Amazon Web Services account.
- Parameters:
listOrdersRequest
-- Returns:
- A Java Future containing the result of the ListOrders operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException A parameter is not valid.
- NotFoundException The specified request is not valid.
- AccessDeniedException You do not have permission to perform this operation.
- InternalServerException An internal error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listOrders
default CompletableFuture<ListOrdersResponse> listOrders(Consumer<ListOrdersRequest.Builder> listOrdersRequest) Lists the Outpost orders for your Amazon Web Services account.
This is a convenience which creates an instance of the
ListOrdersRequest.Builder
avoiding the need to create one manually viaListOrdersRequest.builder()
- Parameters:
listOrdersRequest
- AConsumer
that will call methods onListOrdersRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListOrders operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException A parameter is not valid.
- NotFoundException The specified request is not valid.
- AccessDeniedException You do not have permission to perform this operation.
- InternalServerException An internal error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listOrdersPaginator
This is a variant of
listOrders(software.amazon.awssdk.services.outposts.model.ListOrdersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.outposts.paginators.ListOrdersPublisher publisher = client.listOrdersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.outposts.paginators.ListOrdersPublisher publisher = client.listOrdersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.outposts.model.ListOrdersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.outposts.model.ListOrdersResponse response) { //... }; });
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.outposts.model.ListOrdersRequest)
operation.- Parameters:
listOrdersRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException A parameter is not valid.
- NotFoundException The specified request is not valid.
- AccessDeniedException You do not have permission to perform this operation.
- InternalServerException An internal error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listOrdersPaginator
default ListOrdersPublisher listOrdersPaginator(Consumer<ListOrdersRequest.Builder> listOrdersRequest) This is a variant of
listOrders(software.amazon.awssdk.services.outposts.model.ListOrdersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.outposts.paginators.ListOrdersPublisher publisher = client.listOrdersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.outposts.paginators.ListOrdersPublisher publisher = client.listOrdersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.outposts.model.ListOrdersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.outposts.model.ListOrdersResponse response) { //... }; });
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.outposts.model.ListOrdersRequest)
operation.
This is a convenience which creates an instance of the
ListOrdersRequest.Builder
avoiding the need to create one manually viaListOrdersRequest.builder()
- Parameters:
listOrdersRequest
- AConsumer
that will call methods onListOrdersRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException A parameter is not valid.
- NotFoundException The specified request is not valid.
- AccessDeniedException You do not have permission to perform this operation.
- InternalServerException An internal error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listOutposts
default CompletableFuture<ListOutpostsResponse> listOutposts(ListOutpostsRequest listOutpostsRequest) Lists the Outposts for your Amazon Web Services account.
Use filters to return specific results. If you specify multiple filters, the results include only the resources that match all of the specified filters. For a filter where you can specify multiple values, the results include items that match any of the values that you specify for the filter.
- Parameters:
listOutpostsRequest
-- Returns:
- A Java Future containing the result of the ListOutposts operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException A parameter is not valid.
- AccessDeniedException You do not have permission to perform this operation.
- InternalServerException An internal error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listOutposts
default CompletableFuture<ListOutpostsResponse> listOutposts(Consumer<ListOutpostsRequest.Builder> listOutpostsRequest) Lists the Outposts for your Amazon Web Services account.
Use filters to return specific results. If you specify multiple filters, the results include only the resources that match all of the specified filters. For a filter where you can specify multiple values, the results include items that match any of the values that you specify for the filter.
This is a convenience which creates an instance of the
ListOutpostsRequest.Builder
avoiding the need to create one manually viaListOutpostsRequest.builder()
- Parameters:
listOutpostsRequest
- AConsumer
that will call methods onListOutpostsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListOutposts operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException A parameter is not valid.
- AccessDeniedException You do not have permission to perform this operation.
- InternalServerException An internal error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listOutpostsPaginator
This is a variant of
listOutposts(software.amazon.awssdk.services.outposts.model.ListOutpostsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.outposts.paginators.ListOutpostsPublisher publisher = client.listOutpostsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.outposts.paginators.ListOutpostsPublisher publisher = client.listOutpostsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.outposts.model.ListOutpostsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.outposts.model.ListOutpostsResponse response) { //... }; });
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
listOutposts(software.amazon.awssdk.services.outposts.model.ListOutpostsRequest)
operation.- Parameters:
listOutpostsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException A parameter is not valid.
- AccessDeniedException You do not have permission to perform this operation.
- InternalServerException An internal error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listOutpostsPaginator
default ListOutpostsPublisher listOutpostsPaginator(Consumer<ListOutpostsRequest.Builder> listOutpostsRequest) This is a variant of
listOutposts(software.amazon.awssdk.services.outposts.model.ListOutpostsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.outposts.paginators.ListOutpostsPublisher publisher = client.listOutpostsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.outposts.paginators.ListOutpostsPublisher publisher = client.listOutpostsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.outposts.model.ListOutpostsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.outposts.model.ListOutpostsResponse response) { //... }; });
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
listOutposts(software.amazon.awssdk.services.outposts.model.ListOutpostsRequest)
operation.
This is a convenience which creates an instance of the
ListOutpostsRequest.Builder
avoiding the need to create one manually viaListOutpostsRequest.builder()
- Parameters:
listOutpostsRequest
- AConsumer
that will call methods onListOutpostsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException A parameter is not valid.
- AccessDeniedException You do not have permission to perform this operation.
- InternalServerException An internal error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSites
Lists the Outpost sites for your Amazon Web Services account. Use filters to return specific results.
Use filters to return specific results. If you specify multiple filters, the results include only the resources that match all of the specified filters. For a filter where you can specify multiple values, the results include items that match any of the values that you specify for the filter.
- Parameters:
listSitesRequest
-- Returns:
- A Java Future containing the result of the ListSites operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException A parameter is not valid.
- AccessDeniedException You do not have permission to perform this operation.
- InternalServerException An internal error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSites
default CompletableFuture<ListSitesResponse> listSites(Consumer<ListSitesRequest.Builder> listSitesRequest) Lists the Outpost sites for your Amazon Web Services account. Use filters to return specific results.
Use filters to return specific results. If you specify multiple filters, the results include only the resources that match all of the specified filters. For a filter where you can specify multiple values, the results include items that match any of the values that you specify for the filter.
This is a convenience which creates an instance of the
ListSitesRequest.Builder
avoiding the need to create one manually viaListSitesRequest.builder()
- Parameters:
listSitesRequest
- AConsumer
that will call methods onListSitesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListSites operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException A parameter is not valid.
- AccessDeniedException You do not have permission to perform this operation.
- InternalServerException An internal error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSitesPaginator
This is a variant of
listSites(software.amazon.awssdk.services.outposts.model.ListSitesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.outposts.paginators.ListSitesPublisher publisher = client.listSitesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.outposts.paginators.ListSitesPublisher publisher = client.listSitesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.outposts.model.ListSitesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.outposts.model.ListSitesResponse response) { //... }; });
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
listSites(software.amazon.awssdk.services.outposts.model.ListSitesRequest)
operation.- Parameters:
listSitesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException A parameter is not valid.
- AccessDeniedException You do not have permission to perform this operation.
- InternalServerException An internal error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSitesPaginator
This is a variant of
listSites(software.amazon.awssdk.services.outposts.model.ListSitesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.outposts.paginators.ListSitesPublisher publisher = client.listSitesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.outposts.paginators.ListSitesPublisher publisher = client.listSitesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.outposts.model.ListSitesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.outposts.model.ListSitesResponse response) { //... }; });
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
listSites(software.amazon.awssdk.services.outposts.model.ListSitesRequest)
operation.
This is a convenience which creates an instance of the
ListSitesRequest.Builder
avoiding the need to create one manually viaListSitesRequest.builder()
- Parameters:
listSitesRequest
- AConsumer
that will call methods onListSitesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException A parameter is not valid.
- AccessDeniedException You do not have permission to perform this operation.
- InternalServerException An internal error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags for the specified resource.
- Parameters:
listTagsForResourceRequest
-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException An internal error has occurred.
- ValidationException A parameter is not valid.
- NotFoundException The specified request is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) 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 viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException An internal error has occurred.
- ValidationException A parameter is not valid.
- NotFoundException The specified request is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startCapacityTask
default CompletableFuture<StartCapacityTaskResponse> startCapacityTask(StartCapacityTaskRequest startCapacityTaskRequest) Starts the specified capacity task. You can have one active capacity task for an order.
- Parameters:
startCapacityTaskRequest
-- Returns:
- A Java Future containing the result of the StartCapacityTask operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException A parameter is not valid.
- AccessDeniedException You do not have permission to perform this operation.
- NotFoundException The specified request is not valid.
- InternalServerException An internal error has occurred.
- ConflictException Updating or deleting this resource can cause an inconsistent state.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startCapacityTask
default CompletableFuture<StartCapacityTaskResponse> startCapacityTask(Consumer<StartCapacityTaskRequest.Builder> startCapacityTaskRequest) Starts the specified capacity task. You can have one active capacity task for an order.
This is a convenience which creates an instance of the
StartCapacityTaskRequest.Builder
avoiding the need to create one manually viaStartCapacityTaskRequest.builder()
- Parameters:
startCapacityTaskRequest
- AConsumer
that will call methods onStartCapacityTaskRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartCapacityTask operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException A parameter is not valid.
- AccessDeniedException You do not have permission to perform this operation.
- NotFoundException The specified request is not valid.
- InternalServerException An internal error has occurred.
- ConflictException Updating or deleting this resource can cause an inconsistent state.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startConnection
default CompletableFuture<StartConnectionResponse> startConnection(StartConnectionRequest startConnectionRequest) Amazon Web Services uses this action to install Outpost servers.
Starts the connection required for Outpost server installation.
Use CloudTrail to monitor this action or Amazon Web Services managed policy for Amazon Web Services Outposts to secure it. For more information, see Amazon Web Services managed policies for Amazon Web Services Outposts and Logging Amazon Web Services Outposts API calls with Amazon Web Services CloudTrail in the Amazon Web Services Outposts User Guide.
- Parameters:
startConnectionRequest
-- Returns:
- A Java Future containing the result of the StartConnection operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have permission to perform this operation.
- ValidationException A parameter is not valid.
- NotFoundException The specified request is not valid.
- InternalServerException An internal error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startConnection
default CompletableFuture<StartConnectionResponse> startConnection(Consumer<StartConnectionRequest.Builder> startConnectionRequest) Amazon Web Services uses this action to install Outpost servers.
Starts the connection required for Outpost server installation.
Use CloudTrail to monitor this action or Amazon Web Services managed policy for Amazon Web Services Outposts to secure it. For more information, see Amazon Web Services managed policies for Amazon Web Services Outposts and Logging Amazon Web Services Outposts API calls with Amazon Web Services CloudTrail in the Amazon Web Services Outposts User Guide.
This is a convenience which creates an instance of the
StartConnectionRequest.Builder
avoiding the need to create one manually viaStartConnectionRequest.builder()
- Parameters:
startConnectionRequest
- AConsumer
that will call methods onStartConnectionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartConnection operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have permission to perform this operation.
- ValidationException A parameter is not valid.
- NotFoundException The specified request is not valid.
- InternalServerException An internal error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
Adds tags to the specified resource.
- Parameters:
tagResourceRequest
-- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException An internal error has occurred.
- ValidationException A parameter is not valid.
- NotFoundException The specified request is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) 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 viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException An internal error has occurred.
- ValidationException A parameter is not valid.
- NotFoundException The specified request is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Removes tags from the specified resource.
- Parameters:
untagResourceRequest
-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException An internal error has occurred.
- ValidationException A parameter is not valid.
- NotFoundException The specified request is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) 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 viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException An internal error has occurred.
- ValidationException A parameter is not valid.
- NotFoundException The specified request is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateOutpost
default CompletableFuture<UpdateOutpostResponse> updateOutpost(UpdateOutpostRequest updateOutpostRequest) Updates an Outpost.
- Parameters:
updateOutpostRequest
-- Returns:
- A Java Future containing the result of the UpdateOutpost operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException A parameter is not valid.
- ConflictException Updating or deleting this resource can cause an inconsistent state.
- NotFoundException The specified request is not valid.
- AccessDeniedException You do not have permission to perform this operation.
- InternalServerException An internal error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateOutpost
default CompletableFuture<UpdateOutpostResponse> updateOutpost(Consumer<UpdateOutpostRequest.Builder> updateOutpostRequest) Updates an Outpost.
This is a convenience which creates an instance of the
UpdateOutpostRequest.Builder
avoiding the need to create one manually viaUpdateOutpostRequest.builder()
- Parameters:
updateOutpostRequest
- AConsumer
that will call methods onUpdateOutpostRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateOutpost operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException A parameter is not valid.
- ConflictException Updating or deleting this resource can cause an inconsistent state.
- NotFoundException The specified request is not valid.
- AccessDeniedException You do not have permission to perform this operation.
- InternalServerException An internal error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateSite
Updates the specified site.
- Parameters:
updateSiteRequest
-- Returns:
- A Java Future containing the result of the UpdateSite operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException A parameter is not valid.
- ConflictException Updating or deleting this resource can cause an inconsistent state.
- NotFoundException The specified request is not valid.
- AccessDeniedException You do not have permission to perform this operation.
- InternalServerException An internal error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateSite
default CompletableFuture<UpdateSiteResponse> updateSite(Consumer<UpdateSiteRequest.Builder> updateSiteRequest) Updates the specified site.
This is a convenience which creates an instance of the
UpdateSiteRequest.Builder
avoiding the need to create one manually viaUpdateSiteRequest.builder()
- Parameters:
updateSiteRequest
- AConsumer
that will call methods onUpdateSiteRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateSite operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException A parameter is not valid.
- ConflictException Updating or deleting this resource can cause an inconsistent state.
- NotFoundException The specified request is not valid.
- AccessDeniedException You do not have permission to perform this operation.
- InternalServerException An internal error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateSiteAddress
default CompletableFuture<UpdateSiteAddressResponse> updateSiteAddress(UpdateSiteAddressRequest updateSiteAddressRequest) Updates the address of the specified site.
You can't update a site address if there is an order in progress. You must wait for the order to complete or cancel the order.
You can update the operating address before you place an order at the site, or after all Outposts that belong to the site have been deactivated.
- Parameters:
updateSiteAddressRequest
-- Returns:
- A Java Future containing the result of the UpdateSiteAddress operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException A parameter is not valid.
- AccessDeniedException You do not have permission to perform this operation.
- NotFoundException The specified request is not valid.
- ConflictException Updating or deleting this resource can cause an inconsistent state.
- InternalServerException An internal error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateSiteAddress
default CompletableFuture<UpdateSiteAddressResponse> updateSiteAddress(Consumer<UpdateSiteAddressRequest.Builder> updateSiteAddressRequest) Updates the address of the specified site.
You can't update a site address if there is an order in progress. You must wait for the order to complete or cancel the order.
You can update the operating address before you place an order at the site, or after all Outposts that belong to the site have been deactivated.
This is a convenience which creates an instance of the
UpdateSiteAddressRequest.Builder
avoiding the need to create one manually viaUpdateSiteAddressRequest.builder()
- Parameters:
updateSiteAddressRequest
- AConsumer
that will call methods onUpdateSiteAddressRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateSiteAddress operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException A parameter is not valid.
- AccessDeniedException You do not have permission to perform this operation.
- NotFoundException The specified request is not valid.
- ConflictException Updating or deleting this resource can cause an inconsistent state.
- InternalServerException An internal error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateSiteRackPhysicalProperties
default CompletableFuture<UpdateSiteRackPhysicalPropertiesResponse> updateSiteRackPhysicalProperties(UpdateSiteRackPhysicalPropertiesRequest updateSiteRackPhysicalPropertiesRequest) Update the physical and logistical details for a rack at a site. For more information about hardware requirements for racks, see Network readiness checklist in the Amazon Web Services Outposts User Guide.
To update a rack at a site with an order of
IN_PROGRESS
, you must wait for the order to complete or cancel the order.- Parameters:
updateSiteRackPhysicalPropertiesRequest
-- Returns:
- A Java Future containing the result of the UpdateSiteRackPhysicalProperties operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException A parameter is not valid.
- ConflictException Updating or deleting this resource can cause an inconsistent state.
- NotFoundException The specified request is not valid.
- AccessDeniedException You do not have permission to perform this operation.
- InternalServerException An internal error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateSiteRackPhysicalProperties
default CompletableFuture<UpdateSiteRackPhysicalPropertiesResponse> updateSiteRackPhysicalProperties(Consumer<UpdateSiteRackPhysicalPropertiesRequest.Builder> updateSiteRackPhysicalPropertiesRequest) Update the physical and logistical details for a rack at a site. For more information about hardware requirements for racks, see Network readiness checklist in the Amazon Web Services Outposts User Guide.
To update a rack at a site with an order of
IN_PROGRESS
, you must wait for the order to complete or cancel the order.
This is a convenience which creates an instance of the
UpdateSiteRackPhysicalPropertiesRequest.Builder
avoiding the need to create one manually viaUpdateSiteRackPhysicalPropertiesRequest.builder()
- Parameters:
updateSiteRackPhysicalPropertiesRequest
- AConsumer
that will call methods onUpdateSiteRackPhysicalPropertiesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateSiteRackPhysicalProperties operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException A parameter is not valid.
- ConflictException Updating or deleting this resource can cause an inconsistent state.
- NotFoundException The specified request is not valid.
- AccessDeniedException You do not have permission to perform this operation.
- InternalServerException An internal error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aOutpostsAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aOutpostsAsyncClient
.
-