getNotebooks

Snowflake v2.10.0, Nov 22 25

Snowflake v2.10.0 published on Saturday, Nov 22, 2025 by Pulumi

Schema (JSON)

pulumi/pulumi-snowflake

Snowflake v2.10.0 published on Saturday, Nov 22, 2025 by Pulumi

Schema (JSON)

pulumi/pulumi-snowflake

!> Caution: Preview Feature This feature is considered a preview feature in the provider, regardless of the state of the resource in Snowflake. We do not guarantee its stability. It will be reworked and marked as a stable feature in future releases. Breaking changes are expected, even without bumping the major version. To use this feature, add the relevant feature name to preview_features_enabled field in the provider configuration. Please always refer to the Getting Help section in our Github repo to best determine how to get help for your questions.

Data source used to get details of filtered notebooks. Filtering is aligned with the current possibilities for SHOW NOTEBOOKS query. The results of SHOW and DESCRIBE are encapsulated in one output collection notebooks.

Using getNotebooks

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getNotebooks(args: GetNotebooksArgs, opts?: InvokeOptions): Promise<GetNotebooksResult>
function getNotebooksOutput(args: GetNotebooksOutputArgs, opts?: InvokeOptions): Output<GetNotebooksResult>

def get_notebooks(like: Optional[str] = None,
                  limit: Optional[GetNotebooksLimit] = None,
                  starts_with: Optional[str] = None,
                  with_describe: Optional[bool] = None,
                  opts: Optional[InvokeOptions] = None) -> GetNotebooksResult
