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 |
Retrieves a list of forms for a specified Amplify app and backend environment.
This operation returns paginated results.
Synopsis
- data ListForms = ListForms' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- appId :: Text
- environmentName :: Text
- newListForms :: Text -> Text -> ListForms
- listForms_maxResults :: Lens' ListForms (Maybe Natural)
- listForms_nextToken :: Lens' ListForms (Maybe Text)
- listForms_appId :: Lens' ListForms Text
- listForms_environmentName :: Lens' ListForms Text
- data ListFormsResponse = ListFormsResponse' {
- nextToken :: Maybe Text
- httpStatus :: Int
- entities :: [FormSummary]
- newListFormsResponse :: Int -> ListFormsResponse
- listFormsResponse_nextToken :: Lens' ListFormsResponse (Maybe Text)
- listFormsResponse_httpStatus :: Lens' ListFormsResponse Int
- listFormsResponse_entities :: Lens' ListFormsResponse [FormSummary]
Creating a Request
See: newListForms
smart constructor.
ListForms' | |
|
Instances
Create a value of ListForms
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:ListForms'
, listForms_maxResults
- The maximum number of forms to retrieve.
ListForms
, listForms_nextToken
- The token to request the next page of results.
ListForms
, listForms_appId
- The unique ID for the Amplify app.
ListForms
, listForms_environmentName
- The name of the backend environment that is a part of the Amplify app.
Request Lenses
listForms_maxResults :: Lens' ListForms (Maybe Natural) Source #
The maximum number of forms to retrieve.
listForms_nextToken :: Lens' ListForms (Maybe Text) Source #
The token to request the next page of results.
listForms_environmentName :: Lens' ListForms Text Source #
The name of the backend environment that is a part of the Amplify app.
Destructuring the Response
data ListFormsResponse Source #
See: newListFormsResponse
smart constructor.
ListFormsResponse' | |
|
Instances
Create a value of ListFormsResponse
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:
ListForms
, listFormsResponse_nextToken
- The pagination token that's included if more results are available.
$sel:httpStatus:ListFormsResponse'
, listFormsResponse_httpStatus
- The response's http status code.
$sel:entities:ListFormsResponse'
, listFormsResponse_entities
- The list of forms for the Amplify app.
Response Lenses
listFormsResponse_nextToken :: Lens' ListFormsResponse (Maybe Text) Source #
The pagination token that's included if more results are available.
listFormsResponse_httpStatus :: Lens' ListFormsResponse Int Source #
The response's http status code.
listFormsResponse_entities :: Lens' ListFormsResponse [FormSummary] Source #
The list of forms for the Amplify app.