snowflake.getServices

Explore with Pulumi AI

Snowflake v2.1.0 published on Thursday, Jun 26, 2025 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 services. Filtering is aligned with the current possibilities for SHOW SERVICES query. The results of SHOW and DESCRIBE are encapsulated in one output collection services. By default, the results includes both services and job services. If you want to filter only services or job service, set service_type with a relevant option.

Using getServices

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 getServices(args: GetServicesArgs, opts?: InvokeOptions): Promise<GetServicesResult>
function getServicesOutput(args: GetServicesOutputArgs, opts?: InvokeOptions): Output<GetServicesResult>

def get_services(in_: Optional[GetServicesIn] = None,
                 like: Optional[str] = None,
                 limit: Optional[GetServicesLimit] = None,
                 service_type: Optional[str] = None,
                 starts_with: Optional[str] = None,
                 with_describe: Optional[bool] = None,
                 opts: Optional[InvokeOptions] = None) -> GetServicesResult
def get_services_output(in_: Optional[pulumi.Input[GetServicesInArgs]] = None,
                 like: Optional[pulumi.Input[str]] = None,
                 limit: Optional[pulumi.Input[GetServicesLimitArgs]] = None,
                 service_type: Optional[pulumi.Input[str]] = None,
                 starts_with: Optional[pulumi.Input[str]] = None,
                 with_describe: Optional[pulumi.Input[bool]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetServicesResult]

func GetServices(ctx *Context, args *GetServicesArgs, opts ...InvokeOption) (*GetServicesResult, error)
func GetServicesOutput(ctx *Context, args *GetServicesOutputArgs, opts ...InvokeOption) GetServicesResultOutput

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

public static class GetServices 
{
    public static Task<GetServicesResult> InvokeAsync(GetServicesArgs args, InvokeOptions? opts = null)
    public static Output<GetServicesResult> Invoke(GetServicesInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetServicesResult> getServices(GetServicesArgs args, InvokeOptions options)
public static Output<GetServicesResult> getServices(GetServicesArgs args, InvokeOptions options)

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

The following arguments are supported:

In GetServicesIn: 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 GetServicesLimit: 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.
ServiceType string: (Default: ALL) The type filtering of SHOW SERVICES results. ALL returns both services and job services. JOBS_ONLY returns only job services (JOB option in SQL). SERVICES_ONLY returns only services (EXCLUDE_JOBS option in SQL).
StartsWith string: Filters the output with case-sensitive characters indicating the beginning of the object name.
WithDescribe bool: (Default: true) Runs DESC SERVICE for each service returned by SHOW SERVICES. The output of describe is saved to the description field. By default this value is set to true.

In GetServicesIn: 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 GetServicesLimit: 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.
ServiceType string: (Default: ALL) The type filtering of SHOW SERVICES results. ALL returns both services and job services. JOBS_ONLY returns only job services (JOB option in SQL). SERVICES_ONLY returns only services (EXCLUDE_JOBS option in SQL).
StartsWith string: Filters the output with case-sensitive characters indicating the beginning of the object name.
WithDescribe bool: (Default: true) Runs DESC SERVICE for each service returned by SHOW SERVICES. The output of describe is saved to the description field. By default this value is set to true.

in GetServicesIn: 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 GetServicesLimit: 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.
serviceType String: (Default: ALL) The type filtering of SHOW SERVICES results. ALL returns both services and job services. JOBS_ONLY returns only job services (JOB option in SQL). SERVICES_ONLY returns only services (EXCLUDE_JOBS option in SQL).
startsWith String: Filters the output with case-sensitive characters indicating the beginning of the object name.
withDescribe Boolean: (Default: true) Runs DESC SERVICE for each service returned by SHOW SERVICES. The output of describe is saved to the description field. By default this value is set to true.

in GetServicesIn: 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 GetServicesLimit: 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.
serviceType string: (Default: ALL) The type filtering of SHOW SERVICES results. ALL returns both services and job services. JOBS_ONLY returns only job services (JOB option in SQL). SERVICES_ONLY returns only services (EXCLUDE_JOBS option in SQL).
startsWith string: Filters the output with case-sensitive characters indicating the beginning of the object name.
withDescribe boolean: (Default: true) Runs DESC SERVICE for each service returned by SHOW SERVICES. The output of describe is saved to the description field. By default this value is set to true.

in_ GetServicesIn: 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 GetServicesLimit: 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.
service_type str: (Default: ALL) The type filtering of SHOW SERVICES results. ALL returns both services and job services. JOBS_ONLY returns only job services (JOB option in SQL). SERVICES_ONLY returns only services (EXCLUDE_JOBS option in SQL).
starts_with str: Filters the output with case-sensitive characters indicating the beginning of the object name.
with_describe bool: (Default: true) Runs DESC SERVICE for each service returned by SHOW SERVICES. The output of describe is saved to the description 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 starts_with or like.
serviceType String: (Default: ALL) The type filtering of SHOW SERVICES results. ALL returns both services and job services. JOBS_ONLY returns only job services (JOB option in SQL). SERVICES_ONLY returns only services (EXCLUDE_JOBS option in SQL).
startsWith String: Filters the output with case-sensitive characters indicating the beginning of the object name.
withDescribe Boolean: (Default: true) Runs DESC SERVICE for each service returned by SHOW SERVICES. The output of describe is saved to the description field. By default this value is set to true.

getServices Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
Services List<GetServicesService>: Holds the aggregated output of all services details queries.
In GetServicesIn: 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 GetServicesLimit: 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.
ServiceType string: (Default: ALL) The type filtering of SHOW SERVICES results. ALL returns both services and job services. JOBS_ONLY returns only job services (JOB option in SQL). SERVICES_ONLY returns only services (EXCLUDE_JOBS option in SQL).
StartsWith string: Filters the output with case-sensitive characters indicating the beginning of the object name.
WithDescribe bool: (Default: true) Runs DESC SERVICE for each service returned by SHOW SERVICES. 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.
Services []GetServicesService: Holds the aggregated output of all services details queries.
In GetServicesIn: 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 GetServicesLimit: 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.
ServiceType string: (Default: ALL) The type filtering of SHOW SERVICES results. ALL returns both services and job services. JOBS_ONLY returns only job services (JOB option in SQL). SERVICES_ONLY returns only services (EXCLUDE_JOBS option in SQL).
StartsWith string: Filters the output with case-sensitive characters indicating the beginning of the object name.
WithDescribe bool: (Default: true) Runs DESC SERVICE for each service returned by SHOW SERVICES. 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.
services List<GetServicesService>: Holds the aggregated output of all services details queries.
in GetServicesIn: 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 GetServicesLimit: 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.
serviceType String: (Default: ALL) The type filtering of SHOW SERVICES results. ALL returns both services and job services. JOBS_ONLY returns only job services (JOB option in SQL). SERVICES_ONLY returns only services (EXCLUDE_JOBS option in SQL).
startsWith String: Filters the output with case-sensitive characters indicating the beginning of the object name.
withDescribe Boolean: (Default: true) Runs DESC SERVICE for each service returned by SHOW SERVICES. 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.
services GetServicesService[]: Holds the aggregated output of all services details queries.
in GetServicesIn: 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 GetServicesLimit: 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.
serviceType string: (Default: ALL) The type filtering of SHOW SERVICES results. ALL returns both services and job services. JOBS_ONLY returns only job services (JOB option in SQL). SERVICES_ONLY returns only services (EXCLUDE_JOBS option in SQL).
startsWith string: Filters the output with case-sensitive characters indicating the beginning of the object name.
withDescribe boolean: (Default: true) Runs DESC SERVICE for each service returned by SHOW SERVICES. 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.
services Sequence[GetServicesService]: Holds the aggregated output of all services details queries.
in_ GetServicesIn: 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 GetServicesLimit: 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.
service_type str: (Default: ALL) The type filtering of SHOW SERVICES results. ALL returns both services and job services. JOBS_ONLY returns only job services (JOB option in SQL). SERVICES_ONLY returns only services (EXCLUDE_JOBS option in SQL).
starts_with str: Filters the output with case-sensitive characters indicating the beginning of the object name.
with_describe bool: (Default: true) Runs DESC SERVICE for each service returned by SHOW SERVICES. 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.
services List<Property Map>: Holds the aggregated output of all services 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 _).
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.
serviceType String: (Default: ALL) The type filtering of SHOW SERVICES results. ALL returns both services and job services. JOBS_ONLY returns only job services (JOB option in SQL). SERVICES_ONLY returns only services (EXCLUDE_JOBS option in SQL).
startsWith String: Filters the output with case-sensitive characters indicating the beginning of the object name.
withDescribe Boolean: (Default: true) Runs DESC SERVICE for each service returned by SHOW SERVICES. The output of describe is saved to the description field. By default this value is set to true.

Supporting Types

GetServicesIn

Account bool: Returns records for the entire account.
ComputePool string: Returns records for the specified compute pool.
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.
ComputePool string: Returns records for the specified compute pool.
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.
computePool String: Returns records for the specified compute pool.
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.
computePool string: Returns records for the specified compute pool.
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.
compute_pool str: Returns records for the specified compute pool.
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.
computePool String: Returns records for the specified compute pool.
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.

GetServicesLimit

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.