Skip to content

search_action_connectors

search_action_connectors(
    aws_account_id: AwsAccountId,
    filters: ActionConnectorSearchFilterList,
    *,
    config_overrides: Optional[QuickSightClientConfig] = None,
    max_results: Optional[SearchActionConnectorsRequestMaxResultsInteger] = None,
    next_token: Optional[str] = None,
) -> SearchActionConnectorsResponse

Searches for action connectors in the specified Amazon Web Services account using filters. You can search by connector name, type, or user permissions.

Parameters:

  • aws_account_id (AwsAccountId) –

    The Amazon Web Services account ID in which to search for action connectors.

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

    The maximum number of action connectors to return in a single response. Valid range is 1 to 100.

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

    A pagination token to retrieve the next set of results. Use the token returned from a previous call to continue searching.

  • filters (ActionConnectorSearchFilterList) –

    The search filters to apply. You can filter by connector name, type, or user permissions. Maximum of one filter is supported.

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.

  • InvalidNextTokenException –

    The NextToken value isn't valid.

  • 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_action_connectors(
    self,
    aws_account_id: "capo_quicksight.types.aws_account_id.AwsAccountId",
    filters: "capo_quicksight.types.action_connector_search_filter_list.ActionConnectorSearchFilterList",
    *,
    config_overrides: Optional[QuickSightClientConfig] = None,
    max_results: Optional[
        "capo_quicksight.types.search_action_connectors_request_max_results_integer.SearchActionConnectorsRequestMaxResultsInteger"
    ] = None,
    next_token: Optional[str] = None,
) -> "capo_quicksight.types.search_action_connectors_response.SearchActionConnectorsResponse":
    """<p>Searches for action connectors in the specified Amazon Web Services account using filters. You can search by connector name, type, or user permissions.</p>

    Args:
        aws_account_id: <p>The Amazon Web Services account ID in which to search for action connectors.</p>
        max_results: <p>The maximum number of action connectors to return in a single response. Valid range is 1 to 100.</p>
        next_token: <p>A pagination token to retrieve the next set of results. Use the token returned from a previous call to continue searching.</p>
        filters: <p>The search filters to apply. You can filter by connector name, type, or user permissions. Maximum of one filter is supported.</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.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.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_action_connectors_request.SearchActionConnectorsRequest]",
    ) -> OperationResponse[
        "capo_quicksight.types.search_action_connectors_response.SearchActionConnectorsResponse"
    ]:
        import capo_quicksight._operations.quick_sight_20180401.search_action_connectors

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

    def _redact_output(
        output: "capo_quicksight.types.search_action_connectors_response.SearchActionConnectorsResponse",
    ) -> dict[str, Any]:
        import capo_quicksight.types.search_action_connectors_response

        return capo_quicksight.types.search_action_connectors_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("SearchActionConnectors", redact_output=_redact_output),
    )
    input_: capo_quicksight.types.search_action_connectors_request.SearchActionConnectorsRequest = {
        "aws_account_id": aws_account_id,
        "filters": filters,
    }
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

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