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

Amazonka.APIGateway.UpdateDocumentationVersion

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

- | Undocumented operation.

Synopsis

data UpdateDocumentationVersion = UpdateDocumentationVersion' {
- patchOperations :: Maybe [PatchOperation]
- restApiId :: Text
- documentationVersion :: Text
}
newUpdateDocumentationVersion :: Text -> Text -> UpdateDocumentationVersion
updateDocumentationVersion_patchOperations :: Lens' UpdateDocumentationVersion (Maybe [PatchOperation])
updateDocumentationVersion_restApiId :: Lens' UpdateDocumentationVersion Text
updateDocumentationVersion_documentationVersion :: Lens' UpdateDocumentationVersion Text
data DocumentationVersion = DocumentationVersion' {
- createdDate :: Maybe POSIX
- version :: Maybe Text
- description :: Maybe Text
}
newDocumentationVersion :: DocumentationVersion
documentationVersion_createdDate :: Lens' DocumentationVersion (Maybe UTCTime)
documentationVersion_version :: Lens' DocumentationVersion (Maybe Text)
documentationVersion_description :: Lens' DocumentationVersion (Maybe Text)

Creating a Request

data UpdateDocumentationVersion Source #

Updates an existing documentation version of an API.

See: newUpdateDocumentationVersion smart constructor.

Constructors

UpdateDocumentationVersion'
Fields patchOperations :: Maybe [PatchOperation] A list of update operations to be applied to the specified resource and in the order specified in this list. restApiId :: Text Required The string identifier of the associated RestApi.. documentationVersion :: Text Required The version identifier of the to-be-updated documentation version.

Instances

Instances details

Eq UpdateDocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.UpdateDocumentationVersion Methods (==) :: UpdateDocumentationVersion -> UpdateDocumentationVersion -> Bool # (/=) :: UpdateDocumentationVersion -> UpdateDocumentationVersion -> Bool #
Read UpdateDocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.UpdateDocumentationVersion Methods readsPrec :: Int -> ReadS UpdateDocumentationVersion # readList :: ReadS [UpdateDocumentationVersion] # readPrec :: ReadPrec UpdateDocumentationVersion # readListPrec :: ReadPrec [UpdateDocumentationVersion] #
Show UpdateDocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.UpdateDocumentationVersion Methods showsPrec :: Int -> UpdateDocumentationVersion -> ShowS # show :: UpdateDocumentationVersion -> String # showList :: [UpdateDocumentationVersion] -> ShowS #
Generic UpdateDocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.UpdateDocumentationVersion Associated Types type Rep UpdateDocumentationVersion :: Type -> Type # Methods from :: UpdateDocumentationVersion -> Rep UpdateDocumentationVersion x # to :: Rep UpdateDocumentationVersion x -> UpdateDocumentationVersion #
NFData UpdateDocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.UpdateDocumentationVersion Methods rnf :: UpdateDocumentationVersion -> () #
Hashable UpdateDocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.UpdateDocumentationVersion Methods hashWithSalt :: Int -> UpdateDocumentationVersion -> Int # hash :: UpdateDocumentationVersion -> Int #
ToJSON UpdateDocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.UpdateDocumentationVersion Methods toJSON :: UpdateDocumentationVersion -> Value # toEncoding :: UpdateDocumentationVersion -> Encoding # toJSONList :: [UpdateDocumentationVersion] -> Value # toEncodingList :: [UpdateDocumentationVersion] -> Encoding #
AWSRequest UpdateDocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.UpdateDocumentationVersion Associated Types type AWSResponse UpdateDocumentationVersion # Methods request :: UpdateDocumentationVersion -> Request UpdateDocumentationVersion # response :: MonadResource m => Logger -> Service -> Proxy UpdateDocumentationVersion -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateDocumentationVersion))) #
ToHeaders UpdateDocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.UpdateDocumentationVersion Methods toHeaders :: UpdateDocumentationVersion -> [Header] #
ToPath UpdateDocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.UpdateDocumentationVersion Methods toPath :: UpdateDocumentationVersion -> ByteString #
ToQuery UpdateDocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.UpdateDocumentationVersion Methods toQuery :: UpdateDocumentationVersion -> QueryString #
type Rep UpdateDocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.UpdateDocumentationVersion type Rep UpdateDocumentationVersion = D1 ('MetaData "UpdateDocumentationVersion" "Amazonka.APIGateway.UpdateDocumentationVersion" "libZSservicesZSamazonka-apigatewayZSamazonka-apigateway" 'False) (C1 ('MetaCons "UpdateDocumentationVersion'" 'PrefixI 'True) (S1 ('MetaSel ('Just "patchOperations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PatchOperation])) :: (S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "documentationVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse UpdateDocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.UpdateDocumentationVersion type AWSResponse UpdateDocumentationVersion = DocumentationVersion

newUpdateDocumentationVersion Source #

Arguments

:: Text	`$sel:restApiId:UpdateDocumentationVersion'`
-> Text	`$sel:documentationVersion:UpdateDocumentationVersion'`
-> UpdateDocumentationVersion

Create a value of UpdateDocumentationVersion with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:patchOperations:UpdateDocumentationVersion', updateDocumentationVersion_patchOperations - A list of update operations to be applied to the specified resource and in the order specified in this list.

$sel:restApiId:UpdateDocumentationVersion', updateDocumentationVersion_restApiId - [Required] The string identifier of the associated RestApi..

$sel:documentationVersion:UpdateDocumentationVersion', updateDocumentationVersion_documentationVersion - [Required] The version identifier of the to-be-updated documentation version.

Request Lenses

updateDocumentationVersion_patchOperations :: Lens' UpdateDocumentationVersion (Maybe [PatchOperation]) Source #

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

updateDocumentationVersion_restApiId :: Lens' UpdateDocumentationVersion Text Source #

Required: The string identifier of the associated RestApi..

updateDocumentationVersion_documentationVersion :: Lens' UpdateDocumentationVersion Text Source #

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

Destructuring the Response

data DocumentationVersion Source #

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., OpenAPI) file.

