amazonka-apigateway-2.0: Amazon API Gateway SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.APIGateway.UpdateDocumentationVersion

Description

Updates a documentation version.

Synopsis

Creating a Request

data UpdateDocumentationVersion Source #

Updates an existing documentation version of an API.

See: newUpdateDocumentationVersion smart constructor.

Constructors

UpdateDocumentationVersion' 

Fields

Instances

Instances details
ToJSON UpdateDocumentationVersion Source # 
Instance details

Defined in Amazonka.APIGateway.UpdateDocumentationVersion

ToHeaders UpdateDocumentationVersion Source # 
Instance details

Defined in Amazonka.APIGateway.UpdateDocumentationVersion

ToPath UpdateDocumentationVersion Source # 
Instance details

Defined in Amazonka.APIGateway.UpdateDocumentationVersion

ToQuery UpdateDocumentationVersion Source # 
Instance details

Defined in Amazonka.APIGateway.UpdateDocumentationVersion

AWSRequest UpdateDocumentationVersion Source # 
Instance details

Defined in Amazonka.APIGateway.UpdateDocumentationVersion

Generic UpdateDocumentationVersion Source # 
Instance details

Defined in Amazonka.APIGateway.UpdateDocumentationVersion

Associated Types

type Rep UpdateDocumentationVersion :: Type -> Type #

Read UpdateDocumentationVersion Source # 
Instance details

Defined in Amazonka.APIGateway.UpdateDocumentationVersion

Show UpdateDocumentationVersion Source # 
Instance details

Defined in Amazonka.APIGateway.UpdateDocumentationVersion

NFData UpdateDocumentationVersion Source # 
Instance details

Defined in Amazonka.APIGateway.UpdateDocumentationVersion

Eq UpdateDocumentationVersion Source # 
Instance details

Defined in Amazonka.APIGateway.UpdateDocumentationVersion

Hashable UpdateDocumentationVersion Source # 
Instance details

Defined in Amazonka.APIGateway.UpdateDocumentationVersion

type AWSResponse UpdateDocumentationVersion Source # 
Instance details

Defined in Amazonka.APIGateway.UpdateDocumentationVersion

type Rep UpdateDocumentationVersion Source # 
Instance details

Defined in Amazonka.APIGateway.UpdateDocumentationVersion

type Rep UpdateDocumentationVersion = D1 ('MetaData "UpdateDocumentationVersion" "Amazonka.APIGateway.UpdateDocumentationVersion" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" '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))))

newUpdateDocumentationVersion Source #

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 - For more information about supported patch operations, see Patch Operations.

UpdateDocumentationVersion, updateDocumentationVersion_restApiId - The string identifier of the associated RestApi..

UpdateDocumentationVersion, updateDocumentationVersion_documentationVersion - The version identifier of the to-be-updated documentation version.

Request Lenses

updateDocumentationVersion_restApiId :: Lens' UpdateDocumentationVersion Text Source #

The string identifier of the associated RestApi..

updateDocumentationVersion_documentationVersion :: Lens' UpdateDocumentationVersion Text Source #

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

Destructuring the Response

data DocumentationVersion Source #

A snapshot of the documentation of an API.

See: newDocumentationVersion smart constructor.

Constructors

DocumentationVersion' 

Fields

Instances

Instances details
FromJSON DocumentationVersion Source # 
Instance details

Defined in Amazonka.APIGateway.Types.DocumentationVersion

Generic DocumentationVersion Source # 
Instance details

Defined in Amazonka.APIGateway.Types.DocumentationVersion

Associated Types

type Rep DocumentationVersion :: Type -> Type #

Read DocumentationVersion Source # 
Instance details

Defined in Amazonka.APIGateway.Types.DocumentationVersion

Show DocumentationVersion Source # 
Instance details

Defined in Amazonka.APIGateway.Types.DocumentationVersion

NFData DocumentationVersion Source # 
Instance details

Defined in Amazonka.APIGateway.Types.DocumentationVersion

Methods

rnf :: DocumentationVersion -> () #

Eq DocumentationVersion Source # 
Instance details

Defined in Amazonka.APIGateway.Types.DocumentationVersion

Hashable DocumentationVersion Source # 
Instance details

Defined in Amazonka.APIGateway.Types.DocumentationVersion

type Rep DocumentationVersion Source # 
Instance details

Defined in Amazonka.APIGateway.Types.DocumentationVersion

type Rep DocumentationVersion = D1 ('MetaData "DocumentationVersion" "Amazonka.APIGateway.Types.DocumentationVersion" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "DocumentationVersion'" 'PrefixI 'True) (S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "version") '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:description:DocumentationVersion', documentationVersion_description - The description of the API documentation snapshot.

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

Response Lenses

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

The date when the API documentation snapshot is created.

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

The description of the API documentation snapshot.

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

The version identifier of the API documentation snapshot.