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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

- | Undocumented operation.

This operation returns paginated results.

Synopsis

Creating a Request

data GetDocumentationVersions Source #

Gets the documentation versions of an API.

See: newGetDocumentationVersions smart constructor.

Constructors

GetDocumentationVersions'
Fields limit :: Maybe Int The maximum number of returned results per page. The default value is 25 and the maximum value is 500. position :: Maybe Text The current pagination position in the paged result set. restApiId :: Text Required The string identifier of the associated RestApi.

Instances

Instances details

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

newGetDocumentationVersions Source #

Arguments

:: Text	`$sel:restApiId:GetDocumentationVersions'`
-> GetDocumentationVersions

Create a value of GetDocumentationVersions 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:limit:GetDocumentationVersions', getDocumentationVersions_limit - The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

$sel:position:GetDocumentationVersions', getDocumentationVersions_position - The current pagination position in the paged result set.

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

Request Lenses

getDocumentationVersions_limit :: Lens' GetDocumentationVersions (Maybe Int) Source #

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

getDocumentationVersions_position :: Lens' GetDocumentationVersions (Maybe Text) Source #

The current pagination position in the paged result set.

getDocumentationVersions_restApiId :: Lens' GetDocumentationVersions Text Source #

Required: The string identifier of the associated RestApi.

Destructuring the Response

data GetDocumentationVersionsResponse Source #

The collection of documentation snapshots of an API.

Use the DocumentationVersions to manage documentation snapshots associated with various API stages.

Documenting an API, DocumentationPart, DocumentationVersion

See: newGetDocumentationVersionsResponse smart constructor.

Constructors

GetDocumentationVersionsResponse'
Fields items :: Maybe [DocumentationVersion] The current page of elements from this collection. position :: Maybe Text httpStatus :: Int The response's http status code.

Instances

Instances details

Eq GetDocumentationVersionsResponse Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationVersions Methods (==) :: GetDocumentationVersionsResponse -> GetDocumentationVersionsResponse -> Bool # (/=) :: GetDocumentationVersionsResponse -> GetDocumentationVersionsResponse -> Bool #
Read GetDocumentationVersionsResponse Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationVersions Methods readsPrec :: Int -> ReadS GetDocumentationVersionsResponse # readList :: ReadS [GetDocumentationVersionsResponse] # readPrec :: ReadPrec GetDocumentationVersionsResponse # readListPrec :: ReadPrec [GetDocumentationVersionsResponse] #
Show GetDocumentationVersionsResponse Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationVersions Methods showsPrec :: Int -> GetDocumentationVersionsResponse -> ShowS # show :: GetDocumentationVersionsResponse -> String # showList :: [GetDocumentationVersionsResponse] -> ShowS #
Generic GetDocumentationVersionsResponse Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationVersions Associated Types type Rep GetDocumentationVersionsResponse :: Type -> Type # Methods from :: GetDocumentationVersionsResponse -> Rep GetDocumentationVersionsResponse x # to :: Rep GetDocumentationVersionsResponse x -> GetDocumentationVersionsResponse #
NFData GetDocumentationVersionsResponse Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationVersions Methods rnf :: GetDocumentationVersionsResponse -> () #
type Rep GetDocumentationVersionsResponse Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationVersions type Rep GetDocumentationVersionsResponse = D1 ('MetaData "GetDocumentationVersionsResponse" "Amazonka.APIGateway.GetDocumentationVersions" "libZSservicesZSamazonka-apigatewayZSamazonka-apigateway" 'False) (C1 ('MetaCons "GetDocumentationVersionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "items") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DocumentationVersion])) :: (S1 ('MetaSel ('Just "position") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetDocumentationVersionsResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetDocumentationVersionsResponse'`
-> GetDocumentationVersionsResponse

Create a value of GetDocumentationVersionsResponse 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:items:GetDocumentationVersionsResponse', getDocumentationVersionsResponse_items - The current page of elements from this collection.

$sel:position:GetDocumentationVersions', getDocumentationVersionsResponse_position - Undocumented member.

$sel:httpStatus:GetDocumentationVersionsResponse', getDocumentationVersionsResponse_httpStatus - The response's http status code.

Response Lenses

getDocumentationVersionsResponse_items :: Lens' GetDocumentationVersionsResponse (Maybe [DocumentationVersion]) Source #

The current page of elements from this collection.

getDocumentationVersionsResponse_position :: Lens' GetDocumentationVersionsResponse (Maybe Text) Source #

Undocumented member.

getDocumentationVersionsResponse_httpStatus :: Lens' GetDocumentationVersionsResponse Int Source #

The response's http status code.