AWSAmplifyUIBuilderAsync (AWS SDK for Java

All Superinterfaces:

AWSAmplifyUIBuilder

All Known Implementing Classes:

AbstractAWSAmplifyUIBuilderAsync, AWSAmplifyUIBuilderAsyncClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSAmplifyUIBuilderAsync
extends AWSAmplifyUIBuilder
```
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 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 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 Console User Guide.

Field Summary
- Fields inherited from interface com.amazonaws.services.amplifyuibuilder.AWSAmplifyUIBuilder
  ENDPOINT_PREFIX

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Future<CreateComponentResult>`	`createComponentAsync(CreateComponentRequest createComponentRequest)` Creates a new component for an Amplify app.
`Future<CreateComponentResult>`	`createComponentAsync(CreateComponentRequest createComponentRequest, AsyncHandler<CreateComponentRequest,CreateComponentResult> asyncHandler)` Creates a new component for an Amplify app.
`Future<CreateThemeResult>`	`createThemeAsync(CreateThemeRequest createThemeRequest)` Creates a theme to apply to the components in an Amplify app.
`Future<CreateThemeResult>`	`createThemeAsync(CreateThemeRequest createThemeRequest, AsyncHandler<CreateThemeRequest,CreateThemeResult> asyncHandler)` Creates a theme to apply to the components in an Amplify app.
`Future<DeleteComponentResult>`	`deleteComponentAsync(DeleteComponentRequest deleteComponentRequest)` Deletes a component from an Amplify app.
`Future<DeleteComponentResult>`	`deleteComponentAsync(DeleteComponentRequest deleteComponentRequest, AsyncHandler<DeleteComponentRequest,DeleteComponentResult> asyncHandler)` Deletes a component from an Amplify app.
`Future<DeleteThemeResult>`	`deleteThemeAsync(DeleteThemeRequest deleteThemeRequest)` Deletes a theme from an Amplify app.
`Future<DeleteThemeResult>`	`deleteThemeAsync(DeleteThemeRequest deleteThemeRequest, AsyncHandler<DeleteThemeRequest,DeleteThemeResult> asyncHandler)` Deletes a theme from an Amplify app.
`Future<ExchangeCodeForTokenResult>`	`exchangeCodeForTokenAsync(ExchangeCodeForTokenRequest exchangeCodeForTokenRequest)` Exchanges an access code for a token.
`Future<ExchangeCodeForTokenResult>`	`exchangeCodeForTokenAsync(ExchangeCodeForTokenRequest exchangeCodeForTokenRequest, AsyncHandler<ExchangeCodeForTokenRequest,ExchangeCodeForTokenResult> asyncHandler)` Exchanges an access code for a token.
`Future<ExportComponentsResult>`	`exportComponentsAsync(ExportComponentsRequest exportComponentsRequest)` Exports component configurations to code that is ready to integrate into an Amplify app.
`Future<ExportComponentsResult>`	`exportComponentsAsync(ExportComponentsRequest exportComponentsRequest, AsyncHandler<ExportComponentsRequest,ExportComponentsResult> asyncHandler)` Exports component configurations to code that is ready to integrate into an Amplify app.
`Future<ExportThemesResult>`	`exportThemesAsync(ExportThemesRequest exportThemesRequest)` Exports theme configurations to code that is ready to integrate into an Amplify app.
`Future<ExportThemesResult>`	`exportThemesAsync(ExportThemesRequest exportThemesRequest, AsyncHandler<ExportThemesRequest,ExportThemesResult> asyncHandler)` Exports theme configurations to code that is ready to integrate into an Amplify app.
`Future<GetComponentResult>`	`getComponentAsync(GetComponentRequest getComponentRequest)` Returns an existing component for an Amplify app.
`Future<GetComponentResult>`	`getComponentAsync(GetComponentRequest getComponentRequest, AsyncHandler<GetComponentRequest,GetComponentResult> asyncHandler)` Returns an existing component for an Amplify app.
`Future<GetThemeResult>`	`getThemeAsync(GetThemeRequest getThemeRequest)` Returns an existing theme for an Amplify app.
`Future<GetThemeResult>`	`getThemeAsync(GetThemeRequest getThemeRequest, AsyncHandler<GetThemeRequest,GetThemeResult> asyncHandler)` Returns an existing theme for an Amplify app.
`Future<ListComponentsResult>`	`listComponentsAsync(ListComponentsRequest listComponentsRequest)` Retrieves a list of components for a specified Amplify app and backend environment.
`Future<ListComponentsResult>`	`listComponentsAsync(ListComponentsRequest listComponentsRequest, AsyncHandler<ListComponentsRequest,ListComponentsResult> asyncHandler)` Retrieves a list of components for a specified Amplify app and backend environment.
`Future<ListThemesResult>`	`listThemesAsync(ListThemesRequest listThemesRequest)` Retrieves a list of themes for a specified Amplify app and backend environment.
`Future<ListThemesResult>`	`listThemesAsync(ListThemesRequest listThemesRequest, AsyncHandler<ListThemesRequest,ListThemesResult> asyncHandler)` Retrieves a list of themes for a specified Amplify app and backend environment.
`Future<RefreshTokenResult>`	`refreshTokenAsync(RefreshTokenRequest refreshTokenRequest)` Refreshes a previously issued access token that might have expired.
`Future<RefreshTokenResult>`	`refreshTokenAsync(RefreshTokenRequest refreshTokenRequest, AsyncHandler<RefreshTokenRequest,RefreshTokenResult> asyncHandler)` Refreshes a previously issued access token that might have expired.
`Future<UpdateComponentResult>`	`updateComponentAsync(UpdateComponentRequest updateComponentRequest)` Updates an existing component.
`Future<UpdateComponentResult>`	`updateComponentAsync(UpdateComponentRequest updateComponentRequest, AsyncHandler<UpdateComponentRequest,UpdateComponentResult> asyncHandler)` Updates an existing component.
`Future<UpdateThemeResult>`	`updateThemeAsync(UpdateThemeRequest updateThemeRequest)` Updates an existing theme.
`Future<UpdateThemeResult>`	`updateThemeAsync(UpdateThemeRequest updateThemeRequest, AsyncHandler<UpdateThemeRequest,UpdateThemeResult> asyncHandler)` Updates an existing theme.

Methods inherited from interface com.amazonaws.services.amplifyuibuilder.AWSAmplifyUIBuilder
createComponent, createTheme, deleteComponent, deleteTheme, exchangeCodeForToken, exportComponents, exportThemes, getCachedResponseMetadata, getComponent, getTheme, listComponents, listThemes, refreshToken, shutdown, updateComponent, updateTheme

- Method Detail
  - createComponentAsync
```
Future<CreateComponentResult> createComponentAsync(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.
    
    See Also:
    
    AWS API Documentation
  - createComponentAsync
```
Future<CreateComponentResult> createComponentAsync(CreateComponentRequest createComponentRequest,
                                                   AsyncHandler<CreateComponentRequest,CreateComponentResult> asyncHandler)
```
    Creates a new component for an Amplify app.
    
    Parameters:
    
    createComponentRequest -
    
    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.
    
    Returns:
    
    A Java Future containing the result of the CreateComponent operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createThemeAsync
```
Future<CreateThemeResult> createThemeAsync(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.
    
    See Also:
    
    AWS API Documentation
  - createThemeAsync
```
Future<CreateThemeResult> createThemeAsync(CreateThemeRequest createThemeRequest,
                                           AsyncHandler<CreateThemeRequest,CreateThemeResult> asyncHandler)
```
    Creates a theme to apply to the components in an Amplify app.
    
    Parameters:
    
    createThemeRequest -
    
    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.
    
    Returns:
    
    A Java Future containing the result of the CreateTheme operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteComponentAsync
```
Future<DeleteComponentResult> deleteComponentAsync(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.
    
    See Also:
    
    AWS API Documentation
  - deleteComponentAsync
```
Future<DeleteComponentResult> deleteComponentAsync(DeleteComponentRequest deleteComponentRequest,
                                                   AsyncHandler<DeleteComponentRequest,DeleteComponentResult> asyncHandler)
```
    Deletes a component from an Amplify app.
    
    Parameters:
    
    deleteComponentRequest -
    
    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.
    
    Returns:
    
    A Java Future containing the result of the DeleteComponent operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteThemeAsync
```
Future<DeleteThemeResult> deleteThemeAsync(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.
    
    See Also:
    
    AWS API Documentation
  - deleteThemeAsync
```
Future<DeleteThemeResult> deleteThemeAsync(DeleteThemeRequest deleteThemeRequest,
                                           AsyncHandler<DeleteThemeRequest,DeleteThemeResult> asyncHandler)
```
    Deletes a theme from an Amplify app.
    
    Parameters:
    
    deleteThemeRequest -
    
    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.
    
    Returns:
    
    A Java Future containing the result of the DeleteTheme operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - exchangeCodeForTokenAsync
```
Future<ExchangeCodeForTokenResult> exchangeCodeForTokenAsync(ExchangeCodeForTokenRequest exchangeCodeForTokenRequest)
```
    Exchanges an access code for a token.
    
    Parameters:
    
    exchangeCodeForTokenRequest -
    
    Returns:
    
    A Java Future containing the result of the ExchangeCodeForToken operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - exchangeCodeForTokenAsync
```
Future<ExchangeCodeForTokenResult> exchangeCodeForTokenAsync(ExchangeCodeForTokenRequest exchangeCodeForTokenRequest,
                                                             AsyncHandler<ExchangeCodeForTokenRequest,ExchangeCodeForTokenResult> asyncHandler)
```
    Exchanges an access code for a token.
    
    Parameters:
    
    exchangeCodeForTokenRequest -
    
    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.
    
    Returns:
    
    A Java Future containing the result of the ExchangeCodeForToken operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - exportComponentsAsync
```
Future<ExportComponentsResult> exportComponentsAsync(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.
    
    See Also:
    
    AWS API Documentation
  - exportComponentsAsync
```
Future<ExportComponentsResult> exportComponentsAsync(ExportComponentsRequest exportComponentsRequest,
                                                     AsyncHandler<ExportComponentsRequest,ExportComponentsResult> asyncHandler)
```
    Exports component configurations to code that is ready to integrate into an Amplify app.
    
    Parameters:
    
    exportComponentsRequest -
    
    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.
    
    Returns:
    
    A Java Future containing the result of the ExportComponents operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - exportThemesAsync
```
Future<ExportThemesResult> exportThemesAsync(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.
    
    See Also:
    
    AWS API Documentation
  - exportThemesAsync
```
Future<ExportThemesResult> exportThemesAsync(ExportThemesRequest exportThemesRequest,
                                             AsyncHandler<ExportThemesRequest,ExportThemesResult> asyncHandler)
```
    Exports theme configurations to code that is ready to integrate into an Amplify app.
    
    Parameters:
    
    exportThemesRequest -
    
    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.
    
    Returns:
    
    A Java Future containing the result of the ExportThemes operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getComponentAsync
```
Future<GetComponentResult> getComponentAsync(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.
    
    See Also:
    
    AWS API Documentation
  - getComponentAsync
```
Future<GetComponentResult> getComponentAsync(GetComponentRequest getComponentRequest,
                                             AsyncHandler<GetComponentRequest,GetComponentResult> asyncHandler)
```
    Returns an existing component for an Amplify app.
    
    Parameters:
    
    getComponentRequest -
    
    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.
    
    Returns:
    
    A Java Future containing the result of the GetComponent operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getThemeAsync
```
Future<GetThemeResult> getThemeAsync(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.
    
    See Also:
    
    AWS API Documentation
  - getThemeAsync
```
Future<GetThemeResult> getThemeAsync(GetThemeRequest getThemeRequest,
                                     AsyncHandler<GetThemeRequest,GetThemeResult> asyncHandler)
```
    Returns an existing theme for an Amplify app.
    
    Parameters:
    
    getThemeRequest -
    
    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.
    
    Returns:
    
    A Java Future containing the result of the GetTheme operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listComponentsAsync
```
Future<ListComponentsResult> listComponentsAsync(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.
    
    See Also:
    
    AWS API Documentation
  - listComponentsAsync
```
Future<ListComponentsResult> listComponentsAsync(ListComponentsRequest listComponentsRequest,
                                                 AsyncHandler<ListComponentsRequest,ListComponentsResult> asyncHandler)
```
    Retrieves a list of components for a specified Amplify app and backend environment.
    
    Parameters:
    
    listComponentsRequest -
    
    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.
    
    Returns:
    
    A Java Future containing the result of the ListComponents operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listThemesAsync
```
Future<ListThemesResult> listThemesAsync(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.
    
    See Also:
    
    AWS API Documentation
  - listThemesAsync
```
Future<ListThemesResult> listThemesAsync(ListThemesRequest listThemesRequest,
                                         AsyncHandler<ListThemesRequest,ListThemesResult> asyncHandler)
```
    Retrieves a list of themes for a specified Amplify app and backend environment.
    
    Parameters:
    
    listThemesRequest -
    
    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.
    
    Returns:
    
    A Java Future containing the result of the ListThemes operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - refreshTokenAsync
```
Future<RefreshTokenResult> refreshTokenAsync(RefreshTokenRequest refreshTokenRequest)
```
    Refreshes 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.
    
    See Also:
    
    AWS API Documentation
  - refreshTokenAsync
```
Future<RefreshTokenResult> refreshTokenAsync(RefreshTokenRequest refreshTokenRequest,
                                             AsyncHandler<RefreshTokenRequest,RefreshTokenResult> asyncHandler)
```
    Refreshes a previously issued access token that might have expired.
    
    Parameters:
    
    refreshTokenRequest -
    
    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.
    
    Returns:
    
    A Java Future containing the result of the RefreshToken operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateComponentAsync
```
Future<UpdateComponentResult> updateComponentAsync(UpdateComponentRequest updateComponentRequest)
```
    Updates an existing component.
    
    Parameters:
    
    updateComponentRequest -
    
    Returns:
    
    A Java Future containing the result of the UpdateComponent operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateComponentAsync
```
Future<UpdateComponentResult> updateComponentAsync(UpdateComponentRequest updateComponentRequest,
                                                   AsyncHandler<UpdateComponentRequest,UpdateComponentResult> asyncHandler)
```
    Updates an existing component.
    
    Parameters:
    
    updateComponentRequest -
    
    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.
    
    Returns:
    
    A Java Future containing the result of the UpdateComponent operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateThemeAsync
```
Future<UpdateThemeResult> updateThemeAsync(UpdateThemeRequest updateThemeRequest)
```
    Updates an existing theme.
    
    Parameters:
    
    updateThemeRequest -
    
    Returns:
    
    A Java Future containing the result of the UpdateTheme operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateThemeAsync
```
Future<UpdateThemeResult> updateThemeAsync(UpdateThemeRequest updateThemeRequest,
                                           AsyncHandler<UpdateThemeRequest,UpdateThemeResult> asyncHandler)
```
    Updates an existing theme.
    
    Parameters:
    
    updateThemeRequest -
    
    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.
    
    Returns:
    
    A Java Future containing the result of the UpdateTheme operation returned by the service.
    
    See Also:
    
    AWS API Documentation

Did this page help you?

Interface AWSAmplifyUIBuilderAsync

Field Summary

Fields inherited from interface com.amazonaws.services.amplifyuibuilder.AWSAmplifyUIBuilder

Method Summary

Methods inherited from interface com.amazonaws.services.amplifyuibuilder.AWSAmplifyUIBuilder

Method Detail

createComponentAsync

createComponentAsync

createThemeAsync

createThemeAsync

deleteComponentAsync

deleteComponentAsync

deleteThemeAsync

deleteThemeAsync

exchangeCodeForTokenAsync

exchangeCodeForTokenAsync

exportComponentsAsync

exportComponentsAsync

exportThemesAsync

exportThemesAsync

getComponentAsync

getComponentAsync

getThemeAsync

getThemeAsync

listComponentsAsync

listComponentsAsync

listThemesAsync

listThemesAsync

refreshTokenAsync

refreshTokenAsync

updateComponentAsync

updateComponentAsync

updateThemeAsync

updateThemeAsync