Network.AWS.APIGateway.CreateDocumentationVersion

Undocumented operation.

Creating a Request

createDocumentationVersion

Arguments

:: Text

cdvRestAPIId

-> Text

cdvDocumentationVersion

-> CreateDocumentationVersion

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

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

• cdvStageName - The stage name to be associated with the new documentation snapshot.
• cdvDescription - A description about the new documentation snapshot.
• cdvRestAPIId - [Required] The string identifier of the associated RestApi .
• cdvDocumentationVersion - [Required] The version identifier of the new snapshot.

data CreateDocumentationVersion

Creates a new documentation version of a given API.

See: createDocumentationVersion smart constructor.

Instances

Eq CreateDocumentationVersion

Methods

(==) :: CreateDocumentationVersion -> CreateDocumentationVersion -> Bool

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

Data CreateDocumentationVersion

Methods

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

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

toConstr :: CreateDocumentationVersion -> Constr

dataTypeOf :: CreateDocumentationVersion -> DataType

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

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

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

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

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

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

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

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

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

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

Read CreateDocumentationVersion

Methods

readsPrec :: Int -> ReadS CreateDocumentationVersion

readList :: ReadS [CreateDocumentationVersion]

readPrec :: ReadPrec CreateDocumentationVersion

readListPrec :: ReadPrec [CreateDocumentationVersion]

Show CreateDocumentationVersion

Methods

showsPrec :: Int -> CreateDocumentationVersion -> ShowS

show :: CreateDocumentationVersion -> String

showList :: [CreateDocumentationVersion] -> ShowS

Generic CreateDocumentationVersion

Associated Types

type Rep CreateDocumentationVersion :: * -> *

Methods

from :: CreateDocumentationVersion -> Rep CreateDocumentationVersion x

to :: Rep CreateDocumentationVersion x -> CreateDocumentationVersion

Hashable CreateDocumentationVersion

Methods

hashWithSalt :: Int -> CreateDocumentationVersion -> Int

hash :: CreateDocumentationVersion -> Int

ToJSON CreateDocumentationVersion

Methods

toJSON :: CreateDocumentationVersion -> Value

toEncoding :: CreateDocumentationVersion -> Encoding

toJSONList :: [CreateDocumentationVersion] -> Value

toEncodingList :: [CreateDocumentationVersion] -> Encoding

NFData CreateDocumentationVersion

Methods

rnf :: CreateDocumentationVersion -> ()

AWSRequest CreateDocumentationVersion

Associated Types

type Rs CreateDocumentationVersion :: *

Methods

request :: CreateDocumentationVersion -> Request CreateDocumentationVersion

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

ToQuery CreateDocumentationVersion

Methods

toQuery :: CreateDocumentationVersion -> QueryString

ToPath CreateDocumentationVersion

Methods

toPath :: CreateDocumentationVersion -> ByteString

ToHeaders CreateDocumentationVersion

Methods

toHeaders :: CreateDocumentationVersion -> [Header]

type Rep CreateDocumentationVersion

type Rep CreateDocumentationVersion = D1 (MetaData "CreateDocumentationVersion" "Network.AWS.APIGateway.CreateDocumentationVersion" "amazonka-apigateway-1.5.0-3jDq4KKltGt78uikPpOCEJ" False) (C1 (MetaCons "CreateDocumentationVersion'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_cdvStageName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_cdvDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_cdvRestAPIId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_cdvDocumentationVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))

type Rs CreateDocumentationVersion

type Rs CreateDocumentationVersion = DocumentationVersion

Request Lenses

cdvStageName :: Lens' CreateDocumentationVersion (Maybe Text)

The stage name to be associated with the new documentation snapshot.

cdvDescription :: Lens' CreateDocumentationVersion (Maybe Text)

A description about the new documentation snapshot.

cdvRestAPIId :: Lens' CreateDocumentationVersion Text

Required

The string identifier of the associated RestApi .

cdvDocumentationVersion :: Lens' CreateDocumentationVersion Text

Required

The version identifier of the new 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.