Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.APIGateway.DeleteDeployment

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

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

Creating a Request

data DeleteDeployment Source #

Requests API Gateway to delete a Deployment resource.

See: newDeleteDeployment smart constructor.

Constructors

DeleteDeployment'
Fields restApiId :: Text Required The string identifier of the associated RestApi. deploymentId :: Text Required The identifier of the Deployment resource to delete.

Instances

Instances details

Eq DeleteDeployment Source #
Instance details Defined in Amazonka.APIGateway.DeleteDeployment Methods (==) :: DeleteDeployment -> DeleteDeployment -> Bool # (/=) :: DeleteDeployment -> DeleteDeployment -> Bool #
Read DeleteDeployment Source #
Instance details Defined in Amazonka.APIGateway.DeleteDeployment Methods readsPrec :: Int -> ReadS DeleteDeployment # readList :: ReadS [DeleteDeployment] # readPrec :: ReadPrec DeleteDeployment # readListPrec :: ReadPrec [DeleteDeployment] #
Show DeleteDeployment Source #
Instance details Defined in Amazonka.APIGateway.DeleteDeployment Methods showsPrec :: Int -> DeleteDeployment -> ShowS # show :: DeleteDeployment -> String # showList :: [DeleteDeployment] -> ShowS #
Generic DeleteDeployment Source #
Instance details Defined in Amazonka.APIGateway.DeleteDeployment Associated Types type Rep DeleteDeployment :: Type -> Type # Methods from :: DeleteDeployment -> Rep DeleteDeployment x # to :: Rep DeleteDeployment x -> DeleteDeployment #
NFData DeleteDeployment Source #
Instance details Defined in Amazonka.APIGateway.DeleteDeployment Methods rnf :: DeleteDeployment -> () #
Hashable DeleteDeployment Source #
Instance details Defined in Amazonka.APIGateway.DeleteDeployment Methods hashWithSalt :: Int -> DeleteDeployment -> Int # hash :: DeleteDeployment -> Int #
AWSRequest DeleteDeployment Source #
Instance details Defined in Amazonka.APIGateway.DeleteDeployment Associated Types type AWSResponse DeleteDeployment # Methods request :: DeleteDeployment -> Request DeleteDeployment # response :: MonadResource m => Logger -> Service -> Proxy DeleteDeployment -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteDeployment))) #
ToHeaders DeleteDeployment Source #
Instance details Defined in Amazonka.APIGateway.DeleteDeployment Methods toHeaders :: DeleteDeployment -> [Header] #
ToPath DeleteDeployment Source #
Instance details Defined in Amazonka.APIGateway.DeleteDeployment Methods toPath :: DeleteDeployment -> ByteString #
ToQuery DeleteDeployment Source #
Instance details Defined in Amazonka.APIGateway.DeleteDeployment Methods toQuery :: DeleteDeployment -> QueryString #
type Rep DeleteDeployment Source #
Instance details Defined in Amazonka.APIGateway.DeleteDeployment type Rep DeleteDeployment = D1 ('MetaData "DeleteDeployment" "Amazonka.APIGateway.DeleteDeployment" "libZSservicesZSamazonka-apigatewayZSamazonka-apigateway" 'False) (C1 ('MetaCons "DeleteDeployment'" 'PrefixI 'True) (S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "deploymentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DeleteDeployment Source #
Instance details Defined in Amazonka.APIGateway.DeleteDeployment type AWSResponse DeleteDeployment = DeleteDeploymentResponse

newDeleteDeployment Source #

Arguments

:: Text	`$sel:restApiId:DeleteDeployment'`
-> Text	`$sel:deploymentId:DeleteDeployment'`
-> DeleteDeployment

Create a value of DeleteDeployment with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:restApiId:DeleteDeployment', deleteDeployment_restApiId - [Required] The string identifier of the associated RestApi.

$sel:deploymentId:DeleteDeployment', deleteDeployment_deploymentId - [Required] The identifier of the Deployment resource to delete.

Request Lenses

deleteDeployment_restApiId :: Lens' DeleteDeployment Text Source #

Required: The string identifier of the associated RestApi.

deleteDeployment_deploymentId :: Lens' DeleteDeployment Text Source #

Required: The identifier of the Deployment resource to delete.

Destructuring the Response

data DeleteDeploymentResponse Source #

See: newDeleteDeploymentResponse smart constructor.

Constructors

DeleteDeploymentResponse'

Instances

Instances details

Eq DeleteDeploymentResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteDeployment Methods (==) :: DeleteDeploymentResponse -> DeleteDeploymentResponse -> Bool # (/=) :: DeleteDeploymentResponse -> DeleteDeploymentResponse -> Bool #
Read DeleteDeploymentResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteDeployment Methods readsPrec :: Int -> ReadS DeleteDeploymentResponse # readList :: ReadS [DeleteDeploymentResponse] # readPrec :: ReadPrec DeleteDeploymentResponse # readListPrec :: ReadPrec [DeleteDeploymentResponse] #
Show DeleteDeploymentResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteDeployment Methods showsPrec :: Int -> DeleteDeploymentResponse -> ShowS # show :: DeleteDeploymentResponse -> String # showList :: [DeleteDeploymentResponse] -> ShowS #
Generic DeleteDeploymentResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteDeployment Associated Types type Rep DeleteDeploymentResponse :: Type -> Type # Methods from :: DeleteDeploymentResponse -> Rep DeleteDeploymentResponse x # to :: Rep DeleteDeploymentResponse x -> DeleteDeploymentResponse #
NFData DeleteDeploymentResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteDeployment Methods rnf :: DeleteDeploymentResponse -> () #
type Rep DeleteDeploymentResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteDeployment type Rep DeleteDeploymentResponse = D1 ('MetaData "DeleteDeploymentResponse" "Amazonka.APIGateway.DeleteDeployment" "libZSservicesZSamazonka-apigatewayZSamazonka-apigateway" 'False) (C1 ('MetaCons "DeleteDeploymentResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteDeploymentResponse :: DeleteDeploymentResponse Source #

Create a value of DeleteDeploymentResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.