Skip to content

list_analyses

list_analyses(
    aws_account_id: AwsAccountId,
    *,
    config_overrides: Optional[QuickSightClientConfig] = None,
    next_token: Optional[String] = None,
    max_results: Optional[MaxResults] = None,
) -> ListAnalysesResponse

Lists Amazon Quick Sight analyses that exist in the specified Amazon Web Services account.

Parameters:

  • aws_account_id (AwsAccountId) –

    The ID of the Amazon Web Services account that contains the analyses.

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

    A pagination token that can be used in a subsequent request.

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

    The maximum number of results to return.

Raises:

Source code in docs_src/capo_quicksight/_services/quick_sight.py
def list_analyses(
    self,
    aws_account_id: "capo_quicksight.types.aws_account_id.AwsAccountId",
    *,
    config_overrides: Optional[QuickSightClientConfig] = None,
    next_token: Optional["capo_quicksight.types.string.String"] = None,
    max_results: Optional["capo_quicksight.types.max_results.MaxResults"] = None,
) -> "capo_quicksight.types.list_analyses_response.ListAnalysesResponse":
    """<p>Lists Amazon Quick Sight analyses that exist in the specified Amazon Web Services account.</p>

    Args:
        aws_account_id: <p>The ID of the Amazon Web Services account that contains the analyses.</p>
        next_token: <p>A pagination token that can be used in a subsequent request.</p>
        max_results: <p>The maximum number of results to return.</p>

    Raises:
        capo_quicksight.errors.internal_failure_exception.InternalFailureException: <p>An internal failure occurred.</p>
        capo_quicksight.errors.invalid_next_token_exception.InvalidNextTokenException: <p>The <code>NextToken</code> value isn't valid.</p>
        capo_quicksight.errors.throttling_exception.ThrottlingException: <p>Access is throttled.</p>
        capo_quicksight.errors.unsupported_user_edition_exception.UnsupportedUserEditionException: <p>This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.</p>
        capo_quicksight.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_quicksight.types.list_analyses_request.ListAnalysesRequest]",
    ) -> OperationResponse[
        "capo_quicksight.types.list_analyses_response.ListAnalysesResponse"
    ]:
        import capo_quicksight._operations.quick_sight_20180401.list_analyses

        output, http_response = (
            capo_quicksight._operations.quick_sight_20180401.list_analyses.list_analyses(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListAnalyses")
    )
    input_: capo_quicksight.types.list_analyses_request.ListAnalysesRequest = {
        "aws_account_id": aws_account_id
    }
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output