| 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.AmplifyUiBuilder.ListComponents
Description
Retrieves a list of components for a specified Amplify app and backend environment.
This operation returns paginated results.
Synopsis
- data ListComponents = ListComponents' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- appId :: Text
- environmentName :: Text
- newListComponents :: Text -> Text -> ListComponents
- listComponents_maxResults :: Lens' ListComponents (Maybe Natural)
- listComponents_nextToken :: Lens' ListComponents (Maybe Text)
- listComponents_appId :: Lens' ListComponents Text
- listComponents_environmentName :: Lens' ListComponents Text
- data ListComponentsResponse = ListComponentsResponse' {
- nextToken :: Maybe Text
- httpStatus :: Int
- entities :: [ComponentSummary]
- newListComponentsResponse :: Int -> ListComponentsResponse
- listComponentsResponse_nextToken :: Lens' ListComponentsResponse (Maybe Text)
- listComponentsResponse_httpStatus :: Lens' ListComponentsResponse Int
- listComponentsResponse_entities :: Lens' ListComponentsResponse [ComponentSummary]
Creating a Request
data ListComponents Source #
See: newListComponents smart constructor.
Constructors
| ListComponents' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> ListComponents |
Create a value of ListComponents 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:ListComponents', listComponents_maxResults - The maximum number of components to retrieve.
ListComponents, listComponents_nextToken - The token to request the next page of results.
ListComponents, listComponents_appId - The unique ID for the Amplify app.
ListComponents, listComponents_environmentName - The name of the backend environment that is a part of the Amplify app.
Request Lenses
listComponents_maxResults :: Lens' ListComponents (Maybe Natural) Source #
The maximum number of components to retrieve.
listComponents_nextToken :: Lens' ListComponents (Maybe Text) Source #
The token to request the next page of results.
listComponents_appId :: Lens' ListComponents Text Source #
The unique ID for the Amplify app.
listComponents_environmentName :: Lens' ListComponents Text Source #
The name of the backend environment that is a part of the Amplify app.
Destructuring the Response
data ListComponentsResponse Source #
See: newListComponentsResponse smart constructor.
Constructors
| ListComponentsResponse' | |
Fields
| |
Instances
newListComponentsResponse Source #
Create a value of ListComponentsResponse 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:
ListComponents, listComponentsResponse_nextToken - The pagination token that's included if more results are available.
$sel:httpStatus:ListComponentsResponse', listComponentsResponse_httpStatus - The response's http status code.
$sel:entities:ListComponentsResponse', listComponentsResponse_entities - The list of components for the Amplify app.
Response Lenses
listComponentsResponse_nextToken :: Lens' ListComponentsResponse (Maybe Text) Source #
The pagination token that's included if more results are available.
listComponentsResponse_httpStatus :: Lens' ListComponentsResponse Int Source #
The response's http status code.
listComponentsResponse_entities :: Lens' ListComponentsResponse [ComponentSummary] Source #
The list of components for the Amplify app.