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

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Deletes a documentation part

Creating a Request

data DeleteDocumentationPart Source #

Deletes an existing documentation part of an API.

See: newDeleteDocumentationPart smart constructor.

Constructors

DeleteDocumentationPart'
Fields restApiId :: Text The string identifier of the associated RestApi. documentationPartId :: Text The identifier of the to-be-deleted documentation part.

Instances

Instances details

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

newDeleteDocumentationPart Source #

Arguments

:: Text	`DeleteDocumentationPart`
-> Text	`$sel:documentationPartId:DeleteDocumentationPart'`
-> DeleteDocumentationPart

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

DeleteDocumentationPart, deleteDocumentationPart_restApiId - The string identifier of the associated RestApi.

$sel:documentationPartId:DeleteDocumentationPart', deleteDocumentationPart_documentationPartId - The identifier of the to-be-deleted documentation part.

Request Lenses

deleteDocumentationPart_restApiId :: Lens' DeleteDocumentationPart Text Source #

The string identifier of the associated RestApi.

deleteDocumentationPart_documentationPartId :: Lens' DeleteDocumentationPart Text Source #

The identifier of the to-be-deleted documentation part.

Destructuring the Response

data DeleteDocumentationPartResponse Source #

See: newDeleteDocumentationPartResponse smart constructor.

Constructors

DeleteDocumentationPartResponse'

Instances

Instances details

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

newDeleteDocumentationPartResponse :: DeleteDocumentationPartResponse Source #

Create a value of DeleteDocumentationPartResponse with all optional fields omitted.

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