Interface PartnerCentralBenefitsAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @SdkPublicApi @ThreadSafe public interface PartnerCentralBenefitsAsyncClient extends AwsClient
Service client for accessing PartnerCentral Benefits 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.

AWS Partner Central Benefits Service provides APIs for managing partner benefits, applications, and allocations within the AWS Partner Network ecosystem.

  • Field Details

  • Method Details

    • amendBenefitApplication

      default CompletableFuture<AmendBenefitApplicationResponse> amendBenefitApplication(AmendBenefitApplicationRequest amendBenefitApplicationRequest)

      Modifies an existing benefit application by applying amendments to specific fields while maintaining revision control.

      Parameters:
      amendBenefitApplicationRequest -
      Returns:
      A Java Future containing the result of the AmendBenefitApplication 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 Thrown when the request contains invalid parameters or fails input validation requirements.
      • AccessDeniedException Thrown when the caller does not have sufficient permissions to perform the requested operation.
      • InternalServerException Thrown when an unexpected error occurs on the server side during request processing.
      • ConflictException Thrown when the request conflicts with the current state of the resource, such as attempting to modify a resource that has been changed by another process.
      • ThrottlingException Thrown when the request rate exceeds the allowed limits and the request is being throttled.
      • ResourceNotFoundException Thrown when the requested resource cannot be found or does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PartnerCentralBenefitsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • amendBenefitApplication

      default CompletableFuture<AmendBenefitApplicationResponse> amendBenefitApplication(Consumer<AmendBenefitApplicationRequest.Builder> amendBenefitApplicationRequest)

      Modifies an existing benefit application by applying amendments to specific fields while maintaining revision control.


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

      Parameters:
      amendBenefitApplicationRequest - A Consumer that will call methods on AmendBenefitApplicationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AmendBenefitApplication 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 Thrown when the request contains invalid parameters or fails input validation requirements.
      • AccessDeniedException Thrown when the caller does not have sufficient permissions to perform the requested operation.
      • InternalServerException Thrown when an unexpected error occurs on the server side during request processing.
      • ConflictException Thrown when the request conflicts with the current state of the resource, such as attempting to modify a resource that has been changed by another process.
      • ThrottlingException Thrown when the request rate exceeds the allowed limits and the request is being throttled.
      • ResourceNotFoundException Thrown when the requested resource cannot be found or does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PartnerCentralBenefitsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • associateBenefitApplicationResource

      default CompletableFuture<AssociateBenefitApplicationResourceResponse> associateBenefitApplicationResource(AssociateBenefitApplicationResourceRequest associateBenefitApplicationResourceRequest)

      Links an AWS resource to an existing benefit application for tracking and management purposes.

      Parameters:
      associateBenefitApplicationResourceRequest -
      Returns:
      A Java Future containing the result of the AssociateBenefitApplicationResource 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 Thrown when the request contains invalid parameters or fails input validation requirements.
      • AccessDeniedException Thrown when the caller does not have sufficient permissions to perform the requested operation.
      • InternalServerException Thrown when an unexpected error occurs on the server side during request processing.
      • ConflictException Thrown when the request conflicts with the current state of the resource, such as attempting to modify a resource that has been changed by another process.
      • ThrottlingException Thrown when the request rate exceeds the allowed limits and the request is being throttled.
      • ResourceNotFoundException Thrown when the requested resource cannot be found or does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PartnerCentralBenefitsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • associateBenefitApplicationResource

      default CompletableFuture<AssociateBenefitApplicationResourceResponse> associateBenefitApplicationResource(Consumer<AssociateBenefitApplicationResourceRequest.Builder> associateBenefitApplicationResourceRequest)

      Links an AWS resource to an existing benefit application for tracking and management purposes.


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

      Parameters:
      associateBenefitApplicationResourceRequest - A Consumer that will call methods on AssociateBenefitApplicationResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AssociateBenefitApplicationResource 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 Thrown when the request contains invalid parameters or fails input validation requirements.
      • AccessDeniedException Thrown when the caller does not have sufficient permissions to perform the requested operation.
      • InternalServerException Thrown when an unexpected error occurs on the server side during request processing.
      • ConflictException Thrown when the request conflicts with the current state of the resource, such as attempting to modify a resource that has been changed by another process.
      • ThrottlingException Thrown when the request rate exceeds the allowed limits and the request is being throttled.
      • ResourceNotFoundException Thrown when the requested resource cannot be found or does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PartnerCentralBenefitsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • cancelBenefitApplication

      default CompletableFuture<CancelBenefitApplicationResponse> cancelBenefitApplication(CancelBenefitApplicationRequest cancelBenefitApplicationRequest)

      Cancels a benefit application that is currently in progress, preventing further processing.

      Parameters:
      cancelBenefitApplicationRequest -
      Returns:
      A Java Future containing the result of the CancelBenefitApplication 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 Thrown when the request contains invalid parameters or fails input validation requirements.
      • AccessDeniedException Thrown when the caller does not have sufficient permissions to perform the requested operation.
      • InternalServerException Thrown when an unexpected error occurs on the server side during request processing.
      • ConflictException Thrown when the request conflicts with the current state of the resource, such as attempting to modify a resource that has been changed by another process.
      • ResourceNotFoundException Thrown when the requested resource cannot be found or does not exist.
      • ThrottlingException Thrown when the request rate exceeds the allowed limits and the request is being throttled.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PartnerCentralBenefitsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • cancelBenefitApplication

      default CompletableFuture<CancelBenefitApplicationResponse> cancelBenefitApplication(Consumer<CancelBenefitApplicationRequest.Builder> cancelBenefitApplicationRequest)

      Cancels a benefit application that is currently in progress, preventing further processing.


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

      Parameters:
      cancelBenefitApplicationRequest - A Consumer that will call methods on CancelBenefitApplicationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CancelBenefitApplication 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 Thrown when the request contains invalid parameters or fails input validation requirements.
      • AccessDeniedException Thrown when the caller does not have sufficient permissions to perform the requested operation.
      • InternalServerException Thrown when an unexpected error occurs on the server side during request processing.
      • ConflictException Thrown when the request conflicts with the current state of the resource, such as attempting to modify a resource that has been changed by another process.
      • ResourceNotFoundException Thrown when the requested resource cannot be found or does not exist.
      • ThrottlingException Thrown when the request rate exceeds the allowed limits and the request is being throttled.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PartnerCentralBenefitsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createBenefitApplication

      default CompletableFuture<CreateBenefitApplicationResponse> createBenefitApplication(CreateBenefitApplicationRequest createBenefitApplicationRequest)

      Creates a new benefit application for a partner to request access to AWS benefits and programs.

      Parameters:
      createBenefitApplicationRequest -
      Returns:
      A Java Future containing the result of the CreateBenefitApplication 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 Thrown when the request contains invalid parameters or fails input validation requirements.
      • AccessDeniedException Thrown when the caller does not have sufficient permissions to perform the requested operation.
      • InternalServerException Thrown when an unexpected error occurs on the server side during request processing.
      • ConflictException Thrown when the request conflicts with the current state of the resource, such as attempting to modify a resource that has been changed by another process.
      • ThrottlingException Thrown when the request rate exceeds the allowed limits and the request is being throttled.
      • ResourceNotFoundException Thrown when the requested resource cannot be found or does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PartnerCentralBenefitsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createBenefitApplication

      default CompletableFuture<CreateBenefitApplicationResponse> createBenefitApplication(Consumer<CreateBenefitApplicationRequest.Builder> createBenefitApplicationRequest)

      Creates a new benefit application for a partner to request access to AWS benefits and programs.


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

      Parameters:
      createBenefitApplicationRequest - A Consumer that will call methods on CreateBenefitApplicationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateBenefitApplication 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 Thrown when the request contains invalid parameters or fails input validation requirements.
      • AccessDeniedException Thrown when the caller does not have sufficient permissions to perform the requested operation.
      • InternalServerException Thrown when an unexpected error occurs on the server side during request processing.
      • ConflictException Thrown when the request conflicts with the current state of the resource, such as attempting to modify a resource that has been changed by another process.
      • ThrottlingException Thrown when the request rate exceeds the allowed limits and the request is being throttled.
      • ResourceNotFoundException Thrown when the requested resource cannot be found or does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PartnerCentralBenefitsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociateBenefitApplicationResource

      default CompletableFuture<DisassociateBenefitApplicationResourceResponse> disassociateBenefitApplicationResource(DisassociateBenefitApplicationResourceRequest disassociateBenefitApplicationResourceRequest)

      Removes the association between an AWS resource and a benefit application.

      Parameters:
      disassociateBenefitApplicationResourceRequest -
      Returns:
      A Java Future containing the result of the DisassociateBenefitApplicationResource 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 Thrown when the request contains invalid parameters or fails input validation requirements.
      • AccessDeniedException Thrown when the caller does not have sufficient permissions to perform the requested operation.
      • InternalServerException Thrown when an unexpected error occurs on the server side during request processing.
      • ConflictException Thrown when the request conflicts with the current state of the resource, such as attempting to modify a resource that has been changed by another process.
      • ThrottlingException Thrown when the request rate exceeds the allowed limits and the request is being throttled.
      • ResourceNotFoundException Thrown when the requested resource cannot be found or does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PartnerCentralBenefitsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociateBenefitApplicationResource

      default CompletableFuture<DisassociateBenefitApplicationResourceResponse> disassociateBenefitApplicationResource(Consumer<DisassociateBenefitApplicationResourceRequest.Builder> disassociateBenefitApplicationResourceRequest)

      Removes the association between an AWS resource and a benefit application.


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

      Parameters:
      disassociateBenefitApplicationResourceRequest - A Consumer that will call methods on DisassociateBenefitApplicationResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DisassociateBenefitApplicationResource 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 Thrown when the request contains invalid parameters or fails input validation requirements.
      • AccessDeniedException Thrown when the caller does not have sufficient permissions to perform the requested operation.
      • InternalServerException Thrown when an unexpected error occurs on the server side during request processing.
      • ConflictException Thrown when the request conflicts with the current state of the resource, such as attempting to modify a resource that has been changed by another process.
      • ThrottlingException Thrown when the request rate exceeds the allowed limits and the request is being throttled.
      • ResourceNotFoundException Thrown when the requested resource cannot be found or does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PartnerCentralBenefitsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getBenefit

      default CompletableFuture<GetBenefitResponse> getBenefit(GetBenefitRequest getBenefitRequest)

      Retrieves detailed information about a specific benefit available in the partner catalog.

      Parameters:
      getBenefitRequest -
      Returns:
      A Java Future containing the result of the GetBenefit 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 Thrown when the request contains invalid parameters or fails input validation requirements.
      • AccessDeniedException Thrown when the caller does not have sufficient permissions to perform the requested operation.
      • InternalServerException Thrown when an unexpected error occurs on the server side during request processing.
      • ThrottlingException Thrown when the request rate exceeds the allowed limits and the request is being throttled.
      • ResourceNotFoundException Thrown when the requested resource cannot be found or does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PartnerCentralBenefitsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getBenefit

      default CompletableFuture<GetBenefitResponse> getBenefit(Consumer<GetBenefitRequest.Builder> getBenefitRequest)

      Retrieves detailed information about a specific benefit available in the partner catalog.


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

      Parameters:
      getBenefitRequest - A Consumer that will call methods on GetBenefitRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetBenefit 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 Thrown when the request contains invalid parameters or fails input validation requirements.
      • AccessDeniedException Thrown when the caller does not have sufficient permissions to perform the requested operation.
      • InternalServerException Thrown when an unexpected error occurs on the server side during request processing.
      • ThrottlingException Thrown when the request rate exceeds the allowed limits and the request is being throttled.
      • ResourceNotFoundException Thrown when the requested resource cannot be found or does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PartnerCentralBenefitsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getBenefitAllocation

      default CompletableFuture<GetBenefitAllocationResponse> getBenefitAllocation(GetBenefitAllocationRequest getBenefitAllocationRequest)

      Retrieves detailed information about a specific benefit allocation that has been granted to a partner.

      Parameters:
      getBenefitAllocationRequest -
      Returns:
      A Java Future containing the result of the GetBenefitAllocation 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.
      • AccessDeniedException Thrown when the caller does not have sufficient permissions to perform the requested operation.
      • ValidationException Thrown when the request contains invalid parameters or fails input validation requirements.
      • InternalServerException Thrown when an unexpected error occurs on the server side during request processing.
      • ResourceNotFoundException Thrown when the requested resource cannot be found or does not exist.
      • ThrottlingException Thrown when the request rate exceeds the allowed limits and the request is being throttled.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PartnerCentralBenefitsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getBenefitAllocation

      default CompletableFuture<GetBenefitAllocationResponse> getBenefitAllocation(Consumer<GetBenefitAllocationRequest.Builder> getBenefitAllocationRequest)

      Retrieves detailed information about a specific benefit allocation that has been granted to a partner.


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

      Parameters:
      getBenefitAllocationRequest - A Consumer that will call methods on GetBenefitAllocationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetBenefitAllocation 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.
      • AccessDeniedException Thrown when the caller does not have sufficient permissions to perform the requested operation.
      • ValidationException Thrown when the request contains invalid parameters or fails input validation requirements.
      • InternalServerException Thrown when an unexpected error occurs on the server side during request processing.
      • ResourceNotFoundException Thrown when the requested resource cannot be found or does not exist.
      • ThrottlingException Thrown when the request rate exceeds the allowed limits and the request is being throttled.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PartnerCentralBenefitsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getBenefitApplication

      default CompletableFuture<GetBenefitApplicationResponse> getBenefitApplication(GetBenefitApplicationRequest getBenefitApplicationRequest)

      Retrieves detailed information about a specific benefit application.

      Parameters:
      getBenefitApplicationRequest -
      Returns:
      A Java Future containing the result of the GetBenefitApplication 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 Thrown when the request contains invalid parameters or fails input validation requirements.
      • AccessDeniedException Thrown when the caller does not have sufficient permissions to perform the requested operation.
      • InternalServerException Thrown when an unexpected error occurs on the server side during request processing.
      • ConflictException Thrown when the request conflicts with the current state of the resource, such as attempting to modify a resource that has been changed by another process.
      • ResourceNotFoundException Thrown when the requested resource cannot be found or does not exist.
      • ThrottlingException Thrown when the request rate exceeds the allowed limits and the request is being throttled.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PartnerCentralBenefitsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getBenefitApplication

      default CompletableFuture<GetBenefitApplicationResponse> getBenefitApplication(Consumer<GetBenefitApplicationRequest.Builder> getBenefitApplicationRequest)

      Retrieves detailed information about a specific benefit application.


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

      Parameters:
      getBenefitApplicationRequest - A Consumer that will call methods on GetBenefitApplicationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetBenefitApplication 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 Thrown when the request contains invalid parameters or fails input validation requirements.
      • AccessDeniedException Thrown when the caller does not have sufficient permissions to perform the requested operation.
      • InternalServerException Thrown when an unexpected error occurs on the server side during request processing.
      • ConflictException Thrown when the request conflicts with the current state of the resource, such as attempting to modify a resource that has been changed by another process.
      • ResourceNotFoundException Thrown when the requested resource cannot be found or does not exist.
      • ThrottlingException Thrown when the request rate exceeds the allowed limits and the request is being throttled.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PartnerCentralBenefitsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listBenefitAllocations

      default CompletableFuture<ListBenefitAllocationsResponse> listBenefitAllocations(ListBenefitAllocationsRequest listBenefitAllocationsRequest)

      Retrieves a paginated list of benefit allocations based on specified filter criteria.

      Parameters:
      listBenefitAllocationsRequest -
      Returns:
      A Java Future containing the result of the ListBenefitAllocations 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.
      • AccessDeniedException Thrown when the caller does not have sufficient permissions to perform the requested operation.
      • ValidationException Thrown when the request contains invalid parameters or fails input validation requirements.
      • InternalServerException Thrown when an unexpected error occurs on the server side during request processing.
      • ResourceNotFoundException Thrown when the requested resource cannot be found or does not exist.
      • ThrottlingException Thrown when the request rate exceeds the allowed limits and the request is being throttled.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PartnerCentralBenefitsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listBenefitAllocations

      default CompletableFuture<ListBenefitAllocationsResponse> listBenefitAllocations(Consumer<ListBenefitAllocationsRequest.Builder> listBenefitAllocationsRequest)

      Retrieves a paginated list of benefit allocations based on specified filter criteria.


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

      Parameters:
      listBenefitAllocationsRequest - A Consumer that will call methods on ListBenefitAllocationsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListBenefitAllocations 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.
      • AccessDeniedException Thrown when the caller does not have sufficient permissions to perform the requested operation.
      • ValidationException Thrown when the request contains invalid parameters or fails input validation requirements.
      • InternalServerException Thrown when an unexpected error occurs on the server side during request processing.
      • ResourceNotFoundException Thrown when the requested resource cannot be found or does not exist.
      • ThrottlingException Thrown when the request rate exceeds the allowed limits and the request is being throttled.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PartnerCentralBenefitsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listBenefitAllocationsPaginator

      default ListBenefitAllocationsPublisher listBenefitAllocationsPaginator(ListBenefitAllocationsRequest listBenefitAllocationsRequest)

      This is a variant of listBenefitAllocations(software.amazon.awssdk.services.partnercentralbenefits.model.ListBenefitAllocationsRequest) 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.partnercentralbenefits.paginators.ListBenefitAllocationsPublisher publisher = client.listBenefitAllocationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.partnercentralbenefits.paginators.ListBenefitAllocationsPublisher publisher = client.listBenefitAllocationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.partnercentralbenefits.model.ListBenefitAllocationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.partnercentralbenefits.model.ListBenefitAllocationsResponse 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 listBenefitAllocations(software.amazon.awssdk.services.partnercentralbenefits.model.ListBenefitAllocationsRequest) operation.

      Parameters:
      listBenefitAllocationsRequest -
      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.
      • AccessDeniedException Thrown when the caller does not have sufficient permissions to perform the requested operation.
      • ValidationException Thrown when the request contains invalid parameters or fails input validation requirements.
      • InternalServerException Thrown when an unexpected error occurs on the server side during request processing.
      • ResourceNotFoundException Thrown when the requested resource cannot be found or does not exist.
      • ThrottlingException Thrown when the request rate exceeds the allowed limits and the request is being throttled.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PartnerCentralBenefitsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listBenefitAllocationsPaginator

      default ListBenefitAllocationsPublisher listBenefitAllocationsPaginator(Consumer<ListBenefitAllocationsRequest.Builder> listBenefitAllocationsRequest)

      This is a variant of listBenefitAllocations(software.amazon.awssdk.services.partnercentralbenefits.model.ListBenefitAllocationsRequest) 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.partnercentralbenefits.paginators.ListBenefitAllocationsPublisher publisher = client.listBenefitAllocationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.partnercentralbenefits.paginators.ListBenefitAllocationsPublisher publisher = client.listBenefitAllocationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.partnercentralbenefits.model.ListBenefitAllocationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.partnercentralbenefits.model.ListBenefitAllocationsResponse 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 listBenefitAllocations(software.amazon.awssdk.services.partnercentralbenefits.model.ListBenefitAllocationsRequest) operation.


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

      Parameters:
      listBenefitAllocationsRequest - A Consumer that will call methods on ListBenefitAllocationsRequest.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.
      • AccessDeniedException Thrown when the caller does not have sufficient permissions to perform the requested operation.
      • ValidationException Thrown when the request contains invalid parameters or fails input validation requirements.
      • InternalServerException Thrown when an unexpected error occurs on the server side during request processing.
      • ResourceNotFoundException Thrown when the requested resource cannot be found or does not exist.
      • ThrottlingException Thrown when the request rate exceeds the allowed limits and the request is being throttled.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PartnerCentralBenefitsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listBenefitApplications

      default CompletableFuture<ListBenefitApplicationsResponse> listBenefitApplications(ListBenefitApplicationsRequest listBenefitApplicationsRequest)

      Retrieves a paginated list of benefit applications based on specified filter criteria.

      Parameters:
      listBenefitApplicationsRequest -
      Returns:
      A Java Future containing the result of the ListBenefitApplications 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 Thrown when the request contains invalid parameters or fails input validation requirements.
      • AccessDeniedException Thrown when the caller does not have sufficient permissions to perform the requested operation.
      • InternalServerException Thrown when an unexpected error occurs on the server side during request processing.
      • ThrottlingException Thrown when the request rate exceeds the allowed limits and the request is being throttled.
      • ResourceNotFoundException Thrown when the requested resource cannot be found or does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PartnerCentralBenefitsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listBenefitApplications

      default CompletableFuture<ListBenefitApplicationsResponse> listBenefitApplications(Consumer<ListBenefitApplicationsRequest.Builder> listBenefitApplicationsRequest)

      Retrieves a paginated list of benefit applications based on specified filter criteria.


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

      Parameters:
      listBenefitApplicationsRequest - A Consumer that will call methods on ListBenefitApplicationsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListBenefitApplications 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 Thrown when the request contains invalid parameters or fails input validation requirements.
      • AccessDeniedException Thrown when the caller does not have sufficient permissions to perform the requested operation.
      • InternalServerException Thrown when an unexpected error occurs on the server side during request processing.
      • ThrottlingException Thrown when the request rate exceeds the allowed limits and the request is being throttled.
      • ResourceNotFoundException Thrown when the requested resource cannot be found or does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PartnerCentralBenefitsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listBenefitApplicationsPaginator

      default ListBenefitApplicationsPublisher listBenefitApplicationsPaginator(ListBenefitApplicationsRequest listBenefitApplicationsRequest)

      This is a variant of listBenefitApplications(software.amazon.awssdk.services.partnercentralbenefits.model.ListBenefitApplicationsRequest) 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.partnercentralbenefits.paginators.ListBenefitApplicationsPublisher publisher = client.listBenefitApplicationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.partnercentralbenefits.paginators.ListBenefitApplicationsPublisher publisher = client.listBenefitApplicationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.partnercentralbenefits.model.ListBenefitApplicationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.partnercentralbenefits.model.ListBenefitApplicationsResponse 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 listBenefitApplications(software.amazon.awssdk.services.partnercentralbenefits.model.ListBenefitApplicationsRequest) operation.

      Parameters:
      listBenefitApplicationsRequest -
      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 Thrown when the request contains invalid parameters or fails input validation requirements.
      • AccessDeniedException Thrown when the caller does not have sufficient permissions to perform the requested operation.
      • InternalServerException Thrown when an unexpected error occurs on the server side during request processing.
      • ThrottlingException Thrown when the request rate exceeds the allowed limits and the request is being throttled.
      • ResourceNotFoundException Thrown when the requested resource cannot be found or does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PartnerCentralBenefitsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listBenefitApplicationsPaginator

      default ListBenefitApplicationsPublisher listBenefitApplicationsPaginator(Consumer<ListBenefitApplicationsRequest.Builder> listBenefitApplicationsRequest)

      This is a variant of listBenefitApplications(software.amazon.awssdk.services.partnercentralbenefits.model.ListBenefitApplicationsRequest) 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.partnercentralbenefits.paginators.ListBenefitApplicationsPublisher publisher = client.listBenefitApplicationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.partnercentralbenefits.paginators.ListBenefitApplicationsPublisher publisher = client.listBenefitApplicationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.partnercentralbenefits.model.ListBenefitApplicationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.partnercentralbenefits.model.ListBenefitApplicationsResponse 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 listBenefitApplications(software.amazon.awssdk.services.partnercentralbenefits.model.ListBenefitApplicationsRequest) operation.


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

      Parameters:
      listBenefitApplicationsRequest - A Consumer that will call methods on ListBenefitApplicationsRequest.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 Thrown when the request contains invalid parameters or fails input validation requirements.
      • AccessDeniedException Thrown when the caller does not have sufficient permissions to perform the requested operation.
      • InternalServerException Thrown when an unexpected error occurs on the server side during request processing.
      • ThrottlingException Thrown when the request rate exceeds the allowed limits and the request is being throttled.
      • ResourceNotFoundException Thrown when the requested resource cannot be found or does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PartnerCentralBenefitsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listBenefits

      default CompletableFuture<ListBenefitsResponse> listBenefits(ListBenefitsRequest listBenefitsRequest)

      Retrieves a paginated list of available benefits based on specified filter criteria.

      Parameters:
      listBenefitsRequest -
      Returns:
      A Java Future containing the result of the ListBenefits 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 Thrown when the request contains invalid parameters or fails input validation requirements.
      • AccessDeniedException Thrown when the caller does not have sufficient permissions to perform the requested operation.
      • InternalServerException Thrown when an unexpected error occurs on the server side during request processing.
      • ThrottlingException Thrown when the request rate exceeds the allowed limits and the request is being throttled.
      • ResourceNotFoundException Thrown when the requested resource cannot be found or does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PartnerCentralBenefitsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listBenefits

      default CompletableFuture<ListBenefitsResponse> listBenefits(Consumer<ListBenefitsRequest.Builder> listBenefitsRequest)

      Retrieves a paginated list of available benefits based on specified filter criteria.


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

      Parameters:
      listBenefitsRequest - A Consumer that will call methods on ListBenefitsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListBenefits 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 Thrown when the request contains invalid parameters or fails input validation requirements.
      • AccessDeniedException Thrown when the caller does not have sufficient permissions to perform the requested operation.
      • InternalServerException Thrown when an unexpected error occurs on the server side during request processing.
      • ThrottlingException Thrown when the request rate exceeds the allowed limits and the request is being throttled.
      • ResourceNotFoundException Thrown when the requested resource cannot be found or does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PartnerCentralBenefitsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listBenefitsPaginator

      default ListBenefitsPublisher listBenefitsPaginator(ListBenefitsRequest listBenefitsRequest)

      This is a variant of listBenefits(software.amazon.awssdk.services.partnercentralbenefits.model.ListBenefitsRequest) 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.partnercentralbenefits.paginators.ListBenefitsPublisher publisher = client.listBenefitsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.partnercentralbenefits.paginators.ListBenefitsPublisher publisher = client.listBenefitsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.partnercentralbenefits.model.ListBenefitsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.partnercentralbenefits.model.ListBenefitsResponse 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 listBenefits(software.amazon.awssdk.services.partnercentralbenefits.model.ListBenefitsRequest) operation.

      Parameters:
      listBenefitsRequest -
      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 Thrown when the request contains invalid parameters or fails input validation requirements.
      • AccessDeniedException Thrown when the caller does not have sufficient permissions to perform the requested operation.
      • InternalServerException Thrown when an unexpected error occurs on the server side during request processing.
      • ThrottlingException Thrown when the request rate exceeds the allowed limits and the request is being throttled.
      • ResourceNotFoundException Thrown when the requested resource cannot be found or does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PartnerCentralBenefitsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listBenefitsPaginator

      default ListBenefitsPublisher listBenefitsPaginator(Consumer<ListBenefitsRequest.Builder> listBenefitsRequest)

      This is a variant of listBenefits(software.amazon.awssdk.services.partnercentralbenefits.model.ListBenefitsRequest) 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.partnercentralbenefits.paginators.ListBenefitsPublisher publisher = client.listBenefitsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.partnercentralbenefits.paginators.ListBenefitsPublisher publisher = client.listBenefitsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.partnercentralbenefits.model.ListBenefitsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.partnercentralbenefits.model.ListBenefitsResponse 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 listBenefits(software.amazon.awssdk.services.partnercentralbenefits.model.ListBenefitsRequest) operation.


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

      Parameters:
      listBenefitsRequest - A Consumer that will call methods on ListBenefitsRequest.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 Thrown when the request contains invalid parameters or fails input validation requirements.
      • AccessDeniedException Thrown when the caller does not have sufficient permissions to perform the requested operation.
      • InternalServerException Thrown when an unexpected error occurs on the server side during request processing.
      • ThrottlingException Thrown when the request rate exceeds the allowed limits and the request is being throttled.
      • ResourceNotFoundException Thrown when the requested resource cannot be found or does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PartnerCentralBenefitsException 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)

      Retrieves all tags associated with a specific 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.
      • AccessDeniedException Thrown when the caller does not have sufficient permissions to perform the requested operation.
      • ValidationException Thrown when the request contains invalid parameters or fails input validation requirements.
      • InternalServerException Thrown when an unexpected error occurs on the server side during request processing.
      • ThrottlingException Thrown when the request rate exceeds the allowed limits and the request is being throttled.
      • ResourceNotFoundException Thrown when the requested resource cannot be found or does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PartnerCentralBenefitsException 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)

      Retrieves all tags associated with a specific 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.
      • AccessDeniedException Thrown when the caller does not have sufficient permissions to perform the requested operation.
      • ValidationException Thrown when the request contains invalid parameters or fails input validation requirements.
      • InternalServerException Thrown when an unexpected error occurs on the server side during request processing.
      • ThrottlingException Thrown when the request rate exceeds the allowed limits and the request is being throttled.
      • ResourceNotFoundException Thrown when the requested resource cannot be found or does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PartnerCentralBenefitsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • recallBenefitApplication

      default CompletableFuture<RecallBenefitApplicationResponse> recallBenefitApplication(RecallBenefitApplicationRequest recallBenefitApplicationRequest)

      Recalls a submitted benefit application, returning it to draft status for further modifications.

      Parameters:
      recallBenefitApplicationRequest -
      Returns:
      A Java Future containing the result of the RecallBenefitApplication 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 Thrown when the request contains invalid parameters or fails input validation requirements.
      • AccessDeniedException Thrown when the caller does not have sufficient permissions to perform the requested operation.
      • InternalServerException Thrown when an unexpected error occurs on the server side during request processing.
      • ConflictException Thrown when the request conflicts with the current state of the resource, such as attempting to modify a resource that has been changed by another process.
      • ThrottlingException Thrown when the request rate exceeds the allowed limits and the request is being throttled.
      • ResourceNotFoundException Thrown when the requested resource cannot be found or does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PartnerCentralBenefitsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • recallBenefitApplication

      default CompletableFuture<RecallBenefitApplicationResponse> recallBenefitApplication(Consumer<RecallBenefitApplicationRequest.Builder> recallBenefitApplicationRequest)

      Recalls a submitted benefit application, returning it to draft status for further modifications.


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

      Parameters:
      recallBenefitApplicationRequest - A Consumer that will call methods on RecallBenefitApplicationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the RecallBenefitApplication 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 Thrown when the request contains invalid parameters or fails input validation requirements.
      • AccessDeniedException Thrown when the caller does not have sufficient permissions to perform the requested operation.
      • InternalServerException Thrown when an unexpected error occurs on the server side during request processing.
      • ConflictException Thrown when the request conflicts with the current state of the resource, such as attempting to modify a resource that has been changed by another process.
      • ThrottlingException Thrown when the request rate exceeds the allowed limits and the request is being throttled.
      • ResourceNotFoundException Thrown when the requested resource cannot be found or does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PartnerCentralBenefitsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • submitBenefitApplication

      default CompletableFuture<SubmitBenefitApplicationResponse> submitBenefitApplication(SubmitBenefitApplicationRequest submitBenefitApplicationRequest)

      Submits a benefit application for review and processing by AWS.

      Parameters:
      submitBenefitApplicationRequest -
      Returns:
      A Java Future containing the result of the SubmitBenefitApplication 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.
      • AccessDeniedException Thrown when the caller does not have sufficient permissions to perform the requested operation.
      • ValidationException Thrown when the request contains invalid parameters or fails input validation requirements.
      • InternalServerException Thrown when an unexpected error occurs on the server side during request processing.
      • ConflictException Thrown when the request conflicts with the current state of the resource, such as attempting to modify a resource that has been changed by another process.
      • ResourceNotFoundException Thrown when the requested resource cannot be found or does not exist.
      • ThrottlingException Thrown when the request rate exceeds the allowed limits and the request is being throttled.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PartnerCentralBenefitsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • submitBenefitApplication

      default CompletableFuture<SubmitBenefitApplicationResponse> submitBenefitApplication(Consumer<SubmitBenefitApplicationRequest.Builder> submitBenefitApplicationRequest)

      Submits a benefit application for review and processing by AWS.


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

      Parameters:
      submitBenefitApplicationRequest - A Consumer that will call methods on SubmitBenefitApplicationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the SubmitBenefitApplication 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.
      • AccessDeniedException Thrown when the caller does not have sufficient permissions to perform the requested operation.
      • ValidationException Thrown when the request contains invalid parameters or fails input validation requirements.
      • InternalServerException Thrown when an unexpected error occurs on the server side during request processing.
      • ConflictException Thrown when the request conflicts with the current state of the resource, such as attempting to modify a resource that has been changed by another process.
      • ResourceNotFoundException Thrown when the requested resource cannot be found or does not exist.
      • ThrottlingException Thrown when the request rate exceeds the allowed limits and the request is being throttled.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PartnerCentralBenefitsException 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)

      Adds or updates tags for a specified resource.

      Parameters:
      tagResourceRequest -
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException Thrown when the caller does not have sufficient permissions to perform the requested operation.
      • ValidationException Thrown when the request contains invalid parameters or fails input validation requirements.
      • InternalServerException Thrown when an unexpected error occurs on the server side during request processing.
      • ConflictException Thrown when the request conflicts with the current state of the resource, such as attempting to modify a resource that has been changed by another process.
      • ServiceQuotaExceededException Thrown when the request would exceed the service quotas or limits for the account.
      • ResourceNotFoundException Thrown when the requested resource cannot be found or does not exist.
      • ThrottlingException Thrown when the request rate exceeds the allowed limits and the request is being throttled.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PartnerCentralBenefitsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)

      Adds or updates tags for a specified resource.


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

      Parameters:
      tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.
      Returns:
      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.
      • AccessDeniedException Thrown when the caller does not have sufficient permissions to perform the requested operation.
      • ValidationException Thrown when the request contains invalid parameters or fails input validation requirements.
      • InternalServerException Thrown when an unexpected error occurs on the server side during request processing.
      • ConflictException Thrown when the request conflicts with the current state of the resource, such as attempting to modify a resource that has been changed by another process.
      • ServiceQuotaExceededException Thrown when the request would exceed the service quotas or limits for the account.
      • ResourceNotFoundException Thrown when the requested resource cannot be found or does not exist.
      • ThrottlingException Thrown when the request rate exceeds the allowed limits and the request is being throttled.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PartnerCentralBenefitsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)

      Removes specified tags from a 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.
      • AccessDeniedException Thrown when the caller does not have sufficient permissions to perform the requested operation.
      • ValidationException Thrown when the request contains invalid parameters or fails input validation requirements.
      • InternalServerException Thrown when an unexpected error occurs on the server side during request processing.
      • ConflictException Thrown when the request conflicts with the current state of the resource, such as attempting to modify a resource that has been changed by another process.
      • ServiceQuotaExceededException Thrown when the request would exceed the service quotas or limits for the account.
      • ResourceNotFoundException Thrown when the requested resource cannot be found or does not exist.
      • ThrottlingException Thrown when the request rate exceeds the allowed limits and the request is being throttled.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PartnerCentralBenefitsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)

      Removes specified tags from a 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.
      • AccessDeniedException Thrown when the caller does not have sufficient permissions to perform the requested operation.
      • ValidationException Thrown when the request contains invalid parameters or fails input validation requirements.
      • InternalServerException Thrown when an unexpected error occurs on the server side during request processing.
      • ConflictException Thrown when the request conflicts with the current state of the resource, such as attempting to modify a resource that has been changed by another process.
      • ServiceQuotaExceededException Thrown when the request would exceed the service quotas or limits for the account.
      • ResourceNotFoundException Thrown when the requested resource cannot be found or does not exist.
      • ThrottlingException Thrown when the request rate exceeds the allowed limits and the request is being throttled.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PartnerCentralBenefitsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateBenefitApplication

      default CompletableFuture<UpdateBenefitApplicationResponse> updateBenefitApplication(UpdateBenefitApplicationRequest updateBenefitApplicationRequest)

      Updates an existing benefit application with new information while maintaining revision control.

      Parameters:
      updateBenefitApplicationRequest -
      Returns:
      A Java Future containing the result of the UpdateBenefitApplication 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 Thrown when the request contains invalid parameters or fails input validation requirements.
      • AccessDeniedException Thrown when the caller does not have sufficient permissions to perform the requested operation.
      • InternalServerException Thrown when an unexpected error occurs on the server side during request processing.
      • ConflictException Thrown when the request conflicts with the current state of the resource, such as attempting to modify a resource that has been changed by another process.
      • ResourceNotFoundException Thrown when the requested resource cannot be found or does not exist.
      • ThrottlingException Thrown when the request rate exceeds the allowed limits and the request is being throttled.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PartnerCentralBenefitsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateBenefitApplication

      default CompletableFuture<UpdateBenefitApplicationResponse> updateBenefitApplication(Consumer<UpdateBenefitApplicationRequest.Builder> updateBenefitApplicationRequest)

      Updates an existing benefit application with new information while maintaining revision control.


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

      Parameters:
      updateBenefitApplicationRequest - A Consumer that will call methods on UpdateBenefitApplicationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateBenefitApplication 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 Thrown when the request contains invalid parameters or fails input validation requirements.
      • AccessDeniedException Thrown when the caller does not have sufficient permissions to perform the requested operation.
      • InternalServerException Thrown when an unexpected error occurs on the server side during request processing.
      • ConflictException Thrown when the request conflicts with the current state of the resource, such as attempting to modify a resource that has been changed by another process.
      • ResourceNotFoundException Thrown when the requested resource cannot be found or does not exist.
      • ThrottlingException Thrown when the request rate exceeds the allowed limits and the request is being throttled.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PartnerCentralBenefitsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

      default PartnerCentralBenefitsServiceClientConfiguration 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 PartnerCentralBenefitsAsyncClient create()
      Create a PartnerCentralBenefitsAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static PartnerCentralBenefitsAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a PartnerCentralBenefitsAsyncClient.