com.amazonaws.services.amplifyuibuilder.AWSAmplifyUIBuilderAsync Maven / Gradle / Ivy
/*
* Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.amplifyuibuilder;
import javax.annotation.Generated;
import com.amazonaws.services.amplifyuibuilder.model.*;
/**
* Interface for accessing AWS Amplify UI Builder asynchronously. Each asynchronous method will return a Java Future
* object representing the asynchronous operation; overloads which accept an {@code AsyncHandler} can be used to receive
* notification when an asynchronous operation completes.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.amplifyuibuilder.AbstractAWSAmplifyUIBuilderAsync} instead.
*
*
*
* 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.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AWSAmplifyUIBuilderAsync extends AWSAmplifyUIBuilder {
/**
*
* Creates a new component for an Amplify app.
*
*
* @param createComponentRequest
* @return A Java Future containing the result of the CreateComponent operation returned by the service.
* @sample AWSAmplifyUIBuilderAsync.CreateComponent
* @see AWS API Documentation
*/
java.util.concurrent.Future createComponentAsync(CreateComponentRequest createComponentRequest);
/**
*
* Creates a new component for an Amplify app.
*
*
* @param createComponentRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the CreateComponent operation returned by the service.
* @sample AWSAmplifyUIBuilderAsyncHandler.CreateComponent
* @see AWS API Documentation
*/
java.util.concurrent.Future createComponentAsync(CreateComponentRequest createComponentRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Creates a new form for an Amplify app.
*
*
* @param createFormRequest
* @return A Java Future containing the result of the CreateForm operation returned by the service.
* @sample AWSAmplifyUIBuilderAsync.CreateForm
* @see AWS
* API Documentation
*/
java.util.concurrent.Future createFormAsync(CreateFormRequest createFormRequest);
/**
*
* Creates a new form for an Amplify app.
*
*
* @param createFormRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the CreateForm operation returned by the service.
* @sample AWSAmplifyUIBuilderAsyncHandler.CreateForm
* @see AWS
* API Documentation
*/
java.util.concurrent.Future createFormAsync(CreateFormRequest createFormRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Creates a theme to apply to the components in an Amplify app.
*
*
* @param createThemeRequest
* @return A Java Future containing the result of the CreateTheme operation returned by the service.
* @sample AWSAmplifyUIBuilderAsync.CreateTheme
* @see AWS
* API Documentation
*/
java.util.concurrent.Future createThemeAsync(CreateThemeRequest createThemeRequest);
/**
*
* Creates a theme to apply to the components in an Amplify app.
*
*
* @param createThemeRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the CreateTheme operation returned by the service.
* @sample AWSAmplifyUIBuilderAsyncHandler.CreateTheme
* @see AWS
* API Documentation
*/
java.util.concurrent.Future createThemeAsync(CreateThemeRequest createThemeRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Deletes a component from an Amplify app.
*
*
* @param deleteComponentRequest
* @return A Java Future containing the result of the DeleteComponent operation returned by the service.
* @sample AWSAmplifyUIBuilderAsync.DeleteComponent
* @see AWS API Documentation
*/
java.util.concurrent.Future deleteComponentAsync(DeleteComponentRequest deleteComponentRequest);
/**
*
* Deletes a component from an Amplify app.
*
*
* @param deleteComponentRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DeleteComponent operation returned by the service.
* @sample AWSAmplifyUIBuilderAsyncHandler.DeleteComponent
* @see AWS API Documentation
*/
java.util.concurrent.Future deleteComponentAsync(DeleteComponentRequest deleteComponentRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Deletes a form from an Amplify app.
*
*
* @param deleteFormRequest
* @return A Java Future containing the result of the DeleteForm operation returned by the service.
* @sample AWSAmplifyUIBuilderAsync.DeleteForm
* @see AWS
* API Documentation
*/
java.util.concurrent.Future deleteFormAsync(DeleteFormRequest deleteFormRequest);
/**
*
* Deletes a form from an Amplify app.
*
*
* @param deleteFormRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DeleteForm operation returned by the service.
* @sample AWSAmplifyUIBuilderAsyncHandler.DeleteForm
* @see AWS
* API Documentation
*/
java.util.concurrent.Future deleteFormAsync(DeleteFormRequest deleteFormRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Deletes a theme from an Amplify app.
*
*
* @param deleteThemeRequest
* @return A Java Future containing the result of the DeleteTheme operation returned by the service.
* @sample AWSAmplifyUIBuilderAsync.DeleteTheme
* @see AWS
* API Documentation
*/
java.util.concurrent.Future deleteThemeAsync(DeleteThemeRequest deleteThemeRequest);
/**
*
* Deletes a theme from an Amplify app.
*
*
* @param deleteThemeRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DeleteTheme operation returned by the service.
* @sample AWSAmplifyUIBuilderAsyncHandler.DeleteTheme
* @see AWS
* API Documentation
*/
java.util.concurrent.Future deleteThemeAsync(DeleteThemeRequest deleteThemeRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Exchanges an access code for a token.
*
*
* @param exchangeCodeForTokenRequest
* @return A Java Future containing the result of the ExchangeCodeForToken operation returned by the service.
* @sample AWSAmplifyUIBuilderAsync.ExchangeCodeForToken
* @see AWS API Documentation
*/
java.util.concurrent.Future exchangeCodeForTokenAsync(ExchangeCodeForTokenRequest exchangeCodeForTokenRequest);
/**
*
* Exchanges an access code for a token.
*
*
* @param exchangeCodeForTokenRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ExchangeCodeForToken operation returned by the service.
* @sample AWSAmplifyUIBuilderAsyncHandler.ExchangeCodeForToken
* @see AWS API Documentation
*/
java.util.concurrent.Future exchangeCodeForTokenAsync(ExchangeCodeForTokenRequest exchangeCodeForTokenRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Exports component configurations to code that is ready to integrate into an Amplify app.
*
*
* @param exportComponentsRequest
* @return A Java Future containing the result of the ExportComponents operation returned by the service.
* @sample AWSAmplifyUIBuilderAsync.ExportComponents
* @see AWS API Documentation
*/
java.util.concurrent.Future exportComponentsAsync(ExportComponentsRequest exportComponentsRequest);
/**
*
* Exports component configurations to code that is ready to integrate into an Amplify app.
*
*
* @param exportComponentsRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ExportComponents operation returned by the service.
* @sample AWSAmplifyUIBuilderAsyncHandler.ExportComponents
* @see AWS API Documentation
*/
java.util.concurrent.Future exportComponentsAsync(ExportComponentsRequest exportComponentsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Exports form configurations to code that is ready to integrate into an Amplify app.
*
*
* @param exportFormsRequest
* @return A Java Future containing the result of the ExportForms operation returned by the service.
* @sample AWSAmplifyUIBuilderAsync.ExportForms
* @see AWS
* API Documentation
*/
java.util.concurrent.Future exportFormsAsync(ExportFormsRequest exportFormsRequest);
/**
*
* Exports form configurations to code that is ready to integrate into an Amplify app.
*
*
* @param exportFormsRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ExportForms operation returned by the service.
* @sample AWSAmplifyUIBuilderAsyncHandler.ExportForms
* @see AWS
* API Documentation
*/
java.util.concurrent.Future exportFormsAsync(ExportFormsRequest exportFormsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Exports theme configurations to code that is ready to integrate into an Amplify app.
*
*
* @param exportThemesRequest
* @return A Java Future containing the result of the ExportThemes operation returned by the service.
* @sample AWSAmplifyUIBuilderAsync.ExportThemes
* @see AWS
* API Documentation
*/
java.util.concurrent.Future exportThemesAsync(ExportThemesRequest exportThemesRequest);
/**
*
* Exports theme configurations to code that is ready to integrate into an Amplify app.
*
*
* @param exportThemesRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ExportThemes operation returned by the service.
* @sample AWSAmplifyUIBuilderAsyncHandler.ExportThemes
* @see AWS
* API Documentation
*/
java.util.concurrent.Future exportThemesAsync(ExportThemesRequest exportThemesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Returns an existing component for an Amplify app.
*
*
* @param getComponentRequest
* @return A Java Future containing the result of the GetComponent operation returned by the service.
* @sample AWSAmplifyUIBuilderAsync.GetComponent
* @see AWS
* API Documentation
*/
java.util.concurrent.Future getComponentAsync(GetComponentRequest getComponentRequest);
/**
*
* Returns an existing component for an Amplify app.
*
*
* @param getComponentRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the GetComponent operation returned by the service.
* @sample AWSAmplifyUIBuilderAsyncHandler.GetComponent
* @see AWS
* API Documentation
*/
java.util.concurrent.Future getComponentAsync(GetComponentRequest getComponentRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Returns an existing form for an Amplify app.
*
*
* @param getFormRequest
* @return A Java Future containing the result of the GetForm operation returned by the service.
* @sample AWSAmplifyUIBuilderAsync.GetForm
* @see AWS API
* Documentation
*/
java.util.concurrent.Future getFormAsync(GetFormRequest getFormRequest);
/**
*
* Returns an existing form for an Amplify app.
*
*
* @param getFormRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the GetForm operation returned by the service.
* @sample AWSAmplifyUIBuilderAsyncHandler.GetForm
* @see AWS API
* Documentation
*/
java.util.concurrent.Future getFormAsync(GetFormRequest getFormRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Returns existing metadata for an Amplify app.
*
*
* @param getMetadataRequest
* @return A Java Future containing the result of the GetMetadata operation returned by the service.
* @sample AWSAmplifyUIBuilderAsync.GetMetadata
* @see AWS
* API Documentation
*/
java.util.concurrent.Future getMetadataAsync(GetMetadataRequest getMetadataRequest);
/**
*
* Returns existing metadata for an Amplify app.
*
*
* @param getMetadataRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the GetMetadata operation returned by the service.
* @sample AWSAmplifyUIBuilderAsyncHandler.GetMetadata
* @see AWS
* API Documentation
*/
java.util.concurrent.Future getMetadataAsync(GetMetadataRequest getMetadataRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Returns an existing theme for an Amplify app.
*
*
* @param getThemeRequest
* @return A Java Future containing the result of the GetTheme operation returned by the service.
* @sample AWSAmplifyUIBuilderAsync.GetTheme
* @see AWS API
* Documentation
*/
java.util.concurrent.Future getThemeAsync(GetThemeRequest getThemeRequest);
/**
*
* Returns an existing theme for an Amplify app.
*
*
* @param getThemeRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the GetTheme operation returned by the service.
* @sample AWSAmplifyUIBuilderAsyncHandler.GetTheme
* @see AWS API
* Documentation
*/
java.util.concurrent.Future getThemeAsync(GetThemeRequest getThemeRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Retrieves a list of components for a specified Amplify app and backend environment.
*
*
* @param listComponentsRequest
* @return A Java Future containing the result of the ListComponents operation returned by the service.
* @sample AWSAmplifyUIBuilderAsync.ListComponents
* @see AWS API Documentation
*/
java.util.concurrent.Future listComponentsAsync(ListComponentsRequest listComponentsRequest);
/**
*
* Retrieves a list of components for a specified Amplify app and backend environment.
*
*
* @param listComponentsRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ListComponents operation returned by the service.
* @sample AWSAmplifyUIBuilderAsyncHandler.ListComponents
* @see AWS API Documentation
*/
java.util.concurrent.Future listComponentsAsync(ListComponentsRequest listComponentsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Retrieves a list of forms for a specified Amplify app and backend environment.
*
*
* @param listFormsRequest
* @return A Java Future containing the result of the ListForms operation returned by the service.
* @sample AWSAmplifyUIBuilderAsync.ListForms
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listFormsAsync(ListFormsRequest listFormsRequest);
/**
*
* Retrieves a list of forms for a specified Amplify app and backend environment.
*
*
* @param listFormsRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ListForms operation returned by the service.
* @sample AWSAmplifyUIBuilderAsyncHandler.ListForms
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listFormsAsync(ListFormsRequest listFormsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Retrieves a list of themes for a specified Amplify app and backend environment.
*
*
* @param listThemesRequest
* @return A Java Future containing the result of the ListThemes operation returned by the service.
* @sample AWSAmplifyUIBuilderAsync.ListThemes
* @see AWS
* API Documentation
*/
java.util.concurrent.Future listThemesAsync(ListThemesRequest listThemesRequest);
/**
*
* Retrieves a list of themes for a specified Amplify app and backend environment.
*
*
* @param listThemesRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ListThemes operation returned by the service.
* @sample AWSAmplifyUIBuilderAsyncHandler.ListThemes
* @see AWS
* API Documentation
*/
java.util.concurrent.Future listThemesAsync(ListThemesRequest listThemesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Stores the metadata information about a feature on a form.
*
*
* @param putMetadataFlagRequest
* @return A Java Future containing the result of the PutMetadataFlag operation returned by the service.
* @sample AWSAmplifyUIBuilderAsync.PutMetadataFlag
* @see AWS API Documentation
*/
java.util.concurrent.Future putMetadataFlagAsync(PutMetadataFlagRequest putMetadataFlagRequest);
/**
*
* Stores the metadata information about a feature on a form.
*
*
* @param putMetadataFlagRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the PutMetadataFlag operation returned by the service.
* @sample AWSAmplifyUIBuilderAsyncHandler.PutMetadataFlag
* @see AWS API Documentation
*/
java.util.concurrent.Future putMetadataFlagAsync(PutMetadataFlagRequest putMetadataFlagRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Refreshes a previously issued access token that might have expired.
*
*
* @param refreshTokenRequest
* @return A Java Future containing the result of the RefreshToken operation returned by the service.
* @sample AWSAmplifyUIBuilderAsync.RefreshToken
* @see AWS
* API Documentation
*/
java.util.concurrent.Future refreshTokenAsync(RefreshTokenRequest refreshTokenRequest);
/**
*
* Refreshes a previously issued access token that might have expired.
*
*
* @param refreshTokenRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the RefreshToken operation returned by the service.
* @sample AWSAmplifyUIBuilderAsyncHandler.RefreshToken
* @see AWS
* API Documentation
*/
java.util.concurrent.Future refreshTokenAsync(RefreshTokenRequest refreshTokenRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Updates an existing component.
*
*
* @param updateComponentRequest
* @return A Java Future containing the result of the UpdateComponent operation returned by the service.
* @sample AWSAmplifyUIBuilderAsync.UpdateComponent
* @see AWS API Documentation
*/
java.util.concurrent.Future updateComponentAsync(UpdateComponentRequest updateComponentRequest);
/**
*
* Updates an existing component.
*
*
* @param updateComponentRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the UpdateComponent operation returned by the service.
* @sample AWSAmplifyUIBuilderAsyncHandler.UpdateComponent
* @see AWS API Documentation
*/
java.util.concurrent.Future updateComponentAsync(UpdateComponentRequest updateComponentRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Updates an existing form.
*
*
* @param updateFormRequest
* @return A Java Future containing the result of the UpdateForm operation returned by the service.
* @sample AWSAmplifyUIBuilderAsync.UpdateForm
* @see AWS
* API Documentation
*/
java.util.concurrent.Future updateFormAsync(UpdateFormRequest updateFormRequest);
/**
*
* Updates an existing form.
*
*
* @param updateFormRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the UpdateForm operation returned by the service.
* @sample AWSAmplifyUIBuilderAsyncHandler.UpdateForm
* @see AWS
* API Documentation
*/
java.util.concurrent.Future updateFormAsync(UpdateFormRequest updateFormRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Updates an existing theme.
*
*
* @param updateThemeRequest
* @return A Java Future containing the result of the UpdateTheme operation returned by the service.
* @sample AWSAmplifyUIBuilderAsync.UpdateTheme
* @see AWS
* API Documentation
*/
java.util.concurrent.Future updateThemeAsync(UpdateThemeRequest updateThemeRequest);
/**
*
* Updates an existing theme.
*
*
* @param updateThemeRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the UpdateTheme operation returned by the service.
* @sample AWSAmplifyUIBuilderAsyncHandler.UpdateTheme
* @see AWS
* API Documentation
*/
java.util.concurrent.Future updateThemeAsync(UpdateThemeRequest updateThemeRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy