search_data_sets ¶

search_data_sets(
    aws_account_id: AwsAccountId,
    filters: DataSetSearchFilterList,
    *,
    config_overrides: Optional[QuickSightClientConfig] = None,
    next_token: Optional[String] = None,
    max_results: Optional[MaxResults] = None,
) -> SearchDataSetsResponse

Use the SearchDataSets operation to search for datasets that belong to an account.

Parameters:

aws_account_id (AwsAccountId) –

The Amazon Web Services account ID.
filters (DataSetSearchFilterList) –

The filters to apply to the 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 be returned per request.

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.
InvalidNextTokenException –

The NextToken value isn't valid.
InvalidParameterValueException –

One or more parameters has a value that isn't valid.
ResourceNotFoundException –

One or more resources can't be found.
ThrottlingException –

Access is throttled.
UnknownServiceError –

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

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

def search_data_sets(
    self,
    aws_account_id: "capo_quicksight.types.aws_account_id.AwsAccountId",
    filters: "capo_quicksight.types.data_set_search_filter_list.DataSetSearchFilterList",
    *,
    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_data_sets_response.SearchDataSetsResponse":
    """<p>Use the <code>SearchDataSets</code> operation to search for datasets that belong to an account.</p>

    Args:
        aws_account_id: <p>The Amazon Web Services account ID.</p>
        filters: <p>The filters to apply to the 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 be returned per request.</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_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.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_quicksight.types.search_data_sets_request.SearchDataSetsRequest]",
    ) -> OperationResponse[
        "capo_quicksight.types.search_data_sets_response.SearchDataSetsResponse"
    ]:
        import capo_quicksight._operations.quick_sight_20180401.search_data_sets

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

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