list_components

AmplifyUIBuilder.Client.list_components(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.list_components(
    appId='string',
    environmentName='string',
    maxResults=123,
    nextToken='string'
)

Parameters

• appId (string) --

  [REQUIRED]

  The unique ID for the Amplify app.

• environmentName (string) --

  [REQUIRED]

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

• maxResults (integer) -- The maximum number of components to retrieve.
• nextToken (string) -- The token to request the next page of results.

Return type

dict

Returns

Response Syntax

{
    'entities': [
        {
            'appId': 'string',
            'componentType': 'string',
            'environmentName': 'string',
            'id': 'string',
            'name': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) --

  • entities (list) --

    The list of components for the Amplify app.

    • (dict) --

      Contains a summary of a component. This is a read-only data type that is returned by ListComponents .

      • appId (string) --

        The unique ID of the Amplify app associated with the component.

      • componentType (string) --

        The component type.

      • environmentName (string) --

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

      • id (string) --

        The unique ID of the component.

      • name (string) --

        The name of the component.

  • nextToken (string) --

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

Exceptions

• AmplifyUIBuilder.Client.exceptions.InternalServerException
• AmplifyUIBuilder.Client.exceptions.InvalidParameterException