| 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.GetDocumentationParts
Description
- - | Undocumented operation.
This operation returns paginated results.
Synopsis
- data GetDocumentationParts = GetDocumentationParts' {}
- newGetDocumentationParts :: Text -> GetDocumentationParts
- getDocumentationParts_path :: Lens' GetDocumentationParts (Maybe Text)
- getDocumentationParts_locationStatus :: Lens' GetDocumentationParts (Maybe LocationStatusType)
- getDocumentationParts_nameQuery :: Lens' GetDocumentationParts (Maybe Text)
- getDocumentationParts_limit :: Lens' GetDocumentationParts (Maybe Int)
- getDocumentationParts_type :: Lens' GetDocumentationParts (Maybe DocumentationPartType)
- getDocumentationParts_position :: Lens' GetDocumentationParts (Maybe Text)
- 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
| |
Instances
newGetDocumentationParts Source #
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:
$sel:path:GetDocumentationParts', getDocumentationParts_path - The path of API entities of the to-be-retrieved documentation parts.
$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.
$sel:limit:GetDocumentationParts', getDocumentationParts_limit - The maximum number of returned results per page. The default value is 25
and the maximum value is 500.
$sel:type':GetDocumentationParts', getDocumentationParts_type - The type of API entities of the to-be-retrieved documentation parts.
$sel:position:GetDocumentationParts', getDocumentationParts_position - The current pagination position in the paged result set.
$sel:restApiId:GetDocumentationParts', getDocumentationParts_restApiId - [Required] The string identifier of the associated RestApi.
Request Lenses
getDocumentationParts_path :: Lens' GetDocumentationParts (Maybe Text) Source #
The path of API entities of the to-be-retrieved documentation parts.
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_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_type :: Lens' GetDocumentationParts (Maybe DocumentationPartType) Source #
The type 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_restApiId :: Lens' GetDocumentationParts Text Source #
- Required
- The string identifier of the associated RestApi.
Destructuring the Response
data GetDocumentationPartsResponse Source #
The collection of documentation parts of an API.
Documenting an API, DocumentationPart
See: newGetDocumentationPartsResponse smart constructor.
Constructors
| GetDocumentationPartsResponse' | |
Fields
| |
Instances
newGetDocumentationPartsResponse Source #
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:
$sel:items:GetDocumentationPartsResponse', getDocumentationPartsResponse_items - The current page of elements from this collection.
$sel:position: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.