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.
Implementation 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.
Namespace: Amazon.AmplifyUIBuilder
Assembly: AWSSDK.AmplifyUIBuilder.dll
Version: 3.x.y.z
public class AmazonAmplifyUIBuilderClient : AmazonServiceClient IAmazonAmplifyUIBuilder, IAmazonService, IDisposable
The AmazonAmplifyUIBuilderClient type exposes the following members
Name | Description | |
---|---|---|
AmazonAmplifyUIBuilderClient() |
Constructs AmazonAmplifyUIBuilderClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> |
|
AmazonAmplifyUIBuilderClient(RegionEndpoint) |
Constructs AmazonAmplifyUIBuilderClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> |
|
AmazonAmplifyUIBuilderClient(AmazonAmplifyUIBuilderConfig) |
Constructs AmazonAmplifyUIBuilderClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> |
|
AmazonAmplifyUIBuilderClient(AWSCredentials) |
Constructs AmazonAmplifyUIBuilderClient with AWS Credentials |
|
AmazonAmplifyUIBuilderClient(AWSCredentials, RegionEndpoint) |
Constructs AmazonAmplifyUIBuilderClient with AWS Credentials |
|
AmazonAmplifyUIBuilderClient(AWSCredentials, AmazonAmplifyUIBuilderConfig) |
Constructs AmazonAmplifyUIBuilderClient with AWS Credentials and an AmazonAmplifyUIBuilderClient Configuration object. |
|
AmazonAmplifyUIBuilderClient(string, string) |
Constructs AmazonAmplifyUIBuilderClient with AWS Access Key ID and AWS Secret Key |
|
AmazonAmplifyUIBuilderClient(string, string, RegionEndpoint) |
Constructs AmazonAmplifyUIBuilderClient with AWS Access Key ID and AWS Secret Key |
|
AmazonAmplifyUIBuilderClient(string, string, AmazonAmplifyUIBuilderConfig) |
Constructs AmazonAmplifyUIBuilderClient with AWS Access Key ID, AWS Secret Key and an AmazonAmplifyUIBuilderClient Configuration object. |
|
AmazonAmplifyUIBuilderClient(string, string, string) |
Constructs AmazonAmplifyUIBuilderClient with AWS Access Key ID and AWS Secret Key |
|
AmazonAmplifyUIBuilderClient(string, string, string, RegionEndpoint) |
Constructs AmazonAmplifyUIBuilderClient with AWS Access Key ID and AWS Secret Key |
|
AmazonAmplifyUIBuilderClient(string, string, string, AmazonAmplifyUIBuilderConfig) |
Constructs AmazonAmplifyUIBuilderClient with AWS Access Key ID, AWS Secret Key and an AmazonAmplifyUIBuilderClient Configuration object. |
Name | Type | Description | |
---|---|---|---|
Config | Amazon.Runtime.IClientConfig | Inherited from Amazon.Runtime.AmazonServiceClient. | |
Paginators | Amazon.AmplifyUIBuilder.Model.IAmplifyUIBuilderPaginatorFactory |
Paginators for the service |
Name | Description | |
---|---|---|
CreateComponent(CreateComponentRequest) |
Creates a new component for an Amplify app. |
|
CreateComponentAsync(CreateComponentRequest, CancellationToken) |
Creates a new component for an Amplify app. |
|
CreateForm(CreateFormRequest) |
Creates a new form for an Amplify app. |
|
CreateFormAsync(CreateFormRequest, CancellationToken) |
Creates a new form for an Amplify app. |
|
CreateTheme(CreateThemeRequest) |
Creates a theme to apply to the components in an Amplify app. |
|
CreateThemeAsync(CreateThemeRequest, CancellationToken) |
Creates a theme to apply to the components in an Amplify app. |
|
DeleteComponent(DeleteComponentRequest) |
Deletes a component from an Amplify app. |
|
DeleteComponentAsync(DeleteComponentRequest, CancellationToken) |
Deletes a component from an Amplify app. |
|
DeleteForm(DeleteFormRequest) |
Deletes a form from an Amplify app. |
|
DeleteFormAsync(DeleteFormRequest, CancellationToken) |
Deletes a form from an Amplify app. |
|
DeleteTheme(DeleteThemeRequest) |
Deletes a theme from an Amplify app. |
|
DeleteThemeAsync(DeleteThemeRequest, CancellationToken) |
Deletes a theme from an Amplify app. |
|
DetermineServiceOperationEndpoint(AmazonWebServiceRequest) |
Returns the endpoint that will be used for a particular request. |
|
Dispose() | Inherited from Amazon.Runtime.AmazonServiceClient. | |
ExchangeCodeForToken(ExchangeCodeForTokenRequest) |
This is for internal use.
Amplify uses this action to exchange an access code for a token. |
|
ExchangeCodeForTokenAsync(ExchangeCodeForTokenRequest, CancellationToken) |
This is for internal use.
Amplify uses this action to exchange an access code for a token. |
|
ExportComponents(ExportComponentsRequest) |
Exports component configurations to code that is ready to integrate into an Amplify app. |
|
ExportComponentsAsync(ExportComponentsRequest, CancellationToken) |
Exports component configurations to code that is ready to integrate into an Amplify app. |
|
ExportForms(ExportFormsRequest) |
Exports form configurations to code that is ready to integrate into an Amplify app. |
|
ExportFormsAsync(ExportFormsRequest, CancellationToken) |
Exports form configurations to code that is ready to integrate into an Amplify app. |
|
ExportThemes(ExportThemesRequest) |
Exports theme configurations to code that is ready to integrate into an Amplify app. |
|
ExportThemesAsync(ExportThemesRequest, CancellationToken) |
Exports theme configurations to code that is ready to integrate into an Amplify app. |
|
GetCodegenJob(GetCodegenJobRequest) |
Returns an existing code generation job. |
|
GetCodegenJobAsync(GetCodegenJobRequest, CancellationToken) |
Returns an existing code generation job. |
|
GetComponent(GetComponentRequest) |
Returns an existing component for an Amplify app. |
|
GetComponentAsync(GetComponentRequest, CancellationToken) |
Returns an existing component for an Amplify app. |
|
GetForm(GetFormRequest) |
Returns an existing form for an Amplify app. |
|
GetFormAsync(GetFormRequest, CancellationToken) |
Returns an existing form for an Amplify app. |
|
GetMetadata(GetMetadataRequest) |
Returns existing metadata for an Amplify app. |
|
GetMetadataAsync(GetMetadataRequest, CancellationToken) |
Returns existing metadata for an Amplify app. |
|
GetTheme(GetThemeRequest) |
Returns an existing theme for an Amplify app. |
|
GetThemeAsync(GetThemeRequest, CancellationToken) |
Returns an existing theme for an Amplify app. |
|
ListCodegenJobs(ListCodegenJobsRequest) |
Retrieves a list of code generation jobs for a specified Amplify app and backend environment. |
|
ListCodegenJobsAsync(ListCodegenJobsRequest, CancellationToken) |
Retrieves a list of code generation jobs for a specified Amplify app and backend environment. |
|
ListComponents(ListComponentsRequest) |
Retrieves a list of components for a specified Amplify app and backend environment. |
|
ListComponentsAsync(ListComponentsRequest, CancellationToken) |
Retrieves a list of components for a specified Amplify app and backend environment. |
|
ListForms(ListFormsRequest) |
Retrieves a list of forms for a specified Amplify app and backend environment. |
|
ListFormsAsync(ListFormsRequest, CancellationToken) |
Retrieves a list of forms for a specified Amplify app and backend environment. |
|
ListTagsForResource(ListTagsForResourceRequest) |
Returns a list of tags for a specified Amazon Resource Name (ARN). |
|
ListTagsForResourceAsync(ListTagsForResourceRequest, CancellationToken) |
Returns a list of tags for a specified Amazon Resource Name (ARN). |
|
ListThemes(ListThemesRequest) |
Retrieves a list of themes for a specified Amplify app and backend environment. |
|
ListThemesAsync(ListThemesRequest, CancellationToken) |
Retrieves a list of themes for a specified Amplify app and backend environment. |
|
PutMetadataFlag(PutMetadataFlagRequest) |
Stores the metadata information about a feature on a form. |
|
PutMetadataFlagAsync(PutMetadataFlagRequest, CancellationToken) |
Stores the metadata information about a feature on a form. |
|
RefreshToken(RefreshTokenRequest) |
This is for internal use.
Amplify uses this action to refresh a previously issued access token that might have expired. |
|
RefreshTokenAsync(RefreshTokenRequest, CancellationToken) |
This is for internal use.
Amplify uses this action to refresh a previously issued access token that might have expired. |
|
StartCodegenJob(StartCodegenJobRequest) |
Starts a code generation job for a specified Amplify app and backend environment. |
|
StartCodegenJobAsync(StartCodegenJobRequest, CancellationToken) |
Starts a code generation job for a specified Amplify app and backend environment. |
|
TagResource(TagResourceRequest) |
Tags the resource with a tag key and value. |
|
TagResourceAsync(TagResourceRequest, CancellationToken) |
Tags the resource with a tag key and value. |
|
UntagResource(UntagResourceRequest) |
Untags a resource with a specified Amazon Resource Name (ARN). |
|
UntagResourceAsync(UntagResourceRequest, CancellationToken) |
Untags a resource with a specified Amazon Resource Name (ARN). |
|
UpdateComponent(UpdateComponentRequest) |
Updates an existing component. |
|
UpdateComponentAsync(UpdateComponentRequest, CancellationToken) |
Updates an existing component. |
|
UpdateForm(UpdateFormRequest) |
Updates an existing form. |
|
UpdateFormAsync(UpdateFormRequest, CancellationToken) |
Updates an existing form. |
|
UpdateTheme(UpdateThemeRequest) |
Updates an existing theme. |
|
UpdateThemeAsync(UpdateThemeRequest, CancellationToken) |
Updates an existing theme. |
Name | Description | |
---|---|---|
AfterResponseEvent | Inherited from Amazon.Runtime.AmazonServiceClient. | |
BeforeRequestEvent | Inherited from Amazon.Runtime.AmazonServiceClient. | |
ExceptionEvent | Inherited from Amazon.Runtime.AmazonServiceClient. |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5