Skip to content

list_action_connectors async

list_action_connectors(
    aws_account_id: AwsAccountId,
    *,
    config_overrides: Optional[AsyncQuickSightClientConfig] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[str] = None,
) -> ListActionConnectorsResponse

Lists all action connectors in the specified Amazon Web Services account. Returns summary information for each connector including its name, type, creation time, and status.

Parameters:

  • aws_account_id (AwsAccountId) –

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

  • max_results (Optional[MaxResults], 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 listing action connectors.

Raises:

Source code in docs_src/capo_quicksight/_services/async_quick_sight.py
async def list_action_connectors(
    self,
    aws_account_id: "capo_quicksight.types.aws_account_id.AwsAccountId",
    *,
    config_overrides: Optional[AsyncQuickSightClientConfig] = None,
    max_results: Optional["capo_quicksight.types.max_results.MaxResults"] = None,
    next_token: Optional[str] = None,
) -> "capo_quicksight.types.list_action_connectors_response.ListActionConnectorsResponse":
    """<p>Lists all action connectors in the specified Amazon Web Services account. Returns summary information for each connector including its name, type, creation time, and status.</p>

    Args:
        aws_account_id: <p>The Amazon Web Services account ID for which to list 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 listing action connectors.</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.throttling_exception.ThrottlingException: <p>Access is throttled.</p>
        capo_quicksight.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_quicksight.types.list_action_connectors_request.ListActionConnectorsRequest]",
    ) -> AsyncOperationResponse[
        "capo_quicksight.types.list_action_connectors_response.ListActionConnectorsResponse"
    ]:
        import capo_quicksight._operations.quick_sight_20180401.list_action_connectors

        (
            output,
            http_response,
        ) = await capo_quicksight._operations.quick_sight_20180401.list_action_connectors.async_list_action_connectors(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

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

        return (
            capo_quicksight.types.list_action_connectors_response.redact_sensitive(
                output
            )
        )

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

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output