Api Gateway > Operations > delete_deployment

delete_deployment¶

Operation¶

delete_deployment(input: DeleteDeploymentInput, plugins: list[Plugin] | None = None) -> DeleteDeploymentOutput

Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it.

Parameters:

Name	Type	Description	Default
`input`	`DeleteDeploymentInput`	An instance of `DeleteDeploymentInput`.	required
`plugins`	`list[Plugin] \| None`	A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.	`None`

Returns:

Type	Description
`DeleteDeploymentOutput`	An instance of `DeleteDeploymentOutput`.

Requests API Gateway to delete a Deployment resource.

deployment_id: str | None = None

The identifier of the Deployment resource to delete.

rest_api_id: str | None = None

The string identifier of the associated RestApi.

Dataclass for DeleteDeploymentOutput structure.