View Source AWS.AmplifyUIBuilder (aws-elixir v0.14.1)

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.

Summary

Functions

create_component(client, app_id, environment_name, input, options \\ [])

Creates a new component for an Amplify app.

create_form(client, app_id, environment_name, input, options \\ [])

Creates a new form for an Amplify app.

create_theme(client, app_id, environment_name, input, options \\ [])

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

delete_component(client, app_id, environment_name, id, input, options \\ [])

Deletes a component from an Amplify app.

delete_form(client, app_id, environment_name, id, input, options \\ [])

Deletes a form from an Amplify app.

delete_theme(client, app_id, environment_name, id, input, options \\ [])

Deletes a theme from an Amplify app.

exchange_code_for_token(client, provider, input, options \\ [])

This is for internal use.

export_components(client, app_id, environment_name, next_token \\ nil, options \\ [])

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

export_forms(client, app_id, environment_name, next_token \\ nil, options \\ [])

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

export_themes(client, app_id, environment_name, next_token \\ nil, options \\ [])

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

get_codegen_job(client, app_id, environment_name, id, options \\ [])

Returns an existing code generation job.

get_component(client, app_id, environment_name, id, options \\ [])

Returns an existing component for an Amplify app.

get_form(client, app_id, environment_name, id, options \\ [])

Returns an existing form for an Amplify app.

get_metadata(client, app_id, environment_name, options \\ [])

Returns existing metadata for an Amplify app.

get_theme(client, app_id, environment_name, id, options \\ [])

Returns an existing theme for an Amplify app.

list_codegen_jobs(client, app_id, environment_name, max_results \\ nil, next_token \\ nil, options \\ [])

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

list_components(client, app_id, environment_name, max_results \\ nil, next_token \\ nil, options \\ [])

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

list_forms(client, app_id, environment_name, max_results \\ nil, next_token \\ nil, options \\ [])

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

list_themes(client, app_id, environment_name, max_results \\ nil, next_token \\ nil, options \\ [])

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

metadata()
put_metadata_flag(client, app_id, environment_name, feature_name, input, options \\ [])

Stores the metadata information about a feature on a form.

refresh_token(client, provider, input, options \\ [])

This is for internal use.

start_codegen_job(client, app_id, environment_name, input, options \\ [])

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

update_component(client, app_id, environment_name, id, input, options \\ [])

Updates an existing component.

update_form(client, app_id, environment_name, id, input, options \\ [])

Updates an existing form.

update_theme(client, app_id, environment_name, id, input, options \\ [])

Updates an existing theme.

Functions

Link to this function

create_component(client, app_id, environment_name, input, options \\ [])

View Source

Creates a new component for an Amplify app.

Link to this function

create_form(client, app_id, environment_name, input, options \\ [])

View Source

Creates a new form for an Amplify app.

Link to this function

create_theme(client, app_id, environment_name, input, options \\ [])

View Source

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

Link to this function

delete_component(client, app_id, environment_name, id, input, options \\ [])

View Source

Deletes a component from an Amplify app.

Link to this function

delete_form(client, app_id, environment_name, id, input, options \\ [])

View Source

Deletes a form from an Amplify app.

Link to this function

delete_theme(client, app_id, environment_name, id, input, options \\ [])

View Source

Deletes a theme from an Amplify app.

Link to this function

exchange_code_for_token(client, provider, input, options \\ [])

View Source

This is for internal use.

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

Link to this function

export_components(client, app_id, environment_name, next_token \\ nil, options \\ [])

View Source

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

Link to this function

export_forms(client, app_id, environment_name, next_token \\ nil, options \\ [])

View Source

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

Link to this function

export_themes(client, app_id, environment_name, next_token \\ nil, options \\ [])

View Source

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

Link to this function

get_codegen_job(client, app_id, environment_name, id, options \\ [])

View Source

Returns an existing code generation job.

Link to this function

get_component(client, app_id, environment_name, id, options \\ [])

View Source

Returns an existing component for an Amplify app.

Link to this function

get_form(client, app_id, environment_name, id, options \\ [])

View Source

Returns an existing form for an Amplify app.

Link to this function

get_metadata(client, app_id, environment_name, options \\ [])

View Source

Returns existing metadata for an Amplify app.

Link to this function

get_theme(client, app_id, environment_name, id, options \\ [])

View Source

Returns an existing theme for an Amplify app.

Link to this function

list_codegen_jobs(client, app_id, environment_name, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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

Link to this function

list_components(client, app_id, environment_name, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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

Link to this function

list_forms(client, app_id, environment_name, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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

Link to this function

list_themes(client, app_id, environment_name, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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

Link to this function

metadata()

View Source
Link to this function

put_metadata_flag(client, app_id, environment_name, feature_name, input, options \\ [])

View Source

Stores the metadata information about a feature on a form.

Link to this function

refresh_token(client, provider, input, options \\ [])

View Source

This is for internal use.

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

Link to this function

start_codegen_job(client, app_id, environment_name, input, options \\ [])

View Source

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

Link to this function

update_component(client, app_id, environment_name, id, input, options \\ [])

View Source

Updates an existing component.

Link to this function

update_form(client, app_id, environment_name, id, input, options \\ [])

View Source

Updates an existing form.

Link to this function

update_theme(client, app_id, environment_name, id, input, options \\ [])

View Source

Updates an existing theme.