AmplifyUIBuilder class

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.

Constructors

AmplifyUIBuilder({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

close() → void

Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.

createComponent({required String appId, required CreateComponentData componentToCreate, required String environmentName, String? clientToken}) → Future<CreateComponentResponse>

Creates a new component for an Amplify app.

createForm({required String appId, required String environmentName, required CreateFormData formToCreate, String? clientToken}) → Future<CreateFormResponse>

Creates a new form for an Amplify app.

createTheme({required String appId, required String environmentName, required CreateThemeData themeToCreate, String? clientToken}) → Future<CreateThemeResponse>

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

deleteComponent({required String appId, required String environmentName, required String id}) → Future<void>

Deletes a component from an Amplify app.

deleteForm({required String appId, required String environmentName, required String id}) → Future<void>

Deletes a form from an Amplify app.

deleteTheme({required String appId, required String environmentName, required String id}) → Future<void>

Deletes a theme from an Amplify app.

exchangeCodeForToken({required TokenProviders provider, required ExchangeCodeForTokenRequestBody request}) → Future<ExchangeCodeForTokenResponse>

May throw InvalidParameterException.

exportComponents({required String appId, required String environmentName, String? nextToken}) → Future<ExportComponentsResponse>

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

exportForms({required String appId, required String environmentName, String? nextToken}) → Future<ExportFormsResponse>

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

exportThemes({required String appId, required String environmentName, String? nextToken}) → Future<ExportThemesResponse>

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

getCodegenJob({required String appId, required String environmentName, required String id}) → Future<GetCodegenJobResponse>

Returns an existing code generation job.

getComponent({required String appId, required String environmentName, required String id}) → Future<GetComponentResponse>

Returns an existing component for an Amplify app.

getForm({required String appId, required String environmentName, required String id}) → Future<GetFormResponse>

Returns an existing form for an Amplify app.

getMetadata({required String appId, required String environmentName}) → Future<GetMetadataResponse>

Returns existing metadata for an Amplify app.

getTheme({required String appId, required String environmentName, required String id}) → Future<GetThemeResponse>

Returns an existing theme for an Amplify app.

listCodegenJobs({required String appId, required String environmentName, int? maxResults, String? nextToken}) → Future<ListCodegenJobsResponse>

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

listComponents({required String appId, required String environmentName, int? maxResults, String? nextToken}) → Future<ListComponentsResponse>

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

listForms({required String appId, required String environmentName, int? maxResults, String? nextToken}) → Future<ListFormsResponse>

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

listTagsForResource({required String resourceArn}) → Future<ListTagsForResourceResponse>

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

listThemes({required String appId, required String environmentName, int? maxResults, String? nextToken}) → Future<ListThemesResponse>

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

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

putMetadataFlag({required String appId, required PutMetadataFlagBody body, required String environmentName, required String featureName}) → Future<void>

Stores the metadata information about a feature on a form.

refreshToken({required TokenProviders provider, required RefreshTokenRequestBody refreshTokenBody}) → Future<RefreshTokenResponse>

May throw InvalidParameterException.

startCodegenJob({required String appId, required StartCodegenJobData codegenJobToCreate, required String environmentName, String? clientToken}) → Future<StartCodegenJobResponse>

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

tagResource({required String resourceArn, required Map<String, String> tags}) → Future<void>

Tags the resource with a tag key and value.

toString() → String

A string representation of this object.

inherited

untagResource({required String resourceArn, required List<String> tagKeys}) → Future<void>

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

updateComponent({required String appId, required String environmentName, required String id, required UpdateComponentData updatedComponent, String? clientToken}) → Future<UpdateComponentResponse>

Updates an existing component.

updateForm({required String appId, required String environmentName, required String id, required UpdateFormData updatedForm, String? clientToken}) → Future<UpdateFormResponse>

Updates an existing form.

updateTheme({required String appId, required String environmentName, required String id, required UpdateThemeData updatedTheme, String? clientToken}) → Future<UpdateThemeResponse>

Updates an existing theme.

Operators

operator ==(Object other) → bool

The equality operator.

inherited