Amazonka.AmplifyUiBuilder.ListComponents

Retrieves a list of components for a specified Amplify app and backend environment.

This operation returns paginated results.

Creating a Request

data ListComponents

See: newListComponents smart constructor.

Constructors

ListComponents'

Fields

• maxResults :: Maybe Natural

  The maximum number of components 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

ToHeaders ListComponents

Defined in Amazonka.AmplifyUiBuilder.ListComponents

Methods

toHeaders :: ListComponents -> [Header]

ToPath ListComponents

Defined in Amazonka.AmplifyUiBuilder.ListComponents

Methods

toPath :: ListComponents -> ByteString

ToQuery ListComponents

Defined in Amazonka.AmplifyUiBuilder.ListComponents

Methods

toQuery :: ListComponents -> QueryString

AWSPager ListComponents

Defined in Amazonka.AmplifyUiBuilder.ListComponents

Methods

page :: ListComponents -> AWSResponse ListComponents -> Maybe ListComponents

AWSRequest ListComponents

Defined in Amazonka.AmplifyUiBuilder.ListComponents

Associated Types

type AWSResponse ListComponents

Methods

request :: (Service -> Service) -> ListComponents -> Request ListComponents

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListComponents -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListComponents)))

Generic ListComponents

Defined in Amazonka.AmplifyUiBuilder.ListComponents

Associated Types

type Rep ListComponents :: Type -> Type

Methods

from :: ListComponents -> Rep ListComponents x

to :: Rep ListComponents x -> ListComponents

Read ListComponents

Defined in Amazonka.AmplifyUiBuilder.ListComponents

Methods

readsPrec :: Int -> ReadS ListComponents

readList :: ReadS [ListComponents]

readPrec :: ReadPrec ListComponents

readListPrec :: ReadPrec [ListComponents]

Show ListComponents

Defined in Amazonka.AmplifyUiBuilder.ListComponents

Methods

showsPrec :: Int -> ListComponents -> ShowS

show :: ListComponents -> String

showList :: [ListComponents] -> ShowS

NFData ListComponents

Defined in Amazonka.AmplifyUiBuilder.ListComponents

Methods

rnf :: ListComponents -> ()

Eq ListComponents

Defined in Amazonka.AmplifyUiBuilder.ListComponents

Methods

(==) :: ListComponents -> ListComponents -> Bool

(/=) :: ListComponents -> ListComponents -> Bool

Hashable ListComponents

Defined in Amazonka.AmplifyUiBuilder.ListComponents

Methods

hashWithSalt :: Int -> ListComponents -> Int

hash :: ListComponents -> Int

type AWSResponse ListComponents

Defined in Amazonka.AmplifyUiBuilder.ListComponents

type AWSResponse ListComponents = ListComponentsResponse

type Rep ListComponents

Defined in Amazonka.AmplifyUiBuilder.ListComponents

type Rep ListComponents = D1 ('MetaData "ListComponents" "Amazonka.AmplifyUiBuilder.ListComponents" "amazonka-amplifyuibuilder-2.0-KN0MRaPu7dZCAXr3ruBTcC" 'False) (C1 ('MetaCons "ListComponents'" '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))))

newListComponents

Arguments

:: Text

ListComponents

-> Text

ListComponents

-> 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)

The maximum number of components to retrieve.

listComponents_nextToken :: Lens' ListComponents (Maybe Text)

The token to request the next page of results.

listComponents_appId :: Lens' ListComponents Text

The unique ID for the Amplify app.

listComponents_environmentName :: Lens' ListComponents Text

The name of the backend environment that is a part of the Amplify app.

Destructuring the Response

data ListComponentsResponse

See: newListComponentsResponse smart constructor.

Constructors

ListComponentsResponse'

Fields

• nextToken :: Maybe Text

  The pagination token that's included if more results are available.

• httpStatus :: Int

  The response's http status code.

• entities :: [ComponentSummary]

  The list of components for the Amplify app.

Instances

Generic ListComponentsResponse

Defined in Amazonka.AmplifyUiBuilder.ListComponents

Associated Types

type Rep ListComponentsResponse :: Type -> Type

Methods

from :: ListComponentsResponse -> Rep ListComponentsResponse x

to :: Rep ListComponentsResponse x -> ListComponentsResponse

Read ListComponentsResponse

Defined in Amazonka.AmplifyUiBuilder.ListComponents

Methods

readsPrec :: Int -> ReadS ListComponentsResponse

readList :: ReadS [ListComponentsResponse]

readPrec :: ReadPrec ListComponentsResponse

readListPrec :: ReadPrec [ListComponentsResponse]

Show ListComponentsResponse

Defined in Amazonka.AmplifyUiBuilder.ListComponents

Methods

showsPrec :: Int -> ListComponentsResponse -> ShowS

show :: ListComponentsResponse -> String

showList :: [ListComponentsResponse] -> ShowS

NFData ListComponentsResponse

Defined in Amazonka.AmplifyUiBuilder.ListComponents

Methods

rnf :: ListComponentsResponse -> ()

Eq ListComponentsResponse

Defined in Amazonka.AmplifyUiBuilder.ListComponents

Methods

(==) :: ListComponentsResponse -> ListComponentsResponse -> Bool

(/=) :: ListComponentsResponse -> ListComponentsResponse -> Bool

type Rep ListComponentsResponse

Defined in Amazonka.AmplifyUiBuilder.ListComponents

type Rep ListComponentsResponse = D1 ('MetaData "ListComponentsResponse" "Amazonka.AmplifyUiBuilder.ListComponents" "amazonka-amplifyuibuilder-2.0-KN0MRaPu7dZCAXr3ruBTcC" 'False) (C1 ('MetaCons "ListComponentsResponse'" '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 [ComponentSummary]))))

newListComponentsResponse

Arguments

:: Int

$sel:httpStatus:ListComponentsResponse'

-> ListComponentsResponse

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)

The pagination token that's included if more results are available.

listComponentsResponse_httpStatus :: Lens' ListComponentsResponse Int

The response's http status code.

listComponentsResponse_entities :: Lens' ListComponentsResponse [ComponentSummary]

The list of components for the Amplify app.