Interface GlobalAcceleratorAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any
SdkAsyncHttpClient
supported in the SDK. However, full non-blocking is not guaranteed as the async client may
perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API
call.
This is the Global Accelerator API Reference. This guide is for developers who need detailed information about Global Accelerator API actions, data types, and errors. For more information about Global Accelerator features, see the Global Accelerator Developer Guide.
Global Accelerator is a service in which you create accelerators to improve the performance of your applications for local and global users. Depending on the type of accelerator you choose, you can gain additional benefits.
-
By using a standard accelerator, you can improve availability of your internet applications that are used by a global audience. With a standard accelerator, Global Accelerator directs traffic to optimal endpoints over the Amazon Web Services global network.
-
For other scenarios, you might choose a custom routing accelerator. With a custom routing accelerator, you can use application logic to directly map one or more users to a specific endpoint among many endpoints.
Global Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must
specify the US West (Oregon) Region to create, update, or otherwise work with accelerators. That is, for example,
specify --region us-west-2
on Amazon Web Services CLI commands.
By default, Global Accelerator provides you with static IP addresses that you associate with your accelerator. The static IP addresses are anycast from the Amazon Web Services edge network. For IPv4, Global Accelerator provides two static IPv4 addresses. For dual-stack, Global Accelerator provides a total of four addresses: two static IPv4 addresses and two static IPv6 addresses. With a standard accelerator for IPv4, instead of using the addresses that Global Accelerator provides, you can configure these entry points to be IPv4 addresses from your own IP address ranges that you bring to Global Accelerator (BYOIP).
For a standard accelerator, they distribute incoming application traffic across multiple endpoint resources in multiple Amazon Web Services Regions , which increases the availability of your applications. Endpoints for standard accelerators can be Network Load Balancers, Application Load Balancers, Amazon EC2 instances, or Elastic IP addresses that are located in one Amazon Web Services Region or multiple Amazon Web Services Regions. For custom routing accelerators, you map traffic that arrives to the static IP addresses to specific Amazon EC2 servers in endpoints that are virtual private cloud (VPC) subnets.
The static IP addresses remain assigned to your accelerator for as long as it exists, even if you disable the accelerator and it no longer accepts or routes traffic. However, when you delete an accelerator, you lose the static IP addresses that are assigned to it, so you can no longer route traffic by using them. You can use IAM policies like tag-based permissions with Global Accelerator to limit the users who have permissions to delete an accelerator. For more information, see Tag-based policies.
For standard accelerators, Global Accelerator uses the Amazon Web Services global network to route traffic to the optimal regional endpoint based on health, client location, and policies that you configure. The service reacts instantly to changes in health or configuration to ensure that internet traffic from clients is always directed to healthy endpoints.
For more information about understanding and using Global Accelerator, see the Global Accelerator Developer Guide.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionaddCustomRoutingEndpoints
(Consumer<AddCustomRoutingEndpointsRequest.Builder> addCustomRoutingEndpointsRequest) Associate a virtual private cloud (VPC) subnet endpoint with your custom routing accelerator.addCustomRoutingEndpoints
(AddCustomRoutingEndpointsRequest addCustomRoutingEndpointsRequest) Associate a virtual private cloud (VPC) subnet endpoint with your custom routing accelerator.default CompletableFuture
<AddEndpointsResponse> addEndpoints
(Consumer<AddEndpointsRequest.Builder> addEndpointsRequest) Add endpoints to an endpoint group.default CompletableFuture
<AddEndpointsResponse> addEndpoints
(AddEndpointsRequest addEndpointsRequest) Add endpoints to an endpoint group.advertiseByoipCidr
(Consumer<AdvertiseByoipCidrRequest.Builder> advertiseByoipCidrRequest) Advertises an IPv4 address range that is provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP).advertiseByoipCidr
(AdvertiseByoipCidrRequest advertiseByoipCidrRequest) Advertises an IPv4 address range that is provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP).allowCustomRoutingTraffic
(Consumer<AllowCustomRoutingTrafficRequest.Builder> allowCustomRoutingTrafficRequest) Specify the Amazon EC2 instance (destination) IP addresses and ports for a VPC subnet endpoint that can receive traffic for a custom routing accelerator.allowCustomRoutingTraffic
(AllowCustomRoutingTrafficRequest allowCustomRoutingTrafficRequest) Specify the Amazon EC2 instance (destination) IP addresses and ports for a VPC subnet endpoint that can receive traffic for a custom routing accelerator.builder()
Create a builder that can be used to configure and create aGlobalAcceleratorAsyncClient
.static GlobalAcceleratorAsyncClient
create()
Create aGlobalAcceleratorAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.createAccelerator
(Consumer<CreateAcceleratorRequest.Builder> createAcceleratorRequest) Create an accelerator.createAccelerator
(CreateAcceleratorRequest createAcceleratorRequest) Create an accelerator.createCrossAccountAttachment
(Consumer<CreateCrossAccountAttachmentRequest.Builder> createCrossAccountAttachmentRequest) Create a cross-account attachment in Global Accelerator.createCrossAccountAttachment
(CreateCrossAccountAttachmentRequest createCrossAccountAttachmentRequest) Create a cross-account attachment in Global Accelerator.createCustomRoutingAccelerator
(Consumer<CreateCustomRoutingAcceleratorRequest.Builder> createCustomRoutingAcceleratorRequest) Create a custom routing accelerator.createCustomRoutingAccelerator
(CreateCustomRoutingAcceleratorRequest createCustomRoutingAcceleratorRequest) Create a custom routing accelerator.createCustomRoutingEndpointGroup
(Consumer<CreateCustomRoutingEndpointGroupRequest.Builder> createCustomRoutingEndpointGroupRequest) Create an endpoint group for the specified listener for a custom routing accelerator.createCustomRoutingEndpointGroup
(CreateCustomRoutingEndpointGroupRequest createCustomRoutingEndpointGroupRequest) Create an endpoint group for the specified listener for a custom routing accelerator.createCustomRoutingListener
(Consumer<CreateCustomRoutingListenerRequest.Builder> createCustomRoutingListenerRequest) Create a listener to process inbound connections from clients to a custom routing accelerator.createCustomRoutingListener
(CreateCustomRoutingListenerRequest createCustomRoutingListenerRequest) Create a listener to process inbound connections from clients to a custom routing accelerator.createEndpointGroup
(Consumer<CreateEndpointGroupRequest.Builder> createEndpointGroupRequest) Create an endpoint group for the specified listener.createEndpointGroup
(CreateEndpointGroupRequest createEndpointGroupRequest) Create an endpoint group for the specified listener.default CompletableFuture
<CreateListenerResponse> createListener
(Consumer<CreateListenerRequest.Builder> createListenerRequest) Create a listener to process inbound connections from clients to an accelerator.default CompletableFuture
<CreateListenerResponse> createListener
(CreateListenerRequest createListenerRequest) Create a listener to process inbound connections from clients to an accelerator.deleteAccelerator
(Consumer<DeleteAcceleratorRequest.Builder> deleteAcceleratorRequest) Delete an accelerator.deleteAccelerator
(DeleteAcceleratorRequest deleteAcceleratorRequest) Delete an accelerator.deleteCrossAccountAttachment
(Consumer<DeleteCrossAccountAttachmentRequest.Builder> deleteCrossAccountAttachmentRequest) Delete a cross-account attachment.deleteCrossAccountAttachment
(DeleteCrossAccountAttachmentRequest deleteCrossAccountAttachmentRequest) Delete a cross-account attachment.deleteCustomRoutingAccelerator
(Consumer<DeleteCustomRoutingAcceleratorRequest.Builder> deleteCustomRoutingAcceleratorRequest) Delete a custom routing accelerator.deleteCustomRoutingAccelerator
(DeleteCustomRoutingAcceleratorRequest deleteCustomRoutingAcceleratorRequest) Delete a custom routing accelerator.deleteCustomRoutingEndpointGroup
(Consumer<DeleteCustomRoutingEndpointGroupRequest.Builder> deleteCustomRoutingEndpointGroupRequest) Delete an endpoint group from a listener for a custom routing accelerator.deleteCustomRoutingEndpointGroup
(DeleteCustomRoutingEndpointGroupRequest deleteCustomRoutingEndpointGroupRequest) Delete an endpoint group from a listener for a custom routing accelerator.deleteCustomRoutingListener
(Consumer<DeleteCustomRoutingListenerRequest.Builder> deleteCustomRoutingListenerRequest) Delete a listener for a custom routing accelerator.deleteCustomRoutingListener
(DeleteCustomRoutingListenerRequest deleteCustomRoutingListenerRequest) Delete a listener for a custom routing accelerator.deleteEndpointGroup
(Consumer<DeleteEndpointGroupRequest.Builder> deleteEndpointGroupRequest) Delete an endpoint group from a listener.deleteEndpointGroup
(DeleteEndpointGroupRequest deleteEndpointGroupRequest) Delete an endpoint group from a listener.default CompletableFuture
<DeleteListenerResponse> deleteListener
(Consumer<DeleteListenerRequest.Builder> deleteListenerRequest) Delete a listener from an accelerator.default CompletableFuture
<DeleteListenerResponse> deleteListener
(DeleteListenerRequest deleteListenerRequest) Delete a listener from an accelerator.denyCustomRoutingTraffic
(Consumer<DenyCustomRoutingTrafficRequest.Builder> denyCustomRoutingTrafficRequest) Specify the Amazon EC2 instance (destination) IP addresses and ports for a VPC subnet endpoint that cannot receive traffic for a custom routing accelerator.denyCustomRoutingTraffic
(DenyCustomRoutingTrafficRequest denyCustomRoutingTrafficRequest) Specify the Amazon EC2 instance (destination) IP addresses and ports for a VPC subnet endpoint that cannot receive traffic for a custom routing accelerator.deprovisionByoipCidr
(Consumer<DeprovisionByoipCidrRequest.Builder> deprovisionByoipCidrRequest) Releases the specified address range that you provisioned to use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and deletes the corresponding address pool.deprovisionByoipCidr
(DeprovisionByoipCidrRequest deprovisionByoipCidrRequest) Releases the specified address range that you provisioned to use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and deletes the corresponding address pool.describeAccelerator
(Consumer<DescribeAcceleratorRequest.Builder> describeAcceleratorRequest) Describe an accelerator.describeAccelerator
(DescribeAcceleratorRequest describeAcceleratorRequest) Describe an accelerator.describeAcceleratorAttributes
(Consumer<DescribeAcceleratorAttributesRequest.Builder> describeAcceleratorAttributesRequest) Describe the attributes of an accelerator.describeAcceleratorAttributes
(DescribeAcceleratorAttributesRequest describeAcceleratorAttributesRequest) Describe the attributes of an accelerator.describeCrossAccountAttachment
(Consumer<DescribeCrossAccountAttachmentRequest.Builder> describeCrossAccountAttachmentRequest) Gets configuration information about a cross-account attachment.describeCrossAccountAttachment
(DescribeCrossAccountAttachmentRequest describeCrossAccountAttachmentRequest) Gets configuration information about a cross-account attachment.describeCustomRoutingAccelerator
(Consumer<DescribeCustomRoutingAcceleratorRequest.Builder> describeCustomRoutingAcceleratorRequest) Describe a custom routing accelerator.describeCustomRoutingAccelerator
(DescribeCustomRoutingAcceleratorRequest describeCustomRoutingAcceleratorRequest) Describe a custom routing accelerator.describeCustomRoutingAcceleratorAttributes
(Consumer<DescribeCustomRoutingAcceleratorAttributesRequest.Builder> describeCustomRoutingAcceleratorAttributesRequest) Describe the attributes of a custom routing accelerator.describeCustomRoutingAcceleratorAttributes
(DescribeCustomRoutingAcceleratorAttributesRequest describeCustomRoutingAcceleratorAttributesRequest) Describe the attributes of a custom routing accelerator.describeCustomRoutingEndpointGroup
(Consumer<DescribeCustomRoutingEndpointGroupRequest.Builder> describeCustomRoutingEndpointGroupRequest) Describe an endpoint group for a custom routing accelerator.describeCustomRoutingEndpointGroup
(DescribeCustomRoutingEndpointGroupRequest describeCustomRoutingEndpointGroupRequest) Describe an endpoint group for a custom routing accelerator.describeCustomRoutingListener
(Consumer<DescribeCustomRoutingListenerRequest.Builder> describeCustomRoutingListenerRequest) The description of a listener for a custom routing accelerator.describeCustomRoutingListener
(DescribeCustomRoutingListenerRequest describeCustomRoutingListenerRequest) The description of a listener for a custom routing accelerator.describeEndpointGroup
(Consumer<DescribeEndpointGroupRequest.Builder> describeEndpointGroupRequest) Describe an endpoint group.describeEndpointGroup
(DescribeEndpointGroupRequest describeEndpointGroupRequest) Describe an endpoint group.describeListener
(Consumer<DescribeListenerRequest.Builder> describeListenerRequest) Describe a listener.describeListener
(DescribeListenerRequest describeListenerRequest) Describe a listener.List the accelerators for an Amazon Web Services account.listAccelerators
(Consumer<ListAcceleratorsRequest.Builder> listAcceleratorsRequest) List the accelerators for an Amazon Web Services account.listAccelerators
(ListAcceleratorsRequest listAcceleratorsRequest) List the accelerators for an Amazon Web Services account.default ListAcceleratorsPublisher
This is a variant oflistAccelerators(software.amazon.awssdk.services.globalaccelerator.model.ListAcceleratorsRequest)
operation.default ListAcceleratorsPublisher
listAcceleratorsPaginator
(Consumer<ListAcceleratorsRequest.Builder> listAcceleratorsRequest) This is a variant oflistAccelerators(software.amazon.awssdk.services.globalaccelerator.model.ListAcceleratorsRequest)
operation.default ListAcceleratorsPublisher
listAcceleratorsPaginator
(ListAcceleratorsRequest listAcceleratorsRequest) This is a variant oflistAccelerators(software.amazon.awssdk.services.globalaccelerator.model.ListAcceleratorsRequest)
operation.default CompletableFuture
<ListByoipCidrsResponse> listByoipCidrs
(Consumer<ListByoipCidrsRequest.Builder> listByoipCidrsRequest) Lists the IP address ranges that were specified in calls to ProvisionByoipCidr, including the current state and a history of state changes.default CompletableFuture
<ListByoipCidrsResponse> listByoipCidrs
(ListByoipCidrsRequest listByoipCidrsRequest) Lists the IP address ranges that were specified in calls to ProvisionByoipCidr, including the current state and a history of state changes.default ListByoipCidrsPublisher
listByoipCidrsPaginator
(Consumer<ListByoipCidrsRequest.Builder> listByoipCidrsRequest) This is a variant oflistByoipCidrs(software.amazon.awssdk.services.globalaccelerator.model.ListByoipCidrsRequest)
operation.default ListByoipCidrsPublisher
listByoipCidrsPaginator
(ListByoipCidrsRequest listByoipCidrsRequest) This is a variant oflistByoipCidrs(software.amazon.awssdk.services.globalaccelerator.model.ListByoipCidrsRequest)
operation.listCrossAccountAttachments
(Consumer<ListCrossAccountAttachmentsRequest.Builder> listCrossAccountAttachmentsRequest) List the cross-account attachments that have been created in Global Accelerator.listCrossAccountAttachments
(ListCrossAccountAttachmentsRequest listCrossAccountAttachmentsRequest) List the cross-account attachments that have been created in Global Accelerator.listCrossAccountAttachmentsPaginator
(Consumer<ListCrossAccountAttachmentsRequest.Builder> listCrossAccountAttachmentsRequest) This is a variant oflistCrossAccountAttachments(software.amazon.awssdk.services.globalaccelerator.model.ListCrossAccountAttachmentsRequest)
operation.listCrossAccountAttachmentsPaginator
(ListCrossAccountAttachmentsRequest listCrossAccountAttachmentsRequest) This is a variant oflistCrossAccountAttachments(software.amazon.awssdk.services.globalaccelerator.model.ListCrossAccountAttachmentsRequest)
operation.listCrossAccountResourceAccounts
(Consumer<ListCrossAccountResourceAccountsRequest.Builder> listCrossAccountResourceAccountsRequest) List the accounts that have cross-account resources.listCrossAccountResourceAccounts
(ListCrossAccountResourceAccountsRequest listCrossAccountResourceAccountsRequest) List the accounts that have cross-account resources.listCrossAccountResources
(Consumer<ListCrossAccountResourcesRequest.Builder> listCrossAccountResourcesRequest) List the cross-account resources available to work with.listCrossAccountResources
(ListCrossAccountResourcesRequest listCrossAccountResourcesRequest) List the cross-account resources available to work with.listCrossAccountResourcesPaginator
(Consumer<ListCrossAccountResourcesRequest.Builder> listCrossAccountResourcesRequest) This is a variant oflistCrossAccountResources(software.amazon.awssdk.services.globalaccelerator.model.ListCrossAccountResourcesRequest)
operation.listCrossAccountResourcesPaginator
(ListCrossAccountResourcesRequest listCrossAccountResourcesRequest) This is a variant oflistCrossAccountResources(software.amazon.awssdk.services.globalaccelerator.model.ListCrossAccountResourcesRequest)
operation.listCustomRoutingAccelerators
(Consumer<ListCustomRoutingAcceleratorsRequest.Builder> listCustomRoutingAcceleratorsRequest) List the custom routing accelerators for an Amazon Web Services account.listCustomRoutingAccelerators
(ListCustomRoutingAcceleratorsRequest listCustomRoutingAcceleratorsRequest) List the custom routing accelerators for an Amazon Web Services account.listCustomRoutingAcceleratorsPaginator
(Consumer<ListCustomRoutingAcceleratorsRequest.Builder> listCustomRoutingAcceleratorsRequest) This is a variant oflistCustomRoutingAccelerators(software.amazon.awssdk.services.globalaccelerator.model.ListCustomRoutingAcceleratorsRequest)
operation.listCustomRoutingAcceleratorsPaginator
(ListCustomRoutingAcceleratorsRequest listCustomRoutingAcceleratorsRequest) This is a variant oflistCustomRoutingAccelerators(software.amazon.awssdk.services.globalaccelerator.model.ListCustomRoutingAcceleratorsRequest)
operation.listCustomRoutingEndpointGroups
(Consumer<ListCustomRoutingEndpointGroupsRequest.Builder> listCustomRoutingEndpointGroupsRequest) List the endpoint groups that are associated with a listener for a custom routing accelerator.listCustomRoutingEndpointGroups
(ListCustomRoutingEndpointGroupsRequest listCustomRoutingEndpointGroupsRequest) List the endpoint groups that are associated with a listener for a custom routing accelerator.listCustomRoutingEndpointGroupsPaginator
(Consumer<ListCustomRoutingEndpointGroupsRequest.Builder> listCustomRoutingEndpointGroupsRequest) This is a variant oflistCustomRoutingEndpointGroups(software.amazon.awssdk.services.globalaccelerator.model.ListCustomRoutingEndpointGroupsRequest)
operation.listCustomRoutingEndpointGroupsPaginator
(ListCustomRoutingEndpointGroupsRequest listCustomRoutingEndpointGroupsRequest) This is a variant oflistCustomRoutingEndpointGroups(software.amazon.awssdk.services.globalaccelerator.model.ListCustomRoutingEndpointGroupsRequest)
operation.listCustomRoutingListeners
(Consumer<ListCustomRoutingListenersRequest.Builder> listCustomRoutingListenersRequest) List the listeners for a custom routing accelerator.listCustomRoutingListeners
(ListCustomRoutingListenersRequest listCustomRoutingListenersRequest) List the listeners for a custom routing accelerator.listCustomRoutingListenersPaginator
(Consumer<ListCustomRoutingListenersRequest.Builder> listCustomRoutingListenersRequest) This is a variant oflistCustomRoutingListeners(software.amazon.awssdk.services.globalaccelerator.model.ListCustomRoutingListenersRequest)
operation.listCustomRoutingListenersPaginator
(ListCustomRoutingListenersRequest listCustomRoutingListenersRequest) This is a variant oflistCustomRoutingListeners(software.amazon.awssdk.services.globalaccelerator.model.ListCustomRoutingListenersRequest)
operation.listCustomRoutingPortMappings
(Consumer<ListCustomRoutingPortMappingsRequest.Builder> listCustomRoutingPortMappingsRequest) Provides a complete mapping from the public accelerator IP address and port to destination EC2 instance IP addresses and ports in the virtual public cloud (VPC) subnet endpoint for a custom routing accelerator.listCustomRoutingPortMappings
(ListCustomRoutingPortMappingsRequest listCustomRoutingPortMappingsRequest) Provides a complete mapping from the public accelerator IP address and port to destination EC2 instance IP addresses and ports in the virtual public cloud (VPC) subnet endpoint for a custom routing accelerator.listCustomRoutingPortMappingsByDestination
(Consumer<ListCustomRoutingPortMappingsByDestinationRequest.Builder> listCustomRoutingPortMappingsByDestinationRequest) List the port mappings for a specific EC2 instance (destination) in a VPC subnet endpoint.listCustomRoutingPortMappingsByDestination
(ListCustomRoutingPortMappingsByDestinationRequest listCustomRoutingPortMappingsByDestinationRequest) List the port mappings for a specific EC2 instance (destination) in a VPC subnet endpoint.listCustomRoutingPortMappingsByDestinationPaginator
(Consumer<ListCustomRoutingPortMappingsByDestinationRequest.Builder> listCustomRoutingPortMappingsByDestinationRequest) listCustomRoutingPortMappingsByDestinationPaginator
(ListCustomRoutingPortMappingsByDestinationRequest listCustomRoutingPortMappingsByDestinationRequest) listCustomRoutingPortMappingsPaginator
(Consumer<ListCustomRoutingPortMappingsRequest.Builder> listCustomRoutingPortMappingsRequest) This is a variant oflistCustomRoutingPortMappings(software.amazon.awssdk.services.globalaccelerator.model.ListCustomRoutingPortMappingsRequest)
operation.listCustomRoutingPortMappingsPaginator
(ListCustomRoutingPortMappingsRequest listCustomRoutingPortMappingsRequest) This is a variant oflistCustomRoutingPortMappings(software.amazon.awssdk.services.globalaccelerator.model.ListCustomRoutingPortMappingsRequest)
operation.listEndpointGroups
(Consumer<ListEndpointGroupsRequest.Builder> listEndpointGroupsRequest) List the endpoint groups that are associated with a listener.listEndpointGroups
(ListEndpointGroupsRequest listEndpointGroupsRequest) List the endpoint groups that are associated with a listener.default ListEndpointGroupsPublisher
listEndpointGroupsPaginator
(Consumer<ListEndpointGroupsRequest.Builder> listEndpointGroupsRequest) This is a variant oflistEndpointGroups(software.amazon.awssdk.services.globalaccelerator.model.ListEndpointGroupsRequest)
operation.default ListEndpointGroupsPublisher
listEndpointGroupsPaginator
(ListEndpointGroupsRequest listEndpointGroupsRequest) This is a variant oflistEndpointGroups(software.amazon.awssdk.services.globalaccelerator.model.ListEndpointGroupsRequest)
operation.default CompletableFuture
<ListListenersResponse> listListeners
(Consumer<ListListenersRequest.Builder> listListenersRequest) List the listeners for an accelerator.default CompletableFuture
<ListListenersResponse> listListeners
(ListListenersRequest listListenersRequest) List the listeners for an accelerator.default ListListenersPublisher
listListenersPaginator
(Consumer<ListListenersRequest.Builder> listListenersRequest) This is a variant oflistListeners(software.amazon.awssdk.services.globalaccelerator.model.ListListenersRequest)
operation.default ListListenersPublisher
listListenersPaginator
(ListListenersRequest listListenersRequest) This is a variant oflistListeners(software.amazon.awssdk.services.globalaccelerator.model.ListListenersRequest)
operation.listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) List all tags for an accelerator.listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) List all tags for an accelerator.provisionByoipCidr
(Consumer<ProvisionByoipCidrRequest.Builder> provisionByoipCidrRequest) Provisions an IP address range to use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and creates a corresponding address pool.provisionByoipCidr
(ProvisionByoipCidrRequest provisionByoipCidrRequest) Provisions an IP address range to use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and creates a corresponding address pool.removeCustomRoutingEndpoints
(Consumer<RemoveCustomRoutingEndpointsRequest.Builder> removeCustomRoutingEndpointsRequest) Remove endpoints from a custom routing accelerator.removeCustomRoutingEndpoints
(RemoveCustomRoutingEndpointsRequest removeCustomRoutingEndpointsRequest) Remove endpoints from a custom routing accelerator.default CompletableFuture
<RemoveEndpointsResponse> removeEndpoints
(Consumer<RemoveEndpointsRequest.Builder> removeEndpointsRequest) Remove endpoints from an endpoint group.default CompletableFuture
<RemoveEndpointsResponse> removeEndpoints
(RemoveEndpointsRequest removeEndpointsRequest) Remove endpoints from an endpoint group.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationdefault CompletableFuture
<TagResourceResponse> tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Add tags to an accelerator resource.default CompletableFuture
<TagResourceResponse> tagResource
(TagResourceRequest tagResourceRequest) Add tags to an accelerator resource.default CompletableFuture
<UntagResourceResponse> untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Remove tags from a Global Accelerator resource.default CompletableFuture
<UntagResourceResponse> untagResource
(UntagResourceRequest untagResourceRequest) Remove tags from a Global Accelerator resource.updateAccelerator
(Consumer<UpdateAcceleratorRequest.Builder> updateAcceleratorRequest) Update an accelerator to make changes, such as the following:updateAccelerator
(UpdateAcceleratorRequest updateAcceleratorRequest) Update an accelerator to make changes, such as the following:updateAcceleratorAttributes
(Consumer<UpdateAcceleratorAttributesRequest.Builder> updateAcceleratorAttributesRequest) Update the attributes for an accelerator.updateAcceleratorAttributes
(UpdateAcceleratorAttributesRequest updateAcceleratorAttributesRequest) Update the attributes for an accelerator.updateCrossAccountAttachment
(Consumer<UpdateCrossAccountAttachmentRequest.Builder> updateCrossAccountAttachmentRequest) Update a cross-account attachment to add or remove principals or resources.updateCrossAccountAttachment
(UpdateCrossAccountAttachmentRequest updateCrossAccountAttachmentRequest) Update a cross-account attachment to add or remove principals or resources.updateCustomRoutingAccelerator
(Consumer<UpdateCustomRoutingAcceleratorRequest.Builder> updateCustomRoutingAcceleratorRequest) Update a custom routing accelerator.updateCustomRoutingAccelerator
(UpdateCustomRoutingAcceleratorRequest updateCustomRoutingAcceleratorRequest) Update a custom routing accelerator.updateCustomRoutingAcceleratorAttributes
(Consumer<UpdateCustomRoutingAcceleratorAttributesRequest.Builder> updateCustomRoutingAcceleratorAttributesRequest) Update the attributes for a custom routing accelerator.updateCustomRoutingAcceleratorAttributes
(UpdateCustomRoutingAcceleratorAttributesRequest updateCustomRoutingAcceleratorAttributesRequest) Update the attributes for a custom routing accelerator.updateCustomRoutingListener
(Consumer<UpdateCustomRoutingListenerRequest.Builder> updateCustomRoutingListenerRequest) Update a listener for a custom routing accelerator.updateCustomRoutingListener
(UpdateCustomRoutingListenerRequest updateCustomRoutingListenerRequest) Update a listener for a custom routing accelerator.updateEndpointGroup
(Consumer<UpdateEndpointGroupRequest.Builder> updateEndpointGroupRequest) Update an endpoint group.updateEndpointGroup
(UpdateEndpointGroupRequest updateEndpointGroupRequest) Update an endpoint group.default CompletableFuture
<UpdateListenerResponse> updateListener
(Consumer<UpdateListenerRequest.Builder> updateListenerRequest) Update a listener.default CompletableFuture
<UpdateListenerResponse> updateListener
(UpdateListenerRequest updateListenerRequest) Update a listener.withdrawByoipCidr
(Consumer<WithdrawByoipCidrRequest.Builder> withdrawByoipCidrRequest) Stops advertising an address range that is provisioned as an address pool.withdrawByoipCidr
(WithdrawByoipCidrRequest withdrawByoipCidrRequest) Stops advertising an address range that is provisioned as an address pool.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
-
addCustomRoutingEndpoints
default CompletableFuture<AddCustomRoutingEndpointsResponse> addCustomRoutingEndpoints(AddCustomRoutingEndpointsRequest addCustomRoutingEndpointsRequest) Associate a virtual private cloud (VPC) subnet endpoint with your custom routing accelerator.
The listener port range must be large enough to support the number of IP addresses that can be specified in your subnet. The number of ports required is: subnet size times the number of ports per destination EC2 instances. For example, a subnet defined as /24 requires a listener port range of at least 255 ports.
Note: You must have enough remaining listener ports available to map to the subnet ports, or the call will fail with a LimitExceededException.
By default, all destinations in a subnet in a custom routing accelerator cannot receive traffic. To enable all destinations to receive traffic, or to specify individual port mappings that can receive traffic, see the AllowCustomRoutingTraffic operation.
- Parameters:
addCustomRoutingEndpointsRequest
-- Returns:
- A Java Future containing the result of the AddCustomRoutingEndpoints 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.- EndpointAlreadyExistsException The endpoint that you specified doesn't exist.
- EndpointGroupNotFoundException The endpoint group that you specified doesn't exist.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- InvalidArgumentException An argument that you specified is invalid.
- LimitExceededException Processing your request would cause you to exceed an Global Accelerator limit.
- AccessDeniedException You don't have access permission.
- ConflictException You can't use both of those options.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
addCustomRoutingEndpoints
default CompletableFuture<AddCustomRoutingEndpointsResponse> addCustomRoutingEndpoints(Consumer<AddCustomRoutingEndpointsRequest.Builder> addCustomRoutingEndpointsRequest) Associate a virtual private cloud (VPC) subnet endpoint with your custom routing accelerator.
The listener port range must be large enough to support the number of IP addresses that can be specified in your subnet. The number of ports required is: subnet size times the number of ports per destination EC2 instances. For example, a subnet defined as /24 requires a listener port range of at least 255 ports.
Note: You must have enough remaining listener ports available to map to the subnet ports, or the call will fail with a LimitExceededException.
By default, all destinations in a subnet in a custom routing accelerator cannot receive traffic. To enable all destinations to receive traffic, or to specify individual port mappings that can receive traffic, see the AllowCustomRoutingTraffic operation.
This is a convenience which creates an instance of the
AddCustomRoutingEndpointsRequest.Builder
avoiding the need to create one manually viaAddCustomRoutingEndpointsRequest.builder()
- Parameters:
addCustomRoutingEndpointsRequest
- AConsumer
that will call methods onAddCustomRoutingEndpointsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the AddCustomRoutingEndpoints 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.- EndpointAlreadyExistsException The endpoint that you specified doesn't exist.
- EndpointGroupNotFoundException The endpoint group that you specified doesn't exist.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- InvalidArgumentException An argument that you specified is invalid.
- LimitExceededException Processing your request would cause you to exceed an Global Accelerator limit.
- AccessDeniedException You don't have access permission.
- ConflictException You can't use both of those options.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
addEndpoints
default CompletableFuture<AddEndpointsResponse> addEndpoints(AddEndpointsRequest addEndpointsRequest) Add endpoints to an endpoint group. The
AddEndpoints
API operation is the recommended option for adding endpoints. The alternative options are to add endpoints when you create an endpoint group (with the CreateEndpointGroup API) or when you update an endpoint group (with the UpdateEndpointGroup API).There are two advantages to using
AddEndpoints
to add endpoints in Global Accelerator:-
It's faster, because Global Accelerator only has to resolve the new endpoints that you're adding, rather than resolving new and existing endpoints.
-
It's more convenient, because you don't need to specify the current endpoints that are already in the endpoint group, in addition to the new endpoints that you want to add.
For information about endpoint types and requirements for endpoints that you can add to Global Accelerator, see Endpoints for standard accelerators in the Global Accelerator Developer Guide.
- Parameters:
addEndpointsRequest
-- Returns:
- A Java Future containing the result of the AddEndpoints 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.- TransactionInProgressException There's already a transaction in progress. Another transaction can't be processed.
- EndpointGroupNotFoundException The endpoint group that you specified doesn't exist.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- InvalidArgumentException An argument that you specified is invalid.
- LimitExceededException Processing your request would cause you to exceed an Global Accelerator limit.
- AccessDeniedException You don't have access permission.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
addEndpoints
default CompletableFuture<AddEndpointsResponse> addEndpoints(Consumer<AddEndpointsRequest.Builder> addEndpointsRequest) Add endpoints to an endpoint group. The
AddEndpoints
API operation is the recommended option for adding endpoints. The alternative options are to add endpoints when you create an endpoint group (with the CreateEndpointGroup API) or when you update an endpoint group (with the UpdateEndpointGroup API).There are two advantages to using
AddEndpoints
to add endpoints in Global Accelerator:-
It's faster, because Global Accelerator only has to resolve the new endpoints that you're adding, rather than resolving new and existing endpoints.
-
It's more convenient, because you don't need to specify the current endpoints that are already in the endpoint group, in addition to the new endpoints that you want to add.
For information about endpoint types and requirements for endpoints that you can add to Global Accelerator, see Endpoints for standard accelerators in the Global Accelerator Developer Guide.
This is a convenience which creates an instance of the
AddEndpointsRequest.Builder
avoiding the need to create one manually viaAddEndpointsRequest.builder()
- Parameters:
addEndpointsRequest
- AConsumer
that will call methods onAddEndpointsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the AddEndpoints 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.- TransactionInProgressException There's already a transaction in progress. Another transaction can't be processed.
- EndpointGroupNotFoundException The endpoint group that you specified doesn't exist.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- InvalidArgumentException An argument that you specified is invalid.
- LimitExceededException Processing your request would cause you to exceed an Global Accelerator limit.
- AccessDeniedException You don't have access permission.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
advertiseByoipCidr
default CompletableFuture<AdvertiseByoipCidrResponse> advertiseByoipCidr(AdvertiseByoipCidrRequest advertiseByoipCidrRequest) Advertises an IPv4 address range that is provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP). It can take a few minutes before traffic to the specified addresses starts routing to Amazon Web Services because of propagation delays.
To stop advertising the BYOIP address range, use WithdrawByoipCidr.
For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
- Parameters:
advertiseByoipCidrRequest
-- Returns:
- A Java Future containing the result of the AdvertiseByoipCidr 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.- InternalServiceErrorException There was an internal error for Global Accelerator.
- InvalidArgumentException An argument that you specified is invalid.
- AccessDeniedException You don't have access permission.
- ByoipCidrNotFoundException The CIDR that you specified was not found or is incorrect.
- IncorrectCidrStateException The CIDR that you specified is not valid for this action. For example, the state of the CIDR might be incorrect for this action.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
advertiseByoipCidr
default CompletableFuture<AdvertiseByoipCidrResponse> advertiseByoipCidr(Consumer<AdvertiseByoipCidrRequest.Builder> advertiseByoipCidrRequest) Advertises an IPv4 address range that is provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP). It can take a few minutes before traffic to the specified addresses starts routing to Amazon Web Services because of propagation delays.
To stop advertising the BYOIP address range, use WithdrawByoipCidr.
For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
This is a convenience which creates an instance of the
AdvertiseByoipCidrRequest.Builder
avoiding the need to create one manually viaAdvertiseByoipCidrRequest.builder()
- Parameters:
advertiseByoipCidrRequest
- AConsumer
that will call methods onAdvertiseByoipCidrRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the AdvertiseByoipCidr 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.- InternalServiceErrorException There was an internal error for Global Accelerator.
- InvalidArgumentException An argument that you specified is invalid.
- AccessDeniedException You don't have access permission.
- ByoipCidrNotFoundException The CIDR that you specified was not found or is incorrect.
- IncorrectCidrStateException The CIDR that you specified is not valid for this action. For example, the state of the CIDR might be incorrect for this action.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
allowCustomRoutingTraffic
default CompletableFuture<AllowCustomRoutingTrafficResponse> allowCustomRoutingTraffic(AllowCustomRoutingTrafficRequest allowCustomRoutingTrafficRequest) Specify the Amazon EC2 instance (destination) IP addresses and ports for a VPC subnet endpoint that can receive traffic for a custom routing accelerator. You can allow traffic to all destinations in the subnet endpoint, or allow traffic to a specified list of destination IP addresses and ports in the subnet. Note that you cannot specify IP addresses or ports outside of the range that you configured for the endpoint group.
After you make changes, you can verify that the updates are complete by checking the status of your accelerator: the status changes from IN_PROGRESS to DEPLOYED.
- Parameters:
allowCustomRoutingTrafficRequest
-- Returns:
- A Java Future containing the result of the AllowCustomRoutingTraffic 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.- EndpointGroupNotFoundException The endpoint group that you specified doesn't exist.
- InvalidArgumentException An argument that you specified is invalid.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
allowCustomRoutingTraffic
default CompletableFuture<AllowCustomRoutingTrafficResponse> allowCustomRoutingTraffic(Consumer<AllowCustomRoutingTrafficRequest.Builder> allowCustomRoutingTrafficRequest) Specify the Amazon EC2 instance (destination) IP addresses and ports for a VPC subnet endpoint that can receive traffic for a custom routing accelerator. You can allow traffic to all destinations in the subnet endpoint, or allow traffic to a specified list of destination IP addresses and ports in the subnet. Note that you cannot specify IP addresses or ports outside of the range that you configured for the endpoint group.
After you make changes, you can verify that the updates are complete by checking the status of your accelerator: the status changes from IN_PROGRESS to DEPLOYED.
This is a convenience which creates an instance of the
AllowCustomRoutingTrafficRequest.Builder
avoiding the need to create one manually viaAllowCustomRoutingTrafficRequest.builder()
- Parameters:
allowCustomRoutingTrafficRequest
- AConsumer
that will call methods onAllowCustomRoutingTrafficRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the AllowCustomRoutingTraffic 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.- EndpointGroupNotFoundException The endpoint group that you specified doesn't exist.
- InvalidArgumentException An argument that you specified is invalid.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createAccelerator
default CompletableFuture<CreateAcceleratorResponse> createAccelerator(CreateAcceleratorRequest createAcceleratorRequest) Create an accelerator. An accelerator includes one or more listeners that process inbound connections and direct traffic to one or more endpoint groups, each of which includes endpoints, such as Network Load Balancers.
Global Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the US West (Oregon) Region to create, update, or otherwise work with accelerators. That is, for example, specify
--region us-west-2
on Amazon Web Services CLI commands.- Parameters:
createAcceleratorRequest
-- Returns:
- A Java Future containing the result of the CreateAccelerator 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.- InternalServiceErrorException There was an internal error for Global Accelerator.
- InvalidArgumentException An argument that you specified is invalid.
- LimitExceededException Processing your request would cause you to exceed an Global Accelerator limit.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createAccelerator
default CompletableFuture<CreateAcceleratorResponse> createAccelerator(Consumer<CreateAcceleratorRequest.Builder> createAcceleratorRequest) Create an accelerator. An accelerator includes one or more listeners that process inbound connections and direct traffic to one or more endpoint groups, each of which includes endpoints, such as Network Load Balancers.
Global Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the US West (Oregon) Region to create, update, or otherwise work with accelerators. That is, for example, specify
--region us-west-2
on Amazon Web Services CLI commands.
This is a convenience which creates an instance of the
CreateAcceleratorRequest.Builder
avoiding the need to create one manually viaCreateAcceleratorRequest.builder()
- Parameters:
createAcceleratorRequest
- AConsumer
that will call methods onCreateAcceleratorRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateAccelerator 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.- InternalServiceErrorException There was an internal error for Global Accelerator.
- InvalidArgumentException An argument that you specified is invalid.
- LimitExceededException Processing your request would cause you to exceed an Global Accelerator limit.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createCrossAccountAttachment
default CompletableFuture<CreateCrossAccountAttachmentResponse> createCrossAccountAttachment(CreateCrossAccountAttachmentRequest createCrossAccountAttachmentRequest) Create a cross-account attachment in Global Accelerator. You create a cross-account attachment to specify the principals who have permission to work with resources in accelerators in their own account. You specify, in the same attachment, the resources that are shared.
A principal can be an Amazon Web Services account number or the Amazon Resource Name (ARN) for an accelerator. For account numbers that are listed as principals, to work with a resource listed in the attachment, you must sign in to an account specified as a principal. Then, you can work with resources that are listed, with any of your accelerators. If an accelerator ARN is listed in the cross-account attachment as a principal, anyone with permission to make updates to the accelerator can work with resources that are listed in the attachment.
Specify each principal and resource separately. To specify two CIDR address pools, list them individually under
Resources
, and so on. For a command line operation, for example, you might use a statement like the following:"Resources": [{"Cidr": "169.254.60.0/24"},{"Cidr": "169.254.59.0/24"}]
For more information, see Working with cross-account attachments and resources in Global Accelerator in the Global Accelerator Developer Guide.
- Parameters:
createCrossAccountAttachmentRequest
-- Returns:
- A Java Future containing the result of the CreateCrossAccountAttachment 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.- InternalServiceErrorException There was an internal error for Global Accelerator.
- InvalidArgumentException An argument that you specified is invalid.
- LimitExceededException Processing your request would cause you to exceed an Global Accelerator limit.
- AccessDeniedException You don't have access permission.
- TransactionInProgressException There's already a transaction in progress. Another transaction can't be processed.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createCrossAccountAttachment
default CompletableFuture<CreateCrossAccountAttachmentResponse> createCrossAccountAttachment(Consumer<CreateCrossAccountAttachmentRequest.Builder> createCrossAccountAttachmentRequest) Create a cross-account attachment in Global Accelerator. You create a cross-account attachment to specify the principals who have permission to work with resources in accelerators in their own account. You specify, in the same attachment, the resources that are shared.
A principal can be an Amazon Web Services account number or the Amazon Resource Name (ARN) for an accelerator. For account numbers that are listed as principals, to work with a resource listed in the attachment, you must sign in to an account specified as a principal. Then, you can work with resources that are listed, with any of your accelerators. If an accelerator ARN is listed in the cross-account attachment as a principal, anyone with permission to make updates to the accelerator can work with resources that are listed in the attachment.
Specify each principal and resource separately. To specify two CIDR address pools, list them individually under
Resources
, and so on. For a command line operation, for example, you might use a statement like the following:"Resources": [{"Cidr": "169.254.60.0/24"},{"Cidr": "169.254.59.0/24"}]
For more information, see Working with cross-account attachments and resources in Global Accelerator in the Global Accelerator Developer Guide.
This is a convenience which creates an instance of the
CreateCrossAccountAttachmentRequest.Builder
avoiding the need to create one manually viaCreateCrossAccountAttachmentRequest.builder()
- Parameters:
createCrossAccountAttachmentRequest
- AConsumer
that will call methods onCreateCrossAccountAttachmentRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateCrossAccountAttachment 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.- InternalServiceErrorException There was an internal error for Global Accelerator.
- InvalidArgumentException An argument that you specified is invalid.
- LimitExceededException Processing your request would cause you to exceed an Global Accelerator limit.
- AccessDeniedException You don't have access permission.
- TransactionInProgressException There's already a transaction in progress. Another transaction can't be processed.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createCustomRoutingAccelerator
default CompletableFuture<CreateCustomRoutingAcceleratorResponse> createCustomRoutingAccelerator(CreateCustomRoutingAcceleratorRequest createCustomRoutingAcceleratorRequest) Create a custom routing accelerator. A custom routing accelerator directs traffic to one of possibly thousands of Amazon EC2 instance destinations running in a single or multiple virtual private clouds (VPC) subnet endpoints.
Be aware that, by default, all destination EC2 instances in a VPC subnet endpoint cannot receive traffic. To enable all destinations to receive traffic, or to specify individual port mappings that can receive traffic, see the AllowCustomRoutingTraffic operation.
Global Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the US West (Oregon) Region to create, update, or otherwise work with accelerators. That is, for example, specify
--region us-west-2
on Amazon Web Services CLI commands.- Parameters:
createCustomRoutingAcceleratorRequest
-- Returns:
- A Java Future containing the result of the CreateCustomRoutingAccelerator 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.- InternalServiceErrorException There was an internal error for Global Accelerator.
- InvalidArgumentException An argument that you specified is invalid.
- LimitExceededException Processing your request would cause you to exceed an Global Accelerator limit.
- AccessDeniedException You don't have access permission.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createCustomRoutingAccelerator
default CompletableFuture<CreateCustomRoutingAcceleratorResponse> createCustomRoutingAccelerator(Consumer<CreateCustomRoutingAcceleratorRequest.Builder> createCustomRoutingAcceleratorRequest) Create a custom routing accelerator. A custom routing accelerator directs traffic to one of possibly thousands of Amazon EC2 instance destinations running in a single or multiple virtual private clouds (VPC) subnet endpoints.
Be aware that, by default, all destination EC2 instances in a VPC subnet endpoint cannot receive traffic. To enable all destinations to receive traffic, or to specify individual port mappings that can receive traffic, see the AllowCustomRoutingTraffic operation.
Global Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the US West (Oregon) Region to create, update, or otherwise work with accelerators. That is, for example, specify
--region us-west-2
on Amazon Web Services CLI commands.
This is a convenience which creates an instance of the
CreateCustomRoutingAcceleratorRequest.Builder
avoiding the need to create one manually viaCreateCustomRoutingAcceleratorRequest.builder()
- Parameters:
createCustomRoutingAcceleratorRequest
- AConsumer
that will call methods onCreateCustomRoutingAcceleratorRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateCustomRoutingAccelerator 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.- InternalServiceErrorException There was an internal error for Global Accelerator.
- InvalidArgumentException An argument that you specified is invalid.
- LimitExceededException Processing your request would cause you to exceed an Global Accelerator limit.
- AccessDeniedException You don't have access permission.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createCustomRoutingEndpointGroup
default CompletableFuture<CreateCustomRoutingEndpointGroupResponse> createCustomRoutingEndpointGroup(CreateCustomRoutingEndpointGroupRequest createCustomRoutingEndpointGroupRequest) Create an endpoint group for the specified listener for a custom routing accelerator. An endpoint group is a collection of endpoints in one Amazon Web Services Region.
- Parameters:
createCustomRoutingEndpointGroupRequest
-- Returns:
- A Java Future containing the result of the CreateCustomRoutingEndpointGroup 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.- AcceleratorNotFoundException The accelerator that you specified doesn't exist.
- EndpointGroupAlreadyExistsException The endpoint group that you specified already exists.
- ListenerNotFoundException The listener that you specified doesn't exist.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- InvalidArgumentException An argument that you specified is invalid.
- InvalidPortRangeException The port numbers that you specified are not valid numbers or are not unique for this accelerator.
- LimitExceededException Processing your request would cause you to exceed an Global Accelerator limit.
- AccessDeniedException You don't have access permission.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createCustomRoutingEndpointGroup
default CompletableFuture<CreateCustomRoutingEndpointGroupResponse> createCustomRoutingEndpointGroup(Consumer<CreateCustomRoutingEndpointGroupRequest.Builder> createCustomRoutingEndpointGroupRequest) Create an endpoint group for the specified listener for a custom routing accelerator. An endpoint group is a collection of endpoints in one Amazon Web Services Region.
This is a convenience which creates an instance of the
CreateCustomRoutingEndpointGroupRequest.Builder
avoiding the need to create one manually viaCreateCustomRoutingEndpointGroupRequest.builder()
- Parameters:
createCustomRoutingEndpointGroupRequest
- AConsumer
that will call methods onCreateCustomRoutingEndpointGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateCustomRoutingEndpointGroup 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.- AcceleratorNotFoundException The accelerator that you specified doesn't exist.
- EndpointGroupAlreadyExistsException The endpoint group that you specified already exists.
- ListenerNotFoundException The listener that you specified doesn't exist.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- InvalidArgumentException An argument that you specified is invalid.
- InvalidPortRangeException The port numbers that you specified are not valid numbers or are not unique for this accelerator.
- LimitExceededException Processing your request would cause you to exceed an Global Accelerator limit.
- AccessDeniedException You don't have access permission.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createCustomRoutingListener
default CompletableFuture<CreateCustomRoutingListenerResponse> createCustomRoutingListener(CreateCustomRoutingListenerRequest createCustomRoutingListenerRequest) Create a listener to process inbound connections from clients to a custom routing accelerator. Connections arrive to assigned static IP addresses on the port range that you specify.
- Parameters:
createCustomRoutingListenerRequest
-- Returns:
- A Java Future containing the result of the CreateCustomRoutingListener 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.- InvalidArgumentException An argument that you specified is invalid.
- AcceleratorNotFoundException The accelerator that you specified doesn't exist.
- InvalidPortRangeException The port numbers that you specified are not valid numbers or are not unique for this accelerator.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- LimitExceededException Processing your request would cause you to exceed an Global Accelerator limit.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createCustomRoutingListener
default CompletableFuture<CreateCustomRoutingListenerResponse> createCustomRoutingListener(Consumer<CreateCustomRoutingListenerRequest.Builder> createCustomRoutingListenerRequest) Create a listener to process inbound connections from clients to a custom routing accelerator. Connections arrive to assigned static IP addresses on the port range that you specify.
This is a convenience which creates an instance of the
CreateCustomRoutingListenerRequest.Builder
avoiding the need to create one manually viaCreateCustomRoutingListenerRequest.builder()
- Parameters:
createCustomRoutingListenerRequest
- AConsumer
that will call methods onCreateCustomRoutingListenerRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateCustomRoutingListener 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.- InvalidArgumentException An argument that you specified is invalid.
- AcceleratorNotFoundException The accelerator that you specified doesn't exist.
- InvalidPortRangeException The port numbers that you specified are not valid numbers or are not unique for this accelerator.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- LimitExceededException Processing your request would cause you to exceed an Global Accelerator limit.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createEndpointGroup
default CompletableFuture<CreateEndpointGroupResponse> createEndpointGroup(CreateEndpointGroupRequest createEndpointGroupRequest) Create an endpoint group for the specified listener. An endpoint group is a collection of endpoints in one Amazon Web Services Region. A resource must be valid and active when you add it as an endpoint.
For more information about endpoint types and requirements for endpoints that you can add to Global Accelerator, see Endpoints for standard accelerators in the Global Accelerator Developer Guide.
- Parameters:
createEndpointGroupRequest
-- Returns:
- A Java Future containing the result of the CreateEndpointGroup 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.- AcceleratorNotFoundException The accelerator that you specified doesn't exist.
- EndpointGroupAlreadyExistsException The endpoint group that you specified already exists.
- ListenerNotFoundException The listener that you specified doesn't exist.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- InvalidArgumentException An argument that you specified is invalid.
- LimitExceededException Processing your request would cause you to exceed an Global Accelerator limit.
- AccessDeniedException You don't have access permission.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createEndpointGroup
default CompletableFuture<CreateEndpointGroupResponse> createEndpointGroup(Consumer<CreateEndpointGroupRequest.Builder> createEndpointGroupRequest) Create an endpoint group for the specified listener. An endpoint group is a collection of endpoints in one Amazon Web Services Region. A resource must be valid and active when you add it as an endpoint.
For more information about endpoint types and requirements for endpoints that you can add to Global Accelerator, see Endpoints for standard accelerators in the Global Accelerator Developer Guide.
This is a convenience which creates an instance of the
CreateEndpointGroupRequest.Builder
avoiding the need to create one manually viaCreateEndpointGroupRequest.builder()
- Parameters:
createEndpointGroupRequest
- AConsumer
that will call methods onCreateEndpointGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateEndpointGroup 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.- AcceleratorNotFoundException The accelerator that you specified doesn't exist.
- EndpointGroupAlreadyExistsException The endpoint group that you specified already exists.
- ListenerNotFoundException The listener that you specified doesn't exist.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- InvalidArgumentException An argument that you specified is invalid.
- LimitExceededException Processing your request would cause you to exceed an Global Accelerator limit.
- AccessDeniedException You don't have access permission.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createListener
default CompletableFuture<CreateListenerResponse> createListener(CreateListenerRequest createListenerRequest) Create a listener to process inbound connections from clients to an accelerator. Connections arrive to assigned static IP addresses on a port, port range, or list of port ranges that you specify.
- Parameters:
createListenerRequest
-- Returns:
- A Java Future containing the result of the CreateListener 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.- InvalidArgumentException An argument that you specified is invalid.
- AcceleratorNotFoundException The accelerator that you specified doesn't exist.
- InvalidPortRangeException The port numbers that you specified are not valid numbers or are not unique for this accelerator.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- LimitExceededException Processing your request would cause you to exceed an Global Accelerator limit.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createListener
default CompletableFuture<CreateListenerResponse> createListener(Consumer<CreateListenerRequest.Builder> createListenerRequest) Create a listener to process inbound connections from clients to an accelerator. Connections arrive to assigned static IP addresses on a port, port range, or list of port ranges that you specify.
This is a convenience which creates an instance of the
CreateListenerRequest.Builder
avoiding the need to create one manually viaCreateListenerRequest.builder()
- Parameters:
createListenerRequest
- AConsumer
that will call methods onCreateListenerRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateListener 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.- InvalidArgumentException An argument that you specified is invalid.
- AcceleratorNotFoundException The accelerator that you specified doesn't exist.
- InvalidPortRangeException The port numbers that you specified are not valid numbers or are not unique for this accelerator.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- LimitExceededException Processing your request would cause you to exceed an Global Accelerator limit.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAccelerator
default CompletableFuture<DeleteAcceleratorResponse> deleteAccelerator(DeleteAcceleratorRequest deleteAcceleratorRequest) Delete an accelerator. Before you can delete an accelerator, you must disable it and remove all dependent resources (listeners and endpoint groups). To disable the accelerator, update the accelerator to set
Enabled
to false.When you create an accelerator, by default, Global Accelerator provides you with a set of two static IP addresses. Alternatively, you can bring your own IP address ranges to Global Accelerator and assign IP addresses from those ranges.
The IP addresses are assigned to your accelerator for as long as it exists, even if you disable the accelerator and it no longer accepts or routes traffic. However, when you delete an accelerator, you lose the static IP addresses that are assigned to the accelerator, so you can no longer route traffic by using them. As a best practice, ensure that you have permissions in place to avoid inadvertently deleting accelerators. You can use IAM policies with Global Accelerator to limit the users who have permissions to delete an accelerator. For more information, see Identity and access management in the Global Accelerator Developer Guide.
- Parameters:
deleteAcceleratorRequest
-- Returns:
- A Java Future containing the result of the DeleteAccelerator 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.- AcceleratorNotFoundException The accelerator that you specified doesn't exist.
- AcceleratorNotDisabledException The accelerator that you specified could not be disabled.
- AssociatedListenerFoundException The accelerator that you specified has a listener associated with it. You must remove all dependent resources from an accelerator before you can delete it.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- InvalidArgumentException An argument that you specified is invalid.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAccelerator
default CompletableFuture<DeleteAcceleratorResponse> deleteAccelerator(Consumer<DeleteAcceleratorRequest.Builder> deleteAcceleratorRequest) Delete an accelerator. Before you can delete an accelerator, you must disable it and remove all dependent resources (listeners and endpoint groups). To disable the accelerator, update the accelerator to set
Enabled
to false.When you create an accelerator, by default, Global Accelerator provides you with a set of two static IP addresses. Alternatively, you can bring your own IP address ranges to Global Accelerator and assign IP addresses from those ranges.
The IP addresses are assigned to your accelerator for as long as it exists, even if you disable the accelerator and it no longer accepts or routes traffic. However, when you delete an accelerator, you lose the static IP addresses that are assigned to the accelerator, so you can no longer route traffic by using them. As a best practice, ensure that you have permissions in place to avoid inadvertently deleting accelerators. You can use IAM policies with Global Accelerator to limit the users who have permissions to delete an accelerator. For more information, see Identity and access management in the Global Accelerator Developer Guide.
This is a convenience which creates an instance of the
DeleteAcceleratorRequest.Builder
avoiding the need to create one manually viaDeleteAcceleratorRequest.builder()
- Parameters:
deleteAcceleratorRequest
- AConsumer
that will call methods onDeleteAcceleratorRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteAccelerator 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.- AcceleratorNotFoundException The accelerator that you specified doesn't exist.
- AcceleratorNotDisabledException The accelerator that you specified could not be disabled.
- AssociatedListenerFoundException The accelerator that you specified has a listener associated with it. You must remove all dependent resources from an accelerator before you can delete it.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- InvalidArgumentException An argument that you specified is invalid.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteCrossAccountAttachment
default CompletableFuture<DeleteCrossAccountAttachmentResponse> deleteCrossAccountAttachment(DeleteCrossAccountAttachmentRequest deleteCrossAccountAttachmentRequest) Delete a cross-account attachment. When you delete an attachment, Global Accelerator revokes the permission to use the resources in the attachment from all principals in the list of principals. Global Accelerator revokes the permission for specific resources.
For more information, see Working with cross-account attachments and resources in Global Accelerator in the Global Accelerator Developer Guide.
- Parameters:
deleteCrossAccountAttachmentRequest
-- Returns:
- A Java Future containing the result of the DeleteCrossAccountAttachment 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.- AttachmentNotFoundException No cross-account attachment was found.
- AccessDeniedException You don't have access permission.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- InvalidArgumentException An argument that you specified is invalid.
- TransactionInProgressException There's already a transaction in progress. Another transaction can't be processed.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteCrossAccountAttachment
default CompletableFuture<DeleteCrossAccountAttachmentResponse> deleteCrossAccountAttachment(Consumer<DeleteCrossAccountAttachmentRequest.Builder> deleteCrossAccountAttachmentRequest) Delete a cross-account attachment. When you delete an attachment, Global Accelerator revokes the permission to use the resources in the attachment from all principals in the list of principals. Global Accelerator revokes the permission for specific resources.
For more information, see Working with cross-account attachments and resources in Global Accelerator in the Global Accelerator Developer Guide.
This is a convenience which creates an instance of the
DeleteCrossAccountAttachmentRequest.Builder
avoiding the need to create one manually viaDeleteCrossAccountAttachmentRequest.builder()
- Parameters:
deleteCrossAccountAttachmentRequest
- AConsumer
that will call methods onDeleteCrossAccountAttachmentRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteCrossAccountAttachment 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.- AttachmentNotFoundException No cross-account attachment was found.
- AccessDeniedException You don't have access permission.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- InvalidArgumentException An argument that you specified is invalid.
- TransactionInProgressException There's already a transaction in progress. Another transaction can't be processed.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteCustomRoutingAccelerator
default CompletableFuture<DeleteCustomRoutingAcceleratorResponse> deleteCustomRoutingAccelerator(DeleteCustomRoutingAcceleratorRequest deleteCustomRoutingAcceleratorRequest) Delete a custom routing accelerator. Before you can delete an accelerator, you must disable it and remove all dependent resources (listeners and endpoint groups). To disable the accelerator, update the accelerator to set
Enabled
to false.When you create a custom routing accelerator, by default, Global Accelerator provides you with a set of two static IP addresses.
The IP addresses are assigned to your accelerator for as long as it exists, even if you disable the accelerator and it no longer accepts or routes traffic. However, when you delete an accelerator, you lose the static IP addresses that are assigned to the accelerator, so you can no longer route traffic by using them. As a best practice, ensure that you have permissions in place to avoid inadvertently deleting accelerators. You can use IAM policies with Global Accelerator to limit the users who have permissions to delete an accelerator. For more information, see Identity and access management in the Global Accelerator Developer Guide.
- Parameters:
deleteCustomRoutingAcceleratorRequest
-- Returns:
- A Java Future containing the result of the DeleteCustomRoutingAccelerator 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.- AcceleratorNotFoundException The accelerator that you specified doesn't exist.
- AcceleratorNotDisabledException The accelerator that you specified could not be disabled.
- AssociatedListenerFoundException The accelerator that you specified has a listener associated with it. You must remove all dependent resources from an accelerator before you can delete it.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- InvalidArgumentException An argument that you specified is invalid.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteCustomRoutingAccelerator
default CompletableFuture<DeleteCustomRoutingAcceleratorResponse> deleteCustomRoutingAccelerator(Consumer<DeleteCustomRoutingAcceleratorRequest.Builder> deleteCustomRoutingAcceleratorRequest) Delete a custom routing accelerator. Before you can delete an accelerator, you must disable it and remove all dependent resources (listeners and endpoint groups). To disable the accelerator, update the accelerator to set
Enabled
to false.When you create a custom routing accelerator, by default, Global Accelerator provides you with a set of two static IP addresses.
The IP addresses are assigned to your accelerator for as long as it exists, even if you disable the accelerator and it no longer accepts or routes traffic. However, when you delete an accelerator, you lose the static IP addresses that are assigned to the accelerator, so you can no longer route traffic by using them. As a best practice, ensure that you have permissions in place to avoid inadvertently deleting accelerators. You can use IAM policies with Global Accelerator to limit the users who have permissions to delete an accelerator. For more information, see Identity and access management in the Global Accelerator Developer Guide.
This is a convenience which creates an instance of the
DeleteCustomRoutingAcceleratorRequest.Builder
avoiding the need to create one manually viaDeleteCustomRoutingAcceleratorRequest.builder()
- Parameters:
deleteCustomRoutingAcceleratorRequest
- AConsumer
that will call methods onDeleteCustomRoutingAcceleratorRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteCustomRoutingAccelerator 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.- AcceleratorNotFoundException The accelerator that you specified doesn't exist.
- AcceleratorNotDisabledException The accelerator that you specified could not be disabled.
- AssociatedListenerFoundException The accelerator that you specified has a listener associated with it. You must remove all dependent resources from an accelerator before you can delete it.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- InvalidArgumentException An argument that you specified is invalid.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteCustomRoutingEndpointGroup
default CompletableFuture<DeleteCustomRoutingEndpointGroupResponse> deleteCustomRoutingEndpointGroup(DeleteCustomRoutingEndpointGroupRequest deleteCustomRoutingEndpointGroupRequest) Delete an endpoint group from a listener for a custom routing accelerator.
- Parameters:
deleteCustomRoutingEndpointGroupRequest
-- Returns:
- A Java Future containing the result of the DeleteCustomRoutingEndpointGroup 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.- InvalidArgumentException An argument that you specified is invalid.
- EndpointGroupNotFoundException The endpoint group that you specified doesn't exist.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteCustomRoutingEndpointGroup
default CompletableFuture<DeleteCustomRoutingEndpointGroupResponse> deleteCustomRoutingEndpointGroup(Consumer<DeleteCustomRoutingEndpointGroupRequest.Builder> deleteCustomRoutingEndpointGroupRequest) Delete an endpoint group from a listener for a custom routing accelerator.
This is a convenience which creates an instance of the
DeleteCustomRoutingEndpointGroupRequest.Builder
avoiding the need to create one manually viaDeleteCustomRoutingEndpointGroupRequest.builder()
- Parameters:
deleteCustomRoutingEndpointGroupRequest
- AConsumer
that will call methods onDeleteCustomRoutingEndpointGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteCustomRoutingEndpointGroup 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.- InvalidArgumentException An argument that you specified is invalid.
- EndpointGroupNotFoundException The endpoint group that you specified doesn't exist.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteCustomRoutingListener
default CompletableFuture<DeleteCustomRoutingListenerResponse> deleteCustomRoutingListener(DeleteCustomRoutingListenerRequest deleteCustomRoutingListenerRequest) Delete a listener for a custom routing accelerator.
- Parameters:
deleteCustomRoutingListenerRequest
-- Returns:
- A Java Future containing the result of the DeleteCustomRoutingListener 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.- InvalidArgumentException An argument that you specified is invalid.
- ListenerNotFoundException The listener that you specified doesn't exist.
- AssociatedEndpointGroupFoundException The listener that you specified has an endpoint group associated with it. You must remove all dependent resources from a listener before you can delete it.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteCustomRoutingListener
default CompletableFuture<DeleteCustomRoutingListenerResponse> deleteCustomRoutingListener(Consumer<DeleteCustomRoutingListenerRequest.Builder> deleteCustomRoutingListenerRequest) Delete a listener for a custom routing accelerator.
This is a convenience which creates an instance of the
DeleteCustomRoutingListenerRequest.Builder
avoiding the need to create one manually viaDeleteCustomRoutingListenerRequest.builder()
- Parameters:
deleteCustomRoutingListenerRequest
- AConsumer
that will call methods onDeleteCustomRoutingListenerRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteCustomRoutingListener 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.- InvalidArgumentException An argument that you specified is invalid.
- ListenerNotFoundException The listener that you specified doesn't exist.
- AssociatedEndpointGroupFoundException The listener that you specified has an endpoint group associated with it. You must remove all dependent resources from a listener before you can delete it.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteEndpointGroup
default CompletableFuture<DeleteEndpointGroupResponse> deleteEndpointGroup(DeleteEndpointGroupRequest deleteEndpointGroupRequest) Delete an endpoint group from a listener.
- Parameters:
deleteEndpointGroupRequest
-- Returns:
- A Java Future containing the result of the DeleteEndpointGroup 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.- InvalidArgumentException An argument that you specified is invalid.
- EndpointGroupNotFoundException The endpoint group that you specified doesn't exist.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteEndpointGroup
default CompletableFuture<DeleteEndpointGroupResponse> deleteEndpointGroup(Consumer<DeleteEndpointGroupRequest.Builder> deleteEndpointGroupRequest) Delete an endpoint group from a listener.
This is a convenience which creates an instance of the
DeleteEndpointGroupRequest.Builder
avoiding the need to create one manually viaDeleteEndpointGroupRequest.builder()
- Parameters:
deleteEndpointGroupRequest
- AConsumer
that will call methods onDeleteEndpointGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteEndpointGroup 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.- InvalidArgumentException An argument that you specified is invalid.
- EndpointGroupNotFoundException The endpoint group that you specified doesn't exist.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteListener
default CompletableFuture<DeleteListenerResponse> deleteListener(DeleteListenerRequest deleteListenerRequest) Delete a listener from an accelerator.
- Parameters:
deleteListenerRequest
-- Returns:
- A Java Future containing the result of the DeleteListener 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.- InvalidArgumentException An argument that you specified is invalid.
- ListenerNotFoundException The listener that you specified doesn't exist.
- AssociatedEndpointGroupFoundException The listener that you specified has an endpoint group associated with it. You must remove all dependent resources from a listener before you can delete it.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteListener
default CompletableFuture<DeleteListenerResponse> deleteListener(Consumer<DeleteListenerRequest.Builder> deleteListenerRequest) Delete a listener from an accelerator.
This is a convenience which creates an instance of the
DeleteListenerRequest.Builder
avoiding the need to create one manually viaDeleteListenerRequest.builder()
- Parameters:
deleteListenerRequest
- AConsumer
that will call methods onDeleteListenerRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteListener 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.- InvalidArgumentException An argument that you specified is invalid.
- ListenerNotFoundException The listener that you specified doesn't exist.
- AssociatedEndpointGroupFoundException The listener that you specified has an endpoint group associated with it. You must remove all dependent resources from a listener before you can delete it.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
denyCustomRoutingTraffic
default CompletableFuture<DenyCustomRoutingTrafficResponse> denyCustomRoutingTraffic(DenyCustomRoutingTrafficRequest denyCustomRoutingTrafficRequest) Specify the Amazon EC2 instance (destination) IP addresses and ports for a VPC subnet endpoint that cannot receive traffic for a custom routing accelerator. You can deny traffic to all destinations in the VPC endpoint, or deny traffic to a specified list of destination IP addresses and ports. Note that you cannot specify IP addresses or ports outside of the range that you configured for the endpoint group.
After you make changes, you can verify that the updates are complete by checking the status of your accelerator: the status changes from IN_PROGRESS to DEPLOYED.
- Parameters:
denyCustomRoutingTrafficRequest
-- Returns:
- A Java Future containing the result of the DenyCustomRoutingTraffic 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.- EndpointGroupNotFoundException The endpoint group that you specified doesn't exist.
- InvalidArgumentException An argument that you specified is invalid.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
denyCustomRoutingTraffic
default CompletableFuture<DenyCustomRoutingTrafficResponse> denyCustomRoutingTraffic(Consumer<DenyCustomRoutingTrafficRequest.Builder> denyCustomRoutingTrafficRequest) Specify the Amazon EC2 instance (destination) IP addresses and ports for a VPC subnet endpoint that cannot receive traffic for a custom routing accelerator. You can deny traffic to all destinations in the VPC endpoint, or deny traffic to a specified list of destination IP addresses and ports. Note that you cannot specify IP addresses or ports outside of the range that you configured for the endpoint group.
After you make changes, you can verify that the updates are complete by checking the status of your accelerator: the status changes from IN_PROGRESS to DEPLOYED.
This is a convenience which creates an instance of the
DenyCustomRoutingTrafficRequest.Builder
avoiding the need to create one manually viaDenyCustomRoutingTrafficRequest.builder()
- Parameters:
denyCustomRoutingTrafficRequest
- AConsumer
that will call methods onDenyCustomRoutingTrafficRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DenyCustomRoutingTraffic 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.- EndpointGroupNotFoundException The endpoint group that you specified doesn't exist.
- InvalidArgumentException An argument that you specified is invalid.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deprovisionByoipCidr
default CompletableFuture<DeprovisionByoipCidrResponse> deprovisionByoipCidr(DeprovisionByoipCidrRequest deprovisionByoipCidrRequest) Releases the specified address range that you provisioned to use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and deletes the corresponding address pool.
Before you can release an address range, you must stop advertising it by using WithdrawByoipCidr and you must not have any accelerators that are using static IP addresses allocated from its address range.
For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
- Parameters:
deprovisionByoipCidrRequest
-- Returns:
- A Java Future containing the result of the DeprovisionByoipCidr 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.- InternalServiceErrorException There was an internal error for Global Accelerator.
- InvalidArgumentException An argument that you specified is invalid.
- AccessDeniedException You don't have access permission.
- ByoipCidrNotFoundException The CIDR that you specified was not found or is incorrect.
- IncorrectCidrStateException The CIDR that you specified is not valid for this action. For example, the state of the CIDR might be incorrect for this action.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deprovisionByoipCidr
default CompletableFuture<DeprovisionByoipCidrResponse> deprovisionByoipCidr(Consumer<DeprovisionByoipCidrRequest.Builder> deprovisionByoipCidrRequest) Releases the specified address range that you provisioned to use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and deletes the corresponding address pool.
Before you can release an address range, you must stop advertising it by using WithdrawByoipCidr and you must not have any accelerators that are using static IP addresses allocated from its address range.
For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
This is a convenience which creates an instance of the
DeprovisionByoipCidrRequest.Builder
avoiding the need to create one manually viaDeprovisionByoipCidrRequest.builder()
- Parameters:
deprovisionByoipCidrRequest
- AConsumer
that will call methods onDeprovisionByoipCidrRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeprovisionByoipCidr 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.- InternalServiceErrorException There was an internal error for Global Accelerator.
- InvalidArgumentException An argument that you specified is invalid.
- AccessDeniedException You don't have access permission.
- ByoipCidrNotFoundException The CIDR that you specified was not found or is incorrect.
- IncorrectCidrStateException The CIDR that you specified is not valid for this action. For example, the state of the CIDR might be incorrect for this action.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAccelerator
default CompletableFuture<DescribeAcceleratorResponse> describeAccelerator(DescribeAcceleratorRequest describeAcceleratorRequest) Describe an accelerator.
- Parameters:
describeAcceleratorRequest
-- Returns:
- A Java Future containing the result of the DescribeAccelerator 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.- AcceleratorNotFoundException The accelerator that you specified doesn't exist.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- InvalidArgumentException An argument that you specified is invalid.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAccelerator
default CompletableFuture<DescribeAcceleratorResponse> describeAccelerator(Consumer<DescribeAcceleratorRequest.Builder> describeAcceleratorRequest) Describe an accelerator.
This is a convenience which creates an instance of the
DescribeAcceleratorRequest.Builder
avoiding the need to create one manually viaDescribeAcceleratorRequest.builder()
- Parameters:
describeAcceleratorRequest
- AConsumer
that will call methods onDescribeAcceleratorRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeAccelerator 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.- AcceleratorNotFoundException The accelerator that you specified doesn't exist.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- InvalidArgumentException An argument that you specified is invalid.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAcceleratorAttributes
default CompletableFuture<DescribeAcceleratorAttributesResponse> describeAcceleratorAttributes(DescribeAcceleratorAttributesRequest describeAcceleratorAttributesRequest) Describe the attributes of an accelerator.
- Parameters:
describeAcceleratorAttributesRequest
-- Returns:
- A Java Future containing the result of the DescribeAcceleratorAttributes 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.- AcceleratorNotFoundException The accelerator that you specified doesn't exist.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- InvalidArgumentException An argument that you specified is invalid.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAcceleratorAttributes
default CompletableFuture<DescribeAcceleratorAttributesResponse> describeAcceleratorAttributes(Consumer<DescribeAcceleratorAttributesRequest.Builder> describeAcceleratorAttributesRequest) Describe the attributes of an accelerator.
This is a convenience which creates an instance of the
DescribeAcceleratorAttributesRequest.Builder
avoiding the need to create one manually viaDescribeAcceleratorAttributesRequest.builder()
- Parameters:
describeAcceleratorAttributesRequest
- AConsumer
that will call methods onDescribeAcceleratorAttributesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeAcceleratorAttributes 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.- AcceleratorNotFoundException The accelerator that you specified doesn't exist.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- InvalidArgumentException An argument that you specified is invalid.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeCrossAccountAttachment
default CompletableFuture<DescribeCrossAccountAttachmentResponse> describeCrossAccountAttachment(DescribeCrossAccountAttachmentRequest describeCrossAccountAttachmentRequest) Gets configuration information about a cross-account attachment.
- Parameters:
describeCrossAccountAttachmentRequest
-- Returns:
- A Java Future containing the result of the DescribeCrossAccountAttachment 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.- AttachmentNotFoundException No cross-account attachment was found.
- AccessDeniedException You don't have access permission.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- InvalidArgumentException An argument that you specified is invalid.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeCrossAccountAttachment
default CompletableFuture<DescribeCrossAccountAttachmentResponse> describeCrossAccountAttachment(Consumer<DescribeCrossAccountAttachmentRequest.Builder> describeCrossAccountAttachmentRequest) Gets configuration information about a cross-account attachment.
This is a convenience which creates an instance of the
DescribeCrossAccountAttachmentRequest.Builder
avoiding the need to create one manually viaDescribeCrossAccountAttachmentRequest.builder()
- Parameters:
describeCrossAccountAttachmentRequest
- AConsumer
that will call methods onDescribeCrossAccountAttachmentRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeCrossAccountAttachment 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.- AttachmentNotFoundException No cross-account attachment was found.
- AccessDeniedException You don't have access permission.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- InvalidArgumentException An argument that you specified is invalid.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeCustomRoutingAccelerator
default CompletableFuture<DescribeCustomRoutingAcceleratorResponse> describeCustomRoutingAccelerator(DescribeCustomRoutingAcceleratorRequest describeCustomRoutingAcceleratorRequest) Describe a custom routing accelerator.
- Parameters:
describeCustomRoutingAcceleratorRequest
-- Returns:
- A Java Future containing the result of the DescribeCustomRoutingAccelerator 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.- AcceleratorNotFoundException The accelerator that you specified doesn't exist.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- InvalidArgumentException An argument that you specified is invalid.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeCustomRoutingAccelerator
default CompletableFuture<DescribeCustomRoutingAcceleratorResponse> describeCustomRoutingAccelerator(Consumer<DescribeCustomRoutingAcceleratorRequest.Builder> describeCustomRoutingAcceleratorRequest) Describe a custom routing accelerator.
This is a convenience which creates an instance of the
DescribeCustomRoutingAcceleratorRequest.Builder
avoiding the need to create one manually viaDescribeCustomRoutingAcceleratorRequest.builder()
- Parameters:
describeCustomRoutingAcceleratorRequest
- AConsumer
that will call methods onDescribeCustomRoutingAcceleratorRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeCustomRoutingAccelerator 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.- AcceleratorNotFoundException The accelerator that you specified doesn't exist.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- InvalidArgumentException An argument that you specified is invalid.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeCustomRoutingAcceleratorAttributes
default CompletableFuture<DescribeCustomRoutingAcceleratorAttributesResponse> describeCustomRoutingAcceleratorAttributes(DescribeCustomRoutingAcceleratorAttributesRequest describeCustomRoutingAcceleratorAttributesRequest) Describe the attributes of a custom routing accelerator.
- Parameters:
describeCustomRoutingAcceleratorAttributesRequest
-- Returns:
- A Java Future containing the result of the DescribeCustomRoutingAcceleratorAttributes 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.- AcceleratorNotFoundException The accelerator that you specified doesn't exist.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- InvalidArgumentException An argument that you specified is invalid.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeCustomRoutingAcceleratorAttributes
default CompletableFuture<DescribeCustomRoutingAcceleratorAttributesResponse> describeCustomRoutingAcceleratorAttributes(Consumer<DescribeCustomRoutingAcceleratorAttributesRequest.Builder> describeCustomRoutingAcceleratorAttributesRequest) Describe the attributes of a custom routing accelerator.
This is a convenience which creates an instance of the
DescribeCustomRoutingAcceleratorAttributesRequest.Builder
avoiding the need to create one manually viaDescribeCustomRoutingAcceleratorAttributesRequest.builder()
- Parameters:
describeCustomRoutingAcceleratorAttributesRequest
- AConsumer
that will call methods onDescribeCustomRoutingAcceleratorAttributesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeCustomRoutingAcceleratorAttributes 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.- AcceleratorNotFoundException The accelerator that you specified doesn't exist.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- InvalidArgumentException An argument that you specified is invalid.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeCustomRoutingEndpointGroup
default CompletableFuture<DescribeCustomRoutingEndpointGroupResponse> describeCustomRoutingEndpointGroup(DescribeCustomRoutingEndpointGroupRequest describeCustomRoutingEndpointGroupRequest) Describe an endpoint group for a custom routing accelerator.
- Parameters:
describeCustomRoutingEndpointGroupRequest
-- Returns:
- A Java Future containing the result of the DescribeCustomRoutingEndpointGroup 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.- InvalidArgumentException An argument that you specified is invalid.
- EndpointGroupNotFoundException The endpoint group that you specified doesn't exist.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeCustomRoutingEndpointGroup
default CompletableFuture<DescribeCustomRoutingEndpointGroupResponse> describeCustomRoutingEndpointGroup(Consumer<DescribeCustomRoutingEndpointGroupRequest.Builder> describeCustomRoutingEndpointGroupRequest) Describe an endpoint group for a custom routing accelerator.
This is a convenience which creates an instance of the
DescribeCustomRoutingEndpointGroupRequest.Builder
avoiding the need to create one manually viaDescribeCustomRoutingEndpointGroupRequest.builder()
- Parameters:
describeCustomRoutingEndpointGroupRequest
- AConsumer
that will call methods onDescribeCustomRoutingEndpointGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeCustomRoutingEndpointGroup 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.- InvalidArgumentException An argument that you specified is invalid.
- EndpointGroupNotFoundException The endpoint group that you specified doesn't exist.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeCustomRoutingListener
default CompletableFuture<DescribeCustomRoutingListenerResponse> describeCustomRoutingListener(DescribeCustomRoutingListenerRequest describeCustomRoutingListenerRequest) The description of a listener for a custom routing accelerator.
- Parameters:
describeCustomRoutingListenerRequest
-- Returns:
- A Java Future containing the result of the DescribeCustomRoutingListener 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.- InvalidArgumentException An argument that you specified is invalid.
- ListenerNotFoundException The listener that you specified doesn't exist.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeCustomRoutingListener
default CompletableFuture<DescribeCustomRoutingListenerResponse> describeCustomRoutingListener(Consumer<DescribeCustomRoutingListenerRequest.Builder> describeCustomRoutingListenerRequest) The description of a listener for a custom routing accelerator.
This is a convenience which creates an instance of the
DescribeCustomRoutingListenerRequest.Builder
avoiding the need to create one manually viaDescribeCustomRoutingListenerRequest.builder()
- Parameters:
describeCustomRoutingListenerRequest
- AConsumer
that will call methods onDescribeCustomRoutingListenerRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeCustomRoutingListener 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.- InvalidArgumentException An argument that you specified is invalid.
- ListenerNotFoundException The listener that you specified doesn't exist.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeEndpointGroup
default CompletableFuture<DescribeEndpointGroupResponse> describeEndpointGroup(DescribeEndpointGroupRequest describeEndpointGroupRequest) Describe an endpoint group.
- Parameters:
describeEndpointGroupRequest
-- Returns:
- A Java Future containing the result of the DescribeEndpointGroup 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.- InvalidArgumentException An argument that you specified is invalid.
- EndpointGroupNotFoundException The endpoint group that you specified doesn't exist.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeEndpointGroup
default CompletableFuture<DescribeEndpointGroupResponse> describeEndpointGroup(Consumer<DescribeEndpointGroupRequest.Builder> describeEndpointGroupRequest) Describe an endpoint group.
This is a convenience which creates an instance of the
DescribeEndpointGroupRequest.Builder
avoiding the need to create one manually viaDescribeEndpointGroupRequest.builder()
- Parameters:
describeEndpointGroupRequest
- AConsumer
that will call methods onDescribeEndpointGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeEndpointGroup 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.- InvalidArgumentException An argument that you specified is invalid.
- EndpointGroupNotFoundException The endpoint group that you specified doesn't exist.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeListener
default CompletableFuture<DescribeListenerResponse> describeListener(DescribeListenerRequest describeListenerRequest) Describe a listener.
- Parameters:
describeListenerRequest
-- Returns:
- A Java Future containing the result of the DescribeListener 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.- InvalidArgumentException An argument that you specified is invalid.
- ListenerNotFoundException The listener that you specified doesn't exist.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeListener
default CompletableFuture<DescribeListenerResponse> describeListener(Consumer<DescribeListenerRequest.Builder> describeListenerRequest) Describe a listener.
This is a convenience which creates an instance of the
DescribeListenerRequest.Builder
avoiding the need to create one manually viaDescribeListenerRequest.builder()
- Parameters:
describeListenerRequest
- AConsumer
that will call methods onDescribeListenerRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeListener 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.- InvalidArgumentException An argument that you specified is invalid.
- ListenerNotFoundException The listener that you specified doesn't exist.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAccelerators
default CompletableFuture<ListAcceleratorsResponse> listAccelerators(ListAcceleratorsRequest listAcceleratorsRequest) List the accelerators for an Amazon Web Services account.
- Parameters:
listAcceleratorsRequest
-- Returns:
- A Java Future containing the result of the ListAccelerators 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.- InvalidArgumentException An argument that you specified is invalid.
- InvalidNextTokenException There isn't another item to return.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAccelerators
default CompletableFuture<ListAcceleratorsResponse> listAccelerators(Consumer<ListAcceleratorsRequest.Builder> listAcceleratorsRequest) List the accelerators for an Amazon Web Services account.
This is a convenience which creates an instance of the
ListAcceleratorsRequest.Builder
avoiding the need to create one manually viaListAcceleratorsRequest.builder()
- Parameters:
listAcceleratorsRequest
- AConsumer
that will call methods onListAcceleratorsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListAccelerators 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.- InvalidArgumentException An argument that you specified is invalid.
- InvalidNextTokenException There isn't another item to return.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAccelerators
List the accelerators for an Amazon Web Services account.
- Returns:
- A Java Future containing the result of the ListAccelerators 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.- InvalidArgumentException An argument that you specified is invalid.
- InvalidNextTokenException There isn't another item to return.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAcceleratorsPaginator
This is a variant of
listAccelerators(software.amazon.awssdk.services.globalaccelerator.model.ListAcceleratorsRequest)
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.globalaccelerator.paginators.ListAcceleratorsPublisher publisher = client.listAcceleratorsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.globalaccelerator.paginators.ListAcceleratorsPublisher publisher = client.listAcceleratorsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.globalaccelerator.model.ListAcceleratorsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.globalaccelerator.model.ListAcceleratorsResponse 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
listAccelerators(software.amazon.awssdk.services.globalaccelerator.model.ListAcceleratorsRequest)
operation.- 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.- InvalidArgumentException An argument that you specified is invalid.
- InvalidNextTokenException There isn't another item to return.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAcceleratorsPaginator
default ListAcceleratorsPublisher listAcceleratorsPaginator(ListAcceleratorsRequest listAcceleratorsRequest) This is a variant of
listAccelerators(software.amazon.awssdk.services.globalaccelerator.model.ListAcceleratorsRequest)
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.globalaccelerator.paginators.ListAcceleratorsPublisher publisher = client.listAcceleratorsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.globalaccelerator.paginators.ListAcceleratorsPublisher publisher = client.listAcceleratorsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.globalaccelerator.model.ListAcceleratorsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.globalaccelerator.model.ListAcceleratorsResponse 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
listAccelerators(software.amazon.awssdk.services.globalaccelerator.model.ListAcceleratorsRequest)
operation.- Parameters:
listAcceleratorsRequest
-- 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.- InvalidArgumentException An argument that you specified is invalid.
- InvalidNextTokenException There isn't another item to return.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAcceleratorsPaginator
default ListAcceleratorsPublisher listAcceleratorsPaginator(Consumer<ListAcceleratorsRequest.Builder> listAcceleratorsRequest) This is a variant of
listAccelerators(software.amazon.awssdk.services.globalaccelerator.model.ListAcceleratorsRequest)
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.globalaccelerator.paginators.ListAcceleratorsPublisher publisher = client.listAcceleratorsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.globalaccelerator.paginators.ListAcceleratorsPublisher publisher = client.listAcceleratorsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.globalaccelerator.model.ListAcceleratorsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.globalaccelerator.model.ListAcceleratorsResponse 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
listAccelerators(software.amazon.awssdk.services.globalaccelerator.model.ListAcceleratorsRequest)
operation.
This is a convenience which creates an instance of the
ListAcceleratorsRequest.Builder
avoiding the need to create one manually viaListAcceleratorsRequest.builder()
- Parameters:
listAcceleratorsRequest
- AConsumer
that will call methods onListAcceleratorsRequest.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.- InvalidArgumentException An argument that you specified is invalid.
- InvalidNextTokenException There isn't another item to return.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listByoipCidrs
default CompletableFuture<ListByoipCidrsResponse> listByoipCidrs(ListByoipCidrsRequest listByoipCidrsRequest) Lists the IP address ranges that were specified in calls to ProvisionByoipCidr, including the current state and a history of state changes.
- Parameters:
listByoipCidrsRequest
-- Returns:
- A Java Future containing the result of the ListByoipCidrs 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.- InternalServiceErrorException There was an internal error for Global Accelerator.
- InvalidArgumentException An argument that you specified is invalid.
- AccessDeniedException You don't have access permission.
- InvalidNextTokenException There isn't another item to return.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listByoipCidrs
default CompletableFuture<ListByoipCidrsResponse> listByoipCidrs(Consumer<ListByoipCidrsRequest.Builder> listByoipCidrsRequest) Lists the IP address ranges that were specified in calls to ProvisionByoipCidr, including the current state and a history of state changes.
This is a convenience which creates an instance of the
ListByoipCidrsRequest.Builder
avoiding the need to create one manually viaListByoipCidrsRequest.builder()
- Parameters:
listByoipCidrsRequest
- AConsumer
that will call methods onListByoipCidrsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListByoipCidrs 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.- InternalServiceErrorException There was an internal error for Global Accelerator.
- InvalidArgumentException An argument that you specified is invalid.
- AccessDeniedException You don't have access permission.
- InvalidNextTokenException There isn't another item to return.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listByoipCidrsPaginator
default ListByoipCidrsPublisher listByoipCidrsPaginator(ListByoipCidrsRequest listByoipCidrsRequest) This is a variant of
listByoipCidrs(software.amazon.awssdk.services.globalaccelerator.model.ListByoipCidrsRequest)
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.globalaccelerator.paginators.ListByoipCidrsPublisher publisher = client.listByoipCidrsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.globalaccelerator.paginators.ListByoipCidrsPublisher publisher = client.listByoipCidrsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.globalaccelerator.model.ListByoipCidrsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.globalaccelerator.model.ListByoipCidrsResponse 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
listByoipCidrs(software.amazon.awssdk.services.globalaccelerator.model.ListByoipCidrsRequest)
operation.- Parameters:
listByoipCidrsRequest
-- 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.- InternalServiceErrorException There was an internal error for Global Accelerator.
- InvalidArgumentException An argument that you specified is invalid.
- AccessDeniedException You don't have access permission.
- InvalidNextTokenException There isn't another item to return.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listByoipCidrsPaginator
default ListByoipCidrsPublisher listByoipCidrsPaginator(Consumer<ListByoipCidrsRequest.Builder> listByoipCidrsRequest) This is a variant of
listByoipCidrs(software.amazon.awssdk.services.globalaccelerator.model.ListByoipCidrsRequest)
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.globalaccelerator.paginators.ListByoipCidrsPublisher publisher = client.listByoipCidrsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.globalaccelerator.paginators.ListByoipCidrsPublisher publisher = client.listByoipCidrsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.globalaccelerator.model.ListByoipCidrsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.globalaccelerator.model.ListByoipCidrsResponse 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
listByoipCidrs(software.amazon.awssdk.services.globalaccelerator.model.ListByoipCidrsRequest)
operation.
This is a convenience which creates an instance of the
ListByoipCidrsRequest.Builder
avoiding the need to create one manually viaListByoipCidrsRequest.builder()
- Parameters:
listByoipCidrsRequest
- AConsumer
that will call methods onListByoipCidrsRequest.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.- InternalServiceErrorException There was an internal error for Global Accelerator.
- InvalidArgumentException An argument that you specified is invalid.
- AccessDeniedException You don't have access permission.
- InvalidNextTokenException There isn't another item to return.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCrossAccountAttachments
default CompletableFuture<ListCrossAccountAttachmentsResponse> listCrossAccountAttachments(ListCrossAccountAttachmentsRequest listCrossAccountAttachmentsRequest) List the cross-account attachments that have been created in Global Accelerator.
- Parameters:
listCrossAccountAttachmentsRequest
-- Returns:
- A Java Future containing the result of the ListCrossAccountAttachments 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 don't have access permission.
- InvalidArgumentException An argument that you specified is invalid.
- InvalidNextTokenException There isn't another item to return.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCrossAccountAttachments
default CompletableFuture<ListCrossAccountAttachmentsResponse> listCrossAccountAttachments(Consumer<ListCrossAccountAttachmentsRequest.Builder> listCrossAccountAttachmentsRequest) List the cross-account attachments that have been created in Global Accelerator.
This is a convenience which creates an instance of the
ListCrossAccountAttachmentsRequest.Builder
avoiding the need to create one manually viaListCrossAccountAttachmentsRequest.builder()
- Parameters:
listCrossAccountAttachmentsRequest
- AConsumer
that will call methods onListCrossAccountAttachmentsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListCrossAccountAttachments 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 don't have access permission.
- InvalidArgumentException An argument that you specified is invalid.
- InvalidNextTokenException There isn't another item to return.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCrossAccountAttachmentsPaginator
default ListCrossAccountAttachmentsPublisher listCrossAccountAttachmentsPaginator(ListCrossAccountAttachmentsRequest listCrossAccountAttachmentsRequest) This is a variant of
listCrossAccountAttachments(software.amazon.awssdk.services.globalaccelerator.model.ListCrossAccountAttachmentsRequest)
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.globalaccelerator.paginators.ListCrossAccountAttachmentsPublisher publisher = client.listCrossAccountAttachmentsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.globalaccelerator.paginators.ListCrossAccountAttachmentsPublisher publisher = client.listCrossAccountAttachmentsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.globalaccelerator.model.ListCrossAccountAttachmentsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.globalaccelerator.model.ListCrossAccountAttachmentsResponse 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
listCrossAccountAttachments(software.amazon.awssdk.services.globalaccelerator.model.ListCrossAccountAttachmentsRequest)
operation.- Parameters:
listCrossAccountAttachmentsRequest
-- 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.- AccessDeniedException You don't have access permission.
- InvalidArgumentException An argument that you specified is invalid.
- InvalidNextTokenException There isn't another item to return.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCrossAccountAttachmentsPaginator
default ListCrossAccountAttachmentsPublisher listCrossAccountAttachmentsPaginator(Consumer<ListCrossAccountAttachmentsRequest.Builder> listCrossAccountAttachmentsRequest) This is a variant of
listCrossAccountAttachments(software.amazon.awssdk.services.globalaccelerator.model.ListCrossAccountAttachmentsRequest)
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.globalaccelerator.paginators.ListCrossAccountAttachmentsPublisher publisher = client.listCrossAccountAttachmentsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.globalaccelerator.paginators.ListCrossAccountAttachmentsPublisher publisher = client.listCrossAccountAttachmentsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.globalaccelerator.model.ListCrossAccountAttachmentsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.globalaccelerator.model.ListCrossAccountAttachmentsResponse 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
listCrossAccountAttachments(software.amazon.awssdk.services.globalaccelerator.model.ListCrossAccountAttachmentsRequest)
operation.
This is a convenience which creates an instance of the
ListCrossAccountAttachmentsRequest.Builder
avoiding the need to create one manually viaListCrossAccountAttachmentsRequest.builder()
- Parameters:
listCrossAccountAttachmentsRequest
- AConsumer
that will call methods onListCrossAccountAttachmentsRequest.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.- AccessDeniedException You don't have access permission.
- InvalidArgumentException An argument that you specified is invalid.
- InvalidNextTokenException There isn't another item to return.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCrossAccountResourceAccounts
default CompletableFuture<ListCrossAccountResourceAccountsResponse> listCrossAccountResourceAccounts(ListCrossAccountResourceAccountsRequest listCrossAccountResourceAccountsRequest) List the accounts that have cross-account resources.
For more information, see Working with cross-account attachments and resources in Global Accelerator in the Global Accelerator Developer Guide.
- Parameters:
listCrossAccountResourceAccountsRequest
-- Returns:
- A Java Future containing the result of the ListCrossAccountResourceAccounts 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 don't have access permission.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCrossAccountResourceAccounts
default CompletableFuture<ListCrossAccountResourceAccountsResponse> listCrossAccountResourceAccounts(Consumer<ListCrossAccountResourceAccountsRequest.Builder> listCrossAccountResourceAccountsRequest) List the accounts that have cross-account resources.
For more information, see Working with cross-account attachments and resources in Global Accelerator in the Global Accelerator Developer Guide.
This is a convenience which creates an instance of the
ListCrossAccountResourceAccountsRequest.Builder
avoiding the need to create one manually viaListCrossAccountResourceAccountsRequest.builder()
- Parameters:
listCrossAccountResourceAccountsRequest
- AConsumer
that will call methods onListCrossAccountResourceAccountsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListCrossAccountResourceAccounts 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 don't have access permission.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCrossAccountResources
default CompletableFuture<ListCrossAccountResourcesResponse> listCrossAccountResources(ListCrossAccountResourcesRequest listCrossAccountResourcesRequest) List the cross-account resources available to work with.
- Parameters:
listCrossAccountResourcesRequest
-- Returns:
- A Java Future containing the result of the ListCrossAccountResources 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.- InternalServiceErrorException There was an internal error for Global Accelerator.
- InvalidArgumentException An argument that you specified is invalid.
- InvalidNextTokenException There isn't another item to return.
- AccessDeniedException You don't have access permission.
- AcceleratorNotFoundException The accelerator that you specified doesn't exist.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCrossAccountResources
default CompletableFuture<ListCrossAccountResourcesResponse> listCrossAccountResources(Consumer<ListCrossAccountResourcesRequest.Builder> listCrossAccountResourcesRequest) List the cross-account resources available to work with.
This is a convenience which creates an instance of the
ListCrossAccountResourcesRequest.Builder
avoiding the need to create one manually viaListCrossAccountResourcesRequest.builder()
- Parameters:
listCrossAccountResourcesRequest
- AConsumer
that will call methods onListCrossAccountResourcesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListCrossAccountResources 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.- InternalServiceErrorException There was an internal error for Global Accelerator.
- InvalidArgumentException An argument that you specified is invalid.
- InvalidNextTokenException There isn't another item to return.
- AccessDeniedException You don't have access permission.
- AcceleratorNotFoundException The accelerator that you specified doesn't exist.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCrossAccountResourcesPaginator
default ListCrossAccountResourcesPublisher listCrossAccountResourcesPaginator(ListCrossAccountResourcesRequest listCrossAccountResourcesRequest) This is a variant of
listCrossAccountResources(software.amazon.awssdk.services.globalaccelerator.model.ListCrossAccountResourcesRequest)
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.globalaccelerator.paginators.ListCrossAccountResourcesPublisher publisher = client.listCrossAccountResourcesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.globalaccelerator.paginators.ListCrossAccountResourcesPublisher publisher = client.listCrossAccountResourcesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.globalaccelerator.model.ListCrossAccountResourcesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.globalaccelerator.model.ListCrossAccountResourcesResponse 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
listCrossAccountResources(software.amazon.awssdk.services.globalaccelerator.model.ListCrossAccountResourcesRequest)
operation.- Parameters:
listCrossAccountResourcesRequest
-- 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.- InternalServiceErrorException There was an internal error for Global Accelerator.
- InvalidArgumentException An argument that you specified is invalid.
- InvalidNextTokenException There isn't another item to return.
- AccessDeniedException You don't have access permission.
- AcceleratorNotFoundException The accelerator that you specified doesn't exist.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCrossAccountResourcesPaginator
default ListCrossAccountResourcesPublisher listCrossAccountResourcesPaginator(Consumer<ListCrossAccountResourcesRequest.Builder> listCrossAccountResourcesRequest) This is a variant of
listCrossAccountResources(software.amazon.awssdk.services.globalaccelerator.model.ListCrossAccountResourcesRequest)
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.globalaccelerator.paginators.ListCrossAccountResourcesPublisher publisher = client.listCrossAccountResourcesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.globalaccelerator.paginators.ListCrossAccountResourcesPublisher publisher = client.listCrossAccountResourcesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.globalaccelerator.model.ListCrossAccountResourcesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.globalaccelerator.model.ListCrossAccountResourcesResponse 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
listCrossAccountResources(software.amazon.awssdk.services.globalaccelerator.model.ListCrossAccountResourcesRequest)
operation.
This is a convenience which creates an instance of the
ListCrossAccountResourcesRequest.Builder
avoiding the need to create one manually viaListCrossAccountResourcesRequest.builder()
- Parameters:
listCrossAccountResourcesRequest
- AConsumer
that will call methods onListCrossAccountResourcesRequest.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.- InternalServiceErrorException There was an internal error for Global Accelerator.
- InvalidArgumentException An argument that you specified is invalid.
- InvalidNextTokenException There isn't another item to return.
- AccessDeniedException You don't have access permission.
- AcceleratorNotFoundException The accelerator that you specified doesn't exist.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCustomRoutingAccelerators
default CompletableFuture<ListCustomRoutingAcceleratorsResponse> listCustomRoutingAccelerators(ListCustomRoutingAcceleratorsRequest listCustomRoutingAcceleratorsRequest) List the custom routing accelerators for an Amazon Web Services account.
- Parameters:
listCustomRoutingAcceleratorsRequest
-- Returns:
- A Java Future containing the result of the ListCustomRoutingAccelerators 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.- InvalidArgumentException An argument that you specified is invalid.
- InvalidNextTokenException There isn't another item to return.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCustomRoutingAccelerators
default CompletableFuture<ListCustomRoutingAcceleratorsResponse> listCustomRoutingAccelerators(Consumer<ListCustomRoutingAcceleratorsRequest.Builder> listCustomRoutingAcceleratorsRequest) List the custom routing accelerators for an Amazon Web Services account.
This is a convenience which creates an instance of the
ListCustomRoutingAcceleratorsRequest.Builder
avoiding the need to create one manually viaListCustomRoutingAcceleratorsRequest.builder()
- Parameters:
listCustomRoutingAcceleratorsRequest
- AConsumer
that will call methods onListCustomRoutingAcceleratorsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListCustomRoutingAccelerators 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.- InvalidArgumentException An argument that you specified is invalid.
- InvalidNextTokenException There isn't another item to return.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCustomRoutingAcceleratorsPaginator
default ListCustomRoutingAcceleratorsPublisher listCustomRoutingAcceleratorsPaginator(ListCustomRoutingAcceleratorsRequest listCustomRoutingAcceleratorsRequest) This is a variant of
listCustomRoutingAccelerators(software.amazon.awssdk.services.globalaccelerator.model.ListCustomRoutingAcceleratorsRequest)
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.globalaccelerator.paginators.ListCustomRoutingAcceleratorsPublisher publisher = client.listCustomRoutingAcceleratorsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.globalaccelerator.paginators.ListCustomRoutingAcceleratorsPublisher publisher = client.listCustomRoutingAcceleratorsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.globalaccelerator.model.ListCustomRoutingAcceleratorsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.globalaccelerator.model.ListCustomRoutingAcceleratorsResponse 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
listCustomRoutingAccelerators(software.amazon.awssdk.services.globalaccelerator.model.ListCustomRoutingAcceleratorsRequest)
operation.- Parameters:
listCustomRoutingAcceleratorsRequest
-- 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.- InvalidArgumentException An argument that you specified is invalid.
- InvalidNextTokenException There isn't another item to return.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCustomRoutingAcceleratorsPaginator
default ListCustomRoutingAcceleratorsPublisher listCustomRoutingAcceleratorsPaginator(Consumer<ListCustomRoutingAcceleratorsRequest.Builder> listCustomRoutingAcceleratorsRequest) This is a variant of
listCustomRoutingAccelerators(software.amazon.awssdk.services.globalaccelerator.model.ListCustomRoutingAcceleratorsRequest)
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.globalaccelerator.paginators.ListCustomRoutingAcceleratorsPublisher publisher = client.listCustomRoutingAcceleratorsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.globalaccelerator.paginators.ListCustomRoutingAcceleratorsPublisher publisher = client.listCustomRoutingAcceleratorsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.globalaccelerator.model.ListCustomRoutingAcceleratorsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.globalaccelerator.model.ListCustomRoutingAcceleratorsResponse 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
listCustomRoutingAccelerators(software.amazon.awssdk.services.globalaccelerator.model.ListCustomRoutingAcceleratorsRequest)
operation.
This is a convenience which creates an instance of the
ListCustomRoutingAcceleratorsRequest.Builder
avoiding the need to create one manually viaListCustomRoutingAcceleratorsRequest.builder()
- Parameters:
listCustomRoutingAcceleratorsRequest
- AConsumer
that will call methods onListCustomRoutingAcceleratorsRequest.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.- InvalidArgumentException An argument that you specified is invalid.
- InvalidNextTokenException There isn't another item to return.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCustomRoutingEndpointGroups
default CompletableFuture<ListCustomRoutingEndpointGroupsResponse> listCustomRoutingEndpointGroups(ListCustomRoutingEndpointGroupsRequest listCustomRoutingEndpointGroupsRequest) List the endpoint groups that are associated with a listener for a custom routing accelerator.
- Parameters:
listCustomRoutingEndpointGroupsRequest
-- Returns:
- A Java Future containing the result of the ListCustomRoutingEndpointGroups 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.- ListenerNotFoundException The listener that you specified doesn't exist.
- InvalidNextTokenException There isn't another item to return.
- InvalidArgumentException An argument that you specified is invalid.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCustomRoutingEndpointGroups
default CompletableFuture<ListCustomRoutingEndpointGroupsResponse> listCustomRoutingEndpointGroups(Consumer<ListCustomRoutingEndpointGroupsRequest.Builder> listCustomRoutingEndpointGroupsRequest) List the endpoint groups that are associated with a listener for a custom routing accelerator.
This is a convenience which creates an instance of the
ListCustomRoutingEndpointGroupsRequest.Builder
avoiding the need to create one manually viaListCustomRoutingEndpointGroupsRequest.builder()
- Parameters:
listCustomRoutingEndpointGroupsRequest
- AConsumer
that will call methods onListCustomRoutingEndpointGroupsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListCustomRoutingEndpointGroups 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.- ListenerNotFoundException The listener that you specified doesn't exist.
- InvalidNextTokenException There isn't another item to return.
- InvalidArgumentException An argument that you specified is invalid.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCustomRoutingEndpointGroupsPaginator
default ListCustomRoutingEndpointGroupsPublisher listCustomRoutingEndpointGroupsPaginator(ListCustomRoutingEndpointGroupsRequest listCustomRoutingEndpointGroupsRequest) This is a variant of
listCustomRoutingEndpointGroups(software.amazon.awssdk.services.globalaccelerator.model.ListCustomRoutingEndpointGroupsRequest)
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.globalaccelerator.paginators.ListCustomRoutingEndpointGroupsPublisher publisher = client.listCustomRoutingEndpointGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.globalaccelerator.paginators.ListCustomRoutingEndpointGroupsPublisher publisher = client.listCustomRoutingEndpointGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.globalaccelerator.model.ListCustomRoutingEndpointGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.globalaccelerator.model.ListCustomRoutingEndpointGroupsResponse 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
listCustomRoutingEndpointGroups(software.amazon.awssdk.services.globalaccelerator.model.ListCustomRoutingEndpointGroupsRequest)
operation.- Parameters:
listCustomRoutingEndpointGroupsRequest
-- 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.- ListenerNotFoundException The listener that you specified doesn't exist.
- InvalidNextTokenException There isn't another item to return.
- InvalidArgumentException An argument that you specified is invalid.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCustomRoutingEndpointGroupsPaginator
default ListCustomRoutingEndpointGroupsPublisher listCustomRoutingEndpointGroupsPaginator(Consumer<ListCustomRoutingEndpointGroupsRequest.Builder> listCustomRoutingEndpointGroupsRequest) This is a variant of
listCustomRoutingEndpointGroups(software.amazon.awssdk.services.globalaccelerator.model.ListCustomRoutingEndpointGroupsRequest)
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.globalaccelerator.paginators.ListCustomRoutingEndpointGroupsPublisher publisher = client.listCustomRoutingEndpointGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.globalaccelerator.paginators.ListCustomRoutingEndpointGroupsPublisher publisher = client.listCustomRoutingEndpointGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.globalaccelerator.model.ListCustomRoutingEndpointGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.globalaccelerator.model.ListCustomRoutingEndpointGroupsResponse 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
listCustomRoutingEndpointGroups(software.amazon.awssdk.services.globalaccelerator.model.ListCustomRoutingEndpointGroupsRequest)
operation.
This is a convenience which creates an instance of the
ListCustomRoutingEndpointGroupsRequest.Builder
avoiding the need to create one manually viaListCustomRoutingEndpointGroupsRequest.builder()
- Parameters:
listCustomRoutingEndpointGroupsRequest
- AConsumer
that will call methods onListCustomRoutingEndpointGroupsRequest.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.- ListenerNotFoundException The listener that you specified doesn't exist.
- InvalidNextTokenException There isn't another item to return.
- InvalidArgumentException An argument that you specified is invalid.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCustomRoutingListeners
default CompletableFuture<ListCustomRoutingListenersResponse> listCustomRoutingListeners(ListCustomRoutingListenersRequest listCustomRoutingListenersRequest) List the listeners for a custom routing accelerator.
- Parameters:
listCustomRoutingListenersRequest
-- Returns:
- A Java Future containing the result of the ListCustomRoutingListeners 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.- InvalidArgumentException An argument that you specified is invalid.
- AcceleratorNotFoundException The accelerator that you specified doesn't exist.
- InvalidNextTokenException There isn't another item to return.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCustomRoutingListeners
default CompletableFuture<ListCustomRoutingListenersResponse> listCustomRoutingListeners(Consumer<ListCustomRoutingListenersRequest.Builder> listCustomRoutingListenersRequest) List the listeners for a custom routing accelerator.
This is a convenience which creates an instance of the
ListCustomRoutingListenersRequest.Builder
avoiding the need to create one manually viaListCustomRoutingListenersRequest.builder()
- Parameters:
listCustomRoutingListenersRequest
- AConsumer
that will call methods onListCustomRoutingListenersRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListCustomRoutingListeners 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.- InvalidArgumentException An argument that you specified is invalid.
- AcceleratorNotFoundException The accelerator that you specified doesn't exist.
- InvalidNextTokenException There isn't another item to return.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCustomRoutingListenersPaginator
default ListCustomRoutingListenersPublisher listCustomRoutingListenersPaginator(ListCustomRoutingListenersRequest listCustomRoutingListenersRequest) This is a variant of
listCustomRoutingListeners(software.amazon.awssdk.services.globalaccelerator.model.ListCustomRoutingListenersRequest)
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.globalaccelerator.paginators.ListCustomRoutingListenersPublisher publisher = client.listCustomRoutingListenersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.globalaccelerator.paginators.ListCustomRoutingListenersPublisher publisher = client.listCustomRoutingListenersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.globalaccelerator.model.ListCustomRoutingListenersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.globalaccelerator.model.ListCustomRoutingListenersResponse 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
listCustomRoutingListeners(software.amazon.awssdk.services.globalaccelerator.model.ListCustomRoutingListenersRequest)
operation.- Parameters:
listCustomRoutingListenersRequest
-- 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.- InvalidArgumentException An argument that you specified is invalid.
- AcceleratorNotFoundException The accelerator that you specified doesn't exist.
- InvalidNextTokenException There isn't another item to return.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCustomRoutingListenersPaginator
default ListCustomRoutingListenersPublisher listCustomRoutingListenersPaginator(Consumer<ListCustomRoutingListenersRequest.Builder> listCustomRoutingListenersRequest) This is a variant of
listCustomRoutingListeners(software.amazon.awssdk.services.globalaccelerator.model.ListCustomRoutingListenersRequest)
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.globalaccelerator.paginators.ListCustomRoutingListenersPublisher publisher = client.listCustomRoutingListenersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.globalaccelerator.paginators.ListCustomRoutingListenersPublisher publisher = client.listCustomRoutingListenersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.globalaccelerator.model.ListCustomRoutingListenersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.globalaccelerator.model.ListCustomRoutingListenersResponse 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
listCustomRoutingListeners(software.amazon.awssdk.services.globalaccelerator.model.ListCustomRoutingListenersRequest)
operation.
This is a convenience which creates an instance of the
ListCustomRoutingListenersRequest.Builder
avoiding the need to create one manually viaListCustomRoutingListenersRequest.builder()
- Parameters:
listCustomRoutingListenersRequest
- AConsumer
that will call methods onListCustomRoutingListenersRequest.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.- InvalidArgumentException An argument that you specified is invalid.
- AcceleratorNotFoundException The accelerator that you specified doesn't exist.
- InvalidNextTokenException There isn't another item to return.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCustomRoutingPortMappings
default CompletableFuture<ListCustomRoutingPortMappingsResponse> listCustomRoutingPortMappings(ListCustomRoutingPortMappingsRequest listCustomRoutingPortMappingsRequest) Provides a complete mapping from the public accelerator IP address and port to destination EC2 instance IP addresses and ports in the virtual public cloud (VPC) subnet endpoint for a custom routing accelerator. For each subnet endpoint that you add, Global Accelerator creates a new static port mapping for the accelerator. The port mappings don't change after Global Accelerator generates them, so you can retrieve and cache the full mapping on your servers.
If you remove a subnet from your accelerator, Global Accelerator removes (reclaims) the port mappings. If you add a subnet to your accelerator, Global Accelerator creates new port mappings (the existing ones don't change). If you add or remove EC2 instances in your subnet, the port mappings don't change, because the mappings are created when you add the subnet to Global Accelerator.
The mappings also include a flag for each destination denoting which destination IP addresses and ports are allowed or denied traffic.
- Parameters:
listCustomRoutingPortMappingsRequest
-- Returns:
- A Java Future containing the result of the ListCustomRoutingPortMappings 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.- InvalidArgumentException An argument that you specified is invalid.
- InvalidNextTokenException There isn't another item to return.
- EndpointGroupNotFoundException The endpoint group that you specified doesn't exist.
- AcceleratorNotFoundException The accelerator that you specified doesn't exist.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCustomRoutingPortMappings
default CompletableFuture<ListCustomRoutingPortMappingsResponse> listCustomRoutingPortMappings(Consumer<ListCustomRoutingPortMappingsRequest.Builder> listCustomRoutingPortMappingsRequest) Provides a complete mapping from the public accelerator IP address and port to destination EC2 instance IP addresses and ports in the virtual public cloud (VPC) subnet endpoint for a custom routing accelerator. For each subnet endpoint that you add, Global Accelerator creates a new static port mapping for the accelerator. The port mappings don't change after Global Accelerator generates them, so you can retrieve and cache the full mapping on your servers.
If you remove a subnet from your accelerator, Global Accelerator removes (reclaims) the port mappings. If you add a subnet to your accelerator, Global Accelerator creates new port mappings (the existing ones don't change). If you add or remove EC2 instances in your subnet, the port mappings don't change, because the mappings are created when you add the subnet to Global Accelerator.
The mappings also include a flag for each destination denoting which destination IP addresses and ports are allowed or denied traffic.
This is a convenience which creates an instance of the
ListCustomRoutingPortMappingsRequest.Builder
avoiding the need to create one manually viaListCustomRoutingPortMappingsRequest.builder()
- Parameters:
listCustomRoutingPortMappingsRequest
- AConsumer
that will call methods onListCustomRoutingPortMappingsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListCustomRoutingPortMappings 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.- InvalidArgumentException An argument that you specified is invalid.
- InvalidNextTokenException There isn't another item to return.
- EndpointGroupNotFoundException The endpoint group that you specified doesn't exist.
- AcceleratorNotFoundException The accelerator that you specified doesn't exist.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCustomRoutingPortMappingsByDestination
default CompletableFuture<ListCustomRoutingPortMappingsByDestinationResponse> listCustomRoutingPortMappingsByDestination(ListCustomRoutingPortMappingsByDestinationRequest listCustomRoutingPortMappingsByDestinationRequest) List the port mappings for a specific EC2 instance (destination) in a VPC subnet endpoint. The response is the mappings for one destination IP address. This is useful when your subnet endpoint has mappings that span multiple custom routing accelerators in your account, or for scenarios where you only want to list the port mappings for a specific destination instance.
- Parameters:
listCustomRoutingPortMappingsByDestinationRequest
-- Returns:
- A Java Future containing the result of the ListCustomRoutingPortMappingsByDestination 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.- InvalidArgumentException An argument that you specified is invalid.
- InvalidNextTokenException There isn't another item to return.
- EndpointNotFoundException The endpoint that you specified doesn't exist.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCustomRoutingPortMappingsByDestination
default CompletableFuture<ListCustomRoutingPortMappingsByDestinationResponse> listCustomRoutingPortMappingsByDestination(Consumer<ListCustomRoutingPortMappingsByDestinationRequest.Builder> listCustomRoutingPortMappingsByDestinationRequest) List the port mappings for a specific EC2 instance (destination) in a VPC subnet endpoint. The response is the mappings for one destination IP address. This is useful when your subnet endpoint has mappings that span multiple custom routing accelerators in your account, or for scenarios where you only want to list the port mappings for a specific destination instance.
This is a convenience which creates an instance of the
ListCustomRoutingPortMappingsByDestinationRequest.Builder
avoiding the need to create one manually viaListCustomRoutingPortMappingsByDestinationRequest.builder()
- Parameters:
listCustomRoutingPortMappingsByDestinationRequest
- AConsumer
that will call methods onListCustomRoutingPortMappingsByDestinationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListCustomRoutingPortMappingsByDestination 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.- InvalidArgumentException An argument that you specified is invalid.
- InvalidNextTokenException There isn't another item to return.
- EndpointNotFoundException The endpoint that you specified doesn't exist.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCustomRoutingPortMappingsByDestinationPaginator
default ListCustomRoutingPortMappingsByDestinationPublisher listCustomRoutingPortMappingsByDestinationPaginator(ListCustomRoutingPortMappingsByDestinationRequest listCustomRoutingPortMappingsByDestinationRequest) This is a variant of
listCustomRoutingPortMappingsByDestination(software.amazon.awssdk.services.globalaccelerator.model.ListCustomRoutingPortMappingsByDestinationRequest)
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.globalaccelerator.paginators.ListCustomRoutingPortMappingsByDestinationPublisher publisher = client.listCustomRoutingPortMappingsByDestinationPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.globalaccelerator.paginators.ListCustomRoutingPortMappingsByDestinationPublisher publisher = client.listCustomRoutingPortMappingsByDestinationPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.globalaccelerator.model.ListCustomRoutingPortMappingsByDestinationResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.globalaccelerator.model.ListCustomRoutingPortMappingsByDestinationResponse 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
listCustomRoutingPortMappingsByDestination(software.amazon.awssdk.services.globalaccelerator.model.ListCustomRoutingPortMappingsByDestinationRequest)
operation.- Parameters:
listCustomRoutingPortMappingsByDestinationRequest
-- 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.- InvalidArgumentException An argument that you specified is invalid.
- InvalidNextTokenException There isn't another item to return.
- EndpointNotFoundException The endpoint that you specified doesn't exist.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCustomRoutingPortMappingsByDestinationPaginator
default ListCustomRoutingPortMappingsByDestinationPublisher listCustomRoutingPortMappingsByDestinationPaginator(Consumer<ListCustomRoutingPortMappingsByDestinationRequest.Builder> listCustomRoutingPortMappingsByDestinationRequest) This is a variant of
listCustomRoutingPortMappingsByDestination(software.amazon.awssdk.services.globalaccelerator.model.ListCustomRoutingPortMappingsByDestinationRequest)
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.globalaccelerator.paginators.ListCustomRoutingPortMappingsByDestinationPublisher publisher = client.listCustomRoutingPortMappingsByDestinationPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.globalaccelerator.paginators.ListCustomRoutingPortMappingsByDestinationPublisher publisher = client.listCustomRoutingPortMappingsByDestinationPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.globalaccelerator.model.ListCustomRoutingPortMappingsByDestinationResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.globalaccelerator.model.ListCustomRoutingPortMappingsByDestinationResponse 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
listCustomRoutingPortMappingsByDestination(software.amazon.awssdk.services.globalaccelerator.model.ListCustomRoutingPortMappingsByDestinationRequest)
operation.
This is a convenience which creates an instance of the
ListCustomRoutingPortMappingsByDestinationRequest.Builder
avoiding the need to create one manually viaListCustomRoutingPortMappingsByDestinationRequest.builder()
- Parameters:
listCustomRoutingPortMappingsByDestinationRequest
- AConsumer
that will call methods onListCustomRoutingPortMappingsByDestinationRequest.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.- InvalidArgumentException An argument that you specified is invalid.
- InvalidNextTokenException There isn't another item to return.
- EndpointNotFoundException The endpoint that you specified doesn't exist.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCustomRoutingPortMappingsPaginator
default ListCustomRoutingPortMappingsPublisher listCustomRoutingPortMappingsPaginator(ListCustomRoutingPortMappingsRequest listCustomRoutingPortMappingsRequest) This is a variant of
listCustomRoutingPortMappings(software.amazon.awssdk.services.globalaccelerator.model.ListCustomRoutingPortMappingsRequest)
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.globalaccelerator.paginators.ListCustomRoutingPortMappingsPublisher publisher = client.listCustomRoutingPortMappingsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.globalaccelerator.paginators.ListCustomRoutingPortMappingsPublisher publisher = client.listCustomRoutingPortMappingsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.globalaccelerator.model.ListCustomRoutingPortMappingsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.globalaccelerator.model.ListCustomRoutingPortMappingsResponse 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
listCustomRoutingPortMappings(software.amazon.awssdk.services.globalaccelerator.model.ListCustomRoutingPortMappingsRequest)
operation.- Parameters:
listCustomRoutingPortMappingsRequest
-- 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.- InvalidArgumentException An argument that you specified is invalid.
- InvalidNextTokenException There isn't another item to return.
- EndpointGroupNotFoundException The endpoint group that you specified doesn't exist.
- AcceleratorNotFoundException The accelerator that you specified doesn't exist.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCustomRoutingPortMappingsPaginator
default ListCustomRoutingPortMappingsPublisher listCustomRoutingPortMappingsPaginator(Consumer<ListCustomRoutingPortMappingsRequest.Builder> listCustomRoutingPortMappingsRequest) This is a variant of
listCustomRoutingPortMappings(software.amazon.awssdk.services.globalaccelerator.model.ListCustomRoutingPortMappingsRequest)
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.globalaccelerator.paginators.ListCustomRoutingPortMappingsPublisher publisher = client.listCustomRoutingPortMappingsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.globalaccelerator.paginators.ListCustomRoutingPortMappingsPublisher publisher = client.listCustomRoutingPortMappingsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.globalaccelerator.model.ListCustomRoutingPortMappingsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.globalaccelerator.model.ListCustomRoutingPortMappingsResponse 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
listCustomRoutingPortMappings(software.amazon.awssdk.services.globalaccelerator.model.ListCustomRoutingPortMappingsRequest)
operation.
This is a convenience which creates an instance of the
ListCustomRoutingPortMappingsRequest.Builder
avoiding the need to create one manually viaListCustomRoutingPortMappingsRequest.builder()
- Parameters:
listCustomRoutingPortMappingsRequest
- AConsumer
that will call methods onListCustomRoutingPortMappingsRequest.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.- InvalidArgumentException An argument that you specified is invalid.
- InvalidNextTokenException There isn't another item to return.
- EndpointGroupNotFoundException The endpoint group that you specified doesn't exist.
- AcceleratorNotFoundException The accelerator that you specified doesn't exist.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEndpointGroups
default CompletableFuture<ListEndpointGroupsResponse> listEndpointGroups(ListEndpointGroupsRequest listEndpointGroupsRequest) List the endpoint groups that are associated with a listener.
- Parameters:
listEndpointGroupsRequest
-- Returns:
- A Java Future containing the result of the ListEndpointGroups 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.- ListenerNotFoundException The listener that you specified doesn't exist.
- InvalidNextTokenException There isn't another item to return.
- InvalidArgumentException An argument that you specified is invalid.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEndpointGroups
default CompletableFuture<ListEndpointGroupsResponse> listEndpointGroups(Consumer<ListEndpointGroupsRequest.Builder> listEndpointGroupsRequest) List the endpoint groups that are associated with a listener.
This is a convenience which creates an instance of the
ListEndpointGroupsRequest.Builder
avoiding the need to create one manually viaListEndpointGroupsRequest.builder()
- Parameters:
listEndpointGroupsRequest
- AConsumer
that will call methods onListEndpointGroupsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListEndpointGroups 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.- ListenerNotFoundException The listener that you specified doesn't exist.
- InvalidNextTokenException There isn't another item to return.
- InvalidArgumentException An argument that you specified is invalid.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEndpointGroupsPaginator
default ListEndpointGroupsPublisher listEndpointGroupsPaginator(ListEndpointGroupsRequest listEndpointGroupsRequest) This is a variant of
listEndpointGroups(software.amazon.awssdk.services.globalaccelerator.model.ListEndpointGroupsRequest)
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.globalaccelerator.paginators.ListEndpointGroupsPublisher publisher = client.listEndpointGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.globalaccelerator.paginators.ListEndpointGroupsPublisher publisher = client.listEndpointGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.globalaccelerator.model.ListEndpointGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.globalaccelerator.model.ListEndpointGroupsResponse 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
listEndpointGroups(software.amazon.awssdk.services.globalaccelerator.model.ListEndpointGroupsRequest)
operation.- Parameters:
listEndpointGroupsRequest
-- 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.- ListenerNotFoundException The listener that you specified doesn't exist.
- InvalidNextTokenException There isn't another item to return.
- InvalidArgumentException An argument that you specified is invalid.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEndpointGroupsPaginator
default ListEndpointGroupsPublisher listEndpointGroupsPaginator(Consumer<ListEndpointGroupsRequest.Builder> listEndpointGroupsRequest) This is a variant of
listEndpointGroups(software.amazon.awssdk.services.globalaccelerator.model.ListEndpointGroupsRequest)
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.globalaccelerator.paginators.ListEndpointGroupsPublisher publisher = client.listEndpointGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.globalaccelerator.paginators.ListEndpointGroupsPublisher publisher = client.listEndpointGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.globalaccelerator.model.ListEndpointGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.globalaccelerator.model.ListEndpointGroupsResponse 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
listEndpointGroups(software.amazon.awssdk.services.globalaccelerator.model.ListEndpointGroupsRequest)
operation.
This is a convenience which creates an instance of the
ListEndpointGroupsRequest.Builder
avoiding the need to create one manually viaListEndpointGroupsRequest.builder()
- Parameters:
listEndpointGroupsRequest
- AConsumer
that will call methods onListEndpointGroupsRequest.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.- ListenerNotFoundException The listener that you specified doesn't exist.
- InvalidNextTokenException There isn't another item to return.
- InvalidArgumentException An argument that you specified is invalid.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listListeners
default CompletableFuture<ListListenersResponse> listListeners(ListListenersRequest listListenersRequest) List the listeners for an accelerator.
- Parameters:
listListenersRequest
-- Returns:
- A Java Future containing the result of the ListListeners 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.- InvalidArgumentException An argument that you specified is invalid.
- AcceleratorNotFoundException The accelerator that you specified doesn't exist.
- InvalidNextTokenException There isn't another item to return.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listListeners
default CompletableFuture<ListListenersResponse> listListeners(Consumer<ListListenersRequest.Builder> listListenersRequest) List the listeners for an accelerator.
This is a convenience which creates an instance of the
ListListenersRequest.Builder
avoiding the need to create one manually viaListListenersRequest.builder()
- Parameters:
listListenersRequest
- AConsumer
that will call methods onListListenersRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListListeners 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.- InvalidArgumentException An argument that you specified is invalid.
- AcceleratorNotFoundException The accelerator that you specified doesn't exist.
- InvalidNextTokenException There isn't another item to return.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listListenersPaginator
This is a variant of
listListeners(software.amazon.awssdk.services.globalaccelerator.model.ListListenersRequest)
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.globalaccelerator.paginators.ListListenersPublisher publisher = client.listListenersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.globalaccelerator.paginators.ListListenersPublisher publisher = client.listListenersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.globalaccelerator.model.ListListenersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.globalaccelerator.model.ListListenersResponse 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
listListeners(software.amazon.awssdk.services.globalaccelerator.model.ListListenersRequest)
operation.- Parameters:
listListenersRequest
-- 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.- InvalidArgumentException An argument that you specified is invalid.
- AcceleratorNotFoundException The accelerator that you specified doesn't exist.
- InvalidNextTokenException There isn't another item to return.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listListenersPaginator
default ListListenersPublisher listListenersPaginator(Consumer<ListListenersRequest.Builder> listListenersRequest) This is a variant of
listListeners(software.amazon.awssdk.services.globalaccelerator.model.ListListenersRequest)
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.globalaccelerator.paginators.ListListenersPublisher publisher = client.listListenersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.globalaccelerator.paginators.ListListenersPublisher publisher = client.listListenersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.globalaccelerator.model.ListListenersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.globalaccelerator.model.ListListenersResponse 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
listListeners(software.amazon.awssdk.services.globalaccelerator.model.ListListenersRequest)
operation.
This is a convenience which creates an instance of the
ListListenersRequest.Builder
avoiding the need to create one manually viaListListenersRequest.builder()
- Parameters:
listListenersRequest
- AConsumer
that will call methods onListListenersRequest.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.- InvalidArgumentException An argument that you specified is invalid.
- AcceleratorNotFoundException The accelerator that you specified doesn't exist.
- InvalidNextTokenException There isn't another item to return.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- 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.
- GlobalAcceleratorException 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) List all tags for an accelerator.
For more information, see Tagging in Global Accelerator in the Global Accelerator Developer Guide.
- 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.- AcceleratorNotFoundException The accelerator that you specified doesn't exist.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- InvalidArgumentException An argument that you specified is invalid.
- 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.
- GlobalAcceleratorException 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) List all tags for an accelerator.
For more information, see Tagging in Global Accelerator in the Global Accelerator Developer Guide.
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.- AcceleratorNotFoundException The accelerator that you specified doesn't exist.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- InvalidArgumentException An argument that you specified is invalid.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
provisionByoipCidr
default CompletableFuture<ProvisionByoipCidrResponse> provisionByoipCidr(ProvisionByoipCidrRequest provisionByoipCidrRequest) Provisions an IP address range to use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and creates a corresponding address pool. After the address range is provisioned, it is ready to be advertised using AdvertiseByoipCidr.
For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
- Parameters:
provisionByoipCidrRequest
-- Returns:
- A Java Future containing the result of the ProvisionByoipCidr 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.- InternalServiceErrorException There was an internal error for Global Accelerator.
- InvalidArgumentException An argument that you specified is invalid.
- LimitExceededException Processing your request would cause you to exceed an Global Accelerator limit.
- AccessDeniedException You don't have access permission.
- IncorrectCidrStateException The CIDR that you specified is not valid for this action. For example, the state of the CIDR might be incorrect for this action.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
provisionByoipCidr
default CompletableFuture<ProvisionByoipCidrResponse> provisionByoipCidr(Consumer<ProvisionByoipCidrRequest.Builder> provisionByoipCidrRequest) Provisions an IP address range to use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and creates a corresponding address pool. After the address range is provisioned, it is ready to be advertised using AdvertiseByoipCidr.
For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
This is a convenience which creates an instance of the
ProvisionByoipCidrRequest.Builder
avoiding the need to create one manually viaProvisionByoipCidrRequest.builder()
- Parameters:
provisionByoipCidrRequest
- AConsumer
that will call methods onProvisionByoipCidrRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ProvisionByoipCidr 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.- InternalServiceErrorException There was an internal error for Global Accelerator.
- InvalidArgumentException An argument that you specified is invalid.
- LimitExceededException Processing your request would cause you to exceed an Global Accelerator limit.
- AccessDeniedException You don't have access permission.
- IncorrectCidrStateException The CIDR that you specified is not valid for this action. For example, the state of the CIDR might be incorrect for this action.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
removeCustomRoutingEndpoints
default CompletableFuture<RemoveCustomRoutingEndpointsResponse> removeCustomRoutingEndpoints(RemoveCustomRoutingEndpointsRequest removeCustomRoutingEndpointsRequest) Remove endpoints from a custom routing accelerator.
- Parameters:
removeCustomRoutingEndpointsRequest
-- Returns:
- A Java Future containing the result of the RemoveCustomRoutingEndpoints 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.- EndpointGroupNotFoundException The endpoint group that you specified doesn't exist.
- EndpointNotFoundException The endpoint that you specified doesn't exist.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- InvalidArgumentException An argument that you specified is invalid.
- AccessDeniedException You don't have access permission.
- ConflictException You can't use both of those options.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
removeCustomRoutingEndpoints
default CompletableFuture<RemoveCustomRoutingEndpointsResponse> removeCustomRoutingEndpoints(Consumer<RemoveCustomRoutingEndpointsRequest.Builder> removeCustomRoutingEndpointsRequest) Remove endpoints from a custom routing accelerator.
This is a convenience which creates an instance of the
RemoveCustomRoutingEndpointsRequest.Builder
avoiding the need to create one manually viaRemoveCustomRoutingEndpointsRequest.builder()
- Parameters:
removeCustomRoutingEndpointsRequest
- AConsumer
that will call methods onRemoveCustomRoutingEndpointsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RemoveCustomRoutingEndpoints 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.- EndpointGroupNotFoundException The endpoint group that you specified doesn't exist.
- EndpointNotFoundException The endpoint that you specified doesn't exist.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- InvalidArgumentException An argument that you specified is invalid.
- AccessDeniedException You don't have access permission.
- ConflictException You can't use both of those options.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
removeEndpoints
default CompletableFuture<RemoveEndpointsResponse> removeEndpoints(RemoveEndpointsRequest removeEndpointsRequest) Remove endpoints from an endpoint group.
The
RemoveEndpoints
API operation is the recommended option for removing endpoints. The alternative is to remove endpoints by updating an endpoint group by using the UpdateEndpointGroup API operation. There are two advantages to usingAddEndpoints
to remove endpoints instead:-
It's more convenient, because you only need to specify the endpoints that you want to remove. With the
UpdateEndpointGroup
API operation, you must specify all of the endpoints in the endpoint group except the ones that you want to remove from the group. -
It's faster, because Global Accelerator doesn't need to resolve any endpoints. With the
UpdateEndpointGroup
API operation, Global Accelerator must resolve all of the endpoints that remain in the group.
- Parameters:
removeEndpointsRequest
-- Returns:
- A Java Future containing the result of the RemoveEndpoints 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.- EndpointGroupNotFoundException The endpoint group that you specified doesn't exist.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- InvalidArgumentException An argument that you specified is invalid.
- AccessDeniedException You don't have access permission.
- TransactionInProgressException There's already a transaction in progress. Another transaction can't be processed.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
removeEndpoints
default CompletableFuture<RemoveEndpointsResponse> removeEndpoints(Consumer<RemoveEndpointsRequest.Builder> removeEndpointsRequest) Remove endpoints from an endpoint group.
The
RemoveEndpoints
API operation is the recommended option for removing endpoints. The alternative is to remove endpoints by updating an endpoint group by using the UpdateEndpointGroup API operation. There are two advantages to usingAddEndpoints
to remove endpoints instead:-
It's more convenient, because you only need to specify the endpoints that you want to remove. With the
UpdateEndpointGroup
API operation, you must specify all of the endpoints in the endpoint group except the ones that you want to remove from the group. -
It's faster, because Global Accelerator doesn't need to resolve any endpoints. With the
UpdateEndpointGroup
API operation, Global Accelerator must resolve all of the endpoints that remain in the group.
This is a convenience which creates an instance of the
RemoveEndpointsRequest.Builder
avoiding the need to create one manually viaRemoveEndpointsRequest.builder()
- Parameters:
removeEndpointsRequest
- AConsumer
that will call methods onRemoveEndpointsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RemoveEndpoints 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.- EndpointGroupNotFoundException The endpoint group that you specified doesn't exist.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- InvalidArgumentException An argument that you specified is invalid.
- AccessDeniedException You don't have access permission.
- TransactionInProgressException There's already a transaction in progress. Another transaction can't be processed.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
tagResource
Add tags to an accelerator resource.
For more information, see Tagging in Global Accelerator in the Global Accelerator Developer Guide.
- 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.- AcceleratorNotFoundException The accelerator that you specified doesn't exist.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- InvalidArgumentException An argument that you specified is invalid.
- 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.
- GlobalAcceleratorException 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) Add tags to an accelerator resource.
For more information, see Tagging in Global Accelerator in the Global Accelerator Developer Guide.
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.- AcceleratorNotFoundException The accelerator that you specified doesn't exist.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- InvalidArgumentException An argument that you specified is invalid.
- 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.
- GlobalAcceleratorException 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) Remove tags from a Global Accelerator resource. When you specify a tag key, the action removes both that key and its associated value. The operation succeeds even if you attempt to remove tags from an accelerator that was already removed.
For more information, see Tagging in Global Accelerator in the Global Accelerator Developer Guide.
- 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.- AcceleratorNotFoundException The accelerator that you specified doesn't exist.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- InvalidArgumentException An argument that you specified is invalid.
- 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.
- GlobalAcceleratorException 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) Remove tags from a Global Accelerator resource. When you specify a tag key, the action removes both that key and its associated value. The operation succeeds even if you attempt to remove tags from an accelerator that was already removed.
For more information, see Tagging in Global Accelerator in the Global Accelerator Developer Guide.
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.- AcceleratorNotFoundException The accelerator that you specified doesn't exist.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- InvalidArgumentException An argument that you specified is invalid.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateAccelerator
default CompletableFuture<UpdateAcceleratorResponse> updateAccelerator(UpdateAcceleratorRequest updateAcceleratorRequest) Update an accelerator to make changes, such as the following:
-
Change the name of the accelerator.
-
Disable the accelerator so that it no longer accepts or routes traffic, or so that you can delete it.
-
Enable the accelerator, if it is disabled.
-
Change the IP address type to dual-stack if it is IPv4, or change the IP address type to IPv4 if it's dual-stack.
Be aware that static IP addresses remain assigned to your accelerator for as long as it exists, even if you disable the accelerator and it no longer accepts or routes traffic. However, when you delete the accelerator, you lose the static IP addresses that are assigned to it, so you can no longer route traffic by using them.
Global Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the US West (Oregon) Region to create, update, or otherwise work with accelerators. That is, for example, specify
--region us-west-2
on Amazon Web Services CLI commands.- Parameters:
updateAcceleratorRequest
-- Returns:
- A Java Future containing the result of the UpdateAccelerator 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.- AcceleratorNotFoundException The accelerator that you specified doesn't exist.
- AccessDeniedException You don't have access permission.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- InvalidArgumentException An argument that you specified is invalid.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
updateAccelerator
default CompletableFuture<UpdateAcceleratorResponse> updateAccelerator(Consumer<UpdateAcceleratorRequest.Builder> updateAcceleratorRequest) Update an accelerator to make changes, such as the following:
-
Change the name of the accelerator.
-
Disable the accelerator so that it no longer accepts or routes traffic, or so that you can delete it.
-
Enable the accelerator, if it is disabled.
-
Change the IP address type to dual-stack if it is IPv4, or change the IP address type to IPv4 if it's dual-stack.
Be aware that static IP addresses remain assigned to your accelerator for as long as it exists, even if you disable the accelerator and it no longer accepts or routes traffic. However, when you delete the accelerator, you lose the static IP addresses that are assigned to it, so you can no longer route traffic by using them.
Global Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the US West (Oregon) Region to create, update, or otherwise work with accelerators. That is, for example, specify
--region us-west-2
on Amazon Web Services CLI commands.
This is a convenience which creates an instance of the
UpdateAcceleratorRequest.Builder
avoiding the need to create one manually viaUpdateAcceleratorRequest.builder()
- Parameters:
updateAcceleratorRequest
- AConsumer
that will call methods onUpdateAcceleratorRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateAccelerator 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.- AcceleratorNotFoundException The accelerator that you specified doesn't exist.
- AccessDeniedException You don't have access permission.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- InvalidArgumentException An argument that you specified is invalid.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
updateAcceleratorAttributes
default CompletableFuture<UpdateAcceleratorAttributesResponse> updateAcceleratorAttributes(UpdateAcceleratorAttributesRequest updateAcceleratorAttributesRequest) Update the attributes for an accelerator.
- Parameters:
updateAcceleratorAttributesRequest
-- Returns:
- A Java Future containing the result of the UpdateAcceleratorAttributes 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.- AcceleratorNotFoundException The accelerator that you specified doesn't exist.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- InvalidArgumentException An argument that you specified is invalid.
- AccessDeniedException You don't have access permission.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateAcceleratorAttributes
default CompletableFuture<UpdateAcceleratorAttributesResponse> updateAcceleratorAttributes(Consumer<UpdateAcceleratorAttributesRequest.Builder> updateAcceleratorAttributesRequest) Update the attributes for an accelerator.
This is a convenience which creates an instance of the
UpdateAcceleratorAttributesRequest.Builder
avoiding the need to create one manually viaUpdateAcceleratorAttributesRequest.builder()
- Parameters:
updateAcceleratorAttributesRequest
- AConsumer
that will call methods onUpdateAcceleratorAttributesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateAcceleratorAttributes 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.- AcceleratorNotFoundException The accelerator that you specified doesn't exist.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- InvalidArgumentException An argument that you specified is invalid.
- AccessDeniedException You don't have access permission.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateCrossAccountAttachment
default CompletableFuture<UpdateCrossAccountAttachmentResponse> updateCrossAccountAttachment(UpdateCrossAccountAttachmentRequest updateCrossAccountAttachmentRequest) Update a cross-account attachment to add or remove principals or resources. When you update an attachment to remove a principal (account ID or accelerator) or a resource, Global Accelerator revokes the permission for specific resources.
For more information, see Working with cross-account attachments and resources in Global Accelerator in the Global Accelerator Developer Guide.
- Parameters:
updateCrossAccountAttachmentRequest
-- Returns:
- A Java Future containing the result of the UpdateCrossAccountAttachment 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.- AttachmentNotFoundException No cross-account attachment was found.
- AccessDeniedException You don't have access permission.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- InvalidArgumentException An argument that you specified is invalid.
- LimitExceededException Processing your request would cause you to exceed an Global Accelerator limit.
- TransactionInProgressException There's already a transaction in progress. Another transaction can't be processed.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateCrossAccountAttachment
default CompletableFuture<UpdateCrossAccountAttachmentResponse> updateCrossAccountAttachment(Consumer<UpdateCrossAccountAttachmentRequest.Builder> updateCrossAccountAttachmentRequest) Update a cross-account attachment to add or remove principals or resources. When you update an attachment to remove a principal (account ID or accelerator) or a resource, Global Accelerator revokes the permission for specific resources.
For more information, see Working with cross-account attachments and resources in Global Accelerator in the Global Accelerator Developer Guide.
This is a convenience which creates an instance of the
UpdateCrossAccountAttachmentRequest.Builder
avoiding the need to create one manually viaUpdateCrossAccountAttachmentRequest.builder()
- Parameters:
updateCrossAccountAttachmentRequest
- AConsumer
that will call methods onUpdateCrossAccountAttachmentRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateCrossAccountAttachment 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.- AttachmentNotFoundException No cross-account attachment was found.
- AccessDeniedException You don't have access permission.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- InvalidArgumentException An argument that you specified is invalid.
- LimitExceededException Processing your request would cause you to exceed an Global Accelerator limit.
- TransactionInProgressException There's already a transaction in progress. Another transaction can't be processed.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateCustomRoutingAccelerator
default CompletableFuture<UpdateCustomRoutingAcceleratorResponse> updateCustomRoutingAccelerator(UpdateCustomRoutingAcceleratorRequest updateCustomRoutingAcceleratorRequest) Update a custom routing accelerator.
- Parameters:
updateCustomRoutingAcceleratorRequest
-- Returns:
- A Java Future containing the result of the UpdateCustomRoutingAccelerator 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.- AcceleratorNotFoundException The accelerator that you specified doesn't exist.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- InvalidArgumentException An argument that you specified is invalid.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateCustomRoutingAccelerator
default CompletableFuture<UpdateCustomRoutingAcceleratorResponse> updateCustomRoutingAccelerator(Consumer<UpdateCustomRoutingAcceleratorRequest.Builder> updateCustomRoutingAcceleratorRequest) Update a custom routing accelerator.
This is a convenience which creates an instance of the
UpdateCustomRoutingAcceleratorRequest.Builder
avoiding the need to create one manually viaUpdateCustomRoutingAcceleratorRequest.builder()
- Parameters:
updateCustomRoutingAcceleratorRequest
- AConsumer
that will call methods onUpdateCustomRoutingAcceleratorRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateCustomRoutingAccelerator 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.- AcceleratorNotFoundException The accelerator that you specified doesn't exist.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- InvalidArgumentException An argument that you specified is invalid.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateCustomRoutingAcceleratorAttributes
default CompletableFuture<UpdateCustomRoutingAcceleratorAttributesResponse> updateCustomRoutingAcceleratorAttributes(UpdateCustomRoutingAcceleratorAttributesRequest updateCustomRoutingAcceleratorAttributesRequest) Update the attributes for a custom routing accelerator.
- Parameters:
updateCustomRoutingAcceleratorAttributesRequest
-- Returns:
- A Java Future containing the result of the UpdateCustomRoutingAcceleratorAttributes 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.- AcceleratorNotFoundException The accelerator that you specified doesn't exist.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- InvalidArgumentException An argument that you specified is invalid.
- AccessDeniedException You don't have access permission.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateCustomRoutingAcceleratorAttributes
default CompletableFuture<UpdateCustomRoutingAcceleratorAttributesResponse> updateCustomRoutingAcceleratorAttributes(Consumer<UpdateCustomRoutingAcceleratorAttributesRequest.Builder> updateCustomRoutingAcceleratorAttributesRequest) Update the attributes for a custom routing accelerator.
This is a convenience which creates an instance of the
UpdateCustomRoutingAcceleratorAttributesRequest.Builder
avoiding the need to create one manually viaUpdateCustomRoutingAcceleratorAttributesRequest.builder()
- Parameters:
updateCustomRoutingAcceleratorAttributesRequest
- AConsumer
that will call methods onUpdateCustomRoutingAcceleratorAttributesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateCustomRoutingAcceleratorAttributes 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.- AcceleratorNotFoundException The accelerator that you specified doesn't exist.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- InvalidArgumentException An argument that you specified is invalid.
- AccessDeniedException You don't have access permission.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateCustomRoutingListener
default CompletableFuture<UpdateCustomRoutingListenerResponse> updateCustomRoutingListener(UpdateCustomRoutingListenerRequest updateCustomRoutingListenerRequest) Update a listener for a custom routing accelerator.
- Parameters:
updateCustomRoutingListenerRequest
-- Returns:
- A Java Future containing the result of the UpdateCustomRoutingListener 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.- InvalidArgumentException An argument that you specified is invalid.
- InvalidPortRangeException The port numbers that you specified are not valid numbers or are not unique for this accelerator.
- ListenerNotFoundException The listener that you specified doesn't exist.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- LimitExceededException Processing your request would cause you to exceed an Global Accelerator limit.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateCustomRoutingListener
default CompletableFuture<UpdateCustomRoutingListenerResponse> updateCustomRoutingListener(Consumer<UpdateCustomRoutingListenerRequest.Builder> updateCustomRoutingListenerRequest) Update a listener for a custom routing accelerator.
This is a convenience which creates an instance of the
UpdateCustomRoutingListenerRequest.Builder
avoiding the need to create one manually viaUpdateCustomRoutingListenerRequest.builder()
- Parameters:
updateCustomRoutingListenerRequest
- AConsumer
that will call methods onUpdateCustomRoutingListenerRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateCustomRoutingListener 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.- InvalidArgumentException An argument that you specified is invalid.
- InvalidPortRangeException The port numbers that you specified are not valid numbers or are not unique for this accelerator.
- ListenerNotFoundException The listener that you specified doesn't exist.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- LimitExceededException Processing your request would cause you to exceed an Global Accelerator limit.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateEndpointGroup
default CompletableFuture<UpdateEndpointGroupResponse> updateEndpointGroup(UpdateEndpointGroupRequest updateEndpointGroupRequest) Update an endpoint group. A resource must be valid and active when you add it as an endpoint.
- Parameters:
updateEndpointGroupRequest
-- Returns:
- A Java Future containing the result of the UpdateEndpointGroup 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.- InvalidArgumentException An argument that you specified is invalid.
- EndpointGroupNotFoundException The endpoint group that you specified doesn't exist.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- LimitExceededException Processing your request would cause you to exceed an Global Accelerator limit.
- AccessDeniedException You don't have access permission.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateEndpointGroup
default CompletableFuture<UpdateEndpointGroupResponse> updateEndpointGroup(Consumer<UpdateEndpointGroupRequest.Builder> updateEndpointGroupRequest) Update an endpoint group. A resource must be valid and active when you add it as an endpoint.
This is a convenience which creates an instance of the
UpdateEndpointGroupRequest.Builder
avoiding the need to create one manually viaUpdateEndpointGroupRequest.builder()
- Parameters:
updateEndpointGroupRequest
- AConsumer
that will call methods onUpdateEndpointGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateEndpointGroup 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.- InvalidArgumentException An argument that you specified is invalid.
- EndpointGroupNotFoundException The endpoint group that you specified doesn't exist.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- LimitExceededException Processing your request would cause you to exceed an Global Accelerator limit.
- AccessDeniedException You don't have access permission.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateListener
default CompletableFuture<UpdateListenerResponse> updateListener(UpdateListenerRequest updateListenerRequest) Update a listener.
- Parameters:
updateListenerRequest
-- Returns:
- A Java Future containing the result of the UpdateListener 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.- InvalidArgumentException An argument that you specified is invalid.
- InvalidPortRangeException The port numbers that you specified are not valid numbers or are not unique for this accelerator.
- ListenerNotFoundException The listener that you specified doesn't exist.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- LimitExceededException Processing your request would cause you to exceed an Global Accelerator limit.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateListener
default CompletableFuture<UpdateListenerResponse> updateListener(Consumer<UpdateListenerRequest.Builder> updateListenerRequest) Update a listener.
This is a convenience which creates an instance of the
UpdateListenerRequest.Builder
avoiding the need to create one manually viaUpdateListenerRequest.builder()
- Parameters:
updateListenerRequest
- AConsumer
that will call methods onUpdateListenerRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateListener 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.- InvalidArgumentException An argument that you specified is invalid.
- InvalidPortRangeException The port numbers that you specified are not valid numbers or are not unique for this accelerator.
- ListenerNotFoundException The listener that you specified doesn't exist.
- InternalServiceErrorException There was an internal error for Global Accelerator.
- LimitExceededException Processing your request would cause you to exceed an Global Accelerator limit.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
withdrawByoipCidr
default CompletableFuture<WithdrawByoipCidrResponse> withdrawByoipCidr(WithdrawByoipCidrRequest withdrawByoipCidrRequest) Stops advertising an address range that is provisioned as an address pool. You can perform this operation at most once every 10 seconds, even if you specify different address ranges each time.
It can take a few minutes before traffic to the specified addresses stops routing to Amazon Web Services because of propagation delays.
For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
- Parameters:
withdrawByoipCidrRequest
-- Returns:
- A Java Future containing the result of the WithdrawByoipCidr 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.- InternalServiceErrorException There was an internal error for Global Accelerator.
- InvalidArgumentException An argument that you specified is invalid.
- AccessDeniedException You don't have access permission.
- ByoipCidrNotFoundException The CIDR that you specified was not found or is incorrect.
- IncorrectCidrStateException The CIDR that you specified is not valid for this action. For example, the state of the CIDR might be incorrect for this action.
- 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.
- GlobalAcceleratorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
withdrawByoipCidr
default CompletableFuture<WithdrawByoipCidrResponse> withdrawByoipCidr(Consumer<WithdrawByoipCidrRequest.Builder> withdrawByoipCidrRequest) Stops advertising an address range that is provisioned as an address pool. You can perform this operation at most once every 10 seconds, even if you specify different address ranges each time.
It can take a few minutes before traffic to the specified addresses stops routing to Amazon Web Services because of propagation delays.
For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
This is a convenience which creates an instance of the
WithdrawByoipCidrRequest.Builder
avoiding the need to create one manually viaWithdrawByoipCidrRequest.builder()
- Parameters:
withdrawByoipCidrRequest
- AConsumer
that will call methods onWithdrawByoipCidrRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the WithdrawByoipCidr 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.- InternalServiceErrorException There was an internal error for Global Accelerator.
- InvalidArgumentException An argument that you specified is invalid.
- AccessDeniedException You don't have access permission.
- ByoipCidrNotFoundException The CIDR that you specified was not found or is incorrect.
- IncorrectCidrStateException The CIDR that you specified is not valid for this action. For example, the state of the CIDR might be incorrect for this action.
- 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.
- GlobalAcceleratorException 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 aGlobalAcceleratorAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aGlobalAcceleratorAsyncClient
.
-