Skip to content

search_flows

search_flows(
    aws_account_id: AccountId,
    filters: SearchFlowsFilterList,
    *,
    config_overrides: Optional[QuickSightClientConfig] = None,
    next_token: Optional[str] = None,
    max_results: Optional[FlowMaxResults] = None,
) -> SearchFlowsOutput

Search for the flows in an Amazon Web Services account.

Parameters:

  • aws_account_id (AccountId) –

    The ID of the Amazon Web Services account where you are searching for flows from.

  • filters (SearchFlowsFilterList) –

    The filters applied to the search when searching for flows in the Amazon Web Services account.

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

    The token to request the next set of results, or null if you want to retrieve the first set.

  • max_results (Optional[FlowMaxResults], 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.

  • InvalidParameterValueException –

    One or more parameters 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/quick_sight.py
def search_flows(
    self,
    aws_account_id: "capo_quicksight.types.account_id.AccountId",
    filters: "capo_quicksight.types.search_flows_filter_list.SearchFlowsFilterList",
    *,
    config_overrides: Optional[QuickSightClientConfig] = None,
    next_token: Optional[str] = None,
    max_results: Optional[
        "capo_quicksight.types.flow_max_results.FlowMaxResults"
    ] = None,
) -> "capo_quicksight.types.search_flows_output.SearchFlowsOutput":
    """<p>Search for the flows in an Amazon Web Services account.</p>

    Args:
        aws_account_id: <p>The ID of the Amazon Web Services account where you are searching for flows from.</p>
        filters: <p>The filters applied to the search when searching for flows in the Amazon Web Services account.</p>
        next_token: <p>The token to request the next set of results, or null if you want to retrieve the first set.</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_parameter_value_exception.InvalidParameterValueException: <p>One or more parameters 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.
    """

    def _handler(
        req: "OperationRequest[capo_quicksight.types.search_flows_input.SearchFlowsInput]",
    ) -> OperationResponse[
        "capo_quicksight.types.search_flows_output.SearchFlowsOutput"
    ]:
        import capo_quicksight._operations.quick_sight_20180401.search_flows

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

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