Skip to content

search_analyses

search_analyses(
    aws_account_id: AwsAccountId,
    filters: AnalysisSearchFilterList,
    *,
    config_overrides: Optional[QuickSightClientConfig] = None,
    next_token: Optional[String] = None,
    max_results: Optional[MaxResults] = None,
) -> SearchAnalysesResponse

Searches for analyses that belong to the user specified in the filter.

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

Parameters:

  • aws_account_id (AwsAccountId) –

    The ID of the Amazon Web Services account that contains the analyses that you're searching for.

  • filters (AnalysisSearchFilterList) –

    The structure for the search filters that you want to apply to your search.

  • 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 search_analyses(
    self,
    aws_account_id: "capo_quicksight.types.aws_account_id.AwsAccountId",
    filters: "capo_quicksight.types.analysis_search_filter_list.AnalysisSearchFilterList",
    *,
    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.search_analyses_response.SearchAnalysesResponse":
    """<p>Searches for analyses that belong to the user specified in the filter.</p> <note> <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p> </note>

    Args:
        aws_account_id: <p>The ID of the Amazon Web Services account that contains the analyses that you're searching for.</p>
        filters: <p>The structure for the search filters that you want to apply to your search. </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.invalid_parameter_value_exception.InvalidParameterValueException: <p>One or more parameters has a value that isn't valid.</p>
        capo_quicksight.errors.resource_not_found_exception.ResourceNotFoundException: <p>One or more resources can't be found.</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.search_analyses_request.SearchAnalysesRequest]",
    ) -> OperationResponse[
        "capo_quicksight.types.search_analyses_response.SearchAnalysesResponse"
    ]:
        import capo_quicksight._operations.quick_sight_20180401.search_analyses

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("SearchAnalyses")
    )
    input_: capo_quicksight.types.search_analyses_request.SearchAnalysesRequest = {
        "aws_account_id": aws_account_id,
        "filters": filters,
    }
    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