1. Packages
  2. Snowflake Provider
  3. API Docs
  4. getStages
Viewing docs for Snowflake v2.13.0
published on Thursday, Feb 26, 2026 by Pulumi
snowflake logo
Viewing docs for Snowflake v2.13.0
published on Thursday, Feb 26, 2026 by Pulumi

    !> 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 stages. Filtering is aligned with the current possibilities for SHOW STAGES query. The results of SHOW and DESCRIBE are encapsulated in one output collection stages.

    Using getStages

    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 getStages(args: GetStagesArgs, opts?: InvokeOptions): Promise<GetStagesResult>
    function getStagesOutput(args: GetStagesOutputArgs, opts?: InvokeOptions): Output<GetStagesResult>
    def get_stages(in_: Optional[GetStagesIn] = None,
                   like: Optional[str] = None,
                   with_describe: Optional[bool] = None,
                   opts: Optional[InvokeOptions] = None) -> GetStagesResult
    def get_stages_output(in_: Optional[pulumi.Input[GetStagesInArgs]] = None,
                   like: Optional[pulumi.Input[str]] = None,
                   with_describe: Optional[pulumi.Input[bool]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetStagesResult]
    func GetStages(ctx *Context, args *GetStagesArgs, opts ...InvokeOption) (*GetStagesResult, error)
    func GetStagesOutput(ctx *Context, args *GetStagesOutputArgs, opts ...InvokeOption) GetStagesResultOutput

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

    public static class GetStages 
    {
        public static Task<GetStagesResult> InvokeAsync(GetStagesArgs args, InvokeOptions? opts = null)
        public static Output<GetStagesResult> Invoke(GetStagesInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetStagesResult> getStages(GetStagesArgs args, InvokeOptions options)
    public static Output<GetStagesResult> getStages(GetStagesArgs args, InvokeOptions options)
    
    fn::invoke:
      function: snowflake:index/getStages:getStages
      arguments:
        # arguments dictionary

    The following arguments are supported:

    In GetStagesIn
    IN clause to filter the list of objects
    Like string
    Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
    WithDescribe bool
    (Default: true) Runs DESC STAGE for each stage returned by SHOW STAGES. The output of describe is saved to the describe_output field. By default this value is set to true.
    In GetStagesIn
    IN clause to filter the list of objects
    Like string
    Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
    WithDescribe bool
    (Default: true) Runs DESC STAGE for each stage returned by SHOW STAGES. The output of describe is saved to the describe_output field. By default this value is set to true.
    in GetStagesIn
    IN clause to filter the list of objects
    like String
    Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
    withDescribe Boolean
    (Default: true) Runs DESC STAGE for each stage returned by SHOW STAGES. The output of describe is saved to the describe_output field. By default this value is set to true.
    in GetStagesIn
    IN clause to filter the list of objects
    like string
    Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
    withDescribe boolean
    (Default: true) Runs DESC STAGE for each stage returned by SHOW STAGES. The output of describe is saved to the describe_output field. By default this value is set to true.
    in_ GetStagesIn
    IN clause to filter the list of objects
    like str
    Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
    with_describe bool
    (Default: true) Runs DESC STAGE for each stage returned by SHOW STAGES. The output of describe is saved to the describe_output 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 _).
    withDescribe Boolean
    (Default: true) Runs DESC STAGE for each stage returned by SHOW STAGES. The output of describe is saved to the describe_output field. By default this value is set to true.

    getStages Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Stages List<GetStagesStage>
    Holds the aggregated output of all stages details queries.
    In GetStagesIn
    IN clause to filter the list of objects
    Like string
    Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
    WithDescribe bool
    (Default: true) Runs DESC STAGE for each stage returned by SHOW STAGES. The output of describe is saved to the describe_output field. By default this value is set to true.
    Id string
    The provider-assigned unique ID for this managed resource.
    Stages []GetStagesStage
    Holds the aggregated output of all stages details queries.
    In GetStagesIn
    IN clause to filter the list of objects
    Like string
    Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
    WithDescribe bool
    (Default: true) Runs DESC STAGE for each stage returned by SHOW STAGES. The output of describe is saved to the describe_output field. By default this value is set to true.
    id String
    The provider-assigned unique ID for this managed resource.
    stages List<GetStagesStage>
    Holds the aggregated output of all stages details queries.
    in GetStagesIn
    IN clause to filter the list of objects
    like String
    Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
    withDescribe Boolean
    (Default: true) Runs DESC STAGE for each stage returned by SHOW STAGES. The output of describe is saved to the describe_output field. By default this value is set to true.
    id string
    The provider-assigned unique ID for this managed resource.
    stages GetStagesStage[]
    Holds the aggregated output of all stages details queries.
    in GetStagesIn
    IN clause to filter the list of objects
    like string
    Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
    withDescribe boolean
    (Default: true) Runs DESC STAGE for each stage returned by SHOW STAGES. The output of describe is saved to the describe_output field. By default this value is set to true.
    id str
    The provider-assigned unique ID for this managed resource.
    stages Sequence[GetStagesStage]
    Holds the aggregated output of all stages details queries.
    in_ GetStagesIn
    IN clause to filter the list of objects
    like str
    Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
    with_describe bool
    (Default: true) Runs DESC STAGE for each stage returned by SHOW STAGES. The output of describe is saved to the describe_output field. By default this value is set to true.
    id String
    The provider-assigned unique ID for this managed resource.
    stages List<Property Map>
    Holds the aggregated output of all stages details queries.
    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 _).
    withDescribe Boolean
    (Default: true) Runs DESC STAGE for each stage returned by SHOW STAGES. The output of describe is saved to the describe_output field. By default this value is set to true.

    Supporting Types

    GetStagesIn

    Account bool
    Returns records for the entire account.
    Application string
    Returns records for the specified application.
    ApplicationPackage string
    Returns records for the specified application package.
    Database string
    Returns records for the current database in use or for a specified database.
    Schema string
    Returns records for the current schema in use or a specified schema. Use fully qualified name.
    Account bool
    Returns records for the entire account.
    Application string
    Returns records for the specified application.
    ApplicationPackage string
    Returns records for the specified application package.
    Database string
    Returns records for the current database in use or for a specified database.
    Schema string
    Returns records for the current schema in use or a specified schema. Use fully qualified name.
    account Boolean
    Returns records for the entire account.
    application String
    Returns records for the specified application.
    applicationPackage String
    Returns records for the specified application package.
    database String
    Returns records for the current database in use or for a specified database.
    schema String
    Returns records for the current schema in use or a specified schema. Use fully qualified name.
    account boolean
    Returns records for the entire account.
    application string
    Returns records for the specified application.
    applicationPackage string
    Returns records for the specified application package.
    database string
    Returns records for the current database in use or for a specified database.
    schema string
    Returns records for the current schema in use or a specified schema. Use fully qualified name.
    account bool
    Returns records for the entire account.
    application str
    Returns records for the specified application.
    application_package str
    Returns records for the specified application package.
    database str
    Returns records for the current database in use or for a specified database.
    schema str
    Returns records for the current schema in use or a specified schema. Use fully qualified name.
    account Boolean
    Returns records for the entire account.
    application String
    Returns records for the specified application.
    applicationPackage String
    Returns records for the specified application package.
    database String
    Returns records for the current database in use or for a specified database.
    schema String
    Returns records for the current schema in use or a specified schema. Use fully qualified name.

    GetStagesStage

    DescribeOutputs List<GetStagesStageDescribeOutput>
    Holds the output of DESCRIBE STAGE.
    ShowOutputs List<GetStagesStageShowOutput>
    Holds the output of SHOW STAGES.
    DescribeOutputs []GetStagesStageDescribeOutput
    Holds the output of DESCRIBE STAGE.
    ShowOutputs []GetStagesStageShowOutput
    Holds the output of SHOW STAGES.
    describeOutputs List<GetStagesStageDescribeOutput>
    Holds the output of DESCRIBE STAGE.
    showOutputs List<GetStagesStageShowOutput>
    Holds the output of SHOW STAGES.
    describeOutputs GetStagesStageDescribeOutput[]
    Holds the output of DESCRIBE STAGE.
    showOutputs GetStagesStageShowOutput[]
    Holds the output of SHOW STAGES.
    describe_outputs Sequence[GetStagesStageDescribeOutput]
    Holds the output of DESCRIBE STAGE.
    show_outputs Sequence[GetStagesStageShowOutput]
    Holds the output of SHOW STAGES.
    describeOutputs List<Property Map>
    Holds the output of DESCRIBE STAGE.
    showOutputs List<Property Map>
    Holds the output of SHOW STAGES.

    GetStagesStageDescribeOutput

    GetStagesStageDescribeOutputDirectoryTable

    autoRefresh Boolean
    enable Boolean
    lastRefreshedOn String
    autoRefresh boolean
    enable boolean
    lastRefreshedOn string
    autoRefresh Boolean
    enable Boolean
    lastRefreshedOn String

    GetStagesStageDescribeOutputFileFormat

    GetStagesStageDescribeOutputFileFormatAvro

    Compression string
    NullIfs List<string>
    ReplaceInvalidCharacters bool
    TrimSpace bool
    Type string
    compression String
    nullIfs List<String>
    replaceInvalidCharacters Boolean
    trimSpace Boolean
    type String
    compression string
    nullIfs string[]
    replaceInvalidCharacters boolean
    trimSpace boolean
    type string
    compression String
    nullIfs List<String>
    replaceInvalidCharacters Boolean
    trimSpace Boolean
    type String

    GetStagesStageDescribeOutputFileFormatCsv

    GetStagesStageDescribeOutputFileFormatJson

    GetStagesStageDescribeOutputFileFormatOrc

    NullIfs List<string>
    ReplaceInvalidCharacters bool
    TrimSpace bool
    Type string
    nullIfs List<String>
    replaceInvalidCharacters Boolean
    trimSpace Boolean
    type String
    nullIfs string[]
    replaceInvalidCharacters boolean
    trimSpace boolean
    type string
    nullIfs List<String>
    replaceInvalidCharacters Boolean
    trimSpace Boolean
    type String

    GetStagesStageDescribeOutputFileFormatParquet

    GetStagesStageDescribeOutputFileFormatXml

    GetStagesStageDescribeOutputLocation

    AwsAccessPointArn string
    Urls List<string>
    AwsAccessPointArn string
    Urls []string
    awsAccessPointArn String
    urls List<String>
    awsAccessPointArn string
    urls string[]
    aws_access_point_arn str
    urls Sequence[str]
    awsAccessPointArn String
    urls List<String>

    GetStagesStageShowOutput

    Cloud string
    Comment string
    CreatedOn string
    DatabaseName string
    DirectoryEnabled bool
    Endpoint string
    HasCredentials bool
    HasEncryptionKey bool
    Name string
    Owner string
    OwnerRoleType string
    Region string
    SchemaName string
    StorageIntegration string
    Type string
    Url string
    Cloud string
    Comment string
    CreatedOn string
    DatabaseName string
    DirectoryEnabled bool
    Endpoint string
    HasCredentials bool
    HasEncryptionKey bool
    Name string
    Owner string
    OwnerRoleType string
    Region string
    SchemaName string
    StorageIntegration string
    Type string
    Url string
    cloud String
    comment String
    createdOn String
    databaseName String
    directoryEnabled Boolean
    endpoint String
    hasCredentials Boolean
    hasEncryptionKey Boolean
    name String
    owner String
    ownerRoleType String
    region String
    schemaName String
    storageIntegration String
    type String
    url String
    cloud string
    comment string
    createdOn string
    databaseName string
    directoryEnabled boolean
    endpoint string
    hasCredentials boolean
    hasEncryptionKey boolean
    name string
    owner string
    ownerRoleType string
    region string
    schemaName string
    storageIntegration string
    type string
    url string
    cloud String
    comment String
    createdOn String
    databaseName String
    directoryEnabled Boolean
    endpoint String
    hasCredentials Boolean
    hasEncryptionKey Boolean
    name String
    owner String
    ownerRoleType String
    region String
    schemaName String
    storageIntegration String
    type String
    url String

    Package Details

    Repository
    Snowflake pulumi/pulumi-snowflake
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the snowflake Terraform Provider.
    snowflake logo
    Viewing docs for Snowflake v2.13.0
    published on Thursday, Feb 26, 2026 by Pulumi
      Try Pulumi Cloud free. Your team will thank you.