> ## Documentation Index
> Fetch the complete documentation index at: https://docs.prefect.io/llms.txt
> Use this file to discover all available pages before exploring further.
# deployment
# `prefect.cli.deployment`
Deployment command — native cyclopts implementation.
Manage deployments and deployment schedules.
## Functions
### `inspect`
```python theme={null}
inspect(name: str)
```
View details about a deployment.
**Examples:**
`$ prefect deployment inspect "hello-world/my-deployment"`
```python theme={null}
{
'id': '610df9c3-0fb4-4856-b330-67f588d20201',
'created': '2022-08-01T18:36:25.192102+00:00',
'updated': '2022-08-01T18:36:25.188166+00:00',
'name': 'my-deployment',
'description': None,
'flow_id': 'b57b0aa2-ef3a-479e-be49-381fb0483b4e',
'schedules': None,
'parameters': {'name': 'Marvin'},
'tags': ['test'],
'parameter_openapi_schema': {
'title': 'Parameters',
'type': 'object',
'properties': {
'name': {
'title': 'name',
'type': 'string'
}
},
'required': ['name']
},
'storage_document_id': '63ef008f-1e5d-4e07-a0d4-4535731adb32',
'infrastructure_document_id': '6702c598-7094-42c8-9785-338d2ec3a028',
'infrastructure': {
'type': 'process',
'env': {},
'labels': {},
'name': None,
'command': ['python', '-m', 'prefect.engine'],
'stream_output': True
}
}
```
### `ls`
```python theme={null}
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`
```python theme={null}
run(name: Annotated[Optional[str], cyclopts.Parameter('name', help="A deployed flow's 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`
```python theme={null}
delete(name: Annotated[Optional[str], cyclopts.Parameter('name', help="A deployed flow's name: /")] = None)
```
Delete a deployment.
**Examples:**
```bash theme={null}
$ prefect deployment delete test_flow/test_deployment
$ prefect deployment delete --id dfd3e220-a130-4149-9af6-8d487e02fea6
```
### `create_schedule`
```python theme={null}
create_schedule(name: str)
```
Create a schedule for a given deployment.
### `delete_schedule`
```python theme={null}
delete_schedule(deployment_name: str, schedule_id: UUID)
```
Delete a deployment schedule.
### `pause_schedule`
```python theme={null}
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.
**Examples:**
```bash theme={null}
# Pause a specific schedule
$ prefect deployment schedule pause my-flow/my-deployment abc123-...
# Pause all schedules
$ prefect deployment schedule pause --all
```
### `resume_schedule`
```python theme={null}
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.
**Examples:**
```bash theme={null}
# Resume a specific schedule
$ prefect deployment schedule resume my-flow/my-deployment abc123-...
# Resume all schedules
$ prefect deployment schedule resume --all
```
### `list_schedules`
```python theme={null}
list_schedules(deployment_name: str)
```
View all schedules for a deployment.
### `clear_schedules`
```python theme={null}
clear_schedules(deployment_name: str)
```
Clear all schedules for a deployment.