list_apps `async` ¶

list_apps(
    aws_account_id: AwsAccountId,
    *,
    config_overrides: Optional[AsyncQuickSightClientConfig] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[NextToken] = None,
) -> ListAppsResponse

Lists the apps in an Amazon Web Services account. Results are paginated; use the NextToken parameter to retrieve additional results.

Parameters:

aws_account_id (AwsAccountId) –

The ID of the Amazon Web Services account that contains the apps.
max_results (Optional[MaxResults], default: None ) –

The maximum number of results to return in a single request. Valid range is 1 to 100. If you don't specify a value, the default is 20.
next_token (Optional[NextToken], default: None ) –

The token for the next set of results, or null if there are no more results.

Raises:

AccessDeniedException –

You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
InternalFailureException –

An internal failure occurred.
InvalidParameterException –

One or more parameter has a value that isn't valid.
ThrottlingException –

Access is throttled.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_quicksight/_services/async_quick_sight.py

async def list_apps(
    self,
    aws_account_id: "capo_quicksight.types.aws_account_id.AwsAccountId",
    *,
    config_overrides: Optional[AsyncQuickSightClientConfig] = None,
    max_results: Optional["capo_quicksight.types.max_results.MaxResults"] = None,
    next_token: Optional["capo_quicksight.types.next_token.NextToken"] = None,
) -> "capo_quicksight.types.list_apps_response.ListAppsResponse":
    """<p>Lists the apps in an Amazon Web Services account. Results are paginated; use the <code>NextToken</code> parameter to retrieve additional results.</p>

    Args:
        aws_account_id: <p>The ID of the Amazon Web Services account that contains the apps.</p>
        max_results: <p>The maximum number of results to return in a single request. Valid range is 1 to 100. If you don't specify a value, the default is 20.</p>
        next_token: <p>The token for the next set of results, or null if there are no more results.</p>

    Raises:
        capo_quicksight.errors.access_denied_exception.AccessDeniedException: <p>You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.</p>
        capo_quicksight.errors.internal_failure_exception.InternalFailureException: <p>An internal failure occurred.</p>
        capo_quicksight.errors.invalid_parameter_exception.InvalidParameterException: <p>One or more parameter has a value that isn't valid.</p>
        capo_quicksight.errors.throttling_exception.ThrottlingException: <p>Access is throttled.</p>
        capo_quicksight.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_quicksight.types.list_apps_request.ListAppsRequest]",
    ) -> AsyncOperationResponse[
        "capo_quicksight.types.list_apps_response.ListAppsResponse"
    ]:
        import capo_quicksight._operations.quick_sight_20180401.list_apps

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListApps")
    )
    input_: capo_quicksight.types.list_apps_request.ListAppsRequest = {
        "aws_account_id": aws_account_id
    }
    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

list_apps async ¶

list_apps `async` ¶