AmplifyBackend
AWS Amplify Admin API
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
AWS Amplify Admin API
Endpoints 31
- POSTClone backend
/backend/:AppId/environments/:BackendEnvironmentName/cloneThis operation clones an existing backend. - POSTCreate backend
/backendThis operation creates a backend for an Amplify app. Backends are automatically created at the time of app creation. - POSTCreate backend aPI
/backend/:AppId/apiCreates a new backend API resource. - POSTCreate backend auth
/backend/:AppId/authCreates a new backend authentication resource. - POSTCreate backend config
/backend/:AppId/configCreates a config object for a backend. - POSTCreate backend storage
/backend/:AppId/storageCreates a backend storage resource. - POSTCreate token
/backend/:AppId/challengeGenerates a one-time challenge code to authenticate a user into your Amplify Admin UI. - POSTDelete backend
/backend/:AppId/environments/:BackendEnvironmentName/removeRemoves an existing environment from your Amplify project. - POSTDelete backend aPI
/backend/:AppId/api/:BackendEnvironmentName/removeDeletes an existing backend API resource. - POSTDelete backend auth
/backend/:AppId/auth/:BackendEnvironmentName/removeDeletes an existing backend authentication resource. - POSTDelete backend storage
/backend/:AppId/storage/:BackendEnvironmentName/removeRemoves the specified backend storage resource. - POSTDelete token
/backend/:AppId/challenge/:SessionId/removeDeletes the challenge token based on the given appId and sessionId. - POSTGenerate backend aPI models
/backend/:AppId/api/:BackendEnvironmentName/generateModelsGenerates a model schema for an existing backend API resource. - POSTGet backend
/backend/:AppId/detailsProvides project-level details for your Amplify UI project. - POSTGet backend aPI
/backend/:AppId/api/:BackendEnvironmentName/detailsGets the details for a backend API. - POSTGet backend aPI models
/backend/:AppId/api/:BackendEnvironmentName/getModelsGets a model introspection schema for an existing backend API resource. - POSTGet backend auth
/backend/:AppId/auth/:BackendEnvironmentName/detailsGets a backend auth details. - GETGet backend job
/backend/:AppId/job/:BackendEnvironmentName/:JobIdReturns information about a specific job. - POSTUpdate backend job
/backend/:AppId/job/:BackendEnvironmentName/:JobIdUpdates a specific job. - POSTGet backend storage
/backend/:AppId/storage/:BackendEnvironmentName/detailsGets details for a backend storage resource. - GETGet token
/backend/:AppId/challenge/:SessionIdGets the challenge token based on the given appId and sessionId. - POSTImport backend auth
/backend/:AppId/auth/:BackendEnvironmentName/importImports an existing backend authentication resource. - POSTImport backend storage
/backend/:AppId/storage/:BackendEnvironmentName/importImports an existing backend storage resource. - POSTList backend jobs
/backend/:AppId/job/:BackendEnvironmentNameLists the jobs for the backend of an Amplify app. - POSTList s3 buckets
/s3BucketsThe list of S3 buckets in your account. - POSTRemove all backends
/backend/:AppId/removeRemoves all backend environments from your Amplify project. - POSTRemove backend config
/backend/:AppId/config/removeRemoves the AWS resources required to access the Amplify Admin UI. - POSTUpdate backend aPI
/backend/:AppId/api/:BackendEnvironmentNameUpdates an existing backend API resource. - POSTUpdate backend auth
/backend/:AppId/auth/:BackendEnvironmentNameUpdates an existing backend authentication resource. - POSTUpdate backend config
/backend/:AppId/config/updateUpdates the AWS resources required to access the Amplify Admin UI. - POSTUpdate backend storage
/backend/:AppId/storage/:BackendEnvironmentNameUpdates an existing backend storage resource.
API details
- Base URL
https://amplifybackend.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 31 operations on 30 pathsPOST 29GET 2
- Description format
- AWS Smithy model, API version
2020-08-11 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the AmplifyBackend 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 AmplifyBackend 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 “Clone backend” (POST /backend/:AppId/environments/:BackendEnvironmentName/clone), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the AmplifyBackend?
AWS Amplify Admin API It is listed under Developer tools and has 31 endpoints.
Who publishes the AmplifyBackend?
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 AmplifyBackend?
Requests go to https://amplifybackend.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the AmplifyBackend?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the AmplifyBackend have?
31 operations on 30 paths (29 POST, 2 GET).
Is forking the AmplifyBackend free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.