Skip to content

delete_deployment

Operation

delete_deployment

delete_deployment(request: DeleteDeploymentInput | DeleteDeploymentInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteDeploymentInputDict]) -> 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
request DeleteDeploymentInput | DeleteDeploymentInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[DeleteDeploymentInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteDeploymentOutput

An instance of DeleteDeploymentOutput.

delete_deployment async

delete_deployment(request: DeleteDeploymentInput | DeleteDeploymentInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteDeploymentInputDict]) -> 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
request DeleteDeploymentInput | DeleteDeploymentInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[DeleteDeploymentInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteDeploymentOutput

An instance of DeleteDeploymentOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

DeleteDeploymentInputDict

Bases: TypedDict

Dictionary form of DeleteDeploymentInput.

Attributes

deployment_id instance-attribute
deployment_id: Required[str]

The identifier of the Deployment resource to delete.

rest_api_id instance-attribute
rest_api_id: Required[str]

The string identifier of the associated RestApi.

DeleteDeploymentInput dataclass

Bases: _SerdeShape

Requests API Gateway to delete a Deployment resource.

Attributes

deployment_id class-attribute instance-attribute
deployment_id: str | None = ...

The identifier of the Deployment resource to delete.

rest_api_id class-attribute instance-attribute
rest_api_id: str | None = ...

The string identifier of the associated RestApi.

Output

DeleteDeploymentOutput dataclass

Bases: _SerdeShape

Dataclass for DeleteDeploymentOutput structure.

Attributes

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.