Interface AmplifyUiBuilderAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface AmplifyUiBuilderAsyncClient extends AwsClient
Service client for accessing AWS Amplify UI Builder 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.

The Amplify UI Builder API provides a programmatic interface for creating and configuring user interface (UI) component libraries and themes for use in your Amplify applications. You can then connect these UI components to an application's backend Amazon Web Services resources.

You can also use the Amplify Studio visual designer to create UI components and model data for an app. For more information, see Introduction in the Amplify Docs.

The Amplify Framework is a comprehensive set of SDKs, libraries, tools, and documentation for client app development. For more information, see the Amplify Framework. For more information about deploying an Amplify application to Amazon Web Services, see the Amplify User Guide.

  • Field Details

  • Method Details

    • createComponent

      default CompletableFuture<CreateComponentResponse> createComponent(CreateComponentRequest createComponentRequest)

      Creates a new component for an Amplify app.

      Parameters:
      createComponentRequest -
      Returns:
      A Java Future containing the result of the CreateComponent operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceQuotaExceededException You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account.
      • ResourceConflictException The resource specified in the request conflicts with an existing resource.
      • InternalServerException An internal error has occurred. Please retry your request.
      • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmplifyUiBuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createComponent

      default CompletableFuture<CreateComponentResponse> createComponent(Consumer<CreateComponentRequest.Builder> createComponentRequest)

      Creates a new component for an Amplify app.


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

      Parameters:
      createComponentRequest - A Consumer that will call methods on CreateComponentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateComponent operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceQuotaExceededException You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account.
      • ResourceConflictException The resource specified in the request conflicts with an existing resource.
      • InternalServerException An internal error has occurred. Please retry your request.
      • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmplifyUiBuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createForm

      default CompletableFuture<CreateFormResponse> createForm(CreateFormRequest createFormRequest)

      Creates a new form for an Amplify app.

      Parameters:
      createFormRequest -
      Returns:
      A Java Future containing the result of the CreateForm operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceQuotaExceededException You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account.
      • ResourceConflictException The resource specified in the request conflicts with an existing resource.
      • InternalServerException An internal error has occurred. Please retry your request.
      • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmplifyUiBuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createForm

      default CompletableFuture<CreateFormResponse> createForm(Consumer<CreateFormRequest.Builder> createFormRequest)

      Creates a new form for an Amplify app.


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

      Parameters:
      createFormRequest - A Consumer that will call methods on CreateFormRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateForm operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceQuotaExceededException You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account.
      • ResourceConflictException The resource specified in the request conflicts with an existing resource.
      • InternalServerException An internal error has occurred. Please retry your request.
      • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmplifyUiBuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createTheme

      default CompletableFuture<CreateThemeResponse> createTheme(CreateThemeRequest createThemeRequest)

      Creates a theme to apply to the components in an Amplify app.

      Parameters:
      createThemeRequest -
      Returns:
      A Java Future containing the result of the CreateTheme operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceQuotaExceededException You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account.
      • ResourceConflictException The resource specified in the request conflicts with an existing resource.
      • InternalServerException An internal error has occurred. Please retry your request.
      • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmplifyUiBuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createTheme

      default CompletableFuture<CreateThemeResponse> createTheme(Consumer<CreateThemeRequest.Builder> createThemeRequest)

      Creates a theme to apply to the components in an Amplify app.


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

      Parameters:
      createThemeRequest - A Consumer that will call methods on CreateThemeRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateTheme operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceQuotaExceededException You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account.
      • ResourceConflictException The resource specified in the request conflicts with an existing resource.
      • InternalServerException An internal error has occurred. Please retry your request.
      • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmplifyUiBuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteComponent

      default CompletableFuture<DeleteComponentResponse> deleteComponent(DeleteComponentRequest deleteComponentRequest)

      Deletes a component from an Amplify app.

      Parameters:
      deleteComponentRequest -
      Returns:
      A Java Future containing the result of the DeleteComponent 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.
      • InternalServerException An internal error has occurred. Please retry your request.
      • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.
      • ResourceNotFoundException The requested resource does not exist, or access was denied.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmplifyUiBuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteComponent

      default CompletableFuture<DeleteComponentResponse> deleteComponent(Consumer<DeleteComponentRequest.Builder> deleteComponentRequest)

      Deletes a component from an Amplify app.


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

      Parameters:
      deleteComponentRequest - A Consumer that will call methods on DeleteComponentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteComponent 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.
      • InternalServerException An internal error has occurred. Please retry your request.
      • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.
      • ResourceNotFoundException The requested resource does not exist, or access was denied.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmplifyUiBuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteForm

      default CompletableFuture<DeleteFormResponse> deleteForm(DeleteFormRequest deleteFormRequest)

      Deletes a form from an Amplify app.

      Parameters:
      deleteFormRequest -
      Returns:
      A Java Future containing the result of the DeleteForm 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.
      • InternalServerException An internal error has occurred. Please retry your request.
      • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.
      • ResourceNotFoundException The requested resource does not exist, or access was denied.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmplifyUiBuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteForm

      default CompletableFuture<DeleteFormResponse> deleteForm(Consumer<DeleteFormRequest.Builder> deleteFormRequest)

      Deletes a form from an Amplify app.


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

      Parameters:
      deleteFormRequest - A Consumer that will call methods on DeleteFormRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteForm 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.
      • InternalServerException An internal error has occurred. Please retry your request.
      • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.
      • ResourceNotFoundException The requested resource does not exist, or access was denied.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmplifyUiBuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteTheme

      default CompletableFuture<DeleteThemeResponse> deleteTheme(DeleteThemeRequest deleteThemeRequest)

      Deletes a theme from an Amplify app.

      Parameters:
      deleteThemeRequest -
      Returns:
      A Java Future containing the result of the DeleteTheme 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.
      • InternalServerException An internal error has occurred. Please retry your request.
      • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.
      • ResourceNotFoundException The requested resource does not exist, or access was denied.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmplifyUiBuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteTheme

      default CompletableFuture<DeleteThemeResponse> deleteTheme(Consumer<DeleteThemeRequest.Builder> deleteThemeRequest)

      Deletes a theme from an Amplify app.


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

      Parameters:
      deleteThemeRequest - A Consumer that will call methods on DeleteThemeRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteTheme 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.
      • InternalServerException An internal error has occurred. Please retry your request.
      • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.
      • ResourceNotFoundException The requested resource does not exist, or access was denied.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmplifyUiBuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • exchangeCodeForToken

      default CompletableFuture<ExchangeCodeForTokenResponse> exchangeCodeForToken(ExchangeCodeForTokenRequest exchangeCodeForTokenRequest)

      This is for internal use.

      Amplify uses this action to exchange an access code for a token.

      Parameters:
      exchangeCodeForTokenRequest -
      Returns:
      A Java Future containing the result of the ExchangeCodeForToken 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.
      • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmplifyUiBuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • exchangeCodeForToken

      default CompletableFuture<ExchangeCodeForTokenResponse> exchangeCodeForToken(Consumer<ExchangeCodeForTokenRequest.Builder> exchangeCodeForTokenRequest)

      This is for internal use.

      Amplify uses this action to exchange an access code for a token.


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

      Parameters:
      exchangeCodeForTokenRequest - A Consumer that will call methods on ExchangeCodeForTokenRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ExchangeCodeForToken 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.
      • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmplifyUiBuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • exportComponents

      default CompletableFuture<ExportComponentsResponse> exportComponents(ExportComponentsRequest exportComponentsRequest)

      Exports component configurations to code that is ready to integrate into an Amplify app.

      Parameters:
      exportComponentsRequest -
      Returns:
      A Java Future containing the result of the ExportComponents 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.
      • InternalServerException An internal error has occurred. Please retry your request.
      • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmplifyUiBuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • exportComponents

      default CompletableFuture<ExportComponentsResponse> exportComponents(Consumer<ExportComponentsRequest.Builder> exportComponentsRequest)

      Exports component configurations to code that is ready to integrate into an Amplify app.


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

      Parameters:
      exportComponentsRequest - A Consumer that will call methods on ExportComponentsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ExportComponents 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.
      • InternalServerException An internal error has occurred. Please retry your request.
      • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmplifyUiBuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • exportComponentsPaginator

      default ExportComponentsPublisher exportComponentsPaginator(ExportComponentsRequest exportComponentsRequest)

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

      Parameters:
      exportComponentsRequest -
      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.
      • InternalServerException An internal error has occurred. Please retry your request.
      • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmplifyUiBuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • exportComponentsPaginator

      default ExportComponentsPublisher exportComponentsPaginator(Consumer<ExportComponentsRequest.Builder> exportComponentsRequest)

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


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

      Parameters:
      exportComponentsRequest - A Consumer that will call methods on ExportComponentsRequest.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.
      • InternalServerException An internal error has occurred. Please retry your request.
      • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmplifyUiBuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • exportForms

      default CompletableFuture<ExportFormsResponse> exportForms(ExportFormsRequest exportFormsRequest)

      Exports form configurations to code that is ready to integrate into an Amplify app.

      Parameters:
      exportFormsRequest -
      Returns:
      A Java Future containing the result of the ExportForms 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.
      • InternalServerException An internal error has occurred. Please retry your request.
      • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmplifyUiBuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • exportForms

      default CompletableFuture<ExportFormsResponse> exportForms(Consumer<ExportFormsRequest.Builder> exportFormsRequest)

      Exports form configurations to code that is ready to integrate into an Amplify app.


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

      Parameters:
      exportFormsRequest - A Consumer that will call methods on ExportFormsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ExportForms 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.
      • InternalServerException An internal error has occurred. Please retry your request.
      • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmplifyUiBuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • exportFormsPaginator

      default ExportFormsPublisher exportFormsPaginator(ExportFormsRequest exportFormsRequest)

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

      Parameters:
      exportFormsRequest -
      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.
      • InternalServerException An internal error has occurred. Please retry your request.
      • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmplifyUiBuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • exportFormsPaginator

      default ExportFormsPublisher exportFormsPaginator(Consumer<ExportFormsRequest.Builder> exportFormsRequest)

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


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

      Parameters:
      exportFormsRequest - A Consumer that will call methods on ExportFormsRequest.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.
      • InternalServerException An internal error has occurred. Please retry your request.
      • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmplifyUiBuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • exportThemes

      default CompletableFuture<ExportThemesResponse> exportThemes(ExportThemesRequest exportThemesRequest)

      Exports theme configurations to code that is ready to integrate into an Amplify app.

      Parameters:
      exportThemesRequest -
      Returns:
      A Java Future containing the result of the ExportThemes 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.
      • InternalServerException An internal error has occurred. Please retry your request.
      • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmplifyUiBuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • exportThemes

      default CompletableFuture<ExportThemesResponse> exportThemes(Consumer<ExportThemesRequest.Builder> exportThemesRequest)

      Exports theme configurations to code that is ready to integrate into an Amplify app.


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

      Parameters:
      exportThemesRequest - A Consumer that will call methods on ExportThemesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ExportThemes 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.
      • InternalServerException An internal error has occurred. Please retry your request.
      • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmplifyUiBuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • exportThemesPaginator

      default ExportThemesPublisher exportThemesPaginator(ExportThemesRequest exportThemesRequest)

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

      Parameters:
      exportThemesRequest -
      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.
      • InternalServerException An internal error has occurred. Please retry your request.
      • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmplifyUiBuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • exportThemesPaginator

      default ExportThemesPublisher exportThemesPaginator(Consumer<ExportThemesRequest.Builder> exportThemesRequest)

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


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

      Parameters:
      exportThemesRequest - A Consumer that will call methods on ExportThemesRequest.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.
      • InternalServerException An internal error has occurred. Please retry your request.
      • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmplifyUiBuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getCodegenJob

      default CompletableFuture<GetCodegenJobResponse> getCodegenJob(GetCodegenJobRequest getCodegenJobRequest)

      Returns an existing code generation job.

      Parameters:
      getCodegenJobRequest -
      Returns:
      A Java Future containing the result of the GetCodegenJob 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.
      • InternalServerException An internal error has occurred. Please retry your request.
      • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.
      • ThrottlingException The request was denied due to request throttling.
      • ResourceNotFoundException The requested resource does not exist, or access was denied.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmplifyUiBuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getCodegenJob

      default CompletableFuture<GetCodegenJobResponse> getCodegenJob(Consumer<GetCodegenJobRequest.Builder> getCodegenJobRequest)

      Returns an existing code generation job.


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

      Parameters:
      getCodegenJobRequest - A Consumer that will call methods on GetCodegenJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetCodegenJob 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.
      • InternalServerException An internal error has occurred. Please retry your request.
      • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.
      • ThrottlingException The request was denied due to request throttling.
      • ResourceNotFoundException The requested resource does not exist, or access was denied.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmplifyUiBuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getComponent

      default CompletableFuture<GetComponentResponse> getComponent(GetComponentRequest getComponentRequest)

      Returns an existing component for an Amplify app.

      Parameters:
      getComponentRequest -
      Returns:
      A Java Future containing the result of the GetComponent 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.
      • InternalServerException An internal error has occurred. Please retry your request.
      • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.
      • ResourceNotFoundException The requested resource does not exist, or access was denied.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmplifyUiBuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getComponent

      default CompletableFuture<GetComponentResponse> getComponent(Consumer<GetComponentRequest.Builder> getComponentRequest)

      Returns an existing component for an Amplify app.


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

      Parameters:
      getComponentRequest - A Consumer that will call methods on GetComponentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetComponent 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.
      • InternalServerException An internal error has occurred. Please retry your request.
      • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.
      • ResourceNotFoundException The requested resource does not exist, or access was denied.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmplifyUiBuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getForm

      default CompletableFuture<GetFormResponse> getForm(GetFormRequest getFormRequest)

      Returns an existing form for an Amplify app.

      Parameters:
      getFormRequest -
      Returns:
      A Java Future containing the result of the GetForm 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.
      • InternalServerException An internal error has occurred. Please retry your request.
      • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.
      • ResourceNotFoundException The requested resource does not exist, or access was denied.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmplifyUiBuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getForm

      default CompletableFuture<GetFormResponse> getForm(Consumer<GetFormRequest.Builder> getFormRequest)

      Returns an existing form for an Amplify app.


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

      Parameters:
      getFormRequest - A Consumer that will call methods on GetFormRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetForm 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.
      • InternalServerException An internal error has occurred. Please retry your request.
      • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.
      • ResourceNotFoundException The requested resource does not exist, or access was denied.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmplifyUiBuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getMetadata

      default CompletableFuture<GetMetadataResponse> getMetadata(GetMetadataRequest getMetadataRequest)

      Returns existing metadata for an Amplify app.

      Parameters:
      getMetadataRequest -
      Returns:
      A Java Future containing the result of the GetMetadata 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.
      • UnauthorizedException You don't have permission to perform this operation.
      • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmplifyUiBuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getMetadata

      default CompletableFuture<GetMetadataResponse> getMetadata(Consumer<GetMetadataRequest.Builder> getMetadataRequest)

      Returns existing metadata for an Amplify app.


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

      Parameters:
      getMetadataRequest - A Consumer that will call methods on GetMetadataRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetMetadata 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.
      • UnauthorizedException You don't have permission to perform this operation.
      • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmplifyUiBuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getTheme

      default CompletableFuture<GetThemeResponse> getTheme(GetThemeRequest getThemeRequest)

      Returns an existing theme for an Amplify app.

      Parameters:
      getThemeRequest -
      Returns:
      A Java Future containing the result of the GetTheme 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.
      • InternalServerException An internal error has occurred. Please retry your request.
      • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.
      • ResourceNotFoundException The requested resource does not exist, or access was denied.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmplifyUiBuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getTheme

      default CompletableFuture<GetThemeResponse> getTheme(Consumer<GetThemeRequest.Builder> getThemeRequest)

      Returns an existing theme for an Amplify app.


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

      Parameters:
      getThemeRequest - A Consumer that will call methods on GetThemeRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetTheme 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.
      • InternalServerException An internal error has occurred. Please retry your request.
      • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.
      • ResourceNotFoundException The requested resource does not exist, or access was denied.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmplifyUiBuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listCodegenJobs

      default CompletableFuture<ListCodegenJobsResponse> listCodegenJobs(ListCodegenJobsRequest listCodegenJobsRequest)

      Retrieves a list of code generation jobs for a specified Amplify app and backend environment.

      Parameters:
      listCodegenJobsRequest -
      Returns:
      A Java Future containing the result of the ListCodegenJobs 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.
      • InternalServerException An internal error has occurred. Please retry your request.
      • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.
      • ThrottlingException The request was denied due to request throttling.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmplifyUiBuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listCodegenJobs

      default CompletableFuture<ListCodegenJobsResponse> listCodegenJobs(Consumer<ListCodegenJobsRequest.Builder> listCodegenJobsRequest)

      Retrieves a list of code generation jobs for a specified Amplify app and backend environment.


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

      Parameters:
      listCodegenJobsRequest - A Consumer that will call methods on ListCodegenJobsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListCodegenJobs 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.
      • InternalServerException An internal error has occurred. Please retry your request.
      • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.
      • ThrottlingException The request was denied due to request throttling.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmplifyUiBuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listCodegenJobsPaginator

      default ListCodegenJobsPublisher listCodegenJobsPaginator(ListCodegenJobsRequest listCodegenJobsRequest)

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

      Parameters:
      listCodegenJobsRequest -
      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.
      • InternalServerException An internal error has occurred. Please retry your request.
      • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.
      • ThrottlingException The request was denied due to request throttling.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmplifyUiBuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listCodegenJobsPaginator

      default ListCodegenJobsPublisher listCodegenJobsPaginator(Consumer<ListCodegenJobsRequest.Builder> listCodegenJobsRequest)

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


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

      Parameters:
      listCodegenJobsRequest - A Consumer that will call methods on ListCodegenJobsRequest.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.
      • InternalServerException An internal error has occurred. Please retry your request.
      • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.
      • ThrottlingException The request was denied due to request throttling.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmplifyUiBuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listComponents

      default CompletableFuture<ListComponentsResponse> listComponents(ListComponentsRequest listComponentsRequest)

      Retrieves a list of components for a specified Amplify app and backend environment.

      Parameters:
      listComponentsRequest -
      Returns:
      A Java Future containing the result of the ListComponents 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.
      • InternalServerException An internal error has occurred. Please retry your request.
      • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmplifyUiBuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listComponents

      default CompletableFuture<ListComponentsResponse> listComponents(Consumer<ListComponentsRequest.Builder> listComponentsRequest)

      Retrieves a list of components for a specified Amplify app and backend environment.


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

      Parameters:
      listComponentsRequest - A Consumer that will call methods on ListComponentsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListComponents 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.
      • InternalServerException An internal error has occurred. Please retry your request.
      • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmplifyUiBuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listComponentsPaginator

      default ListComponentsPublisher listComponentsPaginator(ListComponentsRequest listComponentsRequest)

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

      Parameters:
      listComponentsRequest -
      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.
      • InternalServerException An internal error has occurred. Please retry your request.
      • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmplifyUiBuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listComponentsPaginator

      default ListComponentsPublisher listComponentsPaginator(Consumer<ListComponentsRequest.Builder> listComponentsRequest)

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


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

      Parameters:
      listComponentsRequest - A Consumer that will call methods on ListComponentsRequest.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.
      • InternalServerException An internal error has occurred. Please retry your request.
      • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmplifyUiBuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listForms

      default CompletableFuture<ListFormsResponse> listForms(ListFormsRequest listFormsRequest)

      Retrieves a list of forms for a specified Amplify app and backend environment.

      Parameters:
      listFormsRequest -
      Returns:
      A Java Future containing the result of the ListForms 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.
      • InternalServerException An internal error has occurred. Please retry your request.
      • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmplifyUiBuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listForms

      default CompletableFuture<ListFormsResponse> listForms(Consumer<ListFormsRequest.Builder> listFormsRequest)

      Retrieves a list of forms for a specified Amplify app and backend environment.


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

      Parameters:
      listFormsRequest - A Consumer that will call methods on ListFormsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListForms 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.
      • InternalServerException An internal error has occurred. Please retry your request.
      • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmplifyUiBuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listFormsPaginator

      default ListFormsPublisher listFormsPaginator(ListFormsRequest listFormsRequest)

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

      Parameters:
      listFormsRequest -
      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.
      • InternalServerException An internal error has occurred. Please retry your request.
      • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmplifyUiBuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listFormsPaginator

      default ListFormsPublisher listFormsPaginator(Consumer<ListFormsRequest.Builder> listFormsRequest)

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


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

      Parameters:
      listFormsRequest - A Consumer that will call methods on ListFormsRequest.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.
      • InternalServerException An internal error has occurred. Please retry your request.
      • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmplifyUiBuilderException 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)

      Returns a list of tags for a specified Amazon Resource Name (ARN).

      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.
      • UnauthorizedException You don't have permission to perform this operation.
      • InternalServerException An internal error has occurred. Please retry your request.
      • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.
      • ThrottlingException The request was denied due to request throttling.
      • ResourceNotFoundException The requested resource does not exist, or access was denied.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmplifyUiBuilderException 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)

      Returns a list of tags for a specified Amazon Resource Name (ARN).


      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.
      • UnauthorizedException You don't have permission to perform this operation.
      • InternalServerException An internal error has occurred. Please retry your request.
      • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.
      • ThrottlingException The request was denied due to request throttling.
      • ResourceNotFoundException The requested resource does not exist, or access was denied.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmplifyUiBuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listThemes

      default CompletableFuture<ListThemesResponse> listThemes(ListThemesRequest listThemesRequest)

      Retrieves a list of themes for a specified Amplify app and backend environment.

      Parameters:
      listThemesRequest -
      Returns:
      A Java Future containing the result of the ListThemes 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.
      • InternalServerException An internal error has occurred. Please retry your request.
      • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmplifyUiBuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listThemes

      default CompletableFuture<ListThemesResponse> listThemes(Consumer<ListThemesRequest.Builder> listThemesRequest)

      Retrieves a list of themes for a specified Amplify app and backend environment.


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

      Parameters:
      listThemesRequest - A Consumer that will call methods on ListThemesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListThemes 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.
      • InternalServerException An internal error has occurred. Please retry your request.
      • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmplifyUiBuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listThemesPaginator

      default ListThemesPublisher listThemesPaginator(ListThemesRequest listThemesRequest)

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

      Parameters:
      listThemesRequest -
      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.
      • InternalServerException An internal error has occurred. Please retry your request.
      • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmplifyUiBuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listThemesPaginator

      default ListThemesPublisher listThemesPaginator(Consumer<ListThemesRequest.Builder> listThemesRequest)

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


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

      Parameters:
      listThemesRequest - A Consumer that will call methods on ListThemesRequest.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.
      • InternalServerException An internal error has occurred. Please retry your request.
      • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmplifyUiBuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putMetadataFlag

      default CompletableFuture<PutMetadataFlagResponse> putMetadataFlag(PutMetadataFlagRequest putMetadataFlagRequest)

      Stores the metadata information about a feature on a form.

      Parameters:
      putMetadataFlagRequest -
      Returns:
      A Java Future containing the result of the PutMetadataFlag 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.
      • UnauthorizedException You don't have permission to perform this operation.
      • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmplifyUiBuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putMetadataFlag

      default CompletableFuture<PutMetadataFlagResponse> putMetadataFlag(Consumer<PutMetadataFlagRequest.Builder> putMetadataFlagRequest)

      Stores the metadata information about a feature on a form.


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

      Parameters:
      putMetadataFlagRequest - A Consumer that will call methods on PutMetadataFlagRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutMetadataFlag 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.
      • UnauthorizedException You don't have permission to perform this operation.
      • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmplifyUiBuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • refreshToken

      default CompletableFuture<RefreshTokenResponse> refreshToken(RefreshTokenRequest refreshTokenRequest)

      This is for internal use.

      Amplify uses this action to refresh a previously issued access token that might have expired.

      Parameters:
      refreshTokenRequest -
      Returns:
      A Java Future containing the result of the RefreshToken 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.
      • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmplifyUiBuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • refreshToken

      default CompletableFuture<RefreshTokenResponse> refreshToken(Consumer<RefreshTokenRequest.Builder> refreshTokenRequest)

      This is for internal use.

      Amplify uses this action to refresh a previously issued access token that might have expired.


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

      Parameters:
      refreshTokenRequest - A Consumer that will call methods on RefreshTokenRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the RefreshToken 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.
      • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmplifyUiBuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startCodegenJob

      default CompletableFuture<StartCodegenJobResponse> startCodegenJob(StartCodegenJobRequest startCodegenJobRequest)

      Starts a code generation job for a specified Amplify app and backend environment.

      Parameters:
      startCodegenJobRequest -
      Returns:
      A Java Future containing the result of the StartCodegenJob 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.
      • InternalServerException An internal error has occurred. Please retry your request.
      • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.
      • ThrottlingException The request was denied due to request throttling.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmplifyUiBuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startCodegenJob

      default CompletableFuture<StartCodegenJobResponse> startCodegenJob(Consumer<StartCodegenJobRequest.Builder> startCodegenJobRequest)

      Starts a code generation job for a specified Amplify app and backend environment.


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

      Parameters:
      startCodegenJobRequest - A Consumer that will call methods on StartCodegenJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartCodegenJob 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.
      • InternalServerException An internal error has occurred. Please retry your request.
      • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.
      • ThrottlingException The request was denied due to request throttling.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmplifyUiBuilderException 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)

      Tags the resource with a tag key and value.

      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.
      • UnauthorizedException You don't have permission to perform this operation.
      • InternalServerException An internal error has occurred. Please retry your request.
      • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.
      • ThrottlingException The request was denied due to request throttling.
      • ResourceNotFoundException The requested resource does not exist, or access was denied.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmplifyUiBuilderException 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)

      Tags the resource with a tag key and value.


      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.
      • UnauthorizedException You don't have permission to perform this operation.
      • InternalServerException An internal error has occurred. Please retry your request.
      • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.
      • ThrottlingException The request was denied due to request throttling.
      • ResourceNotFoundException The requested resource does not exist, or access was denied.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmplifyUiBuilderException 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)

      Untags a resource with a specified Amazon Resource Name (ARN).

      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.
      • UnauthorizedException You don't have permission to perform this operation.
      • InternalServerException An internal error has occurred. Please retry your request.
      • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.
      • ThrottlingException The request was denied due to request throttling.
      • ResourceNotFoundException The requested resource does not exist, or access was denied.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmplifyUiBuilderException 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)

      Untags a resource with a specified Amazon Resource Name (ARN).


      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.
      • UnauthorizedException You don't have permission to perform this operation.
      • InternalServerException An internal error has occurred. Please retry your request.
      • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.
      • ThrottlingException The request was denied due to request throttling.
      • ResourceNotFoundException The requested resource does not exist, or access was denied.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmplifyUiBuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateComponent

      default CompletableFuture<UpdateComponentResponse> updateComponent(UpdateComponentRequest updateComponentRequest)

      Updates an existing component.

      Parameters:
      updateComponentRequest -
      Returns:
      A Java Future containing the result of the UpdateComponent 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.
      • ResourceConflictException The resource specified in the request conflicts with an existing resource.
      • InternalServerException An internal error has occurred. Please retry your request.
      • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmplifyUiBuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateComponent

      default CompletableFuture<UpdateComponentResponse> updateComponent(Consumer<UpdateComponentRequest.Builder> updateComponentRequest)

      Updates an existing component.


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

      Parameters:
      updateComponentRequest - A Consumer that will call methods on UpdateComponentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateComponent 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.
      • ResourceConflictException The resource specified in the request conflicts with an existing resource.
      • InternalServerException An internal error has occurred. Please retry your request.
      • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmplifyUiBuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateForm

      default CompletableFuture<UpdateFormResponse> updateForm(UpdateFormRequest updateFormRequest)

      Updates an existing form.

      Parameters:
      updateFormRequest -
      Returns:
      A Java Future containing the result of the UpdateForm 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.
      • ResourceConflictException The resource specified in the request conflicts with an existing resource.
      • InternalServerException An internal error has occurred. Please retry your request.
      • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmplifyUiBuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateForm

      default CompletableFuture<UpdateFormResponse> updateForm(Consumer<UpdateFormRequest.Builder> updateFormRequest)

      Updates an existing form.


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

      Parameters:
      updateFormRequest - A Consumer that will call methods on UpdateFormRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateForm 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.
      • ResourceConflictException The resource specified in the request conflicts with an existing resource.
      • InternalServerException An internal error has occurred. Please retry your request.
      • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmplifyUiBuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateTheme

      default CompletableFuture<UpdateThemeResponse> updateTheme(UpdateThemeRequest updateThemeRequest)

      Updates an existing theme.

      Parameters:
      updateThemeRequest -
      Returns:
      A Java Future containing the result of the UpdateTheme 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.
      • ResourceConflictException The resource specified in the request conflicts with an existing resource.
      • InternalServerException An internal error has occurred. Please retry your request.
      • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmplifyUiBuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateTheme

      default CompletableFuture<UpdateThemeResponse> updateTheme(Consumer<UpdateThemeRequest.Builder> updateThemeRequest)

      Updates an existing theme.


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

      Parameters:
      updateThemeRequest - A Consumer that will call methods on UpdateThemeRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateTheme 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.
      • ResourceConflictException The resource specified in the request conflicts with an existing resource.
      • InternalServerException An internal error has occurred. Please retry your request.
      • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmplifyUiBuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

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

    • builder

      static AmplifyUiBuilderAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a AmplifyUiBuilderAsyncClient.