AWS Amplify UI Builder
The Amplify UI Builder API provides a programmatic interface for creating and configuring user interface (UI) component libraries and themes for use in your…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
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 .
Endpoints 28
Component
- GETList components
/app/:appId/environment/:environmentName/components?nextToken=string&maxResults=0Retrieves a list of components for a specified Amplify app and backend environment. - POSTCreate component
/app/:appId/environment/:environmentName/components?clientToken=stringCreates a new component for an Amplify app. - GETGet component
/app/:appId/environment/:environmentName/components/:idReturns an existing component for an Amplify app. - DELETEDelete component
/app/:appId/environment/:environmentName/components/:idDeletes a component from an Amplify app. - PATCHUpdate component
/app/:appId/environment/:environmentName/components/:id?clientToken=stringUpdates an existing component. - GETExport components
/export/app/:appId/environment/:environmentName/components?nextToken=stringExports component configurations to code that is ready to integrate into an Amplify app.
Form
- GETList forms
/app/:appId/environment/:environmentName/forms?nextToken=string&maxResults=0Retrieves a list of forms for a specified Amplify app and backend environment. - POSTCreate form
/app/:appId/environment/:environmentName/forms?clientToken=stringCreates a new form for an Amplify app. - GETGet form
/app/:appId/environment/:environmentName/forms/:idReturns an existing form for an Amplify app. - DELETEDelete form
/app/:appId/environment/:environmentName/forms/:idDeletes a form from an Amplify app. - PATCHUpdate form
/app/:appId/environment/:environmentName/forms/:id?clientToken=stringUpdates an existing form. - GETExport forms
/export/app/:appId/environment/:environmentName/forms?nextToken=stringExports form configurations to code that is ready to integrate into an Amplify app.
Theme
- GETList themes
/app/:appId/environment/:environmentName/themes?nextToken=string&maxResults=0Retrieves a list of themes for a specified Amplify app and backend environment. - POSTCreate theme
/app/:appId/environment/:environmentName/themes?clientToken=stringCreates a theme to apply to the components in an Amplify app. - GETGet theme
/app/:appId/environment/:environmentName/themes/:idReturns an existing theme for an Amplify app. - DELETEDelete theme
/app/:appId/environment/:environmentName/themes/:idDeletes a theme from an Amplify app. - PATCHUpdate theme
/app/:appId/environment/:environmentName/themes/:id?clientToken=stringUpdates an existing theme. - GETExport themes
/export/app/:appId/environment/:environmentName/themes?nextToken=stringExports theme configurations to code that is ready to integrate into an Amplify app.
Codegen job
- GETGet codegen job
/app/:appId/environment/:environmentName/codegen-jobs/:idReturns an existing code generation job. - GETList codegen jobs
/app/:appId/environment/:environmentName/codegen-jobs?nextToken=string&maxResults=0Retrieves a list of code generation jobs for a specified Amplify app and backend environment. - POSTStart codegen job
/app/:appId/environment/:environmentName/codegen-jobs?clientToken=stringStarts a code generation job for a specified Amplify app and backend environment.
- POSTExchange code for token
/tokens/:providerThis is for internal use. Amplify uses this action to exchange an access code for a token. - GETGet metadata
/app/:appId/environment/:environmentName/metadataReturns existing metadata for an Amplify app. - GETList tags for resource
/tags/:resourceArnReturns a list of tags for a specified Amazon Resource Name (ARN). - POSTTag resource
/tags/:resourceArnTags the resource with a tag key and value. - DELETEUntag resource
/tags/:resourceArn?tagKeys=Untags a resource with a specified Amazon Resource Name (ARN). - PUTPut metadata flag
/app/:appId/environment/:environmentName/metadata/features/:featureNameStores the metadata information about a feature on a form. - POSTRefresh token
/tokens/:provider/refreshThis is for internal use. Amplify uses this action to refresh a previously issued access token that might have expired.
API details
- Base URL
https://amplifyuibuilder.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 28 operations on 16 pathsGET 13POST 7DELETE 4PATCH 3PUT 1
- Main resources
- Component 6Form 6Theme 6Codegen job 3
- Description format
- AWS Smithy model, API version
2021-08-11 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the AWS Amplify UI Builder in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the AWS Amplify UI Builder collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “List components” (GET /app/:appId/environment/:environmentName/components?nextToken=string&maxResults=0), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the AWS Amplify UI Builder?
The Amplify UI Builder API provides a programmatic interface for creating and configuring user interface (UI) component libraries and themes for use in your… It is listed under Developer tools and has 28 endpoints.
Who publishes the AWS Amplify UI Builder?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the AWS Amplify UI Builder?
Requests go to https://amplifyuibuilder.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the AWS Amplify UI Builder?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the AWS Amplify UI Builder have?
28 operations on 16 paths (13 GET, 7 POST, 4 DELETE, 3 PATCH, 1 PUT). The largest groups are Component, Form, Theme, Codegen job.
Is forking the AWS Amplify UI Builder free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.