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 |
Lists the types for a given API.
This operation returns paginated results.
Synopsis
- data ListTypes = ListTypes' {}
- newListTypes :: Text -> TypeDefinitionFormat -> ListTypes
- listTypes_maxResults :: Lens' ListTypes (Maybe Natural)
- listTypes_nextToken :: Lens' ListTypes (Maybe Text)
- listTypes_apiId :: Lens' ListTypes Text
- listTypes_format :: Lens' ListTypes TypeDefinitionFormat
- data ListTypesResponse = ListTypesResponse' {}
- newListTypesResponse :: Int -> ListTypesResponse
- listTypesResponse_nextToken :: Lens' ListTypesResponse (Maybe Text)
- listTypesResponse_types :: Lens' ListTypesResponse (Maybe [Type])
- listTypesResponse_httpStatus :: Lens' ListTypesResponse Int
Creating a Request
See: newListTypes
smart constructor.
ListTypes' | |
|
Instances
Create a value of ListTypes
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:maxResults:ListTypes'
, listTypes_maxResults
- The maximum number of results that you want the request to return.
ListTypes
, listTypes_nextToken
- An identifier that was returned from the previous call to this
operation, which you can use to return the next set of items in the
list.
ListTypes
, listTypes_apiId
- The API ID.
ListTypes
, listTypes_format
- The type format: SDL or JSON.
Request Lenses
listTypes_maxResults :: Lens' ListTypes (Maybe Natural) Source #
The maximum number of results that you want the request to return.
listTypes_nextToken :: Lens' ListTypes (Maybe Text) Source #
An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.
listTypes_format :: Lens' ListTypes TypeDefinitionFormat Source #
The type format: SDL or JSON.
Destructuring the Response
data ListTypesResponse Source #
See: newListTypesResponse
smart constructor.
Instances
Create a value of ListTypesResponse
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:
ListTypes
, listTypesResponse_nextToken
- An identifier to pass in the next request to this operation to return
the next set of items in the list.
$sel:types:ListTypesResponse'
, listTypesResponse_types
- The Type
objects.
$sel:httpStatus:ListTypesResponse'
, listTypesResponse_httpStatus
- The response's http status code.
Response Lenses
listTypesResponse_nextToken :: Lens' ListTypesResponse (Maybe Text) Source #
An identifier to pass in the next request to this operation to return the next set of items in the list.
listTypesResponse_types :: Lens' ListTypesResponse (Maybe [Type]) Source #
The Type
objects.
listTypesResponse_httpStatus :: Lens' ListTypesResponse Int Source #
The response's http status code.