Network.AWS.APIGateway.GetDocumentationVersion

Undocumented operation.

Creating a Request

getDocumentationVersion

Arguments

:: Text

gdvdRestAPIId

-> Text

gdvdDocumentationVersion

-> GetDocumentationVersion

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

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

• gdvdRestAPIId - [Required] The string identifier of the associated RestApi .
• gdvdDocumentationVersion - [Required] The version identifier of the to-be-retrieved documentation snapshot.

data GetDocumentationVersion

Gets a documentation snapshot of an API.

See: getDocumentationVersion smart constructor.

Instances

Eq GetDocumentationVersion

Methods

(==) :: GetDocumentationVersion -> GetDocumentationVersion -> Bool

(/=) :: GetDocumentationVersion -> GetDocumentationVersion -> Bool

Data GetDocumentationVersion

Methods

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

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

toConstr :: GetDocumentationVersion -> Constr

dataTypeOf :: GetDocumentationVersion -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> GetDocumentationVersion -> GetDocumentationVersion

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

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

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

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

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

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

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

Read GetDocumentationVersion

Methods

readsPrec :: Int -> ReadS GetDocumentationVersion

readList :: ReadS [GetDocumentationVersion]

readPrec :: ReadPrec GetDocumentationVersion

readListPrec :: ReadPrec [GetDocumentationVersion]

Show GetDocumentationVersion

Methods

showsPrec :: Int -> GetDocumentationVersion -> ShowS

show :: GetDocumentationVersion -> String

showList :: [GetDocumentationVersion] -> ShowS

Generic GetDocumentationVersion

Associated Types

type Rep GetDocumentationVersion :: * -> *

Methods

from :: GetDocumentationVersion -> Rep GetDocumentationVersion x

to :: Rep GetDocumentationVersion x -> GetDocumentationVersion

Hashable GetDocumentationVersion

Methods

hashWithSalt :: Int -> GetDocumentationVersion -> Int

hash :: GetDocumentationVersion -> Int

NFData GetDocumentationVersion

Methods

rnf :: GetDocumentationVersion -> ()

AWSRequest GetDocumentationVersion

Associated Types

type Rs GetDocumentationVersion :: *

Methods

request :: GetDocumentationVersion -> Request GetDocumentationVersion

response :: MonadResource m => Logger -> Service -> Proxy * GetDocumentationVersion -> ClientResponse -> m (Response GetDocumentationVersion)

ToQuery GetDocumentationVersion

Methods

toQuery :: GetDocumentationVersion -> QueryString

ToPath GetDocumentationVersion

Methods

toPath :: GetDocumentationVersion -> ByteString

ToHeaders GetDocumentationVersion

Methods

toHeaders :: GetDocumentationVersion -> [Header]

type Rep GetDocumentationVersion

type Rep GetDocumentationVersion = D1 (MetaData "GetDocumentationVersion" "Network.AWS.APIGateway.GetDocumentationVersion" "amazonka-apigateway-1.5.0-3jDq4KKltGt78uikPpOCEJ" False) (C1 (MetaCons "GetDocumentationVersion'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_gdvdRestAPIId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_gdvdDocumentationVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))

type Rs GetDocumentationVersion

type Rs GetDocumentationVersion = DocumentationVersion

Request Lenses

gdvdRestAPIId :: Lens' GetDocumentationVersion Text

Required

The string identifier of the associated RestApi .

gdvdDocumentationVersion :: Lens' GetDocumentationVersion Text

Required

The version identifier of the to-be-retrieved documentation snapshot.

Destructuring the Response

documentationVersion :: DocumentationVersion

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

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

• dvCreatedDate - The date when the API documentation snapshot is created.
• dvVersion - The version identifier of the API documentation snapshot.
• dvDescription - The description of the API documentation snapshot.

data DocumentationVersion

A snapshot of the documentation of an API.

Publishing API documentation involves creating a documentation version associated with an API stage and exporting the versioned documentation to an external (e.g., Swagger) file.

Documenting an API , DocumentationPart , DocumentationVersions

See: documentationVersion smart constructor.

Instances

Eq DocumentationVersion

Methods

(==) :: DocumentationVersion -> DocumentationVersion -> Bool

(/=) :: DocumentationVersion -> DocumentationVersion -> Bool

Data DocumentationVersion

Methods

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

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

toConstr :: DocumentationVersion -> Constr

dataTypeOf :: DocumentationVersion -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> DocumentationVersion -> DocumentationVersion

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

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

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

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

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

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

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

Read DocumentationVersion

Methods

readsPrec :: Int -> ReadS DocumentationVersion

readList :: ReadS [DocumentationVersion]

readPrec :: ReadPrec DocumentationVersion

readListPrec :: ReadPrec [DocumentationVersion]

Show DocumentationVersion

Methods

showsPrec :: Int -> DocumentationVersion -> ShowS

show :: DocumentationVersion -> String

showList :: [DocumentationVersion] -> ShowS

Generic DocumentationVersion

Associated Types

type Rep DocumentationVersion :: * -> *

Methods

from :: DocumentationVersion -> Rep DocumentationVersion x

to :: Rep DocumentationVersion x -> DocumentationVersion

Hashable DocumentationVersion

Methods

hashWithSalt :: Int -> DocumentationVersion -> Int

hash :: DocumentationVersion -> Int

FromJSON DocumentationVersion

Methods

parseJSON :: Value -> Parser DocumentationVersion

parseJSONList :: Value -> Parser [DocumentationVersion]

NFData DocumentationVersion

Methods

rnf :: DocumentationVersion -> ()

type Rep DocumentationVersion

type Rep DocumentationVersion = D1 (MetaData "DocumentationVersion" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.5.0-3jDq4KKltGt78uikPpOCEJ" False) (C1 (MetaCons "DocumentationVersion'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_dvCreatedDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX))) ((:*:) (S1 (MetaSel (Just Symbol "_dvVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dvDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))

Response Lenses

dvCreatedDate :: Lens' DocumentationVersion (Maybe UTCTime)

The date when the API documentation snapshot is created.

dvVersion :: Lens' DocumentationVersion (Maybe Text)

The version identifier of the API documentation snapshot.

dvDescription :: Lens' DocumentationVersion (Maybe Text)

The description of the API documentation snapshot.