# Prefect ## Getting Started ### Get started - [Introduction](https://docs.prefect.io/v3/get-started/index.md) - [Install Prefect](https://docs.prefect.io/v3/get-started/install.md) - [Quickstart](https://docs.prefect.io/v3/get-started/quickstart.md): Create your first workflow ## Concepts - [Concepts](https://docs.prefect.io/v3/concepts/index.md) ### Workflows - [Flows](https://docs.prefect.io/v3/concepts/flows.md): Flows compose work into a workflow. - [Tasks](https://docs.prefect.io/v3/concepts/tasks.md): Tasks are atomic units of work with transactional semantics. - [Assets](https://docs.prefect.io/v3/concepts/assets.md): Assets represent objects your workflows produce. - [Caching](https://docs.prefect.io/v3/concepts/caching.md) - [States](https://docs.prefect.io/v3/concepts/states.md): Prefect states contain information about the status of a flow or task run. - [Runtime context](https://docs.prefect.io/v3/concepts/runtime-context.md): The runtime context allows global access to information about the current run. - [Artifacts](https://docs.prefect.io/v3/concepts/artifacts.md): Artifacts are persisted outputs designed for human consumption and available in the UI. - [Task runners](https://docs.prefect.io/v3/concepts/task-runners.md): Learn about task runners for concurrent, parallel or distributed execution of tasks. - [Global concurrency limits](https://docs.prefect.io/v3/concepts/global-concurrency-limits.md): Understand how global concurrency limits control execution and manage resource usage. - [Tag-based concurrency limits](https://docs.prefect.io/v3/concepts/tag-based-concurrency-limits.md): Understand how tag-based concurrency limits prevent too many tasks from running simultaneously. ### Deployments - [Deployments](https://docs.prefect.io/v3/concepts/deployments.md): Learn how to use deployments to trigger flow runs remotely. - [Schedule flow runs](https://docs.prefect.io/v3/concepts/schedules.md): Prefect can schedule when to automatically create new flow runs. - [Work pools](https://docs.prefect.io/v3/concepts/work-pools.md): Learn how to configure dynamic infrastructure provisioning with work pools - [Workers](https://docs.prefect.io/v3/concepts/workers.md): Workers poll work pools for new runs to execute. ### Configuration - [Variables](https://docs.prefect.io/v3/concepts/variables.md): Variables are dynamically-named, mutable JSON values that can be used to store and reuse non-sensitive bits of data. - [Blocks](https://docs.prefect.io/v3/concepts/blocks.md): Prefect blocks allow you to manage configuration schemas, infrastructure, and secrets for use with deployments or flow scripts. - [Settings and profiles](https://docs.prefect.io/v3/concepts/settings-and-profiles.md): Prefect settings let you customize behavior across different environments. - [Prefect server](https://docs.prefect.io/v3/concepts/server.md): Self-host your own Prefect server instance. - [Telemetry](https://docs.prefect.io/v3/concepts/telemetry.md): Learn about Prefect's anonymous usage telemetry ### Automations - [Events](https://docs.prefect.io/v3/concepts/events.md): An event is a notification of a change - a record of activity in your stack. - [Automations](https://docs.prefect.io/v3/concepts/automations.md): Learn how to automatically take action in response to events. - [Define event triggers](https://docs.prefect.io/v3/concepts/event-triggers.md): Define a custom trigger to react to many kinds of events and metrics. ### Prefect Cloud - [Rate limits and data retention](https://docs.prefect.io/v3/concepts/rate-limits.md): Understand Prefect Cloud's API rate limits, request size limits, and data retention policies. - [Measure reliability with Service Level Agreements](https://docs.prefect.io/v3/concepts/slas.md): Define the performance expectations for your flows and to enable automated alerts when those expectations are not met. - [Webhooks](https://docs.prefect.io/v3/concepts/webhooks.md): Understand Prefect Cloud webhooks, their configuration, and how to use templates to transform incoming HTTP requests into Prefect events. ## How-to Guides - [How-to Guides](https://docs.prefect.io/v3/how-to-guides/index.md) ### Workflows - [How to write and run a workflow](https://docs.prefect.io/v3/how-to-guides/workflows/write-and-run.md) - [How to use assets to track workflow outputs](https://docs.prefect.io/v3/how-to-guides/workflows/assets.md) - [How to automatically rerun your workflow when it fails](https://docs.prefect.io/v3/how-to-guides/workflows/retries.md) - [How to manually retry a flow run](https://docs.prefect.io/v3/how-to-guides/workflows/retry-flow-runs.md) - [How to customize a workflow's metadata](https://docs.prefect.io/v3/how-to-guides/workflows/custom-metadata.md) - [How to pass inputs to a workflow](https://docs.prefect.io/v3/how-to-guides/workflows/pass-inputs.md) - [How to add logging to a workflow](https://docs.prefect.io/v3/how-to-guides/workflows/add-logging.md) - [How to access runtime information](https://docs.prefect.io/v3/how-to-guides/workflows/access-runtime-info.md) - [How to run work concurrently](https://docs.prefect.io/v3/how-to-guides/workflows/run-work-concurrently.md) - [How to cache workflow step outputs](https://docs.prefect.io/v3/how-to-guides/workflows/cache-workflow-steps.md) - [How to run background tasks](https://docs.prefect.io/v3/how-to-guides/workflows/run-background-tasks.md) - [How to respond to state changes](https://docs.prefect.io/v3/how-to-guides/workflows/state-change-hooks.md): Learn how to execute code in response to entering states in your workflows. - [How to produce workflow artifacts](https://docs.prefect.io/v3/how-to-guides/workflows/artifacts.md) - [How to test workflows](https://docs.prefect.io/v3/how-to-guides/workflows/test-workflows.md): Learn how to test Prefect flows and tasks with the test harness, pytest fixtures, and common troubleshooting patterns. - [How to apply global concurrency and rate limits](https://docs.prefect.io/v3/how-to-guides/workflows/global-concurrency-limits.md): Learn how to control concurrency and apply rate limits using Prefect's provided utilities. - [How to limit concurrent task runs with tags](https://docs.prefect.io/v3/how-to-guides/workflows/tag-based-concurrency-limits.md): Prevent too many tasks from running simultaneously using tags. ### Deployments - [How to create deployments](https://docs.prefect.io/v3/how-to-guides/deployments/create-deployments.md): Learn how to create deployments via the CLI, Python, or Terraform. - [Trigger ad-hoc deployment runs](https://docs.prefect.io/v3/how-to-guides/deployments/run-deployments.md): Learn how to trigger deployment runs using the Prefect CLI and Python SDK. - [How to create schedules](https://docs.prefect.io/v3/how-to-guides/deployments/create-schedules.md): Learn how to create schedules for your deployments. - [Manage Deployment schedules](https://docs.prefect.io/v3/how-to-guides/deployments/manage-schedules.md): Learn how to pause, resume, and remove deployment schedules using the Prefect CLI. - [How to deploy flows with Python](https://docs.prefect.io/v3/how-to-guides/deployments/deploy-via-python.md): Learn how to use the Python SDK to deploy flows to run in work pools. - [How to define deployments with YAML](https://docs.prefect.io/v3/how-to-guides/deployments/prefect-yaml.md): Use YAML to schedule and trigger flow runs and manage your code and deployments. - [How to retrieve code from storage](https://docs.prefect.io/v3/how-to-guides/deployments/store-flow-code.md): Learn about code storage as it relates to execution of deployments - [How to version deployments](https://docs.prefect.io/v3/how-to-guides/deployments/versioning.md): Track changes to your deployments and roll back to previous versions - [How to override job variables](https://docs.prefect.io/v3/how-to-guides/deployments/customize-job-variables.md): Override job variables on a deployment or flow run to set environment variables, specify a Docker image, allocate resources, and more. ### Configuration - [How to store secrets](https://docs.prefect.io/v3/how-to-guides/configuration/store-secrets.md) - [How to share configuration between workflows](https://docs.prefect.io/v3/how-to-guides/configuration/variables.md) - [How to manage settings](https://docs.prefect.io/v3/how-to-guides/configuration/manage-settings.md) ### Automations - [How to create automations](https://docs.prefect.io/v3/how-to-guides/automations/creating-automations.md): Learn how to define automations that trigger actions based on events. - [Custom notifications](https://docs.prefect.io/v3/how-to-guides/automations/custom-notifications.md): Send notifications with custom webhook payloads. - [How to create deployment triggers](https://docs.prefect.io/v3/how-to-guides/automations/creating-deployment-triggers.md): Learn how to define automations that trigger deployment runs based on events. - [How to chain deployments with events](https://docs.prefect.io/v3/how-to-guides/automations/chaining-deployments-with-events.md): Learn how to establish event-based dependencies between individual workflows. - [How to access deployment and flow run parameters](https://docs.prefect.io/v3/how-to-guides/automations/access-parameters-in-templates.md): Learn how to access deployment and flow run parameters in templates - [How to pass event payloads to flows](https://docs.prefect.io/v3/how-to-guides/automations/passing-event-payloads-to-flows.md): Learn how to pass custom event payload data to flows triggered by automations ### Workflow Infrastructure - [How to manage work pools](https://docs.prefect.io/v3/how-to-guides/deployment_infra/manage-work-pools.md): Configure Prefect work pools using the CLI, Terraform, or REST API - [How to run flows in local processes](https://docs.prefect.io/v3/how-to-guides/deployment_infra/run-flows-in-local-processes.md): Create a deployment for a flow by calling the `serve` method. - [How to run flows on serverless compute](https://docs.prefect.io/v3/how-to-guides/deployment_infra/serverless.md): Learn how to use Prefect push work pools to schedule work on serverless infrastructure without having to run a worker. - [How to run flows in Docker containers](https://docs.prefect.io/v3/how-to-guides/deployment_infra/docker.md): Learn how to execute deployments in isolated Docker containers - [How to run flows in a long-lived Docker container](https://docs.prefect.io/v3/how-to-guides/deployment_infra/serve-flows-docker.md): Learn how to serve a flow in a long-lived Docker container - [How to run flows on Kubernetes](https://docs.prefect.io/v3/how-to-guides/deployment_infra/kubernetes.md): Learn how to run flows on Kubernetes using containers. - [How to run flows on Modal](https://docs.prefect.io/v3/how-to-guides/deployment_infra/modal.md): Learn how to use Modal as a push work pool to schedule, run, and debug your Prefect flows - [How to run flows on Coiled](https://docs.prefect.io/v3/how-to-guides/deployment_infra/coiled.md): Deploy cloud infrastructure without expertise with Coiled #### Managed Infrastructure - [How to run flows on Prefect Managed infrastructure](https://docs.prefect.io/v3/how-to-guides/deployment_infra/managed.md): Learn how Prefect runs deployments on Prefect's infrastructure. - [Using cloud workload identity with Prefect Managed work pools](https://docs.prefect.io/v3/how-to-guides/deployment_infra/managed-aws-federated-identity.md): Learn how to configure cloud provider workload identity with short-lived credentials in Prefect Managed work pools. ### Prefect Cloud - [How to connect to Prefect Cloud](https://docs.prefect.io/v3/how-to-guides/cloud/connect-to-cloud.md): Configure a local execution environment to access Prefect Cloud. - [How to manage workspaces](https://docs.prefect.io/v3/how-to-guides/cloud/workspaces.md): Organize and compartmentalize your workflows with workspaces. - [How to create a webhook](https://docs.prefect.io/v3/how-to-guides/cloud/create-a-webhook.md): Learn how to setup a webhook in the UI to trigger automations from external events. - [How to troubleshoot Prefect Cloud](https://docs.prefect.io/v3/how-to-guides/cloud/troubleshoot-cloud.md): Learn how to identify and resolve common issues with Prefect Cloud. - [Prefect scope of support](https://docs.prefect.io/v3/how-to-guides/cloud/scope-of-support.md): Understand what Prefect support covers and where to find help for requests outside its scope. #### Manage accounts - [How to manage user accounts](https://docs.prefect.io/v3/how-to-guides/cloud/manage-users/index.md): Special features for Prefect Cloud users - [How to manage service accounts](https://docs.prefect.io/v3/how-to-guides/cloud/manage-users/service-accounts.md): Workspaces are isolated environments for flows and deployments within Prefect Cloud. - [How to manage teams](https://docs.prefect.io/v3/how-to-guides/cloud/manage-users/manage-teams.md): Manage teams of users in Prefect Cloud. - [How to manage account roles](https://docs.prefect.io/v3/how-to-guides/cloud/manage-users/manage-roles.md): Configure user workspace roles in Prefect Cloud. - [How to manage API keys](https://docs.prefect.io/v3/how-to-guides/cloud/manage-users/api-keys.md): Create an API key to access Prefect Cloud from a local execution environment. - [How to configure single sign-on](https://docs.prefect.io/v3/how-to-guides/cloud/manage-users/configure-sso.md): Configure single sign-on (SSO) for your Prefect Cloud users. - [How to audit Cloud activity](https://docs.prefect.io/v3/how-to-guides/cloud/manage-users/audit-logs.md): Monitor user access and activity with audit logs in Prefect Cloud. - [How to manage Access Control Lists (ACLs)](https://docs.prefect.io/v3/how-to-guides/cloud/manage-users/object-access-control-lists.md): Restrict block and deployment access to individual actors within a workspace. - [How to secure access by IP address](https://docs.prefect.io/v3/how-to-guides/cloud/manage-users/secure-access-by-ip-address.md): Manage network access to Prefect Cloud accounts with IP Allowlists. - [How to secure access over PrivateLink](https://docs.prefect.io/v3/how-to-guides/cloud/manage-users/secure-access-by-private-link.md): Manage network access to Prefect Cloud accounts over PrivateLink. ### Prefect Self-hosted - [How to run a local Prefect server](https://docs.prefect.io/v3/how-to-guides/self-hosted/server-cli.md): Get started with self-hosting by running Prefect server locally. - [How to run the Prefect server in Docker](https://docs.prefect.io/v3/how-to-guides/self-hosted/server-docker.md): Run a containerized Prefect server instance with Docker. - [How to run Prefect on Windows](https://docs.prefect.io/v3/how-to-guides/self-hosted/server-windows.md): Learn how to run Prefect server and workers on Windows with PowerShell. - [How to run the Prefect Server via Docker Compose](https://docs.prefect.io/v3/how-to-guides/self-hosted/docker-compose.md): Deploy a self-hosted Prefect server environment using Docker Compose, including PostgreSQL, Redis, server, background services, and worker. ### AI - [AI assistants with Prefect MCP](https://docs.prefect.io/v3/how-to-guides/ai/index.md) - [How to use the Prefect MCP server](https://docs.prefect.io/v3/how-to-guides/ai/use-prefect-mcp-server.md): Connect AI assistants to Prefect using the Model Context Protocol. - [AI log summaries](https://docs.prefect.io/v3/how-to-guides/ai/flow-run-log-summaries.md): Use AI-generated summaries of flow run logs to understand failures faster. ### Migrate - [How to Migrate from Airflow](https://docs.prefect.io/v3/how-to-guides/migrate/airflow.md): Migration from Apache Airflow to Prefect: A Comprehensive How-To Guide - [How to upgrade to Prefect 3.0](https://docs.prefect.io/v3/how-to-guides/migrate/upgrade-to-prefect-3.md): Learn how to upgrade from Prefect 2.x to Prefect 3.0. - [How to upgrade from agents to workers](https://docs.prefect.io/v3/how-to-guides/migrate/upgrade-agents-to-workers.md): Learn how to upgrade from agents to workers to significantly enhance the experience of deploying flows. - [How to transfer resources between Prefect environments](https://docs.prefect.io/v3/how-to-guides/migrate/transfer-resources.md): Migrate flows, deployments, work pools, and other resources between Prefect profiles ## Advanced - [Advanced](https://docs.prefect.io/v3/advanced/index.md) ### Workflows - [How to customize asset metadata](https://docs.prefect.io/v3/advanced/assets.md): This guide covers how to enhance your assets with rich metadata, custom properties, and explicit dependency management beyond what's automatically inferred from your task graph. - [How to customize caching behavior](https://docs.prefect.io/v3/advanced/caching.md) - [How to customize Prefect's logging configuration](https://docs.prefect.io/v3/advanced/logging-customization.md) - [How to write transactional workflows](https://docs.prefect.io/v3/advanced/transactions.md) - [How to cancel running workflows](https://docs.prefect.io/v3/advanced/cancel-workflows.md) - [How to write interactive workflows](https://docs.prefect.io/v3/advanced/interactive.md) - [How to persist and retrieve workflow results](https://docs.prefect.io/v3/advanced/results.md): Results represent the data returned by a flow or a task and enable features such as caching. - [How to deploy a web application powered by background tasks](https://docs.prefect.io/v3/advanced/background-tasks.md): Learn how to background heavy tasks from a web application to dedicated infrastructure. ### Deployments - [Configure UI forms for validating workflow inputs](https://docs.prefect.io/v3/advanced/form-building.md): Learn how to craft validated and user-friendly input forms for workflows. - [How to generate a custom SDK for your deployments](https://docs.prefect.io/v3/advanced/generate-custom-sdk.md): Generate a custom Python SDK from your deployments for IDE autocomplete and type checking. ### Automations - [How to debounce events](https://docs.prefect.io/v3/advanced/debouncing-events.md): Learn how to use the within parameter to handle multiple events in quick succession without creating a flow run for each event. - [How to detect and respond to zombie flows](https://docs.prefect.io/v3/advanced/detect-zombie-flows.md): Learn how to detect and respond to zombie flows. - [How to emit and use custom events](https://docs.prefect.io/v3/advanced/use-custom-event-grammar.md): Learn how to define specific trigger conditions based on custom event grammar. ### Workflow Infrastructure - [How to configure worker healthchecks](https://docs.prefect.io/v3/advanced/worker-healthchecks.md): Learn how to monitor worker health and automatically restart workers when they become unresponsive. - [How to daemonize worker processes](https://docs.prefect.io/v3/advanced/daemonize-processes.md): Learn how Prefect flow deployments enable configuring flows for scheduled and remote execution with workers. - [How to submit flows directly to dynamic infrastructure](https://docs.prefect.io/v3/advanced/submit-flows-directly-to-dynamic-infrastructure.md): Submit flows directly to different infrastructure types without a deployment ### Platform - [How to scale self-hosted Prefect](https://docs.prefect.io/v3/advanced/self-hosted.md): Learn how to run multiple Prefect server instances for high availability and load distribution - [How to maintain your Prefect database](https://docs.prefect.io/v3/advanced/database-maintenance.md): Monitor and maintain your PostgreSQL database for self-hosted Prefect deployments - [How to build deployments via CI/CD](https://docs.prefect.io/v3/advanced/deploy-ci-cd.md): CI/CD resources for working with Prefect. - [How to manage Prefect resources using Infrastructure as Code](https://docs.prefect.io/v3/advanced/infrastructure-as-code.md): Declaratively manage Prefect resources with additional tools - [How to self-host the Prefect Server with Helm](https://docs.prefect.io/v3/advanced/server-helm.md): Self-host your own Prefect server and connect a Prefect worker to it with Helm. - [How to secure a self-hosted Prefect server](https://docs.prefect.io/v3/advanced/security-settings.md): Learn about the Prefect settings that add security to your self-hosted server. - [How to configure network access for restricted environments](https://docs.prefect.io/v3/advanced/configure-network-access.md): Learn which endpoints and ports to allow for Prefect Cloud and self-hosted Prefect server in restricted network environments. ### Extensibility - [How to use and configure the API client](https://docs.prefect.io/v3/advanced/api-client.md) - [Customizing Base Job Templates](https://docs.prefect.io/v3/advanced/customize-base-job-templates.md): Learn how to customize Kubernetes base job templates for work pools - [How to create custom blocks](https://docs.prefect.io/v3/advanced/custom-blocks.md) - [How to develop a custom worker](https://docs.prefect.io/v3/advanced/developing-a-custom-worker.md): Learn how to create a Prefect worker to run your flows. - [How to write a Prefect plugin](https://docs.prefect.io/v3/advanced/plugins.md) ## Examples - [Overview](https://docs.prefect.io/v3/examples/index.md) ### Examples - [Hello, world!](https://docs.prefect.io/v3/examples/hello-world.md): Your first steps with Prefect – learn how to create a basic flow and understand core concepts. - [API-sourced ETL](https://docs.prefect.io/v3/examples/run-api-sourced-etl.md): Build a small ETL pipeline that fetches JSON from a public API, transforms it with pandas, and writes a CSV – all orchestrated by Prefect. - [dbt Model Orchestration](https://docs.prefect.io/v3/examples/run-dbt-with-prefect.md): Orchestrate any dbt project with bullet-proof retries, observability, and a single Python file — no hand-authored YAML or shell scripts required. - [Social Analytics Dashboard](https://docs.prefect.io/v3/examples/atproto-dashboard-with-prefect-assets.md): Build a social media analytics dashboard using Prefect Assets, ATProto/Bluesky APIs, dbt transformations, and Streamlit visualization. - [Simple web scraper](https://docs.prefect.io/v3/examples/simple-web-scraper.md): Learn how to scrape article content from web pages with Prefect tasks, retries, and automatic logging. - [AI-Powered Data Analyst](https://docs.prefect.io/v3/examples/ai-data-analyst-with-pydantic-ai.md): Build a resilient AI data analyst using Prefect and `pydantic-ai` to analyze datasets, detect anomalies, and generate insights. - [Database Cleanup with Human or AI Approval](https://docs.prefect.io/v3/examples/ai-database-cleanup-with-approval.md): Build database cleanup workflows that evolve from human oversight to AI autonomy. - [Per-worker task concurrency](https://docs.prefect.io/v3/examples/per-worker-task-concurrency.md): Use Global Concurrency Limits to control how many tasks can use a worker's local resources simultaneously. - [Resume Flow Run on PR Merge](https://docs.prefect.io/v3/examples/resume-flow-run-on-pr-merge.md): Automatically resume failed flow runs when a hotfix PR is merged in GitHub. ## Integrations ### Integrations - [Integrations](https://docs.prefect.io/integrations/integrations.md): Prefect integrations are PyPI packages you can install to help you build integrate your workflows with third parties. - [Use integrations](https://docs.prefect.io/integrations/use-integrations.md): Prefect integrations are PyPI packages you can install to help you build and integrate your workflows with third parties. #### AWS - [prefect-aws](https://docs.prefect.io/integrations/prefect-aws/index.md): Build production-ready data workflows that seamlessly integrate with AWS services. `prefect-aws` provides battle-tested blocks, tasks, and infrastructure integrations for AWS, including ECS orchestration, S3 storage, Secrets Manager, Lambda functions, Batch computing, and Glue ETL operations. ##### SDK Reference - [assume_role_parameters](https://docs.prefect.io/integrations/prefect-aws/api-ref/prefect_aws-assume_role_parameters.md) - [batch](https://docs.prefect.io/integrations/prefect-aws/api-ref/prefect_aws-batch.md) - [client_parameters](https://docs.prefect.io/integrations/prefect-aws/api-ref/prefect_aws-client_parameters.md) - [client_waiter](https://docs.prefect.io/integrations/prefect-aws/api-ref/prefect_aws-client_waiter.md) - [credentials](https://docs.prefect.io/integrations/prefect-aws/api-ref/prefect_aws-credentials.md) - [decorators](https://docs.prefect.io/integrations/prefect-aws/api-ref/prefect_aws-decorators.md) - [glue_job](https://docs.prefect.io/integrations/prefect-aws/api-ref/prefect_aws-glue_job.md) - [lambda_function](https://docs.prefect.io/integrations/prefect-aws/api-ref/prefect_aws-lambda_function.md) - [plugins](https://docs.prefect.io/integrations/prefect-aws/api-ref/prefect_aws-plugins.md) - [s3](https://docs.prefect.io/integrations/prefect-aws/api-ref/prefect_aws-s3.md) - [secrets_manager](https://docs.prefect.io/integrations/prefect-aws/api-ref/prefect_aws-secrets_manager.md) - [settings](https://docs.prefect.io/integrations/prefect-aws/api-ref/prefect_aws-settings.md) - [utilities](https://docs.prefect.io/integrations/prefect-aws/api-ref/prefect_aws-utilities.md) ###### prefect_aws.bundles - [execute](https://docs.prefect.io/integrations/prefect-aws/api-ref/prefect_aws-bundles-execute.md) - [upload](https://docs.prefect.io/integrations/prefect-aws/api-ref/prefect_aws-bundles-upload.md) ###### prefect_aws.deployments - [steps](https://docs.prefect.io/integrations/prefect-aws/api-ref/prefect_aws-deployments-steps.md) ###### prefect_aws.templates - [__init__](https://docs.prefect.io/integrations/prefect-aws/api-ref/prefect_aws-templates-__init__.md) - [ecs](https://docs.prefect.io/integrations/prefect-aws/api-ref/prefect_aws-templates-ecs.md) ###### prefect_aws.workers - [ecs_worker](https://docs.prefect.io/integrations/prefect-aws/api-ref/prefect_aws-workers-ecs_worker.md) ##### ECS Worker - [Get to know the ECS worker](https://docs.prefect.io/integrations/prefect-aws/ecs-worker/index.md): Deploy production-ready Prefect workers on AWS Elastic Container Service (ECS) for scalable, containerized flow execution. ECS workers provide robust infrastructure management with automatic scaling, high availability, and seamless AWS integration. - [How to manually deploy an ECS worker to an ECS cluster](https://docs.prefect.io/integrations/prefect-aws/ecs-worker/manual-deployment.md): Step-by-step guide for manually setting up ECS infrastructure to run Prefect workers with full control over cluster configuration, IAM roles, and task definitions. #### Azure - [prefect-azure](https://docs.prefect.io/integrations/prefect-azure/index.md) - [Azure Container Instances Worker Guide](https://docs.prefect.io/integrations/prefect-azure/aci_worker.md): Run Prefect flows on Azure Container Instances with a hybrid work pool, from Azure setup through deployment and execution. ##### SDK Reference - [blob_storage](https://docs.prefect.io/integrations/prefect-azure/api-ref/prefect_azure-blob_storage.md) - [container_instance](https://docs.prefect.io/integrations/prefect-azure/api-ref/prefect_azure-container_instance.md) - [cosmos_db](https://docs.prefect.io/integrations/prefect-azure/api-ref/prefect_azure-cosmos_db.md) - [credentials](https://docs.prefect.io/integrations/prefect-azure/api-ref/prefect_azure-credentials.md) - [decorators](https://docs.prefect.io/integrations/prefect-azure/api-ref/prefect_azure-decorators.md) - [ml_datastore](https://docs.prefect.io/integrations/prefect-azure/api-ref/prefect_azure-ml_datastore.md) - [plugins](https://docs.prefect.io/integrations/prefect-azure/api-ref/prefect_azure-plugins.md) - [repository](https://docs.prefect.io/integrations/prefect-azure/api-ref/prefect_azure-repository.md) - [settings](https://docs.prefect.io/integrations/prefect-azure/api-ref/prefect_azure-settings.md) ###### prefect_azure.bundles - [execute](https://docs.prefect.io/integrations/prefect-azure/api-ref/prefect_azure-bundles-execute.md) - [upload](https://docs.prefect.io/integrations/prefect-azure/api-ref/prefect_azure-bundles-upload.md) ###### prefect_azure.deployments - [steps](https://docs.prefect.io/integrations/prefect-azure/api-ref/prefect_azure-deployments-steps.md) ###### prefect_azure.workers - [__init__](https://docs.prefect.io/integrations/prefect-azure/api-ref/prefect_azure-workers-__init__.md) - [container_instance](https://docs.prefect.io/integrations/prefect-azure/api-ref/prefect_azure-workers-container_instance.md) #### Bitbucket - [prefect-bitbucket](https://docs.prefect.io/integrations/prefect-bitbucket/index.md) ##### SDK Reference - [credentials](https://docs.prefect.io/integrations/prefect-bitbucket/api-ref/prefect_bitbucket-credentials.md) - [repository](https://docs.prefect.io/integrations/prefect-bitbucket/api-ref/prefect_bitbucket-repository.md) #### Dask - [prefect-dask](https://docs.prefect.io/integrations/prefect-dask/index.md): Accelerate your workflows by running tasks in parallel with Dask ##### SDK Reference - [client](https://docs.prefect.io/integrations/prefect-dask/api-ref/prefect_dask-client.md) - [task_runners](https://docs.prefect.io/integrations/prefect-dask/api-ref/prefect_dask-task_runners.md) - [utils](https://docs.prefect.io/integrations/prefect-dask/api-ref/prefect_dask-utils.md) #### Databricks - [prefect-databricks](https://docs.prefect.io/integrations/prefect-databricks/index.md): Trigger Databricks jobs and notebook runs from Prefect flows and wait for their results. ##### SDK Reference - [credentials](https://docs.prefect.io/integrations/prefect-databricks/api-ref/prefect_databricks-credentials.md) - [flows](https://docs.prefect.io/integrations/prefect-databricks/api-ref/prefect_databricks-flows.md) - [jobs](https://docs.prefect.io/integrations/prefect-databricks/api-ref/prefect_databricks-jobs.md) - [rest](https://docs.prefect.io/integrations/prefect-databricks/api-ref/prefect_databricks-rest.md) #### dbt - [prefect-dbt](https://docs.prefect.io/integrations/prefect-dbt/index.md) - [Installation](https://docs.prefect.io/integrations/prefect-dbt/install.md): Install prefect-dbt with a dbt adapter for any warehouse - [PrefectDbtRunner](https://docs.prefect.io/integrations/prefect-dbt/runner.md): Run dbt Core commands from a Prefect flow with asset lineage, lifecycle hooks, and improved logging - [PrefectDbtOrchestrator](https://docs.prefect.io/integrations/prefect-dbt/orchestrator.md): Per-node and per-wave dbt orchestration with retries, caching, and asset lineage - [dbt Cloud](https://docs.prefect.io/integrations/prefect-dbt/dbt-cloud.md): Run dbt Cloud jobs from a Prefect flow with DbtCloudCredentials and DbtCloudJob blocks - [Legacy](https://docs.prefect.io/integrations/prefect-dbt/legacy.md): prefect-dbt 0.6.6 and earlier — DbtCoreOperation, DbtCliProfile, and TargetConfigs ##### SDK Reference - [utilities](https://docs.prefect.io/integrations/prefect-dbt/api-ref/prefect_dbt-utilities.md) ###### prefect_dbt.cli - [commands](https://docs.prefect.io/integrations/prefect-dbt/api-ref/prefect_dbt-cli-commands.md) - [credentials](https://docs.prefect.io/integrations/prefect-dbt/api-ref/prefect_dbt-cli-credentials.md) ###### configs - [base](https://docs.prefect.io/integrations/prefect-dbt/api-ref/prefect_dbt-cli-configs-base.md) - [bigquery](https://docs.prefect.io/integrations/prefect-dbt/api-ref/prefect_dbt-cli-configs-bigquery.md) - [postgres](https://docs.prefect.io/integrations/prefect-dbt/api-ref/prefect_dbt-cli-configs-postgres.md) - [snowflake](https://docs.prefect.io/integrations/prefect-dbt/api-ref/prefect_dbt-cli-configs-snowflake.md) ###### prefect_dbt.cloud - [clients](https://docs.prefect.io/integrations/prefect-dbt/api-ref/prefect_dbt-cloud-clients.md) - [credentials](https://docs.prefect.io/integrations/prefect-dbt/api-ref/prefect_dbt-cloud-credentials.md) - [exceptions](https://docs.prefect.io/integrations/prefect-dbt/api-ref/prefect_dbt-cloud-exceptions.md) - [jobs](https://docs.prefect.io/integrations/prefect-dbt/api-ref/prefect_dbt-cloud-jobs.md) - [models](https://docs.prefect.io/integrations/prefect-dbt/api-ref/prefect_dbt-cloud-models.md) - [runs](https://docs.prefect.io/integrations/prefect-dbt/api-ref/prefect_dbt-cloud-runs.md) - [utils](https://docs.prefect.io/integrations/prefect-dbt/api-ref/prefect_dbt-cloud-utils.md) ###### prefect_dbt.core - [runner](https://docs.prefect.io/integrations/prefect-dbt/api-ref/prefect_dbt-core-runner.md) - [settings](https://docs.prefect.io/integrations/prefect-dbt/api-ref/prefect_dbt-core-settings.md) #### Docker - [prefect-docker](https://docs.prefect.io/integrations/prefect-docker/index.md) ##### SDK Reference - [containers](https://docs.prefect.io/integrations/prefect-docker/api-ref/prefect_docker-containers.md) - [credentials](https://docs.prefect.io/integrations/prefect-docker/api-ref/prefect_docker-credentials.md) - [decorators](https://docs.prefect.io/integrations/prefect-docker/api-ref/prefect_docker-decorators.md) - [host](https://docs.prefect.io/integrations/prefect-docker/api-ref/prefect_docker-host.md) - [images](https://docs.prefect.io/integrations/prefect-docker/api-ref/prefect_docker-images.md) - [types](https://docs.prefect.io/integrations/prefect-docker/api-ref/prefect_docker-types.md) - [worker](https://docs.prefect.io/integrations/prefect-docker/api-ref/prefect_docker-worker.md) ###### prefect_docker.deployments - [steps](https://docs.prefect.io/integrations/prefect-docker/api-ref/prefect_docker-deployments-steps.md) #### Email - [prefect-email](https://docs.prefect.io/integrations/prefect-email/index.md) ##### SDK Reference - [credentials](https://docs.prefect.io/integrations/prefect-email/api-ref/prefect_email-credentials.md) - [message](https://docs.prefect.io/integrations/prefect-email/api-ref/prefect_email-message.md) #### GCP - [prefect-gcp](https://docs.prefect.io/integrations/prefect-gcp/index.md) - [Google Cloud Run Worker Guide](https://docs.prefect.io/integrations/prefect-gcp/gcp-worker-guide.md) ##### SDK Reference - [bigquery](https://docs.prefect.io/integrations/prefect-gcp/api-ref/prefect_gcp-bigquery.md) - [cloud_storage](https://docs.prefect.io/integrations/prefect-gcp/api-ref/prefect_gcp-cloud_storage.md) - [credentials](https://docs.prefect.io/integrations/prefect-gcp/api-ref/prefect_gcp-credentials.md) - [decorators](https://docs.prefect.io/integrations/prefect-gcp/api-ref/prefect_gcp-decorators.md) - [secret_manager](https://docs.prefect.io/integrations/prefect-gcp/api-ref/prefect_gcp-secret_manager.md) - [settings](https://docs.prefect.io/integrations/prefect-gcp/api-ref/prefect_gcp-settings.md) - [utilities](https://docs.prefect.io/integrations/prefect-gcp/api-ref/prefect_gcp-utilities.md) ###### prefect_gcp.bundles - [execute](https://docs.prefect.io/integrations/prefect-gcp/api-ref/prefect_gcp-bundles-execute.md) - [upload](https://docs.prefect.io/integrations/prefect-gcp/api-ref/prefect_gcp-bundles-upload.md) ###### prefect_gcp.deployments - [steps](https://docs.prefect.io/integrations/prefect-gcp/api-ref/prefect_gcp-deployments-steps.md) ###### prefect_gcp.models - [cloud_run_v2](https://docs.prefect.io/integrations/prefect-gcp/api-ref/prefect_gcp-models-cloud_run_v2.md) ###### prefect_gcp.workers - [cloud_run](https://docs.prefect.io/integrations/prefect-gcp/api-ref/prefect_gcp-workers-cloud_run.md) - [cloud_run_v2](https://docs.prefect.io/integrations/prefect-gcp/api-ref/prefect_gcp-workers-cloud_run_v2.md) - [vertex](https://docs.prefect.io/integrations/prefect-gcp/api-ref/prefect_gcp-workers-vertex.md) #### GitHub - [prefect-github](https://docs.prefect.io/integrations/prefect-github/index.md) ##### SDK Reference - [credentials](https://docs.prefect.io/integrations/prefect-github/api-ref/prefect_github-credentials.md) - [exceptions](https://docs.prefect.io/integrations/prefect-github/api-ref/prefect_github-exceptions.md) - [graphql](https://docs.prefect.io/integrations/prefect-github/api-ref/prefect_github-graphql.md) - [mutations](https://docs.prefect.io/integrations/prefect-github/api-ref/prefect_github-mutations.md) - [organization](https://docs.prefect.io/integrations/prefect-github/api-ref/prefect_github-organization.md) - [repository](https://docs.prefect.io/integrations/prefect-github/api-ref/prefect_github-repository.md) - [repository_owner](https://docs.prefect.io/integrations/prefect-github/api-ref/prefect_github-repository_owner.md) - [user](https://docs.prefect.io/integrations/prefect-github/api-ref/prefect_github-user.md) - [utils](https://docs.prefect.io/integrations/prefect-github/api-ref/prefect_github-utils.md) - [viewer](https://docs.prefect.io/integrations/prefect-github/api-ref/prefect_github-viewer.md) ###### prefect_github.schemas - [graphql_schema](https://docs.prefect.io/integrations/prefect-github/api-ref/prefect_github-schemas-graphql_schema.md) #### Gitlab - [prefect-gitlab](https://docs.prefect.io/integrations/prefect-gitlab/index.md) ##### SDK Reference - [credentials](https://docs.prefect.io/integrations/prefect-gitlab/api-ref/prefect_gitlab-credentials.md) - [repositories](https://docs.prefect.io/integrations/prefect-gitlab/api-ref/prefect_gitlab-repositories.md) #### Kubernetes - [prefect-kubernetes](https://docs.prefect.io/integrations/prefect-kubernetes/index.md) ##### SDK Reference - [credentials](https://docs.prefect.io/integrations/prefect-kubernetes/api-ref/prefect_kubernetes-credentials.md) - [custom_objects](https://docs.prefect.io/integrations/prefect-kubernetes/api-ref/prefect_kubernetes-custom_objects.md) - [decorators](https://docs.prefect.io/integrations/prefect-kubernetes/api-ref/prefect_kubernetes-decorators.md) - [deployments](https://docs.prefect.io/integrations/prefect-kubernetes/api-ref/prefect_kubernetes-deployments.md) - [diagnostics](https://docs.prefect.io/integrations/prefect-kubernetes/api-ref/prefect_kubernetes-diagnostics.md) - [exceptions](https://docs.prefect.io/integrations/prefect-kubernetes/api-ref/prefect_kubernetes-exceptions.md) - [flows](https://docs.prefect.io/integrations/prefect-kubernetes/api-ref/prefect_kubernetes-flows.md) - [jobs](https://docs.prefect.io/integrations/prefect-kubernetes/api-ref/prefect_kubernetes-jobs.md) - [observer](https://docs.prefect.io/integrations/prefect-kubernetes/api-ref/prefect_kubernetes-observer.md) - [pods](https://docs.prefect.io/integrations/prefect-kubernetes/api-ref/prefect_kubernetes-pods.md) - [services](https://docs.prefect.io/integrations/prefect-kubernetes/api-ref/prefect_kubernetes-services.md) - [settings](https://docs.prefect.io/integrations/prefect-kubernetes/api-ref/prefect_kubernetes-settings.md) - [utilities](https://docs.prefect.io/integrations/prefect-kubernetes/api-ref/prefect_kubernetes-utilities.md) - [worker](https://docs.prefect.io/integrations/prefect-kubernetes/api-ref/prefect_kubernetes-worker.md) #### Ray - [prefect-ray](https://docs.prefect.io/integrations/prefect-ray/index.md): Accelerate your workflows by running tasks in parallel with Ray ##### SDK Reference - [context](https://docs.prefect.io/integrations/prefect-ray/api-ref/prefect_ray-context.md) - [task_runners](https://docs.prefect.io/integrations/prefect-ray/api-ref/prefect_ray-task_runners.md) #### Redis - [prefect-redis](https://docs.prefect.io/integrations/prefect-redis/index.md) ##### SDK Reference - [blocks](https://docs.prefect.io/integrations/prefect-redis/api-ref/prefect_redis-blocks.md) - [cleanup_queue](https://docs.prefect.io/integrations/prefect-redis/api-ref/prefect_redis-cleanup_queue.md) - [client](https://docs.prefect.io/integrations/prefect-redis/api-ref/prefect_redis-client.md) - [connection](https://docs.prefect.io/integrations/prefect-redis/api-ref/prefect_redis-connection.md) - [lease_storage](https://docs.prefect.io/integrations/prefect-redis/api-ref/prefect_redis-lease_storage.md) - [locking](https://docs.prefect.io/integrations/prefect-redis/api-ref/prefect_redis-locking.md) - [messaging](https://docs.prefect.io/integrations/prefect-redis/api-ref/prefect_redis-messaging.md) - [ordering](https://docs.prefect.io/integrations/prefect-redis/api-ref/prefect_redis-ordering.md) - [tasks](https://docs.prefect.io/integrations/prefect-redis/api-ref/prefect_redis-tasks.md) #### Shell - [prefect-shell](https://docs.prefect.io/integrations/prefect-shell/index.md) ##### SDK Reference - [commands](https://docs.prefect.io/integrations/prefect-shell/api-ref/prefect_shell-commands.md) #### Slack - [prefect-slack](https://docs.prefect.io/integrations/prefect-slack/index.md) ##### SDK Reference - [credentials](https://docs.prefect.io/integrations/prefect-slack/api-ref/prefect_slack-credentials.md) - [messages](https://docs.prefect.io/integrations/prefect-slack/api-ref/prefect_slack-messages.md) #### Snowflake - [prefect-snowflake](https://docs.prefect.io/integrations/prefect-snowflake/index.md) ##### SDK Reference - [credentials](https://docs.prefect.io/integrations/prefect-snowflake/api-ref/prefect_snowflake-credentials.md) - [database](https://docs.prefect.io/integrations/prefect-snowflake/api-ref/prefect_snowflake-database.md) #### SQLAlchemy - [prefect-sqlalchemy](https://docs.prefect.io/integrations/prefect-sqlalchemy/index.md) ##### SDK Reference - [credentials](https://docs.prefect.io/integrations/prefect-sqlalchemy/api-ref/prefect_sqlalchemy-credentials.md) - [database](https://docs.prefect.io/integrations/prefect-sqlalchemy/api-ref/prefect_sqlalchemy-database.md) - [API Reference (581 pages)](https://docs.prefect.io/_llms/api-reference.txt): Documentation for API Reference. ## Contribute ### Contribute - [Contribute](https://docs.prefect.io/contribute/index.md): Join the community, improve Prefect, and share knowledge - [Contribute to documentation](https://docs.prefect.io/contribute/docs-contribute.md): Learn how to contribute to the Prefect docs. - [Develop on Prefect](https://docs.prefect.io/contribute/dev-contribute.md): Learn how to set up Prefect for development, experimentation and code contributions. - [Contribute to integrations](https://docs.prefect.io/contribute/contribute-integrations.md) - [Code and development style guide](https://docs.prefect.io/contribute/styles-practices.md) - [Code of conduct](https://docs.prefect.io/contribute/code-of-conduct.md): Learn about the standards we hold ourselves and our community to. ## Release Notes - [Release Notes](https://docs.prefect.io/v3/release-notes/index.md) - [Versioning and compatibility](https://docs.prefect.io/v3/release-notes/versioning.md): How Prefect versions releases and which client versions are compatible with a given server or Prefect Cloud ### OSS - [3.8](https://docs.prefect.io/v3/release-notes/oss/version-3-8.md) - [3.7](https://docs.prefect.io/v3/release-notes/oss/version-3-7.md) - [3.6](https://docs.prefect.io/v3/release-notes/oss/version-3-6.md) - [3.5](https://docs.prefect.io/v3/release-notes/oss/version-3-5.md) - [3.4](https://docs.prefect.io/v3/release-notes/oss/version-3-4.md) - [3.3](https://docs.prefect.io/v3/release-notes/oss/version-3-3.md) - [3.2](https://docs.prefect.io/v3/release-notes/oss/version-3-2.md) - [3.1](https://docs.prefect.io/v3/release-notes/oss/version-3-1.md) - [3.0](https://docs.prefect.io/v3/release-notes/oss/version-3-0.md) ### Integrations - [prefect-aws](https://docs.prefect.io/v3/release-notes/integrations/prefect-aws.md) - [prefect-azure](https://docs.prefect.io/v3/release-notes/integrations/prefect-azure.md) - [prefect-bitbucket](https://docs.prefect.io/v3/release-notes/integrations/prefect-bitbucket.md) - [prefect-databricks](https://docs.prefect.io/v3/release-notes/integrations/prefect-databricks.md) - [prefect-dbt](https://docs.prefect.io/v3/release-notes/integrations/prefect-dbt.md) - [prefect-docker](https://docs.prefect.io/v3/release-notes/integrations/prefect-docker.md) - [prefect-email](https://docs.prefect.io/v3/release-notes/integrations/prefect-email.md) - [prefect-gcp](https://docs.prefect.io/v3/release-notes/integrations/prefect-gcp.md) - [prefect-github](https://docs.prefect.io/v3/release-notes/integrations/prefect-github.md) - [prefect-gitlab](https://docs.prefect.io/v3/release-notes/integrations/prefect-gitlab.md) - [prefect-kubernetes](https://docs.prefect.io/v3/release-notes/integrations/prefect-kubernetes.md) - [prefect-ray](https://docs.prefect.io/v3/release-notes/integrations/prefect-ray.md) - [prefect-redis](https://docs.prefect.io/v3/release-notes/integrations/prefect-redis.md) - [prefect-shell](https://docs.prefect.io/v3/release-notes/integrations/prefect-shell.md) - [prefect-slack](https://docs.prefect.io/v3/release-notes/integrations/prefect-slack.md) - [prefect-snowflake](https://docs.prefect.io/v3/release-notes/integrations/prefect-snowflake.md) - [prefect-sqlalchemy](https://docs.prefect.io/v3/release-notes/integrations/prefect-sqlalchemy.md) ## OpenAPI Specs - [schema](/v3/api-ref/rest-api/server/schema.json) > The links below point to documentation indexes. Follow each `/_llms/` index recursively until you reach documentation pages. ## Indexes - [API Reference (581 pages)](https://docs.prefect.io/_llms/api-reference.txt): Documentation for API Reference.