Skip to content

You're viewing the docs for Prefect 2.8.1. Click here to view the latest docs.

Prefect Docs

prefect.software

Initializing search

GitHub

Try Prefect Cloud →

Prefect Docs

GitHub

Getting Started
Getting Started
- Installation
- Quickstart
Tutorial
Tutorial
- Flows
- Tasks
- Deployments
- Work Pools
- Workers
How-to Guides
How-to Guides
- Development
  Development
- Execution
  Execution
- Work Pools
  Work Pools
Concepts
Concepts
- Flows
- Tasks
- Deployments
- Work Pools & Workers
- Schedules
- Results
- Artifacts
- States
- Blocks
- Task Runners
- Automations
- Block and Agent-Based Deployments
  Block and Agent-Based Deployments
Cloud
Cloud
Integrations
Integrations
- Using Integrations
- Contributing Integrations
- Libraries
  Libraries
  - AWS
    
    AWS
    
    Guides
    Guides
    
    Setting up an ECS Worker
    
    Batch
    
    Client Waiter
    
    Credentials
    
    ECS Worker
    
    ECS (deprecated)
    
    Glue Job
    
    Lambda
    
    Deployments
    Deployments
    
    Steps
    
    S3
    
    Secrets Manager
  - Azure
    
    Azure
    
    ACI Worker Guide
    
    Credentials
    
    Blob Storage
    
    Cosmos DB
    
    ML Datastore
    
    Container Instance Block
    
    Container Instance Worker
    
    Deployments
    Deployments
    
    Steps
  - Bitbucket
    
    Bitbucket
    
    Credentials
    
    Repositories
  - Dask
    
    Dask
    
    Usage Guide
    
    Task Runners
    
    Utils
  - Databricks
    
    Databricks
    
    Credentials
    
    Jobs
    
    Rest
    
    Flows
  - dbt
    
    dbt
    
    Cloud
    Cloud
    
    Credentials
    
    Jobs
    
    Runs
    
    Clients
    
    Models
    
    Utils
    
    CLI
    CLI
    
    Credentials
    
    Commands
    
    Configs
    Configs
    
    Base
    
    BigQuery
    
    Postgres
    
    Snowflake
  - Docker
    
    Docker
    
    Host
    
    Credentials
    
    Containers
    
    Images
    
    Deployments
    Deployments
    
    Steps
    
    Worker
  - Email
    
    Email
    
    Credentials
    
    Message
  - GCP
    
    GCP
    
    Google Cloud Run Execution Guide
    
    Credentials
    
    Cloud Storage
    
    BigQuery
    
    Secret Manager
    
    Cloud Run
    
    AI Platform
    
    Deployment Steps
    
    Workers
    Workers
    
    Cloud Run
    
    Cloud Run V2
    
    Vertex AI
  - GitHub
    
    GitHub
    
    Credentials
    
    Graphql
    
    Mutations
    
    Organization
    
    Repository
    
    Repository Owner
    
    User
    
    Utils
    
    Viewer
    
    Graphql Schema
  - Gitlab
    
    Gitlab
    
    Credentials
    
    Repositories
  - Kubernetes
    
    Kubernetes
    
    Credentials
    
    Custom Objects
    
    Deployments
    
    Exceptions
    
    Flows
    
    Jobs
    
    Pods
    
    Services
    
    Utilities
    
    Worker
  - Ray
    
    Ray
    
    Task Runners
  - Shell
    
    Shell
    
    Commands
  - Slack
    
    Slack
    
    Credentials
    
    Messages
  - Snowflake
    
    Snowflake
    
    Credentials
    
    Database
  - SQLAlchemy
    
    SQLAlchemy
    
    Credentials
    
    Database
API Reference
API Reference
- Python SDK
  Python SDK
  - prefect.agent
  - prefect.artifacts
  - prefect.blocks
    prefect.blocks
    
    core
    
    fields
    
    kubernetes
    
    notifications
    
    system
    
    webhook
  - prefect.client
    prefect.client
    
    base
    
    cloud
    
    orchestration
    
    schemas
    
    utilities
  - prefect.cli
    prefect.cli
    
    agent
    
    artifact
    
    block
    
    cloud
    
    cloud
    
    concurrency_limit
    
    config
    
    deploy
    
    deployment
    
    dev
    
    flow
    
    flow_run
    
    kubernetes
    
    profile
    
    project
    
    root
    
    server
    
    shell
    
    variable
    
    work_pool
    
    work_queue
    
    worker
  - prefect.context
  - prefect.concurrency
    prefect.concurrency
    
    asyncio
    
    events
    
    services
    
    sync
  - prefect.deployments
    prefect.deployments
    
    deployments
    
    base
    
    runner
    
    steps.core
    
    steps.pull
    
    steps.utility
  - prefect.engine
  - prefect.exceptions
  - prefect.events
  - prefect.filesystems
  - prefect.flows
  - prefect.flow_runs
  - prefect.futures
  - prefect.infrastructure
  - prefect.input
    prefect.input
    
    actions
    
    run_input
  - prefect.logging
    prefect.logging
    
    configuration
    
    formatters
    
    handlers
    
    highlighters
    
    loggers
  - prefect.manifests
  - prefect.runner
    prefect.runner
    
    runner
    
    server
    
    storage
    
    utils
  - prefect.runtime
    prefect.runtime
    
    flow_run
    
    deployment
    
    task_run
  - prefect.serializers
  - prefect.settings
  - prefect.software
  - prefect.states
  - prefect.task_runners
  - prefect.tasks
  - prefect.testing
  - prefect.utilities
    prefect.utilities
    
    annotations
    
    asyncutils
    
    callables
    
    collections
    
    compat
    
    context
    
    dispatch
    
    dockerutils
    
    filesystem
    
    hashing
    
    importtools
    
    math
    
    names
    
    processutils
    
    pydantic
    
    render_swagger
    
    services
    
    slugify
    
    templating
    
    text
    
    visualization
  - prefect.variables
  - prefect.workers
    prefect.workers
    
    base
    
    block
    
    process
    
    server
    
    utilities
- REST API
  REST API
  - Prefect Cloud REST API Reference
  - Prefect Server REST API Reference
- Server API
  Server API
  - API
    API
    
    server.api.admin
    
    server.api.csrf_token
    
    server.api.dependencies
    
    server.api.deployments
    
    server.api.flows
    
    server.api.flow_runs
    
    server.api.flow_run_states
    
    server.api.middleware
    
    server.api.run_history
    
    server.api.saved_searches
    
    server.api.server
    
    server.api.task_runs
    
    server.api.task_run_states
  - Models
    Models
    
    server.models.csrf_token
    
    server.models.flows
    
    server.models.flow_runs
    
    server.models.flow_run_states
    
    server.models.task_runs
    
    server.models.task_run_states
    
    server.models.deployments
    
    server.models.saved_searches
  - Orchestration
    Orchestration
    
    server.orchestration.rules
    
    server.orchestration.policies
    
    server.orchestration.core_policy
    
    server.orchestration.global_policy
  - Schemas
    Schemas
    
    server.schemas.actions
    
    server.schemas.core
    
    server.schemas.filters
    
    server.schemas.responses
    
    server.schemas.schedules
    
    server.schemas.sorting
    
    server.schemas.states
  - Services
    Services
    
    server.services.late_runs
    
    server.services.loop_service
    
    server.services.scheduler
  - Utilities
    Utilities
    
    server.utilities.database
    
    server.utilities.schemas
    
    server.utilities.server
Community
Community

API Reference
Python SDK

`prefect.software` ¶

Was this page helpful?

Thank you for your feedback!

Thank you for your feedback! Feel free to open an issue with more detail.

prefect.software ¶

`prefect.software` ¶