amazonka-apigateway-1.6.0: Amazon API Gateway SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.APIGateway.GetDocumentationParts

Contents

Description

Undocumented operation.

Synopsis

Creating a Request

getDocumentationParts Source #

Creates a value of GetDocumentationParts with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • gdpPath - The path of API entities of the to-be-retrieved documentation parts.
  • gdpLocationStatus - The status of the API documentation parts to retrieve. Valid values are DOCUMENTED for retrieving DocumentationPart resources with content and UNDOCUMENTED for DocumentationPart resources without content.
  • gdpNameQuery - The name of API entities of the to-be-retrieved documentation parts.
  • gdpLimit - The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
  • gdpType - The type of API entities of the to-be-retrieved documentation parts.
  • gdpPosition - The current pagination position in the paged result set.
  • gdpRestAPIId - [Required] The string identifier of the associated RestApi .

data GetDocumentationParts Source #

Gets the documentation parts of an API. The result may be filtered by the type, name, or path of API entities (targets).

See: getDocumentationParts smart constructor.

Instances

Eq GetDocumentationParts Source # 
Data GetDocumentationParts Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetDocumentationParts -> c GetDocumentationParts #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetDocumentationParts #

toConstr :: GetDocumentationParts -> Constr #

dataTypeOf :: GetDocumentationParts -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c GetDocumentationParts) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetDocumentationParts) #

gmapT :: (forall b. Data b => b -> b) -> GetDocumentationParts -> GetDocumentationParts #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetDocumentationParts -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetDocumentationParts -> r #

gmapQ :: (forall d. Data d => d -> u) -> GetDocumentationParts -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> GetDocumentationParts -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetDocumentationParts -> m GetDocumentationParts #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetDocumentationParts -> m GetDocumentationParts #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetDocumentationParts -> m GetDocumentationParts #

Read GetDocumentationParts Source # 
Show GetDocumentationParts Source # 
Generic GetDocumentationParts Source # 
Hashable GetDocumentationParts Source # 
NFData GetDocumentationParts Source # 

Methods

rnf :: GetDocumentationParts -> () #

AWSRequest GetDocumentationParts Source # 
ToHeaders GetDocumentationParts Source # 
ToPath GetDocumentationParts Source # 
ToQuery GetDocumentationParts Source # 
type Rep GetDocumentationParts Source # 
type Rs GetDocumentationParts Source # 

Request Lenses

gdpPath :: Lens' GetDocumentationParts (Maybe Text) Source #

The path of API entities of the to-be-retrieved documentation parts.

gdpLocationStatus :: Lens' GetDocumentationParts (Maybe LocationStatusType) Source #

The status of the API documentation parts to retrieve. Valid values are DOCUMENTED for retrieving DocumentationPart resources with content and UNDOCUMENTED for DocumentationPart resources without content.

gdpNameQuery :: Lens' GetDocumentationParts (Maybe Text) Source #

The name of API entities of the to-be-retrieved documentation parts.

gdpLimit :: Lens' GetDocumentationParts (Maybe Int) Source #

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

gdpType :: Lens' GetDocumentationParts (Maybe DocumentationPartType) Source #

The type of API entities of the to-be-retrieved documentation parts.

gdpPosition :: Lens' GetDocumentationParts (Maybe Text) Source #

The current pagination position in the paged result set.

gdpRestAPIId :: Lens' GetDocumentationParts Text Source #

Required
The string identifier of the associated RestApi .

Destructuring the Response

getDocumentationPartsResponse Source #

Creates a value of GetDocumentationPartsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data GetDocumentationPartsResponse Source #

The collection of documentation parts of an API.

Documenting an API , DocumentationPart

See: getDocumentationPartsResponse smart constructor.

Instances

Eq GetDocumentationPartsResponse Source # 
Data GetDocumentationPartsResponse Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetDocumentationPartsResponse -> c GetDocumentationPartsResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetDocumentationPartsResponse #

toConstr :: GetDocumentationPartsResponse -> Constr #

dataTypeOf :: GetDocumentationPartsResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c GetDocumentationPartsResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetDocumentationPartsResponse) #

gmapT :: (forall b. Data b => b -> b) -> GetDocumentationPartsResponse -> GetDocumentationPartsResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetDocumentationPartsResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetDocumentationPartsResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> GetDocumentationPartsResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> GetDocumentationPartsResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetDocumentationPartsResponse -> m GetDocumentationPartsResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetDocumentationPartsResponse -> m GetDocumentationPartsResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetDocumentationPartsResponse -> m GetDocumentationPartsResponse #

Read GetDocumentationPartsResponse Source # 
Show GetDocumentationPartsResponse Source # 
Generic GetDocumentationPartsResponse Source # 
NFData GetDocumentationPartsResponse Source # 
type Rep GetDocumentationPartsResponse Source # 
type Rep GetDocumentationPartsResponse = D1 * (MetaData "GetDocumentationPartsResponse" "Network.AWS.APIGateway.GetDocumentationParts" "amazonka-apigateway-1.6.0-JJ9NJtNe0aRBcVRYpJCEA2" False) (C1 * (MetaCons "GetDocumentationPartsResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_gdprsItems") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [DocumentationPart]))) ((:*:) * (S1 * (MetaSel (Just Symbol "_gdprsPosition") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_gdprsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

gdprsItems :: Lens' GetDocumentationPartsResponse [DocumentationPart] Source #

The current page of elements from this collection.