delete_deployment ¶

delete_deployment(
    rest_api_id: String,
    deployment_id: String,
    *,
    config_overrides: Optional[APIGatewayClientConfig] = None,
) -> None

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

Parameters:

rest_api_id (String) –

The string identifier of the associated RestApi.
deployment_id (String) –

The identifier of the Deployment resource to delete.

Raises:

BadRequestException –

The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ConflictException –

The request configuration has conflicts. For details, see the accompanying error message.
LimitExceededException –

The request exceeded the rate limit. Retry after the specified time period.
NotFoundException –

The requested resource is not found. Make sure that the request URI is correct.
TooManyRequestsException –

The request has reached its throttling limit. Retry after the specified time period.
UnauthorizedException –

The request is denied because the caller has insufficient permissions.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_api_gateway/_services/api_gateway.py

def delete_deployment(
    self,
    rest_api_id: "capo_api_gateway.types.string.String",
    deployment_id: "capo_api_gateway.types.string.String",
    *,
    config_overrides: Optional[APIGatewayClientConfig] = None,
) -> None:
    """<p>Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it.</p>

    Args:
        rest_api_id: <p>The string identifier of the associated RestApi.</p>
        deployment_id: <p>The identifier of the Deployment resource to delete.</p>

    Raises:
        capo_api_gateway.errors.bad_request_exception.BadRequestException: <p>The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.</p>
        capo_api_gateway.errors.conflict_exception.ConflictException: <p>The request configuration has conflicts. For details, see the accompanying error message.</p>
        capo_api_gateway.errors.limit_exceeded_exception.LimitExceededException: <p>The request exceeded the rate limit. Retry after the specified time period.</p>
        capo_api_gateway.errors.not_found_exception.NotFoundException: <p>The requested resource is not found. Make sure that the request URI is correct.</p>
        capo_api_gateway.errors.too_many_requests_exception.TooManyRequestsException: <p>The request has reached its throttling limit. Retry after the specified time period.</p>
        capo_api_gateway.errors.unauthorized_exception.UnauthorizedException: <p>The request is denied because the caller has insufficient permissions.</p>
        capo_api_gateway.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_api_gateway.types.delete_deployment_request.DeleteDeploymentRequest]",
    ) -> OperationResponse[None]:
        import capo_api_gateway._operations.backplane_control_service.delete_deployment

        output, http_response = (
            capo_api_gateway._operations.backplane_control_service.delete_deployment.delete_deployment(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteDeployment")
    )
    input_: capo_api_gateway.types.delete_deployment_request.DeleteDeploymentRequest = {
        "rest_api_id": rest_api_id,
        "deployment_id": deployment_id,
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output