Skip to content

list_applications async

list_applications(
    *,
    config_overrides: Optional[AsyncAppConfigClientConfig] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[NextToken] = None,
) -> Applications

Lists all applications in your Amazon Web Services account.

Parameters:

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

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

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

    A token to start the list. Next token is a pagination token generated by AppConfig to describe what page the previous List call ended on. For the first List request, the nextToken should not be set. On subsequent calls, the nextToken parameter should be set to the previous responses nextToken value. Use this token to get the next set of results.

Raises:

Examples:

To list the available applications The following list-applications example lists the available applications in your AWS account.

>>> await client.list_applications()
Source code in docs_src/capo_appconfig/_services/async_app_config.py
async def list_applications(
    self,
    *,
    config_overrides: Optional[AsyncAppConfigClientConfig] = None,
    max_results: Optional["capo_appconfig.types.max_results.MaxResults"] = None,
    next_token: Optional["capo_appconfig.types.next_token.NextToken"] = None,
) -> "capo_appconfig.types.applications.Applications":
    """<p>Lists all applications in your Amazon Web Services account.</p>

    Args:
        max_results: <p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>
        next_token: <p>A token to start the list. Next token is a pagination token generated by AppConfig to describe what page the previous List call ended on. For the first List request, the nextToken should not be set. On subsequent calls, the nextToken parameter should be set to the previous responses nextToken value. Use this token to get the next set of results. </p>

    Raises:
        capo_appconfig.errors.bad_request_exception.BadRequestException: <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
        capo_appconfig.errors.internal_server_exception.InternalServerException: <p>There was an internal failure in the AppConfig service.</p>
        capo_appconfig.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To list the available applications
        The following list-applications example lists the available applications in your AWS account.

        >>> await client.list_applications()
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_appconfig.types.list_applications_request.ListApplicationsRequest]",
    ) -> AsyncOperationResponse["capo_appconfig.types.applications.Applications"]:
        import capo_appconfig._operations.amazon_app_config.list_applications

        (
            output,
            http_response,
        ) = await capo_appconfig._operations.amazon_app_config.list_applications.async_list_applications(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListApplications")
    )
    input_: capo_appconfig.types.list_applications_request.ListApplicationsRequest = {}
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

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