1. Packages
  2. Snowflake Provider
  3. API Docs
  4. getWarehouses
Snowflake v1.2.0 published on Monday, Apr 14, 2025 by Pulumi

snowflake.getWarehouses

Explore with Pulumi AI

Snowflake v1.2.0 published on Monday, Apr 14, 2025 by Pulumi

Data source used to get details of filtered warehouses. Filtering is aligned with the current possibilities for SHOW WAREHOUSES query (only like is supported). The results of SHOW, DESCRIBE, and SHOW PARAMETERS IN are encapsulated in one output collection.

Using getWarehouses

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 getWarehouses(args: GetWarehousesArgs, opts?: InvokeOptions): Promise<GetWarehousesResult>
function getWarehousesOutput(args: GetWarehousesOutputArgs, opts?: InvokeOptions): Output<GetWarehousesResult>
Copy
def get_warehouses(like: Optional[str] = None,
                   with_describe: Optional[bool] = None,
                   with_parameters: Optional[bool] = None,
                   opts: Optional[InvokeOptions] = None) -> GetWarehousesResult
def get_warehouses_output(like: Optional[pulumi.Input[str]] = None,
                   with_describe: Optional[pulumi.Input[bool]] = None,
                   with_parameters: Optional[pulumi.Input[bool]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetWarehousesResult]
Copy
func GetWarehouses(ctx *Context, args *GetWarehousesArgs, opts ...InvokeOption) (*GetWarehousesResult, error)
func GetWarehousesOutput(ctx *Context, args *GetWarehousesOutputArgs, opts ...InvokeOption) GetWarehousesResultOutput
Copy

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

public static class GetWarehouses 
{
    public static Task<GetWarehousesResult> InvokeAsync(GetWarehousesArgs args, InvokeOptions? opts = null)
    public static Output<GetWarehousesResult> Invoke(GetWarehousesInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetWarehousesResult> getWarehouses(GetWarehousesArgs args, InvokeOptions options)
public static Output<GetWarehousesResult> getWarehouses(GetWarehousesArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: snowflake:index/getWarehouses:getWarehouses
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Like string
Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
WithDescribe bool
(Default: true) Runs DESC WAREHOUSE for each warehouse returned by SHOW WAREHOUSES. The output of describe is saved to the description field. By default this value is set to true.
WithParameters bool
(Default: true) Runs SHOW PARAMETERS FOR WAREHOUSE for each warehouse returned by SHOW WAREHOUSES. The output of describe is saved to the parameters field as a map. By default this value is set to true.
Like string
Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
WithDescribe bool
(Default: true) Runs DESC WAREHOUSE for each warehouse returned by SHOW WAREHOUSES. The output of describe is saved to the description field. By default this value is set to true.
WithParameters bool
(Default: true) Runs SHOW PARAMETERS FOR WAREHOUSE for each warehouse returned by SHOW WAREHOUSES. The output of describe is saved to the parameters field as a map. By default this value is set to true.
like String
Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
withDescribe Boolean
(Default: true) Runs DESC WAREHOUSE for each warehouse returned by SHOW WAREHOUSES. The output of describe is saved to the description field. By default this value is set to true.
withParameters Boolean
(Default: true) Runs SHOW PARAMETERS FOR WAREHOUSE for each warehouse returned by SHOW WAREHOUSES. The output of describe is saved to the parameters field as a map. By default this value is set to true.
like string
Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
withDescribe boolean
(Default: true) Runs DESC WAREHOUSE for each warehouse returned by SHOW WAREHOUSES. The output of describe is saved to the description field. By default this value is set to true.
withParameters boolean
(Default: true) Runs SHOW PARAMETERS FOR WAREHOUSE for each warehouse returned by SHOW WAREHOUSES. The output of describe is saved to the parameters field as a map. By default this value is set to true.
like str
Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
with_describe bool
(Default: true) Runs DESC WAREHOUSE for each warehouse returned by SHOW WAREHOUSES. The output of describe is saved to the description field. By default this value is set to true.
with_parameters bool
(Default: true) Runs SHOW PARAMETERS FOR WAREHOUSE for each warehouse returned by SHOW WAREHOUSES. The output of describe is saved to the parameters field as a map. By default this value is set to true.
like String
Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
withDescribe Boolean
(Default: true) Runs DESC WAREHOUSE for each warehouse returned by SHOW WAREHOUSES. The output of describe is saved to the description field. By default this value is set to true.
withParameters Boolean
(Default: true) Runs SHOW PARAMETERS FOR WAREHOUSE for each warehouse returned by SHOW WAREHOUSES. The output of describe is saved to the parameters field as a map. By default this value is set to true.

getWarehouses Result

The following output properties are available:

Id string
The provider-assigned unique ID for this managed resource.
Warehouses List<GetWarehousesWarehouse>
Holds the aggregated output of all warehouse details queries.
Like string
Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
WithDescribe bool
(Default: true) Runs DESC WAREHOUSE for each warehouse returned by SHOW WAREHOUSES. The output of describe is saved to the description field. By default this value is set to true.
WithParameters bool
(Default: true) Runs SHOW PARAMETERS FOR WAREHOUSE for each warehouse returned by SHOW WAREHOUSES. The output of describe is saved to the parameters field as a map. By default this value is set to true.
Id string
The provider-assigned unique ID for this managed resource.
Warehouses []GetWarehousesWarehouse
Holds the aggregated output of all warehouse details queries.
Like string
Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
WithDescribe bool
(Default: true) Runs DESC WAREHOUSE for each warehouse returned by SHOW WAREHOUSES. The output of describe is saved to the description field. By default this value is set to true.
WithParameters bool
(Default: true) Runs SHOW PARAMETERS FOR WAREHOUSE for each warehouse returned by SHOW WAREHOUSES. The output of describe is saved to the parameters field as a map. By default this value is set to true.
id String
The provider-assigned unique ID for this managed resource.
warehouses List<GetWarehousesWarehouse>
Holds the aggregated output of all warehouse details queries.
like String
Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
withDescribe Boolean
(Default: true) Runs DESC WAREHOUSE for each warehouse returned by SHOW WAREHOUSES. The output of describe is saved to the description field. By default this value is set to true.
withParameters Boolean
(Default: true) Runs SHOW PARAMETERS FOR WAREHOUSE for each warehouse returned by SHOW WAREHOUSES. The output of describe is saved to the parameters field as a map. By default this value is set to true.
id string
The provider-assigned unique ID for this managed resource.
warehouses GetWarehousesWarehouse[]
Holds the aggregated output of all warehouse details queries.
like string
Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
withDescribe boolean
(Default: true) Runs DESC WAREHOUSE for each warehouse returned by SHOW WAREHOUSES. The output of describe is saved to the description field. By default this value is set to true.
withParameters boolean
(Default: true) Runs SHOW PARAMETERS FOR WAREHOUSE for each warehouse returned by SHOW WAREHOUSES. The output of describe is saved to the parameters field as a map. By default this value is set to true.
id str
The provider-assigned unique ID for this managed resource.
warehouses Sequence[GetWarehousesWarehouse]
Holds the aggregated output of all warehouse details queries.
like str
Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
with_describe bool
(Default: true) Runs DESC WAREHOUSE for each warehouse returned by SHOW WAREHOUSES. The output of describe is saved to the description field. By default this value is set to true.
with_parameters bool
(Default: true) Runs SHOW PARAMETERS FOR WAREHOUSE for each warehouse returned by SHOW WAREHOUSES. The output of describe is saved to the parameters field as a map. By default this value is set to true.
id String
The provider-assigned unique ID for this managed resource.
warehouses List<Property Map>
Holds the aggregated output of all warehouse details queries.
like String
Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
withDescribe Boolean
(Default: true) Runs DESC WAREHOUSE for each warehouse returned by SHOW WAREHOUSES. The output of describe is saved to the description field. By default this value is set to true.
withParameters Boolean
(Default: true) Runs SHOW PARAMETERS FOR WAREHOUSE for each warehouse returned by SHOW WAREHOUSES. The output of describe is saved to the parameters field as a map. By default this value is set to true.

Supporting Types

GetWarehousesWarehouse

DescribeOutputs This property is required. List<GetWarehousesWarehouseDescribeOutput>
Holds the output of DESCRIBE WAREHOUSE.
Parameters This property is required. List<GetWarehousesWarehouseParameter>
Holds the output of SHOW PARAMETERS FOR WAREHOUSE.
ShowOutputs This property is required. List<GetWarehousesWarehouseShowOutput>
Holds the output of SHOW WAREHOUSES.
DescribeOutputs This property is required. []GetWarehousesWarehouseDescribeOutput
Holds the output of DESCRIBE WAREHOUSE.
Parameters This property is required. []GetWarehousesWarehouseParameter
Holds the output of SHOW PARAMETERS FOR WAREHOUSE.
ShowOutputs This property is required. []GetWarehousesWarehouseShowOutput
Holds the output of SHOW WAREHOUSES.
describeOutputs This property is required. List<GetWarehousesWarehouseDescribeOutput>
Holds the output of DESCRIBE WAREHOUSE.
parameters This property is required. List<GetWarehousesWarehouseParameter>
Holds the output of SHOW PARAMETERS FOR WAREHOUSE.
showOutputs This property is required. List<GetWarehousesWarehouseShowOutput>
Holds the output of SHOW WAREHOUSES.
describeOutputs This property is required. GetWarehousesWarehouseDescribeOutput[]
Holds the output of DESCRIBE WAREHOUSE.
parameters This property is required. GetWarehousesWarehouseParameter[]
Holds the output of SHOW PARAMETERS FOR WAREHOUSE.
showOutputs This property is required. GetWarehousesWarehouseShowOutput[]
Holds the output of SHOW WAREHOUSES.
describe_outputs This property is required. Sequence[GetWarehousesWarehouseDescribeOutput]
Holds the output of DESCRIBE WAREHOUSE.
parameters This property is required. Sequence[GetWarehousesWarehouseParameter]
Holds the output of SHOW PARAMETERS FOR WAREHOUSE.
show_outputs This property is required. Sequence[GetWarehousesWarehouseShowOutput]
Holds the output of SHOW WAREHOUSES.
describeOutputs This property is required. List<Property Map>
Holds the output of DESCRIBE WAREHOUSE.
parameters This property is required. List<Property Map>
Holds the output of SHOW PARAMETERS FOR WAREHOUSE.
showOutputs This property is required. List<Property Map>
Holds the output of SHOW WAREHOUSES.

GetWarehousesWarehouseDescribeOutput

CreatedOn This property is required. string
Kind This property is required. string
Name This property is required. string
CreatedOn This property is required. string
Kind This property is required. string
Name This property is required. string
createdOn This property is required. String
kind This property is required. String
name This property is required. String
createdOn This property is required. string
kind This property is required. string
name This property is required. string
created_on This property is required. str
kind This property is required. str
name This property is required. str
createdOn This property is required. String
kind This property is required. String
name This property is required. String

GetWarehousesWarehouseParameter

GetWarehousesWarehouseParameterMaxConcurrencyLevel

Default This property is required. string
Description This property is required. string
Key This property is required. string
Level This property is required. string
Value This property is required. string
Default This property is required. string
Description This property is required. string
Key This property is required. string
Level This property is required. string
Value This property is required. string
default_ This property is required. String
description This property is required. String
key This property is required. String
level This property is required. String
value This property is required. String
default This property is required. string
description This property is required. string
key This property is required. string
level This property is required. string
value This property is required. string
default This property is required. str
description This property is required. str
key This property is required. str
level This property is required. str
value This property is required. str
default This property is required. String
description This property is required. String
key This property is required. String
level This property is required. String
value This property is required. String

GetWarehousesWarehouseParameterStatementQueuedTimeoutInSecond

Default This property is required. string
Description This property is required. string
Key This property is required. string
Level This property is required. string
Value This property is required. string
Default This property is required. string
Description This property is required. string
Key This property is required. string
Level This property is required. string
Value This property is required. string
default_ This property is required. String
description This property is required. String
key This property is required. String
level This property is required. String
value This property is required. String
default This property is required. string
description This property is required. string
key This property is required. string
level This property is required. string
value This property is required. string
default This property is required. str
description This property is required. str
key This property is required. str
level This property is required. str
value This property is required. str
default This property is required. String
description This property is required. String
key This property is required. String
level This property is required. String
value This property is required. String

GetWarehousesWarehouseParameterStatementTimeoutInSecond

Default This property is required. string
Description This property is required. string
Key This property is required. string
Level This property is required. string
Value This property is required. string
Default This property is required. string
Description This property is required. string
Key This property is required. string
Level This property is required. string
Value This property is required. string
default_ This property is required. String
description This property is required. String
key This property is required. String
level This property is required. String
value This property is required. String
default This property is required. string
description This property is required. string
key This property is required. string
level This property is required. string
value This property is required. string
default This property is required. str
description This property is required. str
key This property is required. str
level This property is required. str
value This property is required. str
default This property is required. String
description This property is required. String
key This property is required. String
level This property is required. String
value This property is required. String

GetWarehousesWarehouseShowOutput

AutoResume This property is required. bool
AutoSuspend This property is required. int
Available This property is required. double
Comment This property is required. string
CreatedOn This property is required. string
EnableQueryAcceleration This property is required. bool
IsCurrent This property is required. bool
IsDefault This property is required. bool
MaxClusterCount This property is required. int
MinClusterCount This property is required. int
Name This property is required. string
Other This property is required. double
Owner This property is required. string
OwnerRoleType This property is required. string
Provisioning This property is required. double
QueryAccelerationMaxScaleFactor This property is required. int
Queued This property is required. int
Quiescing This property is required. double
ResourceMonitor This property is required. string
ResumedOn This property is required. string
Running This property is required. int
ScalingPolicy This property is required. string
Size This property is required. string
StartedClusters This property is required. int
State This property is required. string
Type This property is required. string
UpdatedOn This property is required. string
AutoResume This property is required. bool
AutoSuspend This property is required. int
Available This property is required. float64
Comment This property is required. string
CreatedOn This property is required. string
EnableQueryAcceleration This property is required. bool
IsCurrent This property is required. bool
IsDefault This property is required. bool
MaxClusterCount This property is required. int
MinClusterCount This property is required. int
Name This property is required. string
Other This property is required. float64
Owner This property is required. string
OwnerRoleType This property is required. string
Provisioning This property is required. float64
QueryAccelerationMaxScaleFactor This property is required. int
Queued This property is required. int
Quiescing This property is required. float64
ResourceMonitor This property is required. string
ResumedOn This property is required. string
Running This property is required. int
ScalingPolicy This property is required. string
Size This property is required. string
StartedClusters This property is required. int
State This property is required. string
Type This property is required. string
UpdatedOn This property is required. string
autoResume This property is required. Boolean
autoSuspend This property is required. Integer
available This property is required. Double
comment This property is required. String
createdOn This property is required. String
enableQueryAcceleration This property is required. Boolean
isCurrent This property is required. Boolean
isDefault This property is required. Boolean
maxClusterCount This property is required. Integer
minClusterCount This property is required. Integer
name This property is required. String
other This property is required. Double
owner This property is required. String
ownerRoleType This property is required. String
provisioning This property is required. Double
queryAccelerationMaxScaleFactor This property is required. Integer
queued This property is required. Integer
quiescing This property is required. Double
resourceMonitor This property is required. String
resumedOn This property is required. String
running This property is required. Integer
scalingPolicy This property is required. String
size This property is required. String
startedClusters This property is required. Integer
state This property is required. String
type This property is required. String
updatedOn This property is required. String
autoResume This property is required. boolean
autoSuspend This property is required. number
available This property is required. number
comment This property is required. string
createdOn This property is required. string
enableQueryAcceleration This property is required. boolean
isCurrent This property is required. boolean
isDefault This property is required. boolean
maxClusterCount This property is required. number
minClusterCount This property is required. number
name This property is required. string
other This property is required. number
owner This property is required. string
ownerRoleType This property is required. string
provisioning This property is required. number
queryAccelerationMaxScaleFactor This property is required. number
queued This property is required. number
quiescing This property is required. number
resourceMonitor This property is required. string
resumedOn This property is required. string
running This property is required. number
scalingPolicy This property is required. string
size This property is required. string
startedClusters This property is required. number
state This property is required. string
type This property is required. string
updatedOn This property is required. string
auto_resume This property is required. bool
auto_suspend This property is required. int
available This property is required. float
comment This property is required. str
created_on This property is required. str
enable_query_acceleration This property is required. bool
is_current This property is required. bool
is_default This property is required. bool
max_cluster_count This property is required. int
min_cluster_count This property is required. int
name This property is required. str
other This property is required. float
owner This property is required. str
owner_role_type This property is required. str
provisioning This property is required. float
query_acceleration_max_scale_factor This property is required. int
queued This property is required. int
quiescing This property is required. float
resource_monitor This property is required. str
resumed_on This property is required. str
running This property is required. int
scaling_policy This property is required. str
size This property is required. str
started_clusters This property is required. int
state This property is required. str
type This property is required. str
updated_on This property is required. str
autoResume This property is required. Boolean
autoSuspend This property is required. Number
available This property is required. Number
comment This property is required. String
createdOn This property is required. String
enableQueryAcceleration This property is required. Boolean
isCurrent This property is required. Boolean
isDefault This property is required. Boolean
maxClusterCount This property is required. Number
minClusterCount This property is required. Number
name This property is required. String
other This property is required. Number
owner This property is required. String
ownerRoleType This property is required. String
provisioning This property is required. Number
queryAccelerationMaxScaleFactor This property is required. Number
queued This property is required. Number
quiescing This property is required. Number
resourceMonitor This property is required. String
resumedOn This property is required. String
running This property is required. Number
scalingPolicy This property is required. String
size This property is required. String
startedClusters This property is required. Number
state This property is required. String
type This property is required. String
updatedOn This property is required. String

Package Details

Repository
Snowflake pulumi/pulumi-snowflake
License
Apache-2.0
Notes
This Pulumi package is based on the snowflake Terraform Provider.
Snowflake v1.2.0 published on Monday, Apr 14, 2025 by Pulumi