@Generated(value="software.amazon.awssdk:codegen") public interface GlobalAcceleratorClient extends SdkClient
builder()
method.
This is the AWS Global Accelerator API Reference. This guide is for developers who need detailed information about AWS Global Accelerator API actions, data types, and errors. For more information about Global Accelerator features, see the AWS Global Accelerator Developer Guide.
AWS Global Accelerator is a network layer service in which you create accelerators to improve availability and performance for internet applications used by a global audience.
Global Accelerator provides you with static IP addresses that you associate with your accelerator. These IP addresses are anycast from the AWS edge network and distribute incoming application traffic across multiple endpoint resources in multiple AWS Regions, which increases the availability of your applications. Endpoints can be Elastic IP addresses, Network Load Balancers, and Application Load Balancers that are located in one AWS Region or multiple Regions.
Global Accelerator uses the AWS 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 directed to only healthy endpoints.
Global Accelerator includes components that work together to help you improve performance and availability for your applications:
AWS Global Accelerator provides you with a set of static IP addresses which are anycast from the AWS edge network and serve as the single fixed points of contact for your clients. If you already have Elastic Load Balancing or Elastic IP address resources set up for your applications, you can easily add those to Global Accelerator to allow the resources to be accessed by a Global Accelerator static IP address.
An accelerator directs traffic to optimal endpoints over the AWS global network to improve availability and performance for your internet applications that have a global audience. Each accelerator includes one or more listeners.
A network zone services the static IP addresses for your accelerator from a unique IP subnet. Similar to an AWS Availability Zone, a network zone is an isolated unit with its own set of physical infrastructure. When you configure an accelerator, Global Accelerator allocates two IPv4 addresses for it. If one IP address from a network zone becomes unavailable due to IP address blocking by certain client networks, or network disruptions, then client applications can retry on the healthy static IP address from the other isolated network zone.
A listener processes inbound connections from clients to Global Accelerator, based on the protocol and port that you configure. Each listener has one or more endpoint groups associated with it, and traffic is forwarded to endpoints in one of the groups. You associate endpoint groups with listeners by specifying the Regions that you want to distribute traffic to. Traffic is distributed to optimal endpoints within the endpoint groups associated with a listener.
Each endpoint group is associated with a specific AWS Region. Endpoint groups include one or more endpoints in the Region. You can increase or reduce the percentage of traffic that would be otherwise directed to an endpoint group by adjusting a setting called a traffic dial. The traffic dial lets you easily do performance testing or blue/green deployment testing for new releases across different AWS Regions, for example.
An endpoint is an Elastic IP address, Network Load Balancer, or Application Load Balancer. Traffic is routed to endpoints based on several factors, including the geo-proximity to the user, the health of the endpoint, and the configuration options that you choose, such as endpoint weights. You can configure weights for each endpoint, which are numbers that you can use to specify the proportion of traffic to route to each one. This can be useful, for example, to do performance testing within a Region.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
serviceName
close
static final String SERVICE_NAME
static GlobalAcceleratorClient create()
GlobalAcceleratorClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static GlobalAcceleratorClientBuilder builder()
GlobalAcceleratorClient
.default CreateAcceleratorResponse createAccelerator(CreateAcceleratorRequest createAcceleratorRequest) throws InternalServiceErrorException, InvalidArgumentException, LimitExceededException, AwsServiceException, SdkClientException, GlobalAcceleratorException
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. To see an AWS CLI example of creating an accelerator, scroll down to Example.
createAcceleratorRequest
- InternalServiceErrorException
- There was an internal error for AWS Global Accelerator.InvalidArgumentException
- An argument that you specified is invalid.LimitExceededException
- Processing your request would cause you to exceed an AWS 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.AwsServiceException
default CreateAcceleratorResponse createAccelerator(Consumer<CreateAcceleratorRequest.Builder> createAcceleratorRequest) throws InternalServiceErrorException, InvalidArgumentException, LimitExceededException, AwsServiceException, SdkClientException, GlobalAcceleratorException
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. To see an AWS CLI example of creating an accelerator, scroll down to Example.
This is a convenience which creates an instance of the CreateAcceleratorRequest.Builder
avoiding the need
to create one manually via CreateAcceleratorRequest.builder()
createAcceleratorRequest
- A Consumer
that will call methods on CreateAcceleratorRequest.Builder
to create a request.InternalServiceErrorException
- There was an internal error for AWS Global Accelerator.InvalidArgumentException
- An argument that you specified is invalid.LimitExceededException
- Processing your request would cause you to exceed an AWS 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.AwsServiceException
default CreateEndpointGroupResponse createEndpointGroup(CreateEndpointGroupRequest createEndpointGroupRequest) throws AcceleratorNotFoundException, EndpointGroupAlreadyExistsException, ListenerNotFoundException, InternalServiceErrorException, InvalidArgumentException, LimitExceededException, AwsServiceException, SdkClientException, GlobalAcceleratorException
Create an endpoint group for the specified accelerator. An endpoint group is a collection of endpoints in one AWS Region. To see an AWS CLI example of creating an endpoint group, scroll down to Example.
createEndpointGroupRequest
- 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 AWS Global Accelerator.InvalidArgumentException
- An argument that you specified is invalid.LimitExceededException
- Processing your request would cause you to exceed an AWS 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.AwsServiceException
default CreateEndpointGroupResponse createEndpointGroup(Consumer<CreateEndpointGroupRequest.Builder> createEndpointGroupRequest) throws AcceleratorNotFoundException, EndpointGroupAlreadyExistsException, ListenerNotFoundException, InternalServiceErrorException, InvalidArgumentException, LimitExceededException, AwsServiceException, SdkClientException, GlobalAcceleratorException
Create an endpoint group for the specified accelerator. An endpoint group is a collection of endpoints in one AWS Region. To see an AWS CLI example of creating an endpoint group, scroll down to Example.
This is a convenience which creates an instance of the CreateEndpointGroupRequest.Builder
avoiding the
need to create one manually via CreateEndpointGroupRequest.builder()
createEndpointGroupRequest
- A Consumer
that will call methods on CreateEndpointGroupRequest.Builder
to create a
request.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 AWS Global Accelerator.InvalidArgumentException
- An argument that you specified is invalid.LimitExceededException
- Processing your request would cause you to exceed an AWS 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.AwsServiceException
default CreateListenerResponse createListener(CreateListenerRequest createListenerRequest) throws InvalidArgumentException, AcceleratorNotFoundException, InvalidPortRangeException, InternalServiceErrorException, LimitExceededException, AwsServiceException, SdkClientException, GlobalAcceleratorException
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. To see an AWS CLI example of creating a listener, scroll down to Example.
createListenerRequest
- 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 AWS Global Accelerator.LimitExceededException
- Processing your request would cause you to exceed an AWS 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.AwsServiceException
default CreateListenerResponse createListener(Consumer<CreateListenerRequest.Builder> createListenerRequest) throws InvalidArgumentException, AcceleratorNotFoundException, InvalidPortRangeException, InternalServiceErrorException, LimitExceededException, AwsServiceException, SdkClientException, GlobalAcceleratorException
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. To see an AWS CLI example of creating a listener, scroll down to Example.
This is a convenience which creates an instance of the CreateListenerRequest.Builder
avoiding the need to
create one manually via CreateListenerRequest.builder()
createListenerRequest
- A Consumer
that will call methods on CreateListenerRequest.Builder
to create a request.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 AWS Global Accelerator.LimitExceededException
- Processing your request would cause you to exceed an AWS 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.AwsServiceException
default DeleteAcceleratorResponse deleteAccelerator(DeleteAcceleratorRequest deleteAcceleratorRequest) throws AcceleratorNotFoundException, AcceleratorNotDisabledException, AssociatedListenerFoundException, InternalServiceErrorException, InvalidArgumentException, AwsServiceException, SdkClientException, GlobalAcceleratorException
Delete an accelerator. Note: before you can delete an accelerator, you must disable it.
deleteAcceleratorRequest
- AcceleratorNotFoundException
- The accelerator that you specified doesn't exist.AcceleratorNotDisabledException
- The accelerator that you specified could not be disabled.AssociatedListenerFoundException
- The listener that you specified doesn't exist.InternalServiceErrorException
- There was an internal error for AWS 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.AwsServiceException
default DeleteAcceleratorResponse deleteAccelerator(Consumer<DeleteAcceleratorRequest.Builder> deleteAcceleratorRequest) throws AcceleratorNotFoundException, AcceleratorNotDisabledException, AssociatedListenerFoundException, InternalServiceErrorException, InvalidArgumentException, AwsServiceException, SdkClientException, GlobalAcceleratorException
Delete an accelerator. Note: before you can delete an accelerator, you must disable it.
This is a convenience which creates an instance of the DeleteAcceleratorRequest.Builder
avoiding the need
to create one manually via DeleteAcceleratorRequest.builder()
deleteAcceleratorRequest
- A Consumer
that will call methods on DeleteAcceleratorRequest.Builder
to create a request.AcceleratorNotFoundException
- The accelerator that you specified doesn't exist.AcceleratorNotDisabledException
- The accelerator that you specified could not be disabled.AssociatedListenerFoundException
- The listener that you specified doesn't exist.InternalServiceErrorException
- There was an internal error for AWS 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.AwsServiceException
default DeleteEndpointGroupResponse deleteEndpointGroup(DeleteEndpointGroupRequest deleteEndpointGroupRequest) throws EndpointGroupNotFoundException, InternalServiceErrorException, AwsServiceException, SdkClientException, GlobalAcceleratorException
Delete an endpoint group from a listener.
deleteEndpointGroupRequest
- EndpointGroupNotFoundException
- The endpoint group that you specified doesn't exist.InternalServiceErrorException
- There was an internal error for AWS 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.AwsServiceException
default DeleteEndpointGroupResponse deleteEndpointGroup(Consumer<DeleteEndpointGroupRequest.Builder> deleteEndpointGroupRequest) throws EndpointGroupNotFoundException, InternalServiceErrorException, AwsServiceException, SdkClientException, GlobalAcceleratorException
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 via DeleteEndpointGroupRequest.builder()
deleteEndpointGroupRequest
- A Consumer
that will call methods on DeleteEndpointGroupRequest.Builder
to create a
request.EndpointGroupNotFoundException
- The endpoint group that you specified doesn't exist.InternalServiceErrorException
- There was an internal error for AWS 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.AwsServiceException
default DeleteListenerResponse deleteListener(DeleteListenerRequest deleteListenerRequest) throws ListenerNotFoundException, AssociatedEndpointGroupFoundException, InternalServiceErrorException, AwsServiceException, SdkClientException, GlobalAcceleratorException
Delete a listener from an accelerator.
deleteListenerRequest
- ListenerNotFoundException
- The listener that you specified doesn't exist.AssociatedEndpointGroupFoundException
- The endpoint group that you specified doesn't exist.InternalServiceErrorException
- There was an internal error for AWS 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.AwsServiceException
default DeleteListenerResponse deleteListener(Consumer<DeleteListenerRequest.Builder> deleteListenerRequest) throws ListenerNotFoundException, AssociatedEndpointGroupFoundException, InternalServiceErrorException, AwsServiceException, SdkClientException, GlobalAcceleratorException
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 via DeleteListenerRequest.builder()
deleteListenerRequest
- A Consumer
that will call methods on DeleteListenerRequest.Builder
to create a request.ListenerNotFoundException
- The listener that you specified doesn't exist.AssociatedEndpointGroupFoundException
- The endpoint group that you specified doesn't exist.InternalServiceErrorException
- There was an internal error for AWS 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.AwsServiceException
default DescribeAcceleratorResponse describeAccelerator(DescribeAcceleratorRequest describeAcceleratorRequest) throws AcceleratorNotFoundException, InternalServiceErrorException, InvalidArgumentException, AwsServiceException, SdkClientException, GlobalAcceleratorException
Describe an accelerator. To see an AWS CLI example of describing an accelerator, scroll down to Example.
describeAcceleratorRequest
- AcceleratorNotFoundException
- The accelerator that you specified doesn't exist.InternalServiceErrorException
- There was an internal error for AWS 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.AwsServiceException
default DescribeAcceleratorResponse describeAccelerator(Consumer<DescribeAcceleratorRequest.Builder> describeAcceleratorRequest) throws AcceleratorNotFoundException, InternalServiceErrorException, InvalidArgumentException, AwsServiceException, SdkClientException, GlobalAcceleratorException
Describe an accelerator. To see an AWS CLI example of describing an accelerator, scroll down to Example.
This is a convenience which creates an instance of the DescribeAcceleratorRequest.Builder
avoiding the
need to create one manually via DescribeAcceleratorRequest.builder()
describeAcceleratorRequest
- A Consumer
that will call methods on DescribeAcceleratorRequest.Builder
to create a
request.AcceleratorNotFoundException
- The accelerator that you specified doesn't exist.InternalServiceErrorException
- There was an internal error for AWS 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.AwsServiceException
default DescribeAcceleratorAttributesResponse describeAcceleratorAttributes(DescribeAcceleratorAttributesRequest describeAcceleratorAttributesRequest) throws AcceleratorNotFoundException, InternalServiceErrorException, InvalidArgumentException, AwsServiceException, SdkClientException, GlobalAcceleratorException
Describe the attributes of an accelerator.
describeAcceleratorAttributesRequest
- AcceleratorNotFoundException
- The accelerator that you specified doesn't exist.InternalServiceErrorException
- There was an internal error for AWS 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.AwsServiceException
default DescribeAcceleratorAttributesResponse describeAcceleratorAttributes(Consumer<DescribeAcceleratorAttributesRequest.Builder> describeAcceleratorAttributesRequest) throws AcceleratorNotFoundException, InternalServiceErrorException, InvalidArgumentException, AwsServiceException, SdkClientException, GlobalAcceleratorException
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 via DescribeAcceleratorAttributesRequest.builder()
describeAcceleratorAttributesRequest
- A Consumer
that will call methods on DescribeAcceleratorAttributesRequest.Builder
to
create a request.AcceleratorNotFoundException
- The accelerator that you specified doesn't exist.InternalServiceErrorException
- There was an internal error for AWS 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.AwsServiceException
default DescribeEndpointGroupResponse describeEndpointGroup(DescribeEndpointGroupRequest describeEndpointGroupRequest) throws EndpointGroupNotFoundException, InternalServiceErrorException, AwsServiceException, SdkClientException, GlobalAcceleratorException
Describe an endpoint group.
describeEndpointGroupRequest
- EndpointGroupNotFoundException
- The endpoint group that you specified doesn't exist.InternalServiceErrorException
- There was an internal error for AWS 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.AwsServiceException
default DescribeEndpointGroupResponse describeEndpointGroup(Consumer<DescribeEndpointGroupRequest.Builder> describeEndpointGroupRequest) throws EndpointGroupNotFoundException, InternalServiceErrorException, AwsServiceException, SdkClientException, GlobalAcceleratorException
Describe an endpoint group.
This is a convenience which creates an instance of the DescribeEndpointGroupRequest.Builder
avoiding the
need to create one manually via DescribeEndpointGroupRequest.builder()
describeEndpointGroupRequest
- A Consumer
that will call methods on DescribeEndpointGroupRequest.Builder
to create a
request.EndpointGroupNotFoundException
- The endpoint group that you specified doesn't exist.InternalServiceErrorException
- There was an internal error for AWS 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.AwsServiceException
default DescribeListenerResponse describeListener(DescribeListenerRequest describeListenerRequest) throws InvalidArgumentException, ListenerNotFoundException, InternalServiceErrorException, AwsServiceException, SdkClientException, GlobalAcceleratorException
Describe a listener.
describeListenerRequest
- InvalidArgumentException
- An argument that you specified is invalid.ListenerNotFoundException
- The listener that you specified doesn't exist.InternalServiceErrorException
- There was an internal error for AWS 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.AwsServiceException
default DescribeListenerResponse describeListener(Consumer<DescribeListenerRequest.Builder> describeListenerRequest) throws InvalidArgumentException, ListenerNotFoundException, InternalServiceErrorException, AwsServiceException, SdkClientException, GlobalAcceleratorException
Describe a listener.
This is a convenience which creates an instance of the DescribeListenerRequest.Builder
avoiding the need
to create one manually via DescribeListenerRequest.builder()
describeListenerRequest
- A Consumer
that will call methods on DescribeListenerRequest.Builder
to create a request.InvalidArgumentException
- An argument that you specified is invalid.ListenerNotFoundException
- The listener that you specified doesn't exist.InternalServiceErrorException
- There was an internal error for AWS 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.AwsServiceException
default ListAcceleratorsResponse listAccelerators() throws InvalidNextTokenException, InternalServiceErrorException, AwsServiceException, SdkClientException, GlobalAcceleratorException
List the accelerators for an AWS account.
InvalidNextTokenException
- There isn't another item to return.InternalServiceErrorException
- There was an internal error for AWS 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.AwsServiceException
listAccelerators(ListAcceleratorsRequest)
,
AWS API Documentationdefault ListAcceleratorsResponse listAccelerators(ListAcceleratorsRequest listAcceleratorsRequest) throws InvalidNextTokenException, InternalServiceErrorException, AwsServiceException, SdkClientException, GlobalAcceleratorException
List the accelerators for an AWS account.
listAcceleratorsRequest
- InvalidNextTokenException
- There isn't another item to return.InternalServiceErrorException
- There was an internal error for AWS 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.AwsServiceException
default ListAcceleratorsResponse listAccelerators(Consumer<ListAcceleratorsRequest.Builder> listAcceleratorsRequest) throws InvalidNextTokenException, InternalServiceErrorException, AwsServiceException, SdkClientException, GlobalAcceleratorException
List the accelerators for an AWS account.
This is a convenience which creates an instance of the ListAcceleratorsRequest.Builder
avoiding the need
to create one manually via ListAcceleratorsRequest.builder()
listAcceleratorsRequest
- A Consumer
that will call methods on ListAcceleratorsRequest.Builder
to create a request.InvalidNextTokenException
- There isn't another item to return.InternalServiceErrorException
- There was an internal error for AWS 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.AwsServiceException
default ListEndpointGroupsResponse listEndpointGroups(ListEndpointGroupsRequest listEndpointGroupsRequest) throws ListenerNotFoundException, InvalidNextTokenException, InvalidArgumentException, InternalServiceErrorException, AwsServiceException, SdkClientException, GlobalAcceleratorException
List the endpoint groups that are associated with a listener.
listEndpointGroupsRequest
- 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 AWS 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.AwsServiceException
default ListEndpointGroupsResponse listEndpointGroups(Consumer<ListEndpointGroupsRequest.Builder> listEndpointGroupsRequest) throws ListenerNotFoundException, InvalidNextTokenException, InvalidArgumentException, InternalServiceErrorException, AwsServiceException, SdkClientException, GlobalAcceleratorException
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 via ListEndpointGroupsRequest.builder()
listEndpointGroupsRequest
- A Consumer
that will call methods on ListEndpointGroupsRequest.Builder
to create a
request.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 AWS 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.AwsServiceException
default ListListenersResponse listListeners(ListListenersRequest listListenersRequest) throws AcceleratorNotFoundException, InvalidNextTokenException, InternalServiceErrorException, AwsServiceException, SdkClientException, GlobalAcceleratorException
List the listeners for an accelerator.
listListenersRequest
- AcceleratorNotFoundException
- The accelerator that you specified doesn't exist.InvalidNextTokenException
- There isn't another item to return.InternalServiceErrorException
- There was an internal error for AWS 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.AwsServiceException
default ListListenersResponse listListeners(Consumer<ListListenersRequest.Builder> listListenersRequest) throws AcceleratorNotFoundException, InvalidNextTokenException, InternalServiceErrorException, AwsServiceException, SdkClientException, GlobalAcceleratorException
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 via ListListenersRequest.builder()
listListenersRequest
- A Consumer
that will call methods on ListListenersRequest.Builder
to create a request.AcceleratorNotFoundException
- The accelerator that you specified doesn't exist.InvalidNextTokenException
- There isn't another item to return.InternalServiceErrorException
- There was an internal error for AWS 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.AwsServiceException
default UpdateAcceleratorResponse updateAccelerator(UpdateAcceleratorRequest updateAcceleratorRequest) throws AcceleratorNotFoundException, InternalServiceErrorException, InvalidArgumentException, AwsServiceException, SdkClientException, GlobalAcceleratorException
Update an accelerator.
updateAcceleratorRequest
- AcceleratorNotFoundException
- The accelerator that you specified doesn't exist.InternalServiceErrorException
- There was an internal error for AWS 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.AwsServiceException
default UpdateAcceleratorResponse updateAccelerator(Consumer<UpdateAcceleratorRequest.Builder> updateAcceleratorRequest) throws AcceleratorNotFoundException, InternalServiceErrorException, InvalidArgumentException, AwsServiceException, SdkClientException, GlobalAcceleratorException
Update an accelerator.
This is a convenience which creates an instance of the UpdateAcceleratorRequest.Builder
avoiding the need
to create one manually via UpdateAcceleratorRequest.builder()
updateAcceleratorRequest
- A Consumer
that will call methods on UpdateAcceleratorRequest.Builder
to create a request.AcceleratorNotFoundException
- The accelerator that you specified doesn't exist.InternalServiceErrorException
- There was an internal error for AWS 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.AwsServiceException
default UpdateAcceleratorAttributesResponse updateAcceleratorAttributes(UpdateAcceleratorAttributesRequest updateAcceleratorAttributesRequest) throws AcceleratorNotFoundException, InternalServiceErrorException, InvalidArgumentException, AwsServiceException, SdkClientException, GlobalAcceleratorException
Update the attributes for an accelerator. To see an AWS CLI example of updating an accelerator to enable flow logs, scroll down to Example.
updateAcceleratorAttributesRequest
- AcceleratorNotFoundException
- The accelerator that you specified doesn't exist.InternalServiceErrorException
- There was an internal error for AWS 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.AwsServiceException
default UpdateAcceleratorAttributesResponse updateAcceleratorAttributes(Consumer<UpdateAcceleratorAttributesRequest.Builder> updateAcceleratorAttributesRequest) throws AcceleratorNotFoundException, InternalServiceErrorException, InvalidArgumentException, AwsServiceException, SdkClientException, GlobalAcceleratorException
Update the attributes for an accelerator. To see an AWS CLI example of updating an accelerator to enable flow logs, scroll down to Example.
This is a convenience which creates an instance of the UpdateAcceleratorAttributesRequest.Builder
avoiding the need to create one manually via UpdateAcceleratorAttributesRequest.builder()
updateAcceleratorAttributesRequest
- A Consumer
that will call methods on UpdateAcceleratorAttributesRequest.Builder
to create
a request.AcceleratorNotFoundException
- The accelerator that you specified doesn't exist.InternalServiceErrorException
- There was an internal error for AWS 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.AwsServiceException
default UpdateEndpointGroupResponse updateEndpointGroup(UpdateEndpointGroupRequest updateEndpointGroupRequest) throws InvalidArgumentException, EndpointGroupNotFoundException, InternalServiceErrorException, LimitExceededException, AwsServiceException, SdkClientException, GlobalAcceleratorException
Update an endpoint group. To see an AWS CLI example of updating an endpoint group, scroll down to Example.
updateEndpointGroupRequest
- 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 AWS Global Accelerator.LimitExceededException
- Processing your request would cause you to exceed an AWS 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.AwsServiceException
default UpdateEndpointGroupResponse updateEndpointGroup(Consumer<UpdateEndpointGroupRequest.Builder> updateEndpointGroupRequest) throws InvalidArgumentException, EndpointGroupNotFoundException, InternalServiceErrorException, LimitExceededException, AwsServiceException, SdkClientException, GlobalAcceleratorException
Update an endpoint group. To see an AWS CLI example of updating an endpoint group, scroll down to Example.
This is a convenience which creates an instance of the UpdateEndpointGroupRequest.Builder
avoiding the
need to create one manually via UpdateEndpointGroupRequest.builder()
updateEndpointGroupRequest
- A Consumer
that will call methods on UpdateEndpointGroupRequest.Builder
to create a
request.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 AWS Global Accelerator.LimitExceededException
- Processing your request would cause you to exceed an AWS 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.AwsServiceException
default UpdateListenerResponse updateListener(UpdateListenerRequest updateListenerRequest) throws InvalidArgumentException, InvalidPortRangeException, ListenerNotFoundException, InternalServiceErrorException, LimitExceededException, AwsServiceException, SdkClientException, GlobalAcceleratorException
Update a listener.
updateListenerRequest
- 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 AWS Global Accelerator.LimitExceededException
- Processing your request would cause you to exceed an AWS 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.AwsServiceException
default UpdateListenerResponse updateListener(Consumer<UpdateListenerRequest.Builder> updateListenerRequest) throws InvalidArgumentException, InvalidPortRangeException, ListenerNotFoundException, InternalServiceErrorException, LimitExceededException, AwsServiceException, SdkClientException, GlobalAcceleratorException
Update a listener.
This is a convenience which creates an instance of the UpdateListenerRequest.Builder
avoiding the need to
create one manually via UpdateListenerRequest.builder()
updateListenerRequest
- A Consumer
that will call methods on UpdateListenerRequest.Builder
to create a request.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 AWS Global Accelerator.LimitExceededException
- Processing your request would cause you to exceed an AWS 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.AwsServiceException
static ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.