Documenting an API, DocumentationPart, DocumentationVersions

See: newDocumentationVersion smart constructor.

Constructors

DocumentationVersion'
Fields createdDate :: Maybe POSIX The date when the API documentation snapshot is created. version :: Maybe Text The version identifier of the API documentation snapshot. description :: Maybe Text The description of the API documentation snapshot.

Instances

Instances details

Eq DocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationVersion Methods (==) :: DocumentationVersion -> DocumentationVersion -> Bool # (/=) :: DocumentationVersion -> DocumentationVersion -> Bool #
Read DocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationVersion Methods readsPrec :: Int -> ReadS DocumentationVersion # readList :: ReadS [DocumentationVersion] # readPrec :: ReadPrec DocumentationVersion # readListPrec :: ReadPrec [DocumentationVersion] #
Show DocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationVersion Methods showsPrec :: Int -> DocumentationVersion -> ShowS # show :: DocumentationVersion -> String # showList :: [DocumentationVersion] -> ShowS #
Generic DocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationVersion Associated Types type Rep DocumentationVersion :: Type -> Type # Methods from :: DocumentationVersion -> Rep DocumentationVersion x # to :: Rep DocumentationVersion x -> DocumentationVersion #
NFData DocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationVersion Methods rnf :: DocumentationVersion -> () #
Hashable DocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationVersion Methods hashWithSalt :: Int -> DocumentationVersion -> Int # hash :: DocumentationVersion -> Int #
FromJSON DocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationVersion Methods parseJSON :: Value -> Parser DocumentationVersion # parseJSONList :: Value -> Parser [DocumentationVersion] #
type Rep DocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationVersion type Rep DocumentationVersion = D1 ('MetaData "DocumentationVersion" "Amazonka.APIGateway.Types.DocumentationVersion" "libZSservicesZSamazonka-apigatewayZSamazonka-apigateway" 'False) (C1 ('MetaCons "DocumentationVersion'" 'PrefixI 'True) (S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newDocumentationVersion :: DocumentationVersion Source #

Create a value of DocumentationVersion with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:createdDate:DocumentationVersion', documentationVersion_createdDate - The date when the API documentation snapshot is created.

$sel:version:DocumentationVersion', documentationVersion_version - The version identifier of the API documentation snapshot.

$sel:description:DocumentationVersion', documentationVersion_description - The description of the API documentation snapshot.

Response Lenses

documentationVersion_createdDate :: Lens' DocumentationVersion (Maybe UTCTime) Source #

The date when the API documentation snapshot is created.

documentationVersion_version :: Lens' DocumentationVersion (Maybe Text) Source #

The version identifier of the API documentation snapshot.

documentationVersion_description :: Lens' DocumentationVersion (Maybe Text) Source #

The description of the API documentation snapshot.