Skip to content

list_apps async

list_apps(
    *,
    config_overrides: Optional[AsyncAmplifyClientConfig] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[MaxResultsForListApps] = None,
) -> ListAppsResult

Returns a list of the existing Amplify apps.

Parameters:

  • next_token (Optional[NextToken], default: None ) –

    A pagination token. If non-null, the pagination token is returned in a result. Pass its value in another request to retrieve more entries.

  • max_results (Optional[MaxResultsForListApps], default: None ) –

    The maximum number of records to list in a single response.

Raises:

Source code in docs_src/capo_amplify/_services/async_amplify.py
async def list_apps(
    self,
    *,
    config_overrides: Optional[AsyncAmplifyClientConfig] = None,
    next_token: Optional["capo_amplify.types.next_token.NextToken"] = None,
    max_results: Optional[
        "capo_amplify.types.max_results_for_list_apps.MaxResultsForListApps"
    ] = None,
) -> "capo_amplify.types.list_apps_result.ListAppsResult":
    """<p>Returns a list of the existing Amplify apps. </p>

    Args:
        next_token: <p>A pagination token. If non-null, the pagination token is returned in a result. Pass its value in another request to retrieve more entries. </p>
        max_results: <p>The maximum number of records to list in a single response. </p>

    Raises:
        capo_amplify.errors.bad_request_exception.BadRequestException: <p>A request contains unexpected data. </p>
        capo_amplify.errors.internal_failure_exception.InternalFailureException: <p>The service failed to perform an operation due to an internal issue. </p>
        capo_amplify.errors.unauthorized_exception.UnauthorizedException: <p>An operation failed due to a lack of access. </p>
        capo_amplify.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_amplify.types.list_apps_request.ListAppsRequest]",
    ) -> AsyncOperationResponse[
        "capo_amplify.types.list_apps_result.ListAppsResult"
    ]:
        import capo_amplify._operations.amplify.list_apps

        (
            output,
            http_response,
        ) = await capo_amplify._operations.amplify.list_apps.async_list_apps(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_amplify.types.list_apps_result.ListAppsResult",
    ) -> dict[str, Any]:
        import capo_amplify.types.list_apps_result

        return capo_amplify.types.list_apps_result.redact_sensitive(output)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListApps", redact_output=_redact_output)
    )
    input_: capo_amplify.types.list_apps_request.ListAppsRequest = {}
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output