Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.APIGateway.DeleteRestApi

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Deletes the specified API.

Synopsis

data DeleteRestApi = DeleteRestApi' {
- restApiId :: Text
}
newDeleteRestApi :: Text -> DeleteRestApi
deleteRestApi_restApiId :: Lens' DeleteRestApi Text
data DeleteRestApiResponse = DeleteRestApiResponse' {
}
newDeleteRestApiResponse :: DeleteRestApiResponse

Creating a Request

data DeleteRestApi Source #

Request to delete the specified API from your collection.

See: newDeleteRestApi smart constructor.

Constructors

DeleteRestApi'
Fields restApiId :: Text The string identifier of the associated RestApi.

Instances

Instances details

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

newDeleteRestApi Source #

Arguments

:: Text	`DeleteRestApi`
-> DeleteRestApi

Create a value of DeleteRestApi 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:

DeleteRestApi, deleteRestApi_restApiId - The string identifier of the associated RestApi.

Request Lenses

deleteRestApi_restApiId :: Lens' DeleteRestApi Text Source #

The string identifier of the associated RestApi.

Destructuring the Response

data DeleteRestApiResponse Source #

See: newDeleteRestApiResponse smart constructor.

Constructors

DeleteRestApiResponse'

Instances

Instances details

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

newDeleteRestApiResponse :: DeleteRestApiResponse Source #

Create a value of DeleteRestApiResponse with all optional fields omitted.

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