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.DeleteDocumentationVersion

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Deletes a documentation version.

Creating a Request

data DeleteDocumentationVersion Source #

Deletes an existing documentation version of an API.

See: newDeleteDocumentationVersion smart constructor.

Constructors

DeleteDocumentationVersion'
Fields restApiId :: Text The string identifier of the associated RestApi. documentationVersion :: Text The version identifier of a to-be-deleted documentation snapshot.

Instances

Instances details

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

newDeleteDocumentationVersion Source #

Arguments

:: Text	`DeleteDocumentationVersion`
-> Text	`DeleteDocumentationVersion`
-> DeleteDocumentationVersion

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

DeleteDocumentationVersion, deleteDocumentationVersion_restApiId - The string identifier of the associated RestApi.

DeleteDocumentationVersion, deleteDocumentationVersion_documentationVersion - The version identifier of a to-be-deleted documentation snapshot.

Request Lenses

deleteDocumentationVersion_restApiId :: Lens' DeleteDocumentationVersion Text Source #

The string identifier of the associated RestApi.

deleteDocumentationVersion_documentationVersion :: Lens' DeleteDocumentationVersion Text Source #

The version identifier of a to-be-deleted documentation snapshot.

Destructuring the Response

data DeleteDocumentationVersionResponse Source #

See: newDeleteDocumentationVersionResponse smart constructor.

Constructors

DeleteDocumentationVersionResponse'

Instances

Instances details

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

newDeleteDocumentationVersionResponse :: DeleteDocumentationVersionResponse Source #

Create a value of DeleteDocumentationVersionResponse with all optional fields omitted.

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