Network.AWS.APIGateway.GetDocumentationParts

Undocumented operation.

Creating a Request

getDocumentationParts

Arguments

:: Text

gdpRestAPIId

-> GetDocumentationParts

Creates a value of GetDocumentationParts with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• gdpPath - The path of API entities of the to-be-retrieved documentation parts.
• gdpLocationStatus - 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.
• gdpNameQuery - The name of API entities of the to-be-retrieved documentation parts.
• gdpLimit - The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
• gdpType - The type of API entities of the to-be-retrieved documentation parts.
• gdpPosition - The current pagination position in the paged result set.
• gdpRestAPIId - [Required] The string identifier of the associated RestApi .

data GetDocumentationParts

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

See: getDocumentationParts smart constructor.

Instances

Eq GetDocumentationParts

Methods

(==) :: GetDocumentationParts -> GetDocumentationParts -> Bool

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

Data GetDocumentationParts

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetDocumentationParts -> c GetDocumentationParts

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetDocumentationParts

toConstr :: GetDocumentationParts -> Constr

dataTypeOf :: GetDocumentationParts -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c GetDocumentationParts)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetDocumentationParts)

gmapT :: (forall b. Data b => b -> b) -> GetDocumentationParts -> GetDocumentationParts

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetDocumentationParts -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetDocumentationParts -> r

gmapQ :: (forall d. Data d => d -> u) -> GetDocumentationParts -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> GetDocumentationParts -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetDocumentationParts -> m GetDocumentationParts

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetDocumentationParts -> m GetDocumentationParts

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetDocumentationParts -> m GetDocumentationParts

Read GetDocumentationParts

Methods

readsPrec :: Int -> ReadS GetDocumentationParts

readList :: ReadS [GetDocumentationParts]

readPrec :: ReadPrec GetDocumentationParts

readListPrec :: ReadPrec [GetDocumentationParts]

Show GetDocumentationParts

Methods

showsPrec :: Int -> GetDocumentationParts -> ShowS

show :: GetDocumentationParts -> String

showList :: [GetDocumentationParts] -> ShowS

Generic GetDocumentationParts

Associated Types

type Rep GetDocumentationParts :: * -> *

Methods

from :: GetDocumentationParts -> Rep GetDocumentationParts x

to :: Rep GetDocumentationParts x -> GetDocumentationParts

Hashable GetDocumentationParts

Methods

hashWithSalt :: Int -> GetDocumentationParts -> Int

hash :: GetDocumentationParts -> Int

NFData GetDocumentationParts

Methods

rnf :: GetDocumentationParts -> ()

AWSRequest GetDocumentationParts

Associated Types

type Rs GetDocumentationParts :: *

Methods

request :: GetDocumentationParts -> Request GetDocumentationParts

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * GetDocumentationParts -> ClientResponse -> m (Response GetDocumentationParts)

ToHeaders GetDocumentationParts

Methods

toHeaders :: GetDocumentationParts -> [Header]

ToPath GetDocumentationParts

Methods

toPath :: GetDocumentationParts -> ByteString

ToQuery GetDocumentationParts

Methods

toQuery :: GetDocumentationParts -> QueryString

type Rep GetDocumentationParts

type Rep GetDocumentationParts = D1 * (MetaData "GetDocumentationParts" "Network.AWS.APIGateway.GetDocumentationParts" "amazonka-apigateway-1.6.0-JJ9NJtNe0aRBcVRYpJCEA2" False) (C1 * (MetaCons "GetDocumentationParts'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_gdpPath") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_gdpLocationStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe LocationStatusType))) (S1 * (MetaSel (Just Symbol "_gdpNameQuery") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_gdpLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int))) (S1 * (MetaSel (Just Symbol "_gdpType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe DocumentationPartType)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_gdpPosition") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_gdpRestAPIId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))))))

type Rs GetDocumentationParts

type Rs GetDocumentationParts = GetDocumentationPartsResponse

Request Lenses

gdpPath :: Lens' GetDocumentationParts (Maybe Text)

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

gdpLocationStatus :: Lens' GetDocumentationParts (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.

gdpNameQuery :: Lens' GetDocumentationParts (Maybe Text)

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

gdpLimit :: Lens' GetDocumentationParts (Maybe Int)

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

gdpType :: Lens' GetDocumentationParts (Maybe DocumentationPartType)

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

gdpPosition :: Lens' GetDocumentationParts (Maybe Text)

The current pagination position in the paged result set.

gdpRestAPIId :: Lens' GetDocumentationParts Text

Required

The string identifier of the associated RestApi .

Destructuring the Response

getDocumentationPartsResponse

Arguments

:: Int

gdprsResponseStatus

-> GetDocumentationPartsResponse

Creates a value of GetDocumentationPartsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• gdprsItems - The current page of elements from this collection.
• gdprsPosition - Undocumented member.
• gdprsResponseStatus - -- | The response status code.

data GetDocumentationPartsResponse

The collection of documentation parts of an API.

Documenting an API , DocumentationPart

See: getDocumentationPartsResponse smart constructor.

Instances

Eq GetDocumentationPartsResponse

Methods

(==) :: GetDocumentationPartsResponse -> GetDocumentationPartsResponse -> Bool

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

Data GetDocumentationPartsResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetDocumentationPartsResponse -> c GetDocumentationPartsResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetDocumentationPartsResponse

toConstr :: GetDocumentationPartsResponse -> Constr

dataTypeOf :: GetDocumentationPartsResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c GetDocumentationPartsResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetDocumentationPartsResponse)

gmapT :: (forall b. Data b => b -> b) -> GetDocumentationPartsResponse -> GetDocumentationPartsResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetDocumentationPartsResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetDocumentationPartsResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> GetDocumentationPartsResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> GetDocumentationPartsResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetDocumentationPartsResponse -> m GetDocumentationPartsResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetDocumentationPartsResponse -> m GetDocumentationPartsResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetDocumentationPartsResponse -> m GetDocumentationPartsResponse

Read GetDocumentationPartsResponse

Methods

readsPrec :: Int -> ReadS GetDocumentationPartsResponse

readList :: ReadS [GetDocumentationPartsResponse]

readPrec :: ReadPrec GetDocumentationPartsResponse

readListPrec :: ReadPrec [GetDocumentationPartsResponse]

Show GetDocumentationPartsResponse

Methods

showsPrec :: Int -> GetDocumentationPartsResponse -> ShowS

show :: GetDocumentationPartsResponse -> String

showList :: [GetDocumentationPartsResponse] -> ShowS

Generic GetDocumentationPartsResponse

Associated Types

type Rep GetDocumentationPartsResponse :: * -> *

Methods

from :: GetDocumentationPartsResponse -> Rep GetDocumentationPartsResponse x

to :: Rep GetDocumentationPartsResponse x -> GetDocumentationPartsResponse

NFData GetDocumentationPartsResponse

Methods

rnf :: GetDocumentationPartsResponse -> ()

type Rep GetDocumentationPartsResponse

type Rep GetDocumentationPartsResponse = D1 * (MetaData "GetDocumentationPartsResponse" "Network.AWS.APIGateway.GetDocumentationParts" "amazonka-apigateway-1.6.0-JJ9NJtNe0aRBcVRYpJCEA2" False) (C1 * (MetaCons "GetDocumentationPartsResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_gdprsItems") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [DocumentationPart]))) ((:*:) * (S1 * (MetaSel (Just Symbol "_gdprsPosition") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_gdprsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

gdprsItems :: Lens' GetDocumentationPartsResponse [DocumentationPart]

The current page of elements from this collection.

gdprsPosition :: Lens' GetDocumentationPartsResponse (Maybe Text)

Undocumented member.

gdprsResponseStatus :: Lens' GetDocumentationPartsResponse Int

• - | The response status code.