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.CreateDocumentationVersion

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

- | Undocumented operation.

Synopsis

data CreateDocumentationVersion = CreateDocumentationVersion' {
- stageName :: Maybe Text
- description :: Maybe Text
- restApiId :: Text
- documentationVersion :: Text
}
newCreateDocumentationVersion :: Text -> Text -> CreateDocumentationVersion
createDocumentationVersion_stageName :: Lens' CreateDocumentationVersion (Maybe Text)
createDocumentationVersion_description :: Lens' CreateDocumentationVersion (Maybe Text)
createDocumentationVersion_restApiId :: Lens' CreateDocumentationVersion Text
createDocumentationVersion_documentationVersion :: Lens' CreateDocumentationVersion 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 CreateDocumentationVersion Source #

Creates a new documentation version of a given API.

See: newCreateDocumentationVersion smart constructor.

Constructors

CreateDocumentationVersion'
Fields stageName :: Maybe Text The stage name to be associated with the new documentation snapshot. description :: Maybe Text A description about the new documentation snapshot. restApiId :: Text Required The string identifier of the associated RestApi. documentationVersion :: Text Required The version identifier of the new snapshot.

Instances

Instances details

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

newCreateDocumentationVersion Source #

Arguments

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

Create a value of CreateDocumentationVersion 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:stageName:CreateDocumentationVersion', createDocumentationVersion_stageName - The stage name to be associated with the new documentation snapshot.

$sel:description:CreateDocumentationVersion', createDocumentationVersion_description - A description about the new documentation snapshot.

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

$sel:documentationVersion:CreateDocumentationVersion', createDocumentationVersion_documentationVersion - [Required] The version identifier of the new snapshot.

Request Lenses

createDocumentationVersion_stageName :: Lens' CreateDocumentationVersion (Maybe Text) Source #

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

createDocumentationVersion_description :: Lens' CreateDocumentationVersion (Maybe Text) Source #

A description about the new documentation snapshot.

createDocumentationVersion_restApiId :: Lens' CreateDocumentationVersion Text Source #

Required: The string identifier of the associated RestApi.

createDocumentationVersion_documentationVersion :: Lens' CreateDocumentationVersion Text Source #

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