libZSservicesZSamazonka-apigatewayZSamazonka-apigateway
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.APIGateway.GetDocumentationVersion

Description

  • - | Undocumented operation.
Synopsis

Creating a Request

data GetDocumentationVersion Source #

Gets a documentation snapshot of an API.

See: newGetDocumentationVersion smart constructor.

Constructors

GetDocumentationVersion' 

Fields

Instances

Instances details
Eq GetDocumentationVersion Source # 
Instance details

Defined in Amazonka.APIGateway.GetDocumentationVersion

Read GetDocumentationVersion Source # 
Instance details

Defined in Amazonka.APIGateway.GetDocumentationVersion

Show GetDocumentationVersion Source # 
Instance details

Defined in Amazonka.APIGateway.GetDocumentationVersion

Generic GetDocumentationVersion Source # 
Instance details

Defined in Amazonka.APIGateway.GetDocumentationVersion

Associated Types

type Rep GetDocumentationVersion :: Type -> Type #

NFData GetDocumentationVersion Source # 
Instance details

Defined in Amazonka.APIGateway.GetDocumentationVersion

Methods

rnf :: GetDocumentationVersion -> () #

Hashable GetDocumentationVersion Source # 
Instance details

Defined in Amazonka.APIGateway.GetDocumentationVersion

AWSRequest GetDocumentationVersion Source # 
Instance details

Defined in Amazonka.APIGateway.GetDocumentationVersion

ToHeaders GetDocumentationVersion Source # 
Instance details

Defined in Amazonka.APIGateway.GetDocumentationVersion

ToPath GetDocumentationVersion Source # 
Instance details

Defined in Amazonka.APIGateway.GetDocumentationVersion

ToQuery GetDocumentationVersion Source # 
Instance details

Defined in Amazonka.APIGateway.GetDocumentationVersion

type Rep GetDocumentationVersion Source # 
Instance details

Defined in Amazonka.APIGateway.GetDocumentationVersion

type Rep GetDocumentationVersion = D1 ('MetaData "GetDocumentationVersion" "Amazonka.APIGateway.GetDocumentationVersion" "libZSservicesZSamazonka-apigatewayZSamazonka-apigateway" 'False) (C1 ('MetaCons "GetDocumentationVersion'" 'PrefixI 'True) (S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "documentationVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse GetDocumentationVersion Source # 
Instance details

Defined in Amazonka.APIGateway.GetDocumentationVersion

newGetDocumentationVersion Source #

Create a value of GetDocumentationVersion 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:restApiId:GetDocumentationVersion', getDocumentationVersion_restApiId - [Required] The string identifier of the associated RestApi.

$sel:documentationVersion:GetDocumentationVersion', getDocumentationVersion_documentationVersion - [Required] The version identifier of the to-be-retrieved documentation snapshot.

Request Lenses

getDocumentationVersion_restApiId :: Lens' GetDocumentationVersion Text Source #

Required
The string identifier of the associated RestApi.

getDocumentationVersion_documentationVersion :: Lens' GetDocumentationVersion Text Source #

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

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

Instances

Instances details
Eq DocumentationVersion Source # 
Instance details

Defined in Amazonka.APIGateway.Types.DocumentationVersion

Read DocumentationVersion Source # 
Instance details

Defined in Amazonka.APIGateway.Types.DocumentationVersion

Show 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 #

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

FromJSON 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" "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.