Network.AWS.APIGateway.UpdateDocumentationVersion

Undocumented operation.

Creating a Request

updateDocumentationVersion

Arguments

:: Text

udvRestAPIId

-> Text

udvDocumentationVersion

-> UpdateDocumentationVersion

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

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

• udvPatchOperations - A list of update operations to be applied to the specified resource and in the order specified in this list.
• udvRestAPIId - [Required] The identifier of an API of the to-be-updated documentation version.
• udvDocumentationVersion - [Required] The version identifier of the to-be-updated documentation version.

data UpdateDocumentationVersion

Updates an existing documentation version of an API.

See: updateDocumentationVersion smart constructor.

Instances

Eq UpdateDocumentationVersion

Methods

(==) :: UpdateDocumentationVersion -> UpdateDocumentationVersion -> Bool

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

Data UpdateDocumentationVersion

Methods

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

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

toConstr :: UpdateDocumentationVersion -> Constr

dataTypeOf :: UpdateDocumentationVersion -> DataType

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

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

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

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

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

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

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

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

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

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

Read UpdateDocumentationVersion

Methods

readsPrec :: Int -> ReadS UpdateDocumentationVersion

readList :: ReadS [UpdateDocumentationVersion]

readPrec :: ReadPrec UpdateDocumentationVersion

readListPrec :: ReadPrec [UpdateDocumentationVersion]

Show UpdateDocumentationVersion

Methods

showsPrec :: Int -> UpdateDocumentationVersion -> ShowS

show :: UpdateDocumentationVersion -> String

showList :: [UpdateDocumentationVersion] -> ShowS

Generic UpdateDocumentationVersion

Associated Types

type Rep UpdateDocumentationVersion :: * -> *

Methods

from :: UpdateDocumentationVersion -> Rep UpdateDocumentationVersion x

to :: Rep UpdateDocumentationVersion x -> UpdateDocumentationVersion

Hashable UpdateDocumentationVersion

Methods

hashWithSalt :: Int -> UpdateDocumentationVersion -> Int

hash :: UpdateDocumentationVersion -> Int

ToJSON UpdateDocumentationVersion

Methods

toJSON :: UpdateDocumentationVersion -> Value

toEncoding :: UpdateDocumentationVersion -> Encoding

toJSONList :: [UpdateDocumentationVersion] -> Value

toEncodingList :: [UpdateDocumentationVersion] -> Encoding

NFData UpdateDocumentationVersion

Methods

rnf :: UpdateDocumentationVersion -> ()

AWSRequest UpdateDocumentationVersion

Associated Types

type Rs UpdateDocumentationVersion :: *

Methods

request :: UpdateDocumentationVersion -> Request UpdateDocumentationVersion

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

ToPath UpdateDocumentationVersion

Methods

toPath :: UpdateDocumentationVersion -> ByteString

ToHeaders UpdateDocumentationVersion

Methods

toHeaders :: UpdateDocumentationVersion -> [Header]

ToQuery UpdateDocumentationVersion

Methods

toQuery :: UpdateDocumentationVersion -> QueryString

type Rep UpdateDocumentationVersion

type Rep UpdateDocumentationVersion = D1 (MetaData "UpdateDocumentationVersion" "Network.AWS.APIGateway.UpdateDocumentationVersion" "amazonka-apigateway-1.4.5-BIK2fycuXdJFBbWQ9Hqf16" False) (C1 (MetaCons "UpdateDocumentationVersion'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_udvPatchOperations") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [PatchOperation]))) ((:*:) (S1 (MetaSel (Just Symbol "_udvRestAPIId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_udvDocumentationVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))

type Rs UpdateDocumentationVersion

type Rs UpdateDocumentationVersion = DocumentationVersion

Request Lenses

udvPatchOperations :: Lens' UpdateDocumentationVersion [PatchOperation]

A list of update operations to be applied to the specified resource and in the order specified in this list.

udvRestAPIId :: Lens' UpdateDocumentationVersion Text

Required

The identifier of an API of the to-be-updated documentation version.

udvDocumentationVersion :: Lens' UpdateDocumentationVersion Text

Required

The version identifier of the to-be-updated documentation version.

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.4.5-BIK2fycuXdJFBbWQ9Hqf16" 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.