Skip to content

list_kx_dataviews

list_kx_dataviews(
    environment_id: EnvironmentId,
    database_name: DatabaseName,
    *,
    config_overrides: Optional[finspaceClientConfig] = None,
    next_token: Optional[PaginationToken] = None,
    max_results: Optional[MaxResults] = None,
) -> ListKxDataviewsResponse

Returns a list of all the dataviews in the database.

Parameters:

  • environment_id (EnvironmentId) –

    A unique identifier for the kdb environment, for which you want to retrieve a list of dataviews.

  • database_name (DatabaseName) –

    The name of the database where the dataviews were created.

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

    A token that indicates where a results page should begin.

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

    The maximum number of results to return in this request.

Raises:

Source code in docs_src/capo_finspace/_services/finspace.py
def list_kx_dataviews(
    self,
    environment_id: "capo_finspace.types.environment_id.EnvironmentId",
    database_name: "capo_finspace.types.database_name.DatabaseName",
    *,
    config_overrides: Optional[finspaceClientConfig] = None,
    next_token: Optional[
        "capo_finspace.types.pagination_token.PaginationToken"
    ] = None,
    max_results: Optional["capo_finspace.types.max_results.MaxResults"] = None,
) -> "capo_finspace.types.list_kx_dataviews_response.ListKxDataviewsResponse":
    """<p> Returns a list of all the dataviews in the database.</p>

    Args:
        environment_id: <p>A unique identifier for the kdb environment, for which you want to retrieve a list of dataviews.</p>
        database_name: <p> The name of the database where the dataviews were created.</p>
        next_token: <p> A token that indicates where a results page should begin. </p>
        max_results: <p>The maximum number of results to return in this request.</p>

    Raises:
        capo_finspace.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_finspace.errors.internal_server_exception.InternalServerException: <p>The request processing has failed because of an unknown error, exception or failure.</p>
        capo_finspace.errors.resource_not_found_exception.ResourceNotFoundException: <p>One or more resources can't be found.</p>
        capo_finspace.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_finspace.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by an AWS service.</p>
        capo_finspace.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_finspace.types.list_kx_dataviews_request.ListKxDataviewsRequest]",
    ) -> OperationResponse[
        "capo_finspace.types.list_kx_dataviews_response.ListKxDataviewsResponse"
    ]:
        import capo_finspace._operations.aws_habanero_management_service.list_kx_dataviews

        output, http_response = (
            capo_finspace._operations.aws_habanero_management_service.list_kx_dataviews.list_kx_dataviews(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListKxDataviews")
    )
    input_: capo_finspace.types.list_kx_dataviews_request.ListKxDataviewsRequest = {
        "environment_id": environment_id,
        "database_name": database_name,
    }
    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