APIGateway / Client / delete_deployment

delete_deployment#

APIGateway.Client.delete_deployment(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.delete_deployment(
    restApiId='string',
    deploymentId='string'
)
Parameters:
  • restApiId (string) –

    [REQUIRED]

    The string identifier of the associated RestApi.

  • deploymentId (string) –

    [REQUIRED]

    The identifier of the Deployment resource to delete.

Returns:

None

Exceptions

  • APIGateway.Client.exceptions.BadRequestException

  • APIGateway.Client.exceptions.ConflictException

  • APIGateway.Client.exceptions.LimitExceededException

  • APIGateway.Client.exceptions.NotFoundException

  • APIGateway.Client.exceptions.UnauthorizedException

  • APIGateway.Client.exceptions.TooManyRequestsException