AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Interface for accessing AmplifyUIBuilder

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.

Inheritance Hierarchy

Amazon.AmplifyUIBuilder.IAmazonAmplifyUIBuilder

Namespace: Amazon.AmplifyUIBuilder
Assembly: AWSSDK.AmplifyUIBuilder.dll
Version: 3.x.y.z

Syntax

C# 
public interface IAmazonAmplifyUIBuilder
         IAmazonService, IDisposable

The IAmazonAmplifyUIBuilder type exposes the following members

Properties

NameTypeDescription
Public Property Paginators Amazon.AmplifyUIBuilder.Model.IAmplifyUIBuilderPaginatorFactory

Paginators for the service

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method CreateComponent(CreateComponentRequest)

Creates a new component for an Amplify app.

Public Method CreateComponentAsync(CreateComponentRequest, CancellationToken)

Creates a new component for an Amplify app.

Public Method CreateForm(CreateFormRequest)

Creates a new form for an Amplify app.

Public Method CreateFormAsync(CreateFormRequest, CancellationToken)

Creates a new form for an Amplify app.

Public Method CreateTheme(CreateThemeRequest)

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

Public Method CreateThemeAsync(CreateThemeRequest, CancellationToken)

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

Public Method DeleteComponent(DeleteComponentRequest)

Deletes a component from an Amplify app.

Public Method DeleteComponentAsync(DeleteComponentRequest, CancellationToken)

Deletes a component from an Amplify app.

Public Method DeleteForm(DeleteFormRequest)

Deletes a form from an Amplify app.

Public Method DeleteFormAsync(DeleteFormRequest, CancellationToken)

Deletes a form from an Amplify app.

Public Method DeleteTheme(DeleteThemeRequest)

Deletes a theme from an Amplify app.

Public Method DeleteThemeAsync(DeleteThemeRequest, CancellationToken)

Deletes a theme from an Amplify app.

Public Method DetermineServiceOperationEndpoint(AmazonWebServiceRequest)

Returns the endpoint that will be used for a particular request.

Public Method ExchangeCodeForToken(ExchangeCodeForTokenRequest)

This is for internal use.

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

Public Method ExchangeCodeForTokenAsync(ExchangeCodeForTokenRequest, CancellationToken)

This is for internal use.

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

Public Method ExportComponents(ExportComponentsRequest)

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

Public Method ExportComponentsAsync(ExportComponentsRequest, CancellationToken)

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

Public Method ExportForms(ExportFormsRequest)

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

Public Method ExportFormsAsync(ExportFormsRequest, CancellationToken)

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

Public Method ExportThemes(ExportThemesRequest)

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

Public Method ExportThemesAsync(ExportThemesRequest, CancellationToken)

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

Public Method GetCodegenJob(GetCodegenJobRequest)

Returns an existing code generation job.

Public Method GetCodegenJobAsync(GetCodegenJobRequest, CancellationToken)

Returns an existing code generation job.

Public Method GetComponent(GetComponentRequest)

Returns an existing component for an Amplify app.

Public Method GetComponentAsync(GetComponentRequest, CancellationToken)

Returns an existing component for an Amplify app.

Public Method GetForm(GetFormRequest)

Returns an existing form for an Amplify app.

Public Method GetFormAsync(GetFormRequest, CancellationToken)

Returns an existing form for an Amplify app.

Public Method GetMetadata(GetMetadataRequest)

Returns existing metadata for an Amplify app.

Public Method GetMetadataAsync(GetMetadataRequest, CancellationToken)

Returns existing metadata for an Amplify app.

Public Method GetTheme(GetThemeRequest)

Returns an existing theme for an Amplify app.

Public Method GetThemeAsync(GetThemeRequest, CancellationToken)

Returns an existing theme for an Amplify app.

Public Method ListCodegenJobs(ListCodegenJobsRequest)

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

Public Method ListCodegenJobsAsync(ListCodegenJobsRequest, CancellationToken)

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

Public Method ListComponents(ListComponentsRequest)

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

Public Method ListComponentsAsync(ListComponentsRequest, CancellationToken)

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

Public Method ListForms(ListFormsRequest)

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

Public Method ListFormsAsync(ListFormsRequest, CancellationToken)

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

Public Method ListTagsForResource(ListTagsForResourceRequest)

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

Public Method ListTagsForResourceAsync(ListTagsForResourceRequest, CancellationToken)

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

Public Method ListThemes(ListThemesRequest)

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

Public Method ListThemesAsync(ListThemesRequest, CancellationToken)

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

Public Method PutMetadataFlag(PutMetadataFlagRequest)

Stores the metadata information about a feature on a form.

Public Method PutMetadataFlagAsync(PutMetadataFlagRequest, CancellationToken)

Stores the metadata information about a feature on a form.

Public Method RefreshToken(RefreshTokenRequest)

This is for internal use.

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

Public Method RefreshTokenAsync(RefreshTokenRequest, CancellationToken)

This is for internal use.

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

Public Method StartCodegenJob(StartCodegenJobRequest)

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

Public Method StartCodegenJobAsync(StartCodegenJobRequest, CancellationToken)

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

Public Method TagResource(TagResourceRequest)

Tags the resource with a tag key and value.

Public Method TagResourceAsync(TagResourceRequest, CancellationToken)

Tags the resource with a tag key and value.

Public Method UntagResource(UntagResourceRequest)

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

Public Method UntagResourceAsync(UntagResourceRequest, CancellationToken)

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

Public Method UpdateComponent(UpdateComponentRequest)

Updates an existing component.

Public Method UpdateComponentAsync(UpdateComponentRequest, CancellationToken)

Updates an existing component.

Public Method UpdateForm(UpdateFormRequest)

Updates an existing form.

Public Method UpdateFormAsync(UpdateFormRequest, CancellationToken)

Updates an existing form.

Public Method UpdateTheme(UpdateThemeRequest)

Updates an existing theme.

Public Method UpdateThemeAsync(UpdateThemeRequest, CancellationToken)

Updates an existing theme.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5