Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.APIGateway.GetDocumentationParts

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets documentation parts.

This operation returns paginated results.

Synopsis

data GetDocumentationParts = GetDocumentationParts' {
- limit :: Maybe Int
- locationStatus :: Maybe LocationStatusType
- nameQuery :: Maybe Text
- path :: Maybe Text
- position :: Maybe Text
- type' :: Maybe DocumentationPartType
- restApiId :: Text
}
newGetDocumentationParts :: Text -> GetDocumentationParts
getDocumentationParts_limit :: Lens' GetDocumentationParts (Maybe Int)
getDocumentationParts_locationStatus :: Lens' GetDocumentationParts (Maybe LocationStatusType)
getDocumentationParts_nameQuery :: Lens' GetDocumentationParts (Maybe Text)
getDocumentationParts_path :: Lens' GetDocumentationParts (Maybe Text)
getDocumentationParts_position :: Lens' GetDocumentationParts (Maybe Text)
getDocumentationParts_type :: Lens' GetDocumentationParts (Maybe DocumentationPartType)
getDocumentationParts_restApiId :: Lens' GetDocumentationParts Text
data GetDocumentationPartsResponse = GetDocumentationPartsResponse' {
- items :: Maybe [DocumentationPart]
- position :: Maybe Text
- httpStatus :: Int
}
newGetDocumentationPartsResponse :: Int -> GetDocumentationPartsResponse
getDocumentationPartsResponse_items :: Lens' GetDocumentationPartsResponse (Maybe [DocumentationPart])
getDocumentationPartsResponse_position :: Lens' GetDocumentationPartsResponse (Maybe Text)
getDocumentationPartsResponse_httpStatus :: Lens' GetDocumentationPartsResponse Int

Creating a Request

data GetDocumentationParts Source #

Gets the documentation parts of an API. The result may be filtered by the type, name, or path of API entities (targets).

See: newGetDocumentationParts smart constructor.

Constructors

GetDocumentationParts'

Fields

limit :: Maybe Int
The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
locationStatus :: Maybe LocationStatusType
The status of the API documentation parts to retrieve. Valid values are DOCUMENTED for retrieving DocumentationPart resources with content and UNDOCUMENTED for DocumentationPart resources without content.
nameQuery :: Maybe Text
The name of API entities of the to-be-retrieved documentation parts.
path :: Maybe Text
The path of API entities of the to-be-retrieved documentation parts.
position :: Maybe Text
The current pagination position in the paged result set.
type' :: Maybe DocumentationPartType
The type of API entities of the to-be-retrieved documentation parts.
restApiId :: Text
The string identifier of the associated RestApi.

Instances

Instances details

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

newGetDocumentationParts Source #

Arguments

:: Text	`GetDocumentationParts`
-> GetDocumentationParts

Create a value of GetDocumentationParts 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:

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

$sel:locationStatus:GetDocumentationParts', getDocumentationParts_locationStatus - The status of the API documentation parts to retrieve. Valid values are DOCUMENTED for retrieving DocumentationPart resources with content and UNDOCUMENTED for DocumentationPart resources without content.

$sel:nameQuery:GetDocumentationParts', getDocumentationParts_nameQuery - The name of API entities of the to-be-retrieved documentation parts.

GetDocumentationParts, getDocumentationParts_path - The path of API entities of the to-be-retrieved documentation parts.

GetDocumentationParts, getDocumentationParts_position - The current pagination position in the paged result set.

GetDocumentationParts, getDocumentationParts_type - The type of API entities of the to-be-retrieved documentation parts.

GetDocumentationParts, getDocumentationParts_restApiId - The string identifier of the associated RestApi.

Request Lenses

getDocumentationParts_limit :: Lens' GetDocumentationParts (Maybe Int) Source #

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

getDocumentationParts_locationStatus :: Lens' GetDocumentationParts (Maybe LocationStatusType) Source #

The status of the API documentation parts to retrieve. Valid values are DOCUMENTED for retrieving DocumentationPart resources with content and UNDOCUMENTED for DocumentationPart resources without content.

getDocumentationParts_nameQuery :: Lens' GetDocumentationParts (Maybe Text) Source #

The name of API entities of the to-be-retrieved documentation parts.

getDocumentationParts_path :: Lens' GetDocumentationParts (Maybe Text) Source #

The path of API entities of the to-be-retrieved documentation parts.

getDocumentationParts_position :: Lens' GetDocumentationParts (Maybe Text) Source #

The current pagination position in the paged result set.

getDocumentationParts_type :: Lens' GetDocumentationParts (Maybe DocumentationPartType) Source #

The type of API entities of the to-be-retrieved documentation parts.

getDocumentationParts_restApiId :: Lens' GetDocumentationParts Text Source #

The string identifier of the associated RestApi.

Destructuring the Response

data GetDocumentationPartsResponse Source #

The collection of documentation parts of an API.

See: newGetDocumentationPartsResponse smart constructor.

Constructors

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

Instances

Instances details

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

newGetDocumentationPartsResponse Source #

Arguments

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

Create a value of GetDocumentationPartsResponse 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:

GetDocumentationPartsResponse, getDocumentationPartsResponse_items - The current page of elements from this collection.

GetDocumentationParts, getDocumentationPartsResponse_position - Undocumented member.

$sel:httpStatus:GetDocumentationPartsResponse', getDocumentationPartsResponse_httpStatus - The response's http status code.

Response Lenses

getDocumentationPartsResponse_items :: Lens' GetDocumentationPartsResponse (Maybe [DocumentationPart]) Source #

The current page of elements from this collection.

getDocumentationPartsResponse_position :: Lens' GetDocumentationPartsResponse (Maybe Text) Source #

Undocumented member.

getDocumentationPartsResponse_httpStatus :: Lens' GetDocumentationPartsResponse Int Source #

The response's http status code.