Amazonka.APIGateway.UpdateDocumentationVersion

Updates a documentation version.

Creating a Request

data UpdateDocumentationVersion

Updates an existing documentation version of an API.

See: newUpdateDocumentationVersion smart constructor.

Constructors

UpdateDocumentationVersion'

Fields

• patchOperations :: Maybe [PatchOperation]

  For more information about supported patch operations, see Patch Operations.

• restApiId :: Text

  The string identifier of the associated RestApi..

• documentationVersion :: Text

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

Instances

ToJSON UpdateDocumentationVersion

Defined in Amazonka.APIGateway.UpdateDocumentationVersion

Methods

toJSON :: UpdateDocumentationVersion -> Value

toEncoding :: UpdateDocumentationVersion -> Encoding

toJSONList :: [UpdateDocumentationVersion] -> Value

toEncodingList :: [UpdateDocumentationVersion] -> Encoding

ToHeaders UpdateDocumentationVersion

Defined in Amazonka.APIGateway.UpdateDocumentationVersion

Methods

toHeaders :: UpdateDocumentationVersion -> [Header]

ToPath UpdateDocumentationVersion

Defined in Amazonka.APIGateway.UpdateDocumentationVersion

Methods

toPath :: UpdateDocumentationVersion -> ByteString

ToQuery UpdateDocumentationVersion

Defined in Amazonka.APIGateway.UpdateDocumentationVersion

Methods

toQuery :: UpdateDocumentationVersion -> QueryString

AWSRequest UpdateDocumentationVersion

Defined in Amazonka.APIGateway.UpdateDocumentationVersion

Associated Types

type AWSResponse UpdateDocumentationVersion

Methods

request :: (Service -> Service) -> UpdateDocumentationVersion -> Request UpdateDocumentationVersion

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateDocumentationVersion -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateDocumentationVersion)))

Generic UpdateDocumentationVersion

Defined in Amazonka.APIGateway.UpdateDocumentationVersion

Associated Types

type Rep UpdateDocumentationVersion :: Type -> Type

Methods

from :: UpdateDocumentationVersion -> Rep UpdateDocumentationVersion x

to :: Rep UpdateDocumentationVersion x -> UpdateDocumentationVersion

Read UpdateDocumentationVersion

Defined in Amazonka.APIGateway.UpdateDocumentationVersion

Methods

readsPrec :: Int -> ReadS UpdateDocumentationVersion

readList :: ReadS [UpdateDocumentationVersion]

readPrec :: ReadPrec UpdateDocumentationVersion

readListPrec :: ReadPrec [UpdateDocumentationVersion]

Show UpdateDocumentationVersion

Defined in Amazonka.APIGateway.UpdateDocumentationVersion

Methods

showsPrec :: Int -> UpdateDocumentationVersion -> ShowS

show :: UpdateDocumentationVersion -> String

showList :: [UpdateDocumentationVersion] -> ShowS

NFData UpdateDocumentationVersion

Defined in Amazonka.APIGateway.UpdateDocumentationVersion

Methods

rnf :: UpdateDocumentationVersion -> ()

Eq UpdateDocumentationVersion

Defined in Amazonka.APIGateway.UpdateDocumentationVersion

Methods

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

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

Hashable UpdateDocumentationVersion

Defined in Amazonka.APIGateway.UpdateDocumentationVersion

Methods

hashWithSalt :: Int -> UpdateDocumentationVersion -> Int

hash :: UpdateDocumentationVersion -> Int

type AWSResponse UpdateDocumentationVersion

Defined in Amazonka.APIGateway.UpdateDocumentationVersion

type AWSResponse UpdateDocumentationVersion = DocumentationVersion

type Rep UpdateDocumentationVersion

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

Arguments

:: Text

UpdateDocumentationVersion

-> Text

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 - 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_patchOperations :: Lens' UpdateDocumentationVersion (Maybe [PatchOperation])

For more information about supported patch operations, see Patch Operations.

updateDocumentationVersion_restApiId :: Lens' UpdateDocumentationVersion Text

The string identifier of the associated RestApi..

updateDocumentationVersion_documentationVersion :: Lens' UpdateDocumentationVersion Text

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

Destructuring the Response

data DocumentationVersion

A snapshot of the documentation of an API.

See: newDocumentationVersion smart constructor.

Constructors

DocumentationVersion'

Fields

• createdDate :: Maybe POSIX

  The date when the API documentation snapshot is created.

• description :: Maybe Text

  The description of the API documentation snapshot.

• version :: Maybe Text

  The version identifier of the API documentation snapshot.

Instances

FromJSON DocumentationVersion

Defined in Amazonka.APIGateway.Types.DocumentationVersion

Methods

parseJSON :: Value -> Parser DocumentationVersion

parseJSONList :: Value -> Parser [DocumentationVersion]

Generic DocumentationVersion

Defined in Amazonka.APIGateway.Types.DocumentationVersion

Associated Types

type Rep DocumentationVersion :: Type -> Type

Methods

from :: DocumentationVersion -> Rep DocumentationVersion x

to :: Rep DocumentationVersion x -> DocumentationVersion

Read DocumentationVersion

Defined in Amazonka.APIGateway.Types.DocumentationVersion

Methods

readsPrec :: Int -> ReadS DocumentationVersion

readList :: ReadS [DocumentationVersion]

readPrec :: ReadPrec DocumentationVersion

readListPrec :: ReadPrec [DocumentationVersion]

Show DocumentationVersion

Defined in Amazonka.APIGateway.Types.DocumentationVersion

Methods

showsPrec :: Int -> DocumentationVersion -> ShowS

show :: DocumentationVersion -> String

showList :: [DocumentationVersion] -> ShowS

NFData DocumentationVersion

Defined in Amazonka.APIGateway.Types.DocumentationVersion

Methods

rnf :: DocumentationVersion -> ()

Eq DocumentationVersion

Defined in Amazonka.APIGateway.Types.DocumentationVersion

Methods

(==) :: DocumentationVersion -> DocumentationVersion -> Bool

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

Hashable DocumentationVersion

Defined in Amazonka.APIGateway.Types.DocumentationVersion

Methods

hashWithSalt :: Int -> DocumentationVersion -> Int

hash :: DocumentationVersion -> Int

type Rep DocumentationVersion

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

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)

The date when the API documentation snapshot is created.

documentationVersion_description :: Lens' DocumentationVersion (Maybe Text)

The description of the API documentation snapshot.

documentationVersion_version :: Lens' DocumentationVersion (Maybe Text)

The version identifier of the API documentation snapshot.