Amazonka.APIGateway.GetDocumentationVersion

Gets a documentation version.

Creating a Request

data GetDocumentationVersion

Gets a documentation snapshot of an API.

See: newGetDocumentationVersion smart constructor.

Constructors

GetDocumentationVersion'

Fields

• restApiId :: Text

  The string identifier of the associated RestApi.

• documentationVersion :: Text

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

Instances

ToHeaders GetDocumentationVersion

Defined in Amazonka.APIGateway.GetDocumentationVersion

Methods

toHeaders :: GetDocumentationVersion -> [Header]

ToPath GetDocumentationVersion

Defined in Amazonka.APIGateway.GetDocumentationVersion

Methods

toPath :: GetDocumentationVersion -> ByteString

ToQuery GetDocumentationVersion

Defined in Amazonka.APIGateway.GetDocumentationVersion

Methods

toQuery :: GetDocumentationVersion -> QueryString

AWSRequest GetDocumentationVersion

Defined in Amazonka.APIGateway.GetDocumentationVersion

Associated Types

type AWSResponse GetDocumentationVersion

Methods

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

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

Generic GetDocumentationVersion

Defined in Amazonka.APIGateway.GetDocumentationVersion

Associated Types

type Rep GetDocumentationVersion :: Type -> Type

Methods

from :: GetDocumentationVersion -> Rep GetDocumentationVersion x

to :: Rep GetDocumentationVersion x -> GetDocumentationVersion

Read GetDocumentationVersion

Defined in Amazonka.APIGateway.GetDocumentationVersion

Methods

readsPrec :: Int -> ReadS GetDocumentationVersion

readList :: ReadS [GetDocumentationVersion]

readPrec :: ReadPrec GetDocumentationVersion

readListPrec :: ReadPrec [GetDocumentationVersion]

Show GetDocumentationVersion

Defined in Amazonka.APIGateway.GetDocumentationVersion

Methods

showsPrec :: Int -> GetDocumentationVersion -> ShowS

show :: GetDocumentationVersion -> String

showList :: [GetDocumentationVersion] -> ShowS

NFData GetDocumentationVersion

Defined in Amazonka.APIGateway.GetDocumentationVersion

Methods

rnf :: GetDocumentationVersion -> ()

Eq GetDocumentationVersion

Defined in Amazonka.APIGateway.GetDocumentationVersion

Methods

(==) :: GetDocumentationVersion -> GetDocumentationVersion -> Bool

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

Hashable GetDocumentationVersion

Defined in Amazonka.APIGateway.GetDocumentationVersion

Methods

hashWithSalt :: Int -> GetDocumentationVersion -> Int

hash :: GetDocumentationVersion -> Int

type AWSResponse GetDocumentationVersion

Defined in Amazonka.APIGateway.GetDocumentationVersion

type AWSResponse GetDocumentationVersion = DocumentationVersion

type Rep GetDocumentationVersion

Defined in Amazonka.APIGateway.GetDocumentationVersion

type Rep GetDocumentationVersion = D1 ('MetaData "GetDocumentationVersion" "Amazonka.APIGateway.GetDocumentationVersion" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetDocumentationVersion'" 'PrefixI 'True) (S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "documentationVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetDocumentationVersion

Arguments

:: Text

GetDocumentationVersion

-> Text

GetDocumentationVersion

-> GetDocumentationVersion

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:

GetDocumentationVersion, getDocumentationVersion_restApiId - The string identifier of the associated RestApi.

GetDocumentationVersion, getDocumentationVersion_documentationVersion - The version identifier of the to-be-retrieved documentation snapshot.

Request Lenses

getDocumentationVersion_restApiId :: Lens' GetDocumentationVersion Text

The string identifier of the associated RestApi.

getDocumentationVersion_documentationVersion :: Lens' GetDocumentationVersion Text

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

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.