Commands
analytics
Add analytics resources to your Amplify project
amplify analytics <subcommand>add
Takes you through a CLI flow to add an analytics resource to your local backend
amplify analytics addupdate
Takes you through steps in the CLI to update an analytics resource
amplify analytics updatepush
Provisions only analytics cloud resources with the latest local developments
amplify analytics pushremove
Removes analytics resource from your local backend
amplify analytics removeconsole
Opens the web console for the analytics category
amplify analytics consoleapi
Enable an easy and secure solution to access backend data
amplify api <subcommand>add-graphql-datasource
Add an RDS datasource to your GraphQL API
amplify api add-graphql-datasourcerebuild
Removes all GraphQL resources and recreates the API (only use in dev envs)
amplify api rebuildadd
Takes you through a CLI flow to add a api resource to your local backend
amplify api addpush
Provisions API cloud resources with the latest local developments
amplify api pushremove
Removes API resource from your local backend
amplify api removeupdate
Updates an API resource
amplify api updategql-compile
Compiles your GraphQL schema and generates a CloudFormation template
amplify api gql-compileconsole
Opens the web console for the selected api service
amplify api consolemigrate
Migrates GraphQL schemas to the latest GraphQL transformer version
amplify api migrateoverride
Generates overrides file to apply custom modifications to CloudFormation
amplify api overridestatus
Displays the current status of your API
amplify api statusauth
Enable sign-in, sign-up, and sign-out for your app
amplify auth <subcommand>add
Adds an auth resource to your local backend
amplify auth addimport
Imports an existing auth resource to your local backend
amplify auth importpush
Provisions only auth cloud resources with the latest local developments
amplify auth pushremove
Removes auth resources from your local backend
amplify auth removeupdate
Updates the auth resource from your local backend
amplify auth updateconsole
Opens the web console for the auth category
amplify auth consolecodegen
Generates GraphQL statements and type annotations
amplify codegen <subcommand>configure
Configure GraphQL codegen for your Amplify project
amplify codegen configurestatements
Generates GraphQL statements (queries, mutations, and subscriptions)
amplify codegen statementstypes
Generates GraphQL type annotations
amplify codegen typesmodels
Generates GraphQL DataStore models
amplify codegen modelsconfigure
Configure the CLI to work with your AWS profile
amplify configure [subcommand]| Flag | Description |
|---|---|
--usage-data-on | Turn on usage data sharing. |
--usage-data-off | Turn off usage data sharing. |
--share-project-config-on | Turn on non-sensitive project configurations sharing on failures. |
--share-project-config-off | Turn off non-sensitive project configurations sharing on failures. |
console
Opens the web console for the selected cloud resource
amplify console <category><category>
Removes a resource for an Amplify category in your local backend
amplify console <category>delete
Delete the Amplify project
amplify delete [-y | --yes] [-f | --force]| Flag | Description |
|---|---|
-y|--yes | Skip all interactive prompts by selecting default options |
-f|--force | Skip all interactive prompts by selecting default options |
diagnose
Capture non-sensitive Amplify backend metadata for debugging purposes
amplify diagnose [--send-report] [--auto-send-off] [--auto-send-on]| Flag | Description |
|---|---|
--send-report | Share non-sensitive project configurations of your Amplify backend with the Amplify team |
--auto-send-off | Opt out of sharing your project configurations with Amplify on failures |
--auto-send-on | Opt in to sharing your project configurations with Amplify on failures |
env
Displays and manages environment related information for your Amplify project
amplify env <subcommand>add
Adds a new environment to your Amplify Project
amplify env addcheckout <env-name>
Moves your environment to the environment specified in the command
amplify env checkout <env-name>get
Displays and manages environment related information for your Amplify project
amplify env getimport
Imports an existing Amplify project environment stack to your local backend
amplify env importlist
Displays a list of all the environments in your Amplify project
amplify env listpull
Pulls your environment with the current cloud environment
amplify env pullremove
Removes an environment from the Amplify project
amplify env removeupdate
Update the environment configuration
amplify env updateexport
Export Amplify CLI-generated backend as a Cloud Development Kit (CDK) stack
amplify export [--out <path>]| Flag | Description |
|---|---|
--out <path> | Specify the output path, where this is typically the path to your CDK project |
function
Configure function resources for your Amplify project
amplify function <subcommand>add
Takes you through a CLI flow to add a function resource to your local backend
amplify function addupdate
Takes you through a CLI flow to update an existing function resource
amplify function updatepush
Provisions only function cloud resources with the latest local developments
amplify function pushbuild
Builds all the functions in the project
amplify function buildremove
Removes function resource from your local backend
amplify function removeconsole
Opens the web console for the function category
amplify function consolegeo
Configure geo resources for your Amplify project
amplify geo <subcommand>add
Takes you through a CLI flow to add a geo resource to your local backend
amplify geo addupdate
Takes you through steps in the CLI to update a geo resource
amplify geo updatepush
Provisions only geo cloud resources with the latest local developments
amplify geo pushremove
Removes geo resource from your local backend
amplify geo removeconsole
Opens the web console for the geo category
amplify geo consolehosting
Configure hosting resources for your Amplify project
amplify hosting <subcommand>serve
Opens your deployed site
amplify hosting serveconfigure
Configure hosting resources via the Amplify Console
amplify hosting configurepublish
Publishes changes to manually deployed apps
amplify hosting publishremove
Remove hosting from you app
amplify hosting removepush
Provisions cloud resources with the latest local changes
amplify hosting pushimport
Imports existing resources to your local backend
amplify import <subcommand> [--headless <payload>]| Flag | Description |
|---|---|
--headless | Headless JSON payload |
init
Initialize a new Amplify project
amplify init [-y | --yes] [--amplify <payload>] [--envName <env-name>] [--debug] [--frontend <payload>] [--providers <payload>] [--categories <payload>] [--app <git-url>] [--permissions-boundary <ARN>]| Flag | Description |
|---|---|
-y|--yes | Skip all interactive prompts by selecting default options |
--amplify | Basic information of the project |
--frontend | Information for the project's frontend application |
--envName | Name of the environment for the Amplify project |
--debug | Run the CLI in debug mode |
--providers | Configuration settings for provider plugins |
--categories | Configuration settings for resources in the given categories |
--app | Specify a GitHub repository from which to create an Amplify project |
--permissions-boundary <ARN> | Specify an IAM permissions boundary for the roles created during init |
interactions
Configure interactions resources for your Amplify project
amplify interactions <subcommand>add
Adds a interactions resources to your local backend
amplify interactions addupdate
Takes you through a CLI flow to update an interactions resource
amplify interactions updatepush
Provisions only interactions cloud resources with the latest local developments
amplify interactions pushremove
Removes interactions resources from your local backend
amplify interactions removelogout
Logs out of Amplify Studio
amplify logout [--appId <appId>]| Flag | Description |
|---|---|
--appId <appId> | Specify app ID |
mock
Run mock server for testing categories locally
amplify mock [subcommand]api
Run mock server for testing API locally
amplify mock apistorage
Run mock server for testing storage locally
amplify mock storagefunction
Run mock server for testing functions locally
amplify mock functionfunction <function-name>
Run mock server for testing a specific function locally
amplify mock function <function-name>notifications
Configure notifications for your Amplify project
amplify notificationsadd
Adds a notification channel
amplify notifications addremove
Removes a notification channel
amplify notifications removeupdate
Updates the configuration of a notification channel
amplify notifications updatestatus
Lists the enabled/disabled statuses of the available notification channels
amplify notifications statusconsole
Opens the Amazon Pinpoint console displaying the current channel settings
amplify notifications consolepush
Provisions cloud resources with the latest local changes
amplify notifications pushoverride
Override Amplify-generated resources with Cloud Development Kit (CDK)
amplify override <subcommand>api
Override Amplify-generated GraphQL API resources
amplify override apiauth
Override Amplify-generated auth resources
amplify override authstorage
Override Amplify-generated storage resources
amplify override storageproject
override Amplify-generated project-level resources, such as IAM roles
amplify override projectplugin
Configure Amplify plugins
amplify plugin <subcommand>init
Scaffolds a skeleton Amplify CLI plugin
amplify plugin initconfigure
Configures Amplify CLI plugin options
amplify plugin configurelist
Lists general plugin information
amplify plugin listscan
Explicitly starts a scan/search for new and existing plugins
amplify plugin scanadd
Explicitly adds a plugin for the Amplify CLI to use
amplify plugin addremove
Explicitly removes a plugin from the Amplify CLI
amplify plugin removeverify
Verifies if a plugin package/directory is a valid Amplify CLI plugin
amplify plugin verifypredictions
Configure predictions resources for your Amplify project
amplify predictions <subcommand>add
Takes you through a CLI flow to add a predictions resource to your local backend
amplify predictions addremove
Removes predictions resource from your local backend
amplify predictions removeupdate
Takes you through steps in the CLI to update an predictions resource
amplify predictions updateconsole
Opens a web console to view your predictions resource
amplify predictions consolepush
Provisions cloud resources with the latest local changes
amplify predictions pushpublish
Executes amplify push and hosts the frontend app
amplify publish [-y | --yes] [--codegen] [-f | --force] [--allow-destructive-graphql-schema-updates] [-c | --invalidateCloudFront]| Flag | Description |
|---|---|
-y|--yes | Automatically accept publish prompt |
--codegen | Configuration for GraphQL codegen |
-f|--force | Pushes all resources regardless of update status and bypasses all guardrails |
--allow-destructive-graphql-schema-updates | Pushes schema changes that require removal or replacement of underlying tables |
-c|--invalidateCloudFront | Send an invalidation request to the Amazon CloudFront service |
pull
Fetch upstream backend changes from the cloud and updates the local environment
amplify pull [--appId <app-id>] [--envName <env-name>] [--debug] [-y | --yes] [--restore] [--amplify <payload>] [--frontend <payload>] [--providers <payload>] [--categories <payload>]| Flag | Description |
|---|---|
--appId <app-id> | The unique identifier for the Amplify project |
--envName <env-name> | Name of the environment for the Amplify project |
--debug | Run the CLI in debug mode |
-y|--yes | Skip all interactive prompts by selecting default options |
--restore | Overwrite your local backend changes with configurations from the cloud |
--amplify | Basic information of the project |
--frontend | Information for the project's frontend application |
--providers | Configuration settings for provider plugins |
push
Provisions cloud resources with the latest local changes
amplify push [category] [--codegen] [--debug] [-f | --force] [-y | --yes] [--allow-destructive-graphql-schema-updates]| Flag | Description |
|---|---|
--codegen | Configuration for GraphQL codegen |
--debug | Run the CLI in debug mode |
-f|--force | Pushes all resources regardless of update status and bypasses all guardrails |
-y|--yes | Skip all interactive prompts by selecting default options |
--allow-destructive-graphql-schema-updates | Pushes schema changes that require removal or replacement of underlying tables |
[category]
Provisions cloud resources with the latest local changes for a single category
amplify push [category]status
Shows the state of local resources not yet pushed to the cloud
amplify status [-v | --verbose]| Flag | Description |
|---|---|
-v|--verbose | Shows verbose details, including cloudformation differences |
notifications
Lists the enabled/disabled statuses of the available notification channels
amplify status notificationsapi
Displays the current status of your API
amplify status apiauth
Displays the current status of your auth resource
amplify status authcustom
Displays the current status of your custom resource
amplify status customstorage
Displays the current status of your storage resource
amplify status storageanalytics
Displays the current status of your analytics resource
amplify status analyticsfunction
Displays the current status of your function resource
amplify status functionhosting
Displays the current status of your hosting
amplify status hostinginteractions
Displays the current status of your interactions resource
amplify status interactionspredictions
Displays the current status of your predictions resource
amplify status predictionsstorage
Enable a mechanism for managing user content
amplify storage <subcommand>add
Adds a storage resource to your local backend
amplify storage addimport
Import an existing storage resource to your local backend
amplify storage importupdate
Update a storage resource
amplify storage updatepush
Provisions storage cloud resources with the latest local developments
amplify storage pushremove
Removes storage resource from your local backend
amplify storage removeoverride
Generates 'overrides.ts' for overriding storage resources
amplify storage overrideconsole
Opens the web console for the storage category
amplify storage console