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

Network.AWS.APIGateway.GetDocumentationVersions

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Undocumented operation.

Creating a Request

getDocumentationVersions Source #

Arguments

:: Text	`gdvRestAPIId`
-> GetDocumentationVersions

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

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

gdvLimit - The page size of the returned documentation versions.
gdvPosition - The position of the returned DocumentationVersion in the DocumentationVersions collection.
gdvRestAPIId - [Required] The identifier of an API of the to-be-retrieved documentation versions.

data GetDocumentationVersions Source #

Gets the documentation versions of an API.

See: getDocumentationVersions smart constructor.

Instances

Eq GetDocumentationVersions Source #
Methods (==) :: GetDocumentationVersions -> GetDocumentationVersions -> Bool # (/=) :: GetDocumentationVersions -> GetDocumentationVersions -> Bool #
Data GetDocumentationVersions Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetDocumentationVersions -> c GetDocumentationVersions # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetDocumentationVersions # toConstr :: GetDocumentationVersions -> Constr # dataTypeOf :: GetDocumentationVersions -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c GetDocumentationVersions) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetDocumentationVersions) # gmapT :: (forall b. Data b => b -> b) -> GetDocumentationVersions -> GetDocumentationVersions # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetDocumentationVersions -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetDocumentationVersions -> r # gmapQ :: (forall d. Data d => d -> u) -> GetDocumentationVersions -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> GetDocumentationVersions -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetDocumentationVersions -> m GetDocumentationVersions # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetDocumentationVersions -> m GetDocumentationVersions # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetDocumentationVersions -> m GetDocumentationVersions #
Read GetDocumentationVersions Source #
Methods readsPrec :: Int -> ReadS GetDocumentationVersions # readList :: ReadS [GetDocumentationVersions] # readPrec :: ReadPrec GetDocumentationVersions # readListPrec :: ReadPrec [GetDocumentationVersions] #
Show GetDocumentationVersions Source #
Methods showsPrec :: Int -> GetDocumentationVersions -> ShowS # show :: GetDocumentationVersions -> String # showList :: [GetDocumentationVersions] -> ShowS #
Generic GetDocumentationVersions Source #
Associated Types type Rep GetDocumentationVersions :: * -> * # Methods from :: GetDocumentationVersions -> Rep GetDocumentationVersions x # to :: Rep GetDocumentationVersions x -> GetDocumentationVersions #
Hashable GetDocumentationVersions Source #
Methods hashWithSalt :: Int -> GetDocumentationVersions -> Int # hash :: GetDocumentationVersions -> Int #
NFData GetDocumentationVersions Source #
Methods rnf :: GetDocumentationVersions -> () #
AWSRequest GetDocumentationVersions Source #
Associated Types type Rs GetDocumentationVersions :: * # Methods request :: GetDocumentationVersions -> Request GetDocumentationVersions # response :: MonadResource m => Logger -> Service -> Proxy * GetDocumentationVersions -> ClientResponse -> m (Response GetDocumentationVersions) #
ToPath GetDocumentationVersions Source #
Methods toPath :: GetDocumentationVersions -> ByteString #
ToHeaders GetDocumentationVersions Source #
Methods toHeaders :: GetDocumentationVersions -> [Header] #
ToQuery GetDocumentationVersions Source #
Methods toQuery :: GetDocumentationVersions -> QueryString #
type Rep GetDocumentationVersions Source #
type Rep GetDocumentationVersions = D1 (MetaData "GetDocumentationVersions" "Network.AWS.APIGateway.GetDocumentationVersions" "amazonka-apigateway-1.4.5-BIK2fycuXdJFBbWQ9Hqf16" False) (C1 (MetaCons "GetDocumentationVersions'" PrefixI True) ((::) (S1 (MetaSel (Just Symbol "_gdvLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int))) ((::) (S1 (MetaSel (Just Symbol "_gdvPosition") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_gdvRestAPIId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))
type Rs GetDocumentationVersions Source #
type Rs GetDocumentationVersions = GetDocumentationVersionsResponse

Request Lenses

gdvLimit :: Lens' GetDocumentationVersions (Maybe Int) Source #

The page size of the returned documentation versions.

gdvPosition :: Lens' GetDocumentationVersions (Maybe Text) Source #

The position of the returned DocumentationVersion in the DocumentationVersions collection.

gdvRestAPIId :: Lens' GetDocumentationVersions Text Source #

Required: The identifier of an API of the to-be-retrieved documentation versions.

Destructuring the Response

getDocumentationVersionsResponse Source #

Arguments

:: Int	`gdvrsResponseStatus`
-> GetDocumentationVersionsResponse

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

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

gdvrsItems - The current page of DocumentationVersion items from the DocumentationVersions collection of an API.
gdvrsPosition - Undocumented member.
gdvrsResponseStatus - -- | The response status code.

data GetDocumentationVersionsResponse Source #

The collection of documentation snapshots of an API.

Use the DocumentationVersions to manage documentation snapshots associated with various API stages.

Documenting an API , DocumentationPart , DocumentationVersion

See: getDocumentationVersionsResponse smart constructor.

Instances

Eq GetDocumentationVersionsResponse Source #
Methods (==) :: GetDocumentationVersionsResponse -> GetDocumentationVersionsResponse -> Bool # (/=) :: GetDocumentationVersionsResponse -> GetDocumentationVersionsResponse -> Bool #
Data GetDocumentationVersionsResponse Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetDocumentationVersionsResponse -> c GetDocumentationVersionsResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetDocumentationVersionsResponse # toConstr :: GetDocumentationVersionsResponse -> Constr # dataTypeOf :: GetDocumentationVersionsResponse -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c GetDocumentationVersionsResponse) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetDocumentationVersionsResponse) # gmapT :: (forall b. Data b => b -> b) -> GetDocumentationVersionsResponse -> GetDocumentationVersionsResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetDocumentationVersionsResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetDocumentationVersionsResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> GetDocumentationVersionsResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> GetDocumentationVersionsResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetDocumentationVersionsResponse -> m GetDocumentationVersionsResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetDocumentationVersionsResponse -> m GetDocumentationVersionsResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetDocumentationVersionsResponse -> m GetDocumentationVersionsResponse #
Read GetDocumentationVersionsResponse Source #
Methods readsPrec :: Int -> ReadS GetDocumentationVersionsResponse # readList :: ReadS [GetDocumentationVersionsResponse] # readPrec :: ReadPrec GetDocumentationVersionsResponse # readListPrec :: ReadPrec [GetDocumentationVersionsResponse] #
Show GetDocumentationVersionsResponse Source #
Methods showsPrec :: Int -> GetDocumentationVersionsResponse -> ShowS # show :: GetDocumentationVersionsResponse -> String # showList :: [GetDocumentationVersionsResponse] -> ShowS #
Generic GetDocumentationVersionsResponse Source #
Associated Types type Rep GetDocumentationVersionsResponse :: * -> * # Methods from :: GetDocumentationVersionsResponse -> Rep GetDocumentationVersionsResponse x # to :: Rep GetDocumentationVersionsResponse x -> GetDocumentationVersionsResponse #
NFData GetDocumentationVersionsResponse Source #
Methods rnf :: GetDocumentationVersionsResponse -> () #
type Rep GetDocumentationVersionsResponse Source #
type Rep GetDocumentationVersionsResponse = D1 (MetaData "GetDocumentationVersionsResponse" "Network.AWS.APIGateway.GetDocumentationVersions" "amazonka-apigateway-1.4.5-BIK2fycuXdJFBbWQ9Hqf16" False) (C1 (MetaCons "GetDocumentationVersionsResponse'" PrefixI True) ((::) (S1 (MetaSel (Just Symbol "_gdvrsItems") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [DocumentationVersion]))) ((::) (S1 (MetaSel (Just Symbol "_gdvrsPosition") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_gdvrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)))))

Response Lenses

gdvrsItems :: Lens' GetDocumentationVersionsResponse [DocumentationVersion] Source #

The current page of DocumentationVersion items from the DocumentationVersions collection of an API.

gdvrsPosition :: Lens' GetDocumentationVersionsResponse (Maybe Text) Source #

Undocumented member.

gdvrsResponseStatus :: Lens' GetDocumentationVersionsResponse Int Source #

- | The response status code.