Interface EvsAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @SdkPublicApi @ThreadSafe public interface EvsAsyncClient extends AwsClient
Service client for accessing EVS asynchronously. This can be created using the static 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.

Amazon Elastic VMware Service (Amazon EVS) is a service that you can use to deploy a VMware Cloud Foundation (VCF) software environment directly on EC2 bare metal instances within an Amazon Virtual Private Cloud (VPC).

Workloads running on Amazon EVS are fully compatible with workloads running on any standard VMware vSphere environment. This means that you can migrate any VMware-based workload to Amazon EVS without workload modification.

  • Field Details

  • Method Details

    • associateEipToVlan

      default CompletableFuture<AssociateEipToVlanResponse> associateEipToVlan(AssociateEipToVlanRequest associateEipToVlanRequest)

      Associates an Elastic IP address with a public HCX VLAN. This operation is only allowed for public HCX VLANs at this time.

      Parameters:
      associateEipToVlanRequest -
      Returns:
      A Java Future containing the result of the AssociateEipToVlan 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 invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottlingException The operation couldn't be performed because the service is throttling requests. This exception is thrown when there are too many requests accepted concurrently from the service endpoint.
      • ValidationException The input fails to satisfy the specified constraints. You will see this exception if invalid inputs are provided for any of the Amazon EVS environment operations, or if a list operation is performed on an environment resource that is still initializing.
      • ResourceNotFoundException A service resource associated with the request could not be found. The resource might not be specified correctly, or it may have a state of DELETED.
      • 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.
      • EvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • associateEipToVlan

      default CompletableFuture<AssociateEipToVlanResponse> associateEipToVlan(Consumer<AssociateEipToVlanRequest.Builder> associateEipToVlanRequest)

      Associates an Elastic IP address with a public HCX VLAN. This operation is only allowed for public HCX VLANs at this time.


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

      Parameters:
      associateEipToVlanRequest - A Consumer that will call methods on AssociateEipToVlanRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AssociateEipToVlan 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 invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottlingException The operation couldn't be performed because the service is throttling requests. This exception is thrown when there are too many requests accepted concurrently from the service endpoint.
      • ValidationException The input fails to satisfy the specified constraints. You will see this exception if invalid inputs are provided for any of the Amazon EVS environment operations, or if a list operation is performed on an environment resource that is still initializing.
      • ResourceNotFoundException A service resource associated with the request could not be found. The resource might not be specified correctly, or it may have a state of DELETED.
      • 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.
      • EvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createEnvironment

      default CompletableFuture<CreateEnvironmentResponse> createEnvironment(CreateEnvironmentRequest createEnvironmentRequest)

      Creates an Amazon EVS environment that runs VCF software, such as SDDC Manager, NSX Manager, and vCenter Server.

      During environment creation, Amazon EVS performs validations on DNS settings, provisions VLAN subnets and hosts, and deploys the supplied version of VCF.

      It can take several hours to create an environment. After the deployment completes, you can configure VCF in the vSphere user interface according to your needs.

      You cannot use the dedicatedHostId and placementGroupId parameters together in the same CreateEnvironment action. This results in a ValidationException response.

      Parameters:
      createEnvironmentRequest -
      Returns:
      A Java Future containing the result of the CreateEnvironment 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 invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the specified constraints. You will see this exception if invalid inputs are provided for any of the Amazon EVS environment operations, or if a list operation is performed on an environment resource that is still initializing.
      • 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.
      • EvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createEnvironment

      default CompletableFuture<CreateEnvironmentResponse> createEnvironment(Consumer<CreateEnvironmentRequest.Builder> createEnvironmentRequest)

      Creates an Amazon EVS environment that runs VCF software, such as SDDC Manager, NSX Manager, and vCenter Server.

      During environment creation, Amazon EVS performs validations on DNS settings, provisions VLAN subnets and hosts, and deploys the supplied version of VCF.

      It can take several hours to create an environment. After the deployment completes, you can configure VCF in the vSphere user interface according to your needs.

      You cannot use the dedicatedHostId and placementGroupId parameters together in the same CreateEnvironment action. This results in a ValidationException response.


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

      Parameters:
      createEnvironmentRequest - A Consumer that will call methods on CreateEnvironmentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateEnvironment 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 invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the specified constraints. You will see this exception if invalid inputs are provided for any of the Amazon EVS environment operations, or if a list operation is performed on an environment resource that is still initializing.
      • 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.
      • EvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createEnvironmentHost

      default CompletableFuture<CreateEnvironmentHostResponse> createEnvironmentHost(CreateEnvironmentHostRequest createEnvironmentHostRequest)

      Creates an ESXi host and adds it to an Amazon EVS environment. Amazon EVS supports 4-16 hosts per environment.

      This action can only be used after the Amazon EVS environment is deployed.

      You can use the dedicatedHostId parameter to specify an Amazon EC2 Dedicated Host for ESXi host creation.

      You can use the placementGroupId parameter to specify a cluster or partition placement group to launch EC2 instances into.

      You cannot use the dedicatedHostId and placementGroupId parameters together in the same CreateEnvironmentHost action. This results in a ValidationException response.

      Parameters:
      createEnvironmentHostRequest -
      Returns:
      A Java Future containing the result of the CreateEnvironmentHost 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 invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottlingException The operation couldn't be performed because the service is throttling requests. This exception is thrown when there are too many requests accepted concurrently from the service endpoint.
      • ValidationException The input fails to satisfy the specified constraints. You will see this exception if invalid inputs are provided for any of the Amazon EVS environment operations, or if a list operation is performed on an environment resource that is still initializing.
      • 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.
      • EvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createEnvironmentHost

      default CompletableFuture<CreateEnvironmentHostResponse> createEnvironmentHost(Consumer<CreateEnvironmentHostRequest.Builder> createEnvironmentHostRequest)

      Creates an ESXi host and adds it to an Amazon EVS environment. Amazon EVS supports 4-16 hosts per environment.

      This action can only be used after the Amazon EVS environment is deployed.

      You can use the dedicatedHostId parameter to specify an Amazon EC2 Dedicated Host for ESXi host creation.

      You can use the placementGroupId parameter to specify a cluster or partition placement group to launch EC2 instances into.

      You cannot use the dedicatedHostId and placementGroupId parameters together in the same CreateEnvironmentHost action. This results in a ValidationException response.


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

      Parameters:
      createEnvironmentHostRequest - A Consumer that will call methods on CreateEnvironmentHostRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateEnvironmentHost 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 invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottlingException The operation couldn't be performed because the service is throttling requests. This exception is thrown when there are too many requests accepted concurrently from the service endpoint.
      • ValidationException The input fails to satisfy the specified constraints. You will see this exception if invalid inputs are provided for any of the Amazon EVS environment operations, or if a list operation is performed on an environment resource that is still initializing.
      • 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.
      • EvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteEnvironment

      default CompletableFuture<DeleteEnvironmentResponse> deleteEnvironment(DeleteEnvironmentRequest deleteEnvironmentRequest)

      Deletes an Amazon EVS environment.

      Amazon EVS environments will only be enabled for deletion once the hosts are deleted. You can delete hosts using the DeleteEnvironmentHost action.

      Environment deletion also deletes the associated Amazon EVS VLAN subnets and Amazon Web Services Secrets Manager secrets that Amazon EVS created. Amazon Web Services resources that you create are not deleted. These resources may continue to incur costs.

      Parameters:
      deleteEnvironmentRequest -
      Returns:
      A Java Future containing the result of the DeleteEnvironment 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 invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the specified constraints. You will see this exception if invalid inputs are provided for any of the Amazon EVS environment operations, or if a list operation is performed on an environment resource that is still initializing.
      • ResourceNotFoundException A service resource associated with the request could not be found. The resource might not be specified correctly, or it may have a state of DELETED.
      • 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.
      • EvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteEnvironment

      default CompletableFuture<DeleteEnvironmentResponse> deleteEnvironment(Consumer<DeleteEnvironmentRequest.Builder> deleteEnvironmentRequest)

      Deletes an Amazon EVS environment.

      Amazon EVS environments will only be enabled for deletion once the hosts are deleted. You can delete hosts using the DeleteEnvironmentHost action.

      Environment deletion also deletes the associated Amazon EVS VLAN subnets and Amazon Web Services Secrets Manager secrets that Amazon EVS created. Amazon Web Services resources that you create are not deleted. These resources may continue to incur costs.


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

      Parameters:
      deleteEnvironmentRequest - A Consumer that will call methods on DeleteEnvironmentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteEnvironment 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 invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the specified constraints. You will see this exception if invalid inputs are provided for any of the Amazon EVS environment operations, or if a list operation is performed on an environment resource that is still initializing.
      • ResourceNotFoundException A service resource associated with the request could not be found. The resource might not be specified correctly, or it may have a state of DELETED.
      • 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.
      • EvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteEnvironmentHost

      default CompletableFuture<DeleteEnvironmentHostResponse> deleteEnvironmentHost(DeleteEnvironmentHostRequest deleteEnvironmentHostRequest)

      Deletes a host from an Amazon EVS environment.

      Before deleting a host, you must unassign and decommission the host from within the SDDC Manager user interface. Not doing so could impact the availability of your virtual machines or result in data loss.

      Parameters:
      deleteEnvironmentHostRequest -
      Returns:
      A Java Future containing the result of the DeleteEnvironmentHost 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 invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the specified constraints. You will see this exception if invalid inputs are provided for any of the Amazon EVS environment operations, or if a list operation is performed on an environment resource that is still initializing.
      • ResourceNotFoundException A service resource associated with the request could not be found. The resource might not be specified correctly, or it may have a state of DELETED.
      • 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.
      • EvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteEnvironmentHost

      default CompletableFuture<DeleteEnvironmentHostResponse> deleteEnvironmentHost(Consumer<DeleteEnvironmentHostRequest.Builder> deleteEnvironmentHostRequest)

      Deletes a host from an Amazon EVS environment.

      Before deleting a host, you must unassign and decommission the host from within the SDDC Manager user interface. Not doing so could impact the availability of your virtual machines or result in data loss.


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

      Parameters:
      deleteEnvironmentHostRequest - A Consumer that will call methods on DeleteEnvironmentHostRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteEnvironmentHost 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 invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the specified constraints. You will see this exception if invalid inputs are provided for any of the Amazon EVS environment operations, or if a list operation is performed on an environment resource that is still initializing.
      • ResourceNotFoundException A service resource associated with the request could not be found. The resource might not be specified correctly, or it may have a state of DELETED.
      • 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.
      • EvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociateEipFromVlan

      default CompletableFuture<DisassociateEipFromVlanResponse> disassociateEipFromVlan(DisassociateEipFromVlanRequest disassociateEipFromVlanRequest)

      Disassociates an Elastic IP address from a public HCX VLAN. This operation is only allowed for public HCX VLANs at this time.

      Parameters:
      disassociateEipFromVlanRequest -
      Returns:
      A Java Future containing the result of the DisassociateEipFromVlan 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 invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottlingException The operation couldn't be performed because the service is throttling requests. This exception is thrown when there are too many requests accepted concurrently from the service endpoint.
      • ValidationException The input fails to satisfy the specified constraints. You will see this exception if invalid inputs are provided for any of the Amazon EVS environment operations, or if a list operation is performed on an environment resource that is still initializing.
      • ResourceNotFoundException A service resource associated with the request could not be found. The resource might not be specified correctly, or it may have a state of DELETED.
      • 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.
      • EvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociateEipFromVlan

      default CompletableFuture<DisassociateEipFromVlanResponse> disassociateEipFromVlan(Consumer<DisassociateEipFromVlanRequest.Builder> disassociateEipFromVlanRequest)

      Disassociates an Elastic IP address from a public HCX VLAN. This operation is only allowed for public HCX VLANs at this time.


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

      Parameters:
      disassociateEipFromVlanRequest - A Consumer that will call methods on DisassociateEipFromVlanRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DisassociateEipFromVlan 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 invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottlingException The operation couldn't be performed because the service is throttling requests. This exception is thrown when there are too many requests accepted concurrently from the service endpoint.
      • ValidationException The input fails to satisfy the specified constraints. You will see this exception if invalid inputs are provided for any of the Amazon EVS environment operations, or if a list operation is performed on an environment resource that is still initializing.
      • ResourceNotFoundException A service resource associated with the request could not be found. The resource might not be specified correctly, or it may have a state of DELETED.
      • 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.
      • EvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getEnvironment

      default CompletableFuture<GetEnvironmentResponse> getEnvironment(GetEnvironmentRequest getEnvironmentRequest)

      Returns a description of the specified environment.

      Parameters:
      getEnvironmentRequest -
      Returns:
      A Java Future containing the result of the GetEnvironment 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 invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the specified constraints. You will see this exception if invalid inputs are provided for any of the Amazon EVS environment operations, or if a list operation is performed on an environment resource that is still initializing.
      • ResourceNotFoundException A service resource associated with the request could not be found. The resource might not be specified correctly, or it may have a state of DELETED.
      • 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.
      • EvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getEnvironment

      default CompletableFuture<GetEnvironmentResponse> getEnvironment(Consumer<GetEnvironmentRequest.Builder> getEnvironmentRequest)

      Returns a description of the specified environment.


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

      Parameters:
      getEnvironmentRequest - A Consumer that will call methods on GetEnvironmentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetEnvironment 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 invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the specified constraints. You will see this exception if invalid inputs are provided for any of the Amazon EVS environment operations, or if a list operation is performed on an environment resource that is still initializing.
      • ResourceNotFoundException A service resource associated with the request could not be found. The resource might not be specified correctly, or it may have a state of DELETED.
      • 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.
      • EvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEnvironmentHosts

      default CompletableFuture<ListEnvironmentHostsResponse> listEnvironmentHosts(ListEnvironmentHostsRequest listEnvironmentHostsRequest)

      List the hosts within an environment.

      Parameters:
      listEnvironmentHostsRequest -
      Returns:
      A Java Future containing the result of the ListEnvironmentHosts 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 invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the specified constraints. You will see this exception if invalid inputs are provided for any of the Amazon EVS environment operations, or if a list operation is performed on an environment resource that is still initializing.
      • ResourceNotFoundException A service resource associated with the request could not be found. The resource might not be specified correctly, or it may have a state of DELETED.
      • 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.
      • EvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEnvironmentHosts

      default CompletableFuture<ListEnvironmentHostsResponse> listEnvironmentHosts(Consumer<ListEnvironmentHostsRequest.Builder> listEnvironmentHostsRequest)

      List the hosts within an environment.


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

      Parameters:
      listEnvironmentHostsRequest - A Consumer that will call methods on ListEnvironmentHostsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListEnvironmentHosts 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 invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the specified constraints. You will see this exception if invalid inputs are provided for any of the Amazon EVS environment operations, or if a list operation is performed on an environment resource that is still initializing.
      • ResourceNotFoundException A service resource associated with the request could not be found. The resource might not be specified correctly, or it may have a state of DELETED.
      • 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.
      • EvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEnvironmentHostsPaginator

      default ListEnvironmentHostsPublisher listEnvironmentHostsPaginator(ListEnvironmentHostsRequest listEnvironmentHostsRequest)

      This is a variant of listEnvironmentHosts(software.amazon.awssdk.services.evs.model.ListEnvironmentHostsRequest) 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 new Subscription 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 method 
       
 software.amazon.awssdk.services.evs.paginators.ListEnvironmentHostsPublisher publisher = client.listEnvironmentHostsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.evs.paginators.ListEnvironmentHostsPublisher publisher = client.listEnvironmentHostsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.evs.model.ListEnvironmentHostsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.evs.model.ListEnvironmentHostsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 listEnvironmentHosts(software.amazon.awssdk.services.evs.model.ListEnvironmentHostsRequest) operation.

      Parameters:
      listEnvironmentHostsRequest -
      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 invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the specified constraints. You will see this exception if invalid inputs are provided for any of the Amazon EVS environment operations, or if a list operation is performed on an environment resource that is still initializing.
      • ResourceNotFoundException A service resource associated with the request could not be found. The resource might not be specified correctly, or it may have a state of DELETED.
      • 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.
      • EvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEnvironmentHostsPaginator

      default ListEnvironmentHostsPublisher listEnvironmentHostsPaginator(Consumer<ListEnvironmentHostsRequest.Builder> listEnvironmentHostsRequest)

      This is a variant of listEnvironmentHosts(software.amazon.awssdk.services.evs.model.ListEnvironmentHostsRequest) 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 new Subscription 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 method 
       
 software.amazon.awssdk.services.evs.paginators.ListEnvironmentHostsPublisher publisher = client.listEnvironmentHostsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.evs.paginators.ListEnvironmentHostsPublisher publisher = client.listEnvironmentHostsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.evs.model.ListEnvironmentHostsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.evs.model.ListEnvironmentHostsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 listEnvironmentHosts(software.amazon.awssdk.services.evs.model.ListEnvironmentHostsRequest) operation.


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

      Parameters:
      listEnvironmentHostsRequest - A Consumer that will call methods on ListEnvironmentHostsRequest.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 invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the specified constraints. You will see this exception if invalid inputs are provided for any of the Amazon EVS environment operations, or if a list operation is performed on an environment resource that is still initializing.
      • ResourceNotFoundException A service resource associated with the request could not be found. The resource might not be specified correctly, or it may have a state of DELETED.
      • 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.
      • EvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEnvironmentVlans

      default CompletableFuture<ListEnvironmentVlansResponse> listEnvironmentVlans(ListEnvironmentVlansRequest listEnvironmentVlansRequest)

      Lists environment VLANs that are associated with the specified environment.

      Parameters:
      listEnvironmentVlansRequest -
      Returns:
      A Java Future containing the result of the ListEnvironmentVlans 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 invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the specified constraints. You will see this exception if invalid inputs are provided for any of the Amazon EVS environment operations, or if a list operation is performed on an environment resource that is still initializing.
      • ResourceNotFoundException A service resource associated with the request could not be found. The resource might not be specified correctly, or it may have a state of DELETED.
      • 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.
      • EvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEnvironmentVlans

      default CompletableFuture<ListEnvironmentVlansResponse> listEnvironmentVlans(Consumer<ListEnvironmentVlansRequest.Builder> listEnvironmentVlansRequest)

      Lists environment VLANs that are associated with the specified environment.


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

      Parameters:
      listEnvironmentVlansRequest - A Consumer that will call methods on ListEnvironmentVlansRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListEnvironmentVlans 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 invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the specified constraints. You will see this exception if invalid inputs are provided for any of the Amazon EVS environment operations, or if a list operation is performed on an environment resource that is still initializing.
      • ResourceNotFoundException A service resource associated with the request could not be found. The resource might not be specified correctly, or it may have a state of DELETED.
      • 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.
      • EvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEnvironmentVlansPaginator

      default ListEnvironmentVlansPublisher listEnvironmentVlansPaginator(ListEnvironmentVlansRequest listEnvironmentVlansRequest)

      This is a variant of listEnvironmentVlans(software.amazon.awssdk.services.evs.model.ListEnvironmentVlansRequest) 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 new Subscription 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 method 
       
 software.amazon.awssdk.services.evs.paginators.ListEnvironmentVlansPublisher publisher = client.listEnvironmentVlansPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.evs.paginators.ListEnvironmentVlansPublisher publisher = client.listEnvironmentVlansPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.evs.model.ListEnvironmentVlansResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.evs.model.ListEnvironmentVlansResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 listEnvironmentVlans(software.amazon.awssdk.services.evs.model.ListEnvironmentVlansRequest) operation.

      Parameters:
      listEnvironmentVlansRequest -
      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 invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the specified constraints. You will see this exception if invalid inputs are provided for any of the Amazon EVS environment operations, or if a list operation is performed on an environment resource that is still initializing.
      • ResourceNotFoundException A service resource associated with the request could not be found. The resource might not be specified correctly, or it may have a state of DELETED.
      • 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.
      • EvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEnvironmentVlansPaginator

      default ListEnvironmentVlansPublisher listEnvironmentVlansPaginator(Consumer<ListEnvironmentVlansRequest.Builder> listEnvironmentVlansRequest)

      This is a variant of listEnvironmentVlans(software.amazon.awssdk.services.evs.model.ListEnvironmentVlansRequest) 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 new Subscription 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 method 
       
 software.amazon.awssdk.services.evs.paginators.ListEnvironmentVlansPublisher publisher = client.listEnvironmentVlansPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.evs.paginators.ListEnvironmentVlansPublisher publisher = client.listEnvironmentVlansPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.evs.model.ListEnvironmentVlansResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.evs.model.ListEnvironmentVlansResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 listEnvironmentVlans(software.amazon.awssdk.services.evs.model.ListEnvironmentVlansRequest) operation.


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

      Parameters:
      listEnvironmentVlansRequest - A Consumer that will call methods on ListEnvironmentVlansRequest.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 invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the specified constraints. You will see this exception if invalid inputs are provided for any of the Amazon EVS environment operations, or if a list operation is performed on an environment resource that is still initializing.
      • ResourceNotFoundException A service resource associated with the request could not be found. The resource might not be specified correctly, or it may have a state of DELETED.
      • 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.
      • EvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEnvironments

      default CompletableFuture<ListEnvironmentsResponse> listEnvironments(ListEnvironmentsRequest listEnvironmentsRequest)

      Lists the Amazon EVS environments in your Amazon Web Services account in the specified Amazon Web Services Region.

      Parameters:
      listEnvironmentsRequest -
      Returns:
      A Java Future containing the result of the ListEnvironments 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 invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the specified constraints. You will see this exception if invalid inputs are provided for any of the Amazon EVS environment operations, or if a list operation is performed on an environment resource that is still initializing.
      • 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.
      • EvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEnvironments

      default CompletableFuture<ListEnvironmentsResponse> listEnvironments(Consumer<ListEnvironmentsRequest.Builder> listEnvironmentsRequest)

      Lists the Amazon EVS environments in your Amazon Web Services account in the specified Amazon Web Services Region.


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

      Parameters:
      listEnvironmentsRequest - A Consumer that will call methods on ListEnvironmentsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListEnvironments 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 invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the specified constraints. You will see this exception if invalid inputs are provided for any of the Amazon EVS environment operations, or if a list operation is performed on an environment resource that is still initializing.
      • 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.
      • EvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEnvironmentsPaginator

      default ListEnvironmentsPublisher listEnvironmentsPaginator(ListEnvironmentsRequest listEnvironmentsRequest)

      This is a variant of listEnvironments(software.amazon.awssdk.services.evs.model.ListEnvironmentsRequest) 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 new Subscription 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 method 
       
 software.amazon.awssdk.services.evs.paginators.ListEnvironmentsPublisher publisher = client.listEnvironmentsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.evs.paginators.ListEnvironmentsPublisher publisher = client.listEnvironmentsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.evs.model.ListEnvironmentsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.evs.model.ListEnvironmentsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 listEnvironments(software.amazon.awssdk.services.evs.model.ListEnvironmentsRequest) operation.

      Parameters:
      listEnvironmentsRequest -
      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 invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the specified constraints. You will see this exception if invalid inputs are provided for any of the Amazon EVS environment operations, or if a list operation is performed on an environment resource that is still initializing.
      • 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.
      • EvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEnvironmentsPaginator

      default ListEnvironmentsPublisher listEnvironmentsPaginator(Consumer<ListEnvironmentsRequest.Builder> listEnvironmentsRequest)

      This is a variant of listEnvironments(software.amazon.awssdk.services.evs.model.ListEnvironmentsRequest) 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 new Subscription 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 method 
       
 software.amazon.awssdk.services.evs.paginators.ListEnvironmentsPublisher publisher = client.listEnvironmentsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.evs.paginators.ListEnvironmentsPublisher publisher = client.listEnvironmentsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.evs.model.ListEnvironmentsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.evs.model.ListEnvironmentsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 listEnvironments(software.amazon.awssdk.services.evs.model.ListEnvironmentsRequest) operation.


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

      Parameters:
      listEnvironmentsRequest - A Consumer that will call methods on ListEnvironmentsRequest.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 invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the specified constraints. You will see this exception if invalid inputs are provided for any of the Amazon EVS environment operations, or if a list operation is performed on an environment resource that is still initializing.
      • 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.
      • EvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

      Lists the tags for an Amazon EVS resource.

      Parameters:
      listTagsForResourceRequest -
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException A service resource associated with the request could not be found. The resource might not be specified correctly, or it may have a state of DELETED.
      • 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.
      • EvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)

      Lists the tags for an Amazon EVS resource.


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

      Parameters:
      listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.
      Returns:
      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 invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException A service resource associated with the request could not be found. The resource might not be specified correctly, or it may have a state of DELETED.
      • 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.
      • EvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)

      Associates the specified tags to an Amazon EVS resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they aren't changed. When a resource is deleted, the tags associated with that resource are also deleted. Tags that you create for Amazon EVS resources don't propagate to any other resources associated with the environment. For example, if you tag an environment with this operation, that tag doesn't automatically propagate to the VLAN subnets and hosts associated with the environment.

      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 invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceQuotaExceededException The number of one or more Amazon EVS resources exceeds the maximum allowed. For a list of Amazon EVS quotas, see Amazon EVS endpoints and quotas in the Amazon EVS User Guide. Delete some resources or request an increase in your service quota. To request an increase, see Amazon Web Services Service Quotas in the Amazon Web Services General Reference Guide.
      • ResourceNotFoundException A service resource associated with the request could not be found. The resource might not be specified correctly, or it may have a state of DELETED.
      • TooManyTagsException

        TooManyTagsException is deprecated. See ServiceQuotaExceededException instead.

        A service resource associated with the request has more than 200 tags.

      • TagPolicyException

        TagPolicyException is deprecated. See ValidationException instead.

        The request doesn't comply with IAM tag policy. Correct your request and then retry it.

      • 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.
      • EvsException 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)

      Associates the specified tags to an Amazon EVS resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they aren't changed. When a resource is deleted, the tags associated with that resource are also deleted. Tags that you create for Amazon EVS resources don't propagate to any other resources associated with the environment. For example, if you tag an environment with this operation, that tag doesn't automatically propagate to the VLAN subnets and hosts associated with the environment.


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

      Parameters:
      tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.
      Returns:
      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 invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceQuotaExceededException The number of one or more Amazon EVS resources exceeds the maximum allowed. For a list of Amazon EVS quotas, see Amazon EVS endpoints and quotas in the Amazon EVS User Guide. Delete some resources or request an increase in your service quota. To request an increase, see Amazon Web Services Service Quotas in the Amazon Web Services General Reference Guide.
      • ResourceNotFoundException A service resource associated with the request could not be found. The resource might not be specified correctly, or it may have a state of DELETED.
      • TooManyTagsException

        TooManyTagsException is deprecated. See ServiceQuotaExceededException instead.

        A service resource associated with the request has more than 200 tags.

      • TagPolicyException

        TagPolicyException is deprecated. See ValidationException instead.

        The request doesn't comply with IAM tag policy. Correct your request and then retry it.

      • 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.
      • EvsException 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)

      Deletes specified tags from an Amazon EVS resource.

      Parameters:
      untagResourceRequest -
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException A service resource associated with the request could not be found. The resource might not be specified correctly, or it may have a state of DELETED.
      • TagPolicyException

        TagPolicyException is deprecated. See ValidationException instead.

        The request doesn't comply with IAM tag policy. Correct your request and then retry it.

      • 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.
      • EvsException 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)

      Deletes specified tags from an Amazon EVS resource.


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

      Parameters:
      untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.
      Returns:
      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 invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException A service resource associated with the request could not be found. The resource might not be specified correctly, or it may have a state of DELETED.
      • TagPolicyException

        TagPolicyException is deprecated. See ValidationException instead.

        The request doesn't comply with IAM tag policy. Correct your request and then retry it.

      • 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.
      • EvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

      default EvsServiceClientConfiguration serviceClientConfiguration()
      Description copied from interface: SdkClient
      The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
      Specified by:
      serviceClientConfiguration in interface AwsClient
      Specified by:
      serviceClientConfiguration in interface SdkClient
      Returns:
      SdkServiceClientConfiguration

    • create

      static EvsAsyncClient create()
      Create a EvsAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static EvsAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a EvsAsyncClient.