`prefect.cli.deployment`

Deployment command — native cyclopts implementation. Manage deployments and deployment schedules.

Functions

`inspect`

inspect(name: str)

View details about a deployment.

`ls`

ls(flow_name: Annotated[Optional[list[str]], cyclopts.Parameter('flow_name', help='One or more flow names to filter deployments by.')] = None)

View all deployments or deployments for specific flows.

`run`

run(name: Annotated[Optional[str], cyclopts.Parameter('name', help="A deployed flow's name: <FLOW_NAME>/<DEPLOYMENT_NAME>")] = None)

Create a flow run for the given flow and deployment. The flow run will be scheduled to run immediately unless --start-in or --start-at is specified. The flow run will not execute until a worker starts. To watch the flow run until it reaches a terminal state, use the --watch flag.

`delete`

delete(name: Annotated[Optional[str], cyclopts.Parameter('name', help="A deployed flow's name: <FLOW_NAME>/<DEPLOYMENT_NAME>")] = None)

Delete a deployment.

`create_schedule`

create_schedule(name: str)

Create a schedule for a given deployment.

`delete_schedule`

delete_schedule(deployment_name: str, schedule_id: UUID)

Delete a deployment schedule.

`pause_schedule`

pause_schedule(deployment_name: Annotated[Optional[str], cyclopts.Parameter('deployment_name')] = None, schedule_id: Annotated[Optional[UUID], cyclopts.Parameter('schedule_id')] = None)

Pause deployment schedules.

`resume_schedule`

resume_schedule(deployment_name: Annotated[Optional[str], cyclopts.Parameter('deployment_name')] = None, schedule_id: Annotated[Optional[UUID], cyclopts.Parameter('schedule_id')] = None)

Resume deployment schedules.

`list_schedules`

list_schedules(deployment_name: str)

View all schedules for a deployment.

`clear_schedules`

clear_schedules(deployment_name: str)

Clear all schedules for a deployment.

​prefect.cli.deployment

​Functions

​inspect

​ls

​run

​delete

​create_schedule

​delete_schedule

​pause_schedule

​resume_schedule

​list_schedules

​clear_schedules