getCortexAgents

Snowflake v2.17.0, Jun 25 26

Viewing docs for Snowflake v2.17.0
published on Thursday, Jun 25, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-snowflake

Viewing docs for Snowflake v2.17.0
published on Thursday, Jun 25, 2026 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 previewFeaturesEnabled 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 Cortex agents. Filtering is aligned with the current possibilities for SHOW AGENTS query. The results of SHOW and DESCRIBE are encapsulated in one output collection cortexAgents.

Using getCortexAgents

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 getCortexAgents(args: GetCortexAgentsArgs, opts?: InvokeOptions): Promise<GetCortexAgentsResult>
function getCortexAgentsOutput(args: GetCortexAgentsOutputArgs, opts?: InvokeOptions): Output<GetCortexAgentsResult>

def get_cortex_agents(in_: Optional[GetCortexAgentsIn] = None,
                      like: Optional[str] = None,
                      limit: Optional[GetCortexAgentsLimit] = None,
                      starts_with: Optional[str] = None,
                      with_describe: Optional[bool] = None,
                      opts: Optional[InvokeOptions] = None) -> GetCortexAgentsResult
def get_cortex_agents_output(in_: pulumi.Input[Optional[GetCortexAgentsInArgs]] = None,
                      like: pulumi.Input[Optional[str]] = None,
                      limit: pulumi.Input[Optional[GetCortexAgentsLimitArgs]] = None,
                      starts_with: pulumi.Input[Optional[str]] = None,
                      with_describe: pulumi.Input[Optional[bool]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetCortexAgentsResult]

func GetCortexAgents(ctx *Context, args *GetCortexAgentsArgs, opts ...InvokeOption) (*GetCortexAgentsResult, error)
func GetCortexAgentsOutput(ctx *Context, args *GetCortexAgentsOutputArgs, opts ...InvokeOption) GetCortexAgentsResultOutput

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

public static class GetCortexAgents 
{
    public static Task<GetCortexAgentsResult> InvokeAsync(GetCortexAgentsArgs args, InvokeOptions? opts = null)
    public static Output<GetCortexAgentsResult> Invoke(GetCortexAgentsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetCortexAgentsResult> getCortexAgents(GetCortexAgentsArgs args, InvokeOptions options)
public static Output<GetCortexAgentsResult> getCortexAgents(GetCortexAgentsArgs args, InvokeOptions options)

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

data "snowflake_getcortexagents" "name" {
    # arguments
}

The following arguments are supported:

In GetCortexAgentsIn: IN clause to filter the list of objects
Like string: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
Limit GetCortexAgentsLimit: 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 startsWith or like.
StartsWith string: Filters the output with case-sensitive characters indicating the beginning of the object name.
WithDescribe bool: (Default: true) Runs DESC AGENT for each object returned by SHOW AGENTS. The output of describe is saved to the describeOutput field. By default this value is set to true.

In GetCortexAgentsIn: IN clause to filter the list of objects
Like string: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
Limit GetCortexAgentsLimit: 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 startsWith or like.
StartsWith string: Filters the output with case-sensitive characters indicating the beginning of the object name.
WithDescribe bool: (Default: true) Runs DESC AGENT for each object returned by SHOW AGENTS. The output of describe is saved to the describeOutput field. By default this value is set to true.

in object: IN clause to filter the list of objects
like string: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
limit object: 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 startsWith or like.
starts_with string: Filters the output with case-sensitive characters indicating the beginning of the object name.
with_describe bool: (Default: true) Runs DESC AGENT for each object returned by SHOW AGENTS. The output of describe is saved to the describeOutput field. By default this value is set to true.

in GetCortexAgentsIn: IN clause to filter the list of objects
like String: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
limit GetCortexAgentsLimit: 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 startsWith or like.
startsWith String: Filters the output with case-sensitive characters indicating the beginning of the object name.
withDescribe Boolean: (Default: true) Runs DESC AGENT for each object returned by SHOW AGENTS. The output of describe is saved to the describeOutput field. By default this value is set to true.

in GetCortexAgentsIn: IN clause to filter the list of objects
like string: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
limit GetCortexAgentsLimit: 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 startsWith or like.
startsWith string: Filters the output with case-sensitive characters indicating the beginning of the object name.
withDescribe boolean: (Default: true) Runs DESC AGENT for each object returned by SHOW AGENTS. The output of describe is saved to the describeOutput field. By default this value is set to true.

in_ GetCortexAgentsIn: IN clause to filter the list of objects
like str: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
limit GetCortexAgentsLimit: 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 startsWith 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 AGENT for each object returned by SHOW AGENTS. The output of describe is saved to the describeOutput field. By default this value is set to true.

in Property Map: IN clause to filter the list of objects
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 startsWith or like.
startsWith String: Filters the output with case-sensitive characters indicating the beginning of the object name.
withDescribe Boolean: (Default: true) Runs DESC AGENT for each object returned by SHOW AGENTS. The output of describe is saved to the describeOutput field. By default this value is set to true.