Skip to main content
Amplify Dev Center Docs
Amplify Dev Center Docs
Docs
Learn
UI Library
Contribute
About AWS Amplify
Pricing

Choose your framework/language

v0v1
  • React
  • JavaScript
  • Flutter
  • Swift
  • Android
  • React Native
  • Angular
  • Next.js
  • Vue
  • How Amplify works
  • Start
    • Getting started
      • Introduction
      • Set up Amplify CLI
      • Set up fullstack project
      • Generate model files
      • Integrate your app
      • Next steps
    • Project setup
      • Set up Amplify prerequisites
      • Create your application
      • Platform setup
      • Escape hatch
      • Upgrade guide
  • Build & connect backend
    • Authentication
      • Set up Amplify Auth
      • Accessing credentials
      • Manage credentials
      • Enable sign-in
      • Sign-in with custom flow
      • Enable sign-in with web UI
      • Multi-step sign-in
      • Enable guest access
      • Add social provider sign-in
      • Enable sign-out
      • Manage user attributes
      • Set up password change and recovery
      • Manage MFA settings
      • Add SMS flows
      • Remember a device
      • Advanced workflows
      • Delete user account
      • Set up admin actions
      • Set up user group management
      • Use an existing Cognito User Pool and Identity Pool
      • Use existing resources without the CLI
      • Override Amplify-generated Cognito resources
      • Listen to auth events
    • API (GraphQL)
      • Set up Amplify GraphQL API
      • Connect API to existing MySQL or PostgreSQL database
      • Customize your data model
      • Customize authorization rules
      • AppSync Concepts
      • Configure authorization modes
      • Create, update, and delete application data
      • Read application data
      • Subscribe to real-time events
      • Set up custom queries and mutations
      • Build search and aggregate queries
      • Working with caching and offline scenarios
      • JavaScript, Android, Swift, and Flutter client code generation
      • Advanced Workflows
      • Use existing AWS resources
      • Incorporate machine learning
      • Evolving GraphQL schemas
      • Modify Amplify-generated resources
      • Troubleshooting
      • Best practice
        • Batch put custom resolver
        • GraphQL query with sorting by date
        • Warehouse Management System
    • API (REST)
      • Configure REST API
      • Set up Amplify REST API
      • Fetch data
      • Update data
      • Delete data
      • Define authorization rules
      • Test the REST API
      • Build a generative AI sandbox with Amplify and Amazon Bedrock
      • Use existing AWS resources
      • Override Amplify-generated API Gateway resources
    • Storage
      • Configure Storage
      • Set up Amplify Storage
      • Upload files
      • Download files
      • Get file properties
      • List files
      • Copy files
      • Move files
      • Remove files
      • File access levels
      • Use transfer acceleration
      • Lambda triggers
      • Import an S3 bucket or DynamoDB table
      • Use existing AWS resources
      • Modify Amplify-generated resources
    • Functions
      • Set up a function
      • Reuse code and assets using layers
      • Environment variables
      • Access secret values
      • Build options
      • Configure Lambda function settings
    • Push Notifications
      • Set up Amplify Push Notifications
      • Request permissions
      • Receive a device token
      • Interact with notifications
      • Identify user to Amazon Pinpoint
      • Add app badge count
      • Enable rich notifications
      • Test push notifications
      • Set up push notification services
    • More features
      • Analytics
        • Set up Amplify Analytics
        • Record events
        • Identify user
        • Automatically track sessions
        • Enable and disable analytics
        • Use existing AWS resources
      • DataStore
        • Set up Amplify DataStore
        • Manipulating data
        • Relational models
        • Syncing data to cloud
        • Set up authorization rules
        • Conflict resolution
        • Observe in real time
        • DataStore events
        • Additional DataStore methods
        • Schema updates
        • How it works
        • Customize primary keys
    • Troubleshooting
      • Upgrading Amplify packages
  • Build UI
    • Amplify UI
    • Form Builder
      • Customize form inputs
      • Data binding
      • Configure special inputs
      • Validate form data
      • Manage form lifecycle
      • Customize action buttons (Submit, Cancel, Clear, Reset)
      • Extend input element in code
    • Figma-to-Code
      • Data binding
      • UI event handler
      • Collections
      • Component slots
      • Theming
      • Responsive components
      • Extend with code
      • Best practices
  • Deploy & host
    • Amplify Hosting
  • Tools
    • CLI
      • Start
        • Set up Amplify CLI
        • Explore key workflows for Amplify CLI
      • Commands
      • API (GraphQL)
        • Directives reference
      • Hosting
      • Custom AWS resources
        • Use CDK to add custom AWS resources
        • Use CloudFormation to add custom AWS resources
      • Project-level configurations
        • Apply tags to generated resources
        • IAM Permissions Boundary for Amplify-generated roles
        • Command hooks
        • Monorepo project structure
        • Override Amplify-generated project-level IAM resources
        • Troubleshooting
      • Team environments
        • Share single environment
        • Sandbox environments
        • Multiple frontends
        • Continuous deployment
        • Commands
      • Advanced workflows
        • Lambda triggers
        • Mocking and testing
        • Serverless containers
        • Export Amplify project to CDK
        • Headless mode for CI/CD
      • Plugins
        • Architecture
        • Authoring a new plugin
      • Migration & backwards compatibility
        • AWS CDK v1 to v2 migration
        • Lazy loading and custom selection set
        • GraphQL Transformer v1 to v2 migration
        • Override feature enablement migration
        • Lambda layer behavior updates
        • CLI Auth Signup Changes
        • Amplify Codegen Models - List and list components nullability
        • Migrate project to another AWS account
        • GraphQL Transformer @auth identity claim changes
      • Reference
        • IAM policy
        • IAM roles and MFA
        • Files and folders
        • Usage data in Amplify CLI
        • Diagnose
        • Feature flags
        • SSM Parameter Store
    • Studio
      • Basics
        • Getting started
        • Extend with the Amplify CLI
        • Manage team access
        • Custom domains
      • Tutorial
        • Build UI
        • Model database
        • Bind UI to data
        • Collections
        • Write React code
      • Data
        • Data modeling
        • Relationships
        • Data management
      • Authentication
        • Manage authentication for users and groups
        • Import Amazon Cognito resources
      • Authorization
        • Access control
      • Storage
        • File browser
        • File storage
    • Libraries
    • Reference
    Edit on GitHub

    Was this page helpful?

    Can you provide more details?

    File an issue on GitHub

    Flutter API references

    • Amplify Libraries for Flutter API reference
    • Amplify Libraries for Flutter: Core reference
    • Amplify Libraries for Flutter: Analytics reference
    • Amplify Libraries for Flutter: Auth reference
    • Amplify Libraries for Flutter: Authenticator reference
    • Amplify Libraries for Flutter: Datastore reference
    • Amplify Libraries for Flutter: Storage reference

    Amplify open source software, documentation and community are supported by Amazon Web Services.

    © 2023, Amazon Web Services, Inc. and its affiliates.

    All rights reserved. View the site terms and privacy policy.

    Flutter and the related logo are trademarks of Google LLC. We are not endorsed by or affiliated with Google LLC.

    • Twitter
    • Discord
    • Github