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.ListForms

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

data ListForms Source #

See: newListForms smart constructor.

Constructors

ListForms'
Fields maxResults :: Maybe Natural The maximum number of forms to retrieve. nextToken :: Maybe Text The token to request the next page of results. appId :: Text The unique ID for the Amplify app. environmentName :: Text The name of the backend environment that is a part of the Amplify app.

Instances

Instances details

ToHeaders ListForms Source #
Instance details Defined in Amazonka.AmplifyUiBuilder.ListForms Methods toHeaders :: ListForms -> [Header] #
ToPath ListForms Source #
Instance details Defined in Amazonka.AmplifyUiBuilder.ListForms Methods toPath :: ListForms -> ByteString #
ToQuery ListForms Source #
Instance details Defined in Amazonka.AmplifyUiBuilder.ListForms Methods toQuery :: ListForms -> QueryString #
AWSPager ListForms Source #
Instance details Defined in Amazonka.AmplifyUiBuilder.ListForms Methods page :: ListForms -> AWSResponse ListForms -> Maybe ListForms #
AWSRequest ListForms Source #
Instance details Defined in Amazonka.AmplifyUiBuilder.ListForms Associated Types type AWSResponse ListForms # Methods request :: (Service -> Service) -> ListForms -> Request ListForms # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListForms -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListForms))) #
Generic ListForms Source #
Instance details Defined in Amazonka.AmplifyUiBuilder.ListForms Associated Types type Rep ListForms :: Type -> Type # Methods from :: ListForms -> Rep ListForms x # to :: Rep ListForms x -> ListForms #
Read ListForms Source #
Instance details Defined in Amazonka.AmplifyUiBuilder.ListForms Methods readsPrec :: Int -> ReadS ListForms # readList :: ReadS [ListForms] # readPrec :: ReadPrec ListForms # readListPrec :: ReadPrec [ListForms] #
Show ListForms Source #
Instance details Defined in Amazonka.AmplifyUiBuilder.ListForms Methods showsPrec :: Int -> ListForms -> ShowS # show :: ListForms -> String # showList :: [ListForms] -> ShowS #
NFData ListForms Source #
Instance details Defined in Amazonka.AmplifyUiBuilder.ListForms Methods rnf :: ListForms -> () #
Eq ListForms Source #
Instance details Defined in Amazonka.AmplifyUiBuilder.ListForms Methods (==) :: ListForms -> ListForms -> Bool # (/=) :: ListForms -> ListForms -> Bool #
Hashable ListForms Source #
Instance details Defined in Amazonka.AmplifyUiBuilder.ListForms Methods hashWithSalt :: Int -> ListForms -> Int # hash :: ListForms -> Int #
type AWSResponse ListForms Source #
Instance details Defined in Amazonka.AmplifyUiBuilder.ListForms type AWSResponse ListForms = ListFormsResponse
type Rep ListForms Source #
Instance details Defined in Amazonka.AmplifyUiBuilder.ListForms type Rep ListForms = D1 ('MetaData "ListForms" "Amazonka.AmplifyUiBuilder.ListForms" "amazonka-amplifyuibuilder-2.0-KN0MRaPu7dZCAXr3ruBTcC" 'False) (C1 ('MetaCons "ListForms'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "appId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "environmentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListForms Source #

Arguments

:: Text	`ListForms`
-> Text	`ListForms`
-> ListForms

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_appId :: Lens' ListForms Text Source #

The unique ID for the Amplify app.

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.

Constructors

ListFormsResponse'
Fields nextToken :: Maybe Text The pagination token that's included if more results are available. httpStatus :: Int The response's http status code. entities :: [FormSummary] The list of forms for the Amplify app.

Instances

Instances details

Generic ListFormsResponse Source #
Instance details Defined in Amazonka.AmplifyUiBuilder.ListForms Associated Types type Rep ListFormsResponse :: Type -> Type # Methods from :: ListFormsResponse -> Rep ListFormsResponse x # to :: Rep ListFormsResponse x -> ListFormsResponse #
Read ListFormsResponse Source #
Instance details Defined in Amazonka.AmplifyUiBuilder.ListForms Methods readsPrec :: Int -> ReadS ListFormsResponse # readList :: ReadS [ListFormsResponse] # readPrec :: ReadPrec ListFormsResponse # readListPrec :: ReadPrec [ListFormsResponse] #
Show ListFormsResponse Source #
Instance details Defined in Amazonka.AmplifyUiBuilder.ListForms Methods showsPrec :: Int -> ListFormsResponse -> ShowS # show :: ListFormsResponse -> String # showList :: [ListFormsResponse] -> ShowS #
NFData ListFormsResponse Source #
Instance details Defined in Amazonka.AmplifyUiBuilder.ListForms Methods rnf :: ListFormsResponse -> () #
Eq ListFormsResponse Source #
Instance details Defined in Amazonka.AmplifyUiBuilder.ListForms Methods (==) :: ListFormsResponse -> ListFormsResponse -> Bool # (/=) :: ListFormsResponse -> ListFormsResponse -> Bool #
type Rep ListFormsResponse Source #
Instance details Defined in Amazonka.AmplifyUiBuilder.ListForms type Rep ListFormsResponse = D1 ('MetaData "ListFormsResponse" "Amazonka.AmplifyUiBuilder.ListForms" "amazonka-amplifyuibuilder-2.0-KN0MRaPu7dZCAXr3ruBTcC" 'False) (C1 ('MetaCons "ListFormsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "entities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [FormSummary]))))

newListFormsResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListFormsResponse'`
-> ListFormsResponse

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.