search_dashboards ¶

def search_dashboards(
    self,
    aws_account_id: "capo_quicksight.types.aws_account_id.AwsAccountId",
    filters: "capo_quicksight.types.dashboard_search_filter_list.DashboardSearchFilterList",
    *,
    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_dashboards_response.SearchDashboardsResponse":
    """<p>Searches for dashboards that belong to a user. </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 user whose dashboards you're searching for. </p>
        filters: <p>The filters to apply to the search. Currently, you can search only by user name, for example, <code>"Filters": [ { "Name": "QUICKSIGHT_USER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1" } ]</code> </p>
        next_token: <p>The token for the next set of results, or null if there are no more results.</p>
        max_results: <p>The maximum number of results to be returned per request.</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_dashboards_request.SearchDashboardsRequest]",
    ) -> OperationResponse[
        "capo_quicksight.types.search_dashboards_response.SearchDashboardsResponse"
    ]:
        import capo_quicksight._operations.quick_sight_20180401.search_dashboards

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("SearchDashboards")
    )
    input_: capo_quicksight.types.search_dashboards_request.SearchDashboardsRequest = {
        "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