def get_notebooks_output(like: Optional[pulumi.Input[str]] = None,
                  limit: Optional[pulumi.Input[GetNotebooksLimitArgs]] = None,
                  starts_with: Optional[pulumi.Input[str]] = None,
                  with_describe: Optional[pulumi.Input[bool]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetNotebooksResult]

func GetNotebooks(ctx *Context, args *GetNotebooksArgs, opts ...InvokeOption) (*GetNotebooksResult, error)
func GetNotebooksOutput(ctx *Context, args *GetNotebooksOutputArgs, opts ...InvokeOption) GetNotebooksResultOutput

> Note: This function is named GetNotebooks in the Go SDK.

public static class GetNotebooks 
{
    public static Task<GetNotebooksResult> InvokeAsync(GetNotebooksArgs args, InvokeOptions? opts = null)
    public static Output<GetNotebooksResult> Invoke(GetNotebooksInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetNotebooksResult> getNotebooks(GetNotebooksArgs args, InvokeOptions options)
public static Output<GetNotebooksResult> getNotebooks(GetNotebooksArgs args, InvokeOptions options)

fn::invoke:
  function: snowflake:index/getNotebooks:getNotebooks
  arguments:
    # arguments dictionary

The following arguments are supported:

Like string: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
Limit GetNotebooksLimit: Limits the number of rows returned. If the limit.from is set, then the limit will start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with starts_with or like.
StartsWith string: Filters the output with case-sensitive characters indicating the beginning of the object name.
WithDescribe bool: (Default: true) Runs DESC NOTEBOOK for each notebook returned by SHOW NOTEBOOKS. The output of describe is saved to the description field. By default this value is set to true.

Like string: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
Limit GetNotebooksLimit: Limits the number of rows returned. If the limit.from is set, then the limit will start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with starts_with or like.
StartsWith string: Filters the output with case-sensitive characters indicating the beginning of the object name.
WithDescribe bool: (Default: true) Runs DESC NOTEBOOK for each notebook returned by SHOW NOTEBOOKS. The output of describe is saved to the description field. By default this value is set to true.

like String: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
limit GetNotebooksLimit: Limits the number of rows returned. If the limit.from is set, then the limit will start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with starts_with or like.
startsWith String: Filters the output with case-sensitive characters indicating the beginning of the object name.
withDescribe Boolean: (Default: true) Runs DESC NOTEBOOK for each notebook returned by SHOW NOTEBOOKS. The output of describe is saved to the description field. By default this value is set to true.

like string: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
limit GetNotebooksLimit: Limits the number of rows returned. If the limit.from is set, then the limit will start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with starts_with or like.
startsWith string: Filters the output with case-sensitive characters indicating the beginning of the object name.
withDescribe boolean: (Default: true) Runs DESC NOTEBOOK for each notebook returned by SHOW NOTEBOOKS. The output of describe is saved to the description field. By default this value is set to true.

like str: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
limit GetNotebooksLimit: Limits the number of rows returned. If the limit.from is set, then the limit will start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with starts_with or like.
starts_with str: Filters the output with case-sensitive characters indicating the beginning of the object name.
with_describe bool: (Default: true) Runs DESC NOTEBOOK for each notebook returned by SHOW NOTEBOOKS. The output of describe is saved to the description field. By default this value is set to true.

like String: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
limit Property Map: Limits the number of rows returned. If the limit.from is set, then the limit will start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with starts_with or like.
startsWith String: Filters the output with case-sensitive characters indicating the beginning of the object name.
withDescribe Boolean: (Default: true) Runs DESC NOTEBOOK for each notebook returned by SHOW NOTEBOOKS. The output of describe is saved to the description field. By default this value is set to true.

getNotebooks Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
Notebooks List<GetNotebooksNotebook>: Holds the aggregated output of all notebooks details queries.
Like string: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
Limit GetNotebooksLimit: Limits the number of rows returned. If the limit.from is set, then the limit will start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with starts_with or like.
StartsWith string: Filters the output with case-sensitive characters indicating the beginning of the object name.
WithDescribe bool: (Default: true) Runs DESC NOTEBOOK for each notebook returned by SHOW NOTEBOOKS. The output of describe is saved to the description field. By default this value is set to true.

Id string: The provider-assigned unique ID for this managed resource.
Notebooks []GetNotebooksNotebook: Holds the aggregated output of all notebooks details queries.
Like string: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
Limit GetNotebooksLimit: Limits the number of rows returned. If the limit.from is set, then the limit will start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with starts_with or like.
StartsWith string: Filters the output with case-sensitive characters indicating the beginning of the object name.
WithDescribe bool: (Default: true) Runs DESC NOTEBOOK for each notebook returned by SHOW NOTEBOOKS. The output of describe is saved to the description field. By default this value is set to true.

id String: The provider-assigned unique ID for this managed resource.
notebooks List<GetNotebooksNotebook>: Holds the aggregated output of all notebooks details queries.
like String: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
limit GetNotebooksLimit: Limits the number of rows returned. If the limit.from is set, then the limit will start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with starts_with or like.
startsWith String: Filters the output with case-sensitive characters indicating the beginning of the object name.
withDescribe Boolean: (Default: true) Runs DESC NOTEBOOK for each notebook returned by SHOW NOTEBOOKS. The output of describe is saved to the description field. By default this value is set to true.

id string: The provider-assigned unique ID for this managed resource.
notebooks GetNotebooksNotebook[]: Holds the aggregated output of all notebooks details queries.
like string: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
limit GetNotebooksLimit: Limits the number of rows returned. If the limit.from is set, then the limit will start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with starts_with or like.
startsWith string: Filters the output with case-sensitive characters indicating the beginning of the object name.
withDescribe boolean: (Default: true) Runs DESC NOTEBOOK for each notebook returned by SHOW NOTEBOOKS. The output of describe is saved to the description field. By default this value is set to true.

id str: The provider-assigned unique ID for this managed resource.
notebooks Sequence[GetNotebooksNotebook]: Holds the aggregated output of all notebooks details queries.
like str: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
limit GetNotebooksLimit: Limits the number of rows returned. If the limit.from is set, then the limit will start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with starts_with or like.
starts_with str: Filters the output with case-sensitive characters indicating the beginning of the object name.
with_describe bool: (Default: true) Runs DESC NOTEBOOK for each notebook returned by SHOW NOTEBOOKS. The output of describe is saved to the description field. By default this value is set to true.

id String: The provider-assigned unique ID for this managed resource.
notebooks List<Property Map>: Holds the aggregated output of all notebooks details queries.
like String: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
limit Property Map: Limits the number of rows returned. If the limit.from is set, then the limit will start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with starts_with or like.
startsWith String: Filters the output with case-sensitive characters indicating the beginning of the object name.
withDescribe Boolean: (Default: true) Runs DESC NOTEBOOK for each notebook returned by SHOW NOTEBOOKS. The output of describe is saved to the description field. By default this value is set to true.

Supporting Types

GetNotebooksLimit

Rows int: The maximum number of rows to return.
From string: Specifies a case-sensitive pattern that is used to match object name. After the first match, the limit on the number of rows will be applied.

Rows int: The maximum number of rows to return.
From string: Specifies a case-sensitive pattern that is used to match object name. After the first match, the limit on the number of rows will be applied.

rows Integer: The maximum number of rows to return.
from String: Specifies a case-sensitive pattern that is used to match object name. After the first match, the limit on the number of rows will be applied.

rows number: The maximum number of rows to return.
from string: Specifies a case-sensitive pattern that is used to match object name. After the first match, the limit on the number of rows will be applied.

rows int: The maximum number of rows to return.
from_ str: Specifies a case-sensitive pattern that is used to match object name. After the first match, the limit on the number of rows will be applied.

rows Number: The maximum number of rows to return.
from String: Specifies a case-sensitive pattern that is used to match object name. After the first match, the limit on the number of rows will be applied.