!> Preview Feature This data source is a preview feature and is subject to breaking changes, even without bumping the major version. To use this feature, add snowflake_listings_datasource to preview_features_enabled field in the provider configuration. Read more about preview features in our documentation.
Note This data source focuses on base query commands (SHOW LISTINGS and DESCRIBE LISTING). Other query commands like SHOW AVAILABLE LISTINGS, DESCRIBE AVAILABLE LISTING, SHOW LISTING OFFERS, SHOW OFFERS, SHOW PRICING PLANS, and SHOW VERSIONS IN LISTING are not included and will be added depending on demand.
Data source used to get details of filtered listings. Filtering is aligned with the current possibilities for SHOW LISTINGS query (like, starts_with, and limit are supported). The results of SHOW and DESCRIBE are encapsulated in one output collection.
Using getListings
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 getListings(args: GetListingsArgs, opts?: InvokeOptions): Promise<GetListingsResult>
function getListingsOutput(args: GetListingsOutputArgs, opts?: InvokeOptions): Output<GetListingsResult>def get_listings(like: Optional[str] = None,
limit: Optional[GetListingsLimit] = None,
starts_with: Optional[str] = None,
with_describe: Optional[bool] = None,
opts: Optional[InvokeOptions] = None) -> GetListingsResult
def get_listings_output(like: Optional[pulumi.Input[str]] = None,
limit: Optional[pulumi.Input[GetListingsLimitArgs]] = None,
starts_with: Optional[pulumi.Input[str]] = None,
with_describe: Optional[pulumi.Input[bool]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetListingsResult]func GetListings(ctx *Context, args *GetListingsArgs, opts ...InvokeOption) (*GetListingsResult, error)
func GetListingsOutput(ctx *Context, args *GetListingsOutputArgs, opts ...InvokeOption) GetListingsResultOutput> Note: This function is named GetListings in the Go SDK.
public static class GetListings
{
public static Task<GetListingsResult> InvokeAsync(GetListingsArgs args, InvokeOptions? opts = null)
public static Output<GetListingsResult> Invoke(GetListingsInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetListingsResult> getListings(GetListingsArgs args, InvokeOptions options)
public static Output<GetListingsResult> getListings(GetListingsArgs args, InvokeOptions options)
fn::invoke:
function: snowflake:index/getListings:getListings
arguments:
# arguments dictionaryThe following arguments are supported:
- Like string
- Filters the output with case-insensitive pattern, with support for SQL wildcard characters (
%and_). - Limit
Get
Listings Limit - Limits the number of rows returned. If the
limit.fromis 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 withstarts_withorlike. - Starts
With string - Filters the output with case-sensitive characters indicating the beginning of the object name.
- With
Describe bool - (Default:
true) Runs DESC LISTING for each listing returned by SHOW LISTINGS. 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
Get
Listings Limit - Limits the number of rows returned. If the
limit.fromis 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 withstarts_withorlike. - Starts
With string - Filters the output with case-sensitive characters indicating the beginning of the object name.
- With
Describe bool - (Default:
true) Runs DESC LISTING for each listing returned by SHOW LISTINGS. 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
Get
Listings Limit - Limits the number of rows returned. If the
limit.fromis 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 withstarts_withorlike. - starts
With String - Filters the output with case-sensitive characters indicating the beginning of the object name.
- with
Describe Boolean - (Default:
true) Runs DESC LISTING for each listing returned by SHOW LISTINGS. 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
Get
Listings Limit - Limits the number of rows returned. If the
limit.fromis 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 withstarts_withorlike. - starts
With string - Filters the output with case-sensitive characters indicating the beginning of the object name.
- with
Describe boolean - (Default:
true) Runs DESC LISTING for each listing returned by SHOW LISTINGS. 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
Get
Listings Limit - Limits the number of rows returned. If the
limit.fromis 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 withstarts_withorlike. - starts_
with str - Filters the output with case-sensitive characters indicating the beginning of the object name.
- with_
describe bool - (Default:
true) Runs DESC LISTING for each listing returned by SHOW LISTINGS. 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.fromis 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 withstarts_withorlike. - starts
With String - Filters the output with case-sensitive characters indicating the beginning of the object name.
- with
Describe Boolean - (Default:
true) Runs DESC LISTING for each listing returned by SHOW LISTINGS. The output of describe is saved to the description field. By default this value is set to true.
getListings Result
The following output properties are available:
- Id string
- The provider-assigned unique ID for this managed resource.
- Listings
List<Get
Listings Listing> - Holds the aggregated output of all listings details queries.
- Like string
- Filters the output with case-insensitive pattern, with support for SQL wildcard characters (
%and_). - Limit
Get
Listings Limit - Limits the number of rows returned. If the
limit.fromis 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 withstarts_withorlike. - Starts
With string - Filters the output with case-sensitive characters indicating the beginning of the object name.
- With
Describe bool - (Default:
true) Runs DESC LISTING for each listing returned by SHOW LISTINGS. 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.
- Listings
[]Get
Listings Listing - Holds the aggregated output of all listings details queries.
- Like string
- Filters the output with case-insensitive pattern, with support for SQL wildcard characters (
%and_). - Limit
Get
Listings Limit - Limits the number of rows returned. If the
limit.fromis 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 withstarts_withorlike. - Starts
With string - Filters the output with case-sensitive characters indicating the beginning of the object name.
- With
Describe bool - (Default:
true) Runs DESC LISTING for each listing returned by SHOW LISTINGS. 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.
- listings
List<Get
Listings Listing> - Holds the aggregated output of all listings details queries.
- like String
- Filters the output with case-insensitive pattern, with support for SQL wildcard characters (
%and_). - limit
Get
Listings Limit - Limits the number of rows returned. If the
limit.fromis 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 withstarts_withorlike. - starts
With String - Filters the output with case-sensitive characters indicating the beginning of the object name.
- with
Describe Boolean - (Default:
true) Runs DESC LISTING for each listing returned by SHOW LISTINGS. 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.
- listings
Get
Listings Listing[] - Holds the aggregated output of all listings details queries.
- like string
- Filters the output with case-insensitive pattern, with support for SQL wildcard characters (
%and_). - limit
Get
Listings Limit - Limits the number of rows returned. If the
limit.fromis 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 withstarts_withorlike. - starts
With string - Filters the output with case-sensitive characters indicating the beginning of the object name.
- with
Describe boolean - (Default:
true) Runs DESC LISTING for each listing returned by SHOW LISTINGS. 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.
- listings
Sequence[Get
Listings Listing] - Holds the aggregated output of all listings details queries.
- like str
- Filters the output with case-insensitive pattern, with support for SQL wildcard characters (
%and_). - limit
Get
Listings Limit - Limits the number of rows returned. If the
limit.fromis 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 withstarts_withorlike. - starts_
with str - Filters the output with case-sensitive characters indicating the beginning of the object name.
- with_
describe bool - (Default:
true) Runs DESC LISTING for each listing returned by SHOW LISTINGS. 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.
- listings List<Property Map>
- Holds the aggregated output of all listings 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.fromis 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 withstarts_withorlike. - starts
With String - Filters the output with case-sensitive characters indicating the beginning of the object name.
- with
Describe Boolean - (Default:
true) Runs DESC LISTING for each listing returned by SHOW LISTINGS. The output of describe is saved to the description field. By default this value is set to true.
Supporting Types
GetListingsLimit
GetListingsListing
- Describe
Outputs List<GetListings Listing Describe Output> - Holds the output of DESCRIBE LISTING.
- Show
Outputs List<GetListings Listing Show Output> - Holds the output of SHOW LISTINGS.
- Describe
Outputs []GetListings Listing Describe Output - Holds the output of DESCRIBE LISTING.
- Show
Outputs []GetListings Listing Show Output - Holds the output of SHOW LISTINGS.
- describe
Outputs List<GetListings Listing Describe Output> - Holds the output of DESCRIBE LISTING.
- show
Outputs List<GetListings Listing Show Output> - Holds the output of SHOW LISTINGS.
- describe
Outputs GetListings Listing Describe Output[] - Holds the output of DESCRIBE LISTING.
- show
Outputs GetListings Listing Show Output[] - Holds the output of SHOW LISTINGS.
- describe_
outputs Sequence[GetListings Listing Describe Output] - Holds the output of DESCRIBE LISTING.
- show_
outputs Sequence[GetListings Listing Show Output] - Holds the output of SHOW LISTINGS.
- describe
Outputs List<Property Map> - Holds the output of DESCRIBE LISTING.
- show
Outputs List<Property Map> - Holds the output of SHOW LISTINGS.
GetListingsListingDescribeOutput
- Application
Package string - Approver
Contact string - Business
Needs string - Categories string
- Comment string
- Created
On string - Customized
Contact stringInfo - Data
Attributes string - Data
Dictionary string - Data
Preview string - Description string
- Distribution string
- Global
Name string - Is
Application bool - Is
By boolRequest - Is
Limited boolTrial - Is
Monetized bool - Is
Mountless boolQueryable - bool
- Is
Targeted bool - Last
Committed stringVersion Alias - Last
Committed stringVersion Name - Last
Committed stringVersion Uri - Legacy
Uniform stringListing Locators - Limited
Trial stringPlan - Listing
Terms string - Live
Version stringUri - Manifest
Yaml string - Monetization
Display stringOrder - Name string
- Organization
Profile stringName - Owner string
- Owner
Role stringType - Profile string
- Published
On string - Published
Version stringAlias - Published
Version stringName - Published
Version stringUri - Refresh
Schedule string - Refresh
Type string - Regions string
- Rejection
Reason string - Request
Approval stringType - Resources string
- Retried
On string - Review
State string - Revisions string
- Scheduled
Drop stringTime - string
- State string
- Subtitle string
- Support
Contact string - Target
Accounts string - Title string
- Trial
Details string - Uniform
Listing stringLocator - Unpublished
By stringAdmin Reasons - Updated
On string - Usage
Examples string
- Application
Package string - Approver
Contact string - Business
Needs string - Categories string
- Comment string
- Created
On string - Customized
Contact stringInfo - Data
Attributes string - Data
Dictionary string - Data
Preview string - Description string
- Distribution string
- Global
Name string - Is
Application bool - Is
By boolRequest - Is
Limited boolTrial - Is
Monetized bool - Is
Mountless boolQueryable - bool
- Is
Targeted bool - Last
Committed stringVersion Alias - Last
Committed stringVersion Name - Last
Committed stringVersion Uri - Legacy
Uniform stringListing Locators - Limited
Trial stringPlan - Listing
Terms string - Live
Version stringUri - Manifest
Yaml string - Monetization
Display stringOrder - Name string
- Organization
Profile stringName - Owner string
- Owner
Role stringType - Profile string
- Published
On string - Published
Version stringAlias - Published
Version stringName - Published
Version stringUri - Refresh
Schedule string - Refresh
Type string - Regions string
- Rejection
Reason string - Request
Approval stringType - Resources string
- Retried
On string - Review
State string - Revisions string
- Scheduled
Drop stringTime - string
- State string
- Subtitle string
- Support
Contact string - Target
Accounts string - Title string
- Trial
Details string - Uniform
Listing stringLocator - Unpublished
By stringAdmin Reasons - Updated
On string - Usage
Examples string
- application
Package String - approver
Contact String - business
Needs String - categories String
- comment String
- created
On String - customized
Contact StringInfo - data
Attributes String - data
Dictionary String - data
Preview String - description String
- distribution String
- global
Name String - is
Application Boolean - is
By BooleanRequest - is
Limited BooleanTrial - is
Monetized Boolean - is
Mountless BooleanQueryable - Boolean
- is
Targeted Boolean - last
Committed StringVersion Alias - last
Committed StringVersion Name - last
Committed StringVersion Uri - legacy
Uniform StringListing Locators - limited
Trial StringPlan - listing
Terms String - live
Version StringUri - manifest
Yaml String - monetization
Display StringOrder - name String
- organization
Profile StringName - owner String
- owner
Role StringType - profile String
- published
On String - published
Version StringAlias - published
Version StringName - published
Version StringUri - refresh
Schedule String - refresh
Type String - regions String
- rejection
Reason String - request
Approval StringType - resources String
- retried
On String - review
State String - revisions String
- scheduled
Drop StringTime - String
- state String
- subtitle String
- support
Contact String - target
Accounts String - title String
- trial
Details String - uniform
Listing StringLocator - unpublished
By StringAdmin Reasons - updated
On String - usage
Examples String
- application
Package string - approver
Contact string - business
Needs string - categories string
- comment string
- created
On string - customized
Contact stringInfo - data
Attributes string - data
Dictionary string - data
Preview string - description string
- distribution string
- global
Name string - is
Application boolean - is
By booleanRequest - is
Limited booleanTrial - is
Monetized boolean - is
Mountless booleanQueryable - boolean
- is
Targeted boolean - last
Committed stringVersion Alias - last
Committed stringVersion Name - last
Committed stringVersion Uri - legacy
Uniform stringListing Locators - limited
Trial stringPlan - listing
Terms string - live
Version stringUri - manifest
Yaml string - monetization
Display stringOrder - name string
- organization
Profile stringName - owner string
- owner
Role stringType - profile string
- published
On string - published
Version stringAlias - published
Version stringName - published
Version stringUri - refresh
Schedule string - refresh
Type string - regions string
- rejection
Reason string - request
Approval stringType - resources string
- retried
On string - review
State string - revisions string
- scheduled
Drop stringTime - string
- state string
- subtitle string
- support
Contact string - target
Accounts string - title string
- trial
Details string - uniform
Listing stringLocator - unpublished
By stringAdmin Reasons - updated
On string - usage
Examples string
- application_
package str - approver_
contact str - business_
needs str - categories str
- comment str
- created_
on str - customized_
contact_ strinfo - data_
attributes str - data_
dictionary str - data_
preview str - description str
- distribution str
- global_
name str - is_
application bool - is_
by_ boolrequest - is_
limited_ booltrial - is_
monetized bool - is_
mountless_ boolqueryable - bool
- is_
targeted bool - last_
committed_ strversion_ alias - last_
committed_ strversion_ name - last_
committed_ strversion_ uri - legacy_
uniform_ strlisting_ locators - limited_
trial_ strplan - listing_
terms str - live_
version_ struri - manifest_
yaml str - monetization_
display_ strorder - name str
- organization_
profile_ strname - owner str
- owner_
role_ strtype - profile str
- published_
on str - published_
version_ stralias - published_
version_ strname - published_
version_ struri - refresh_
schedule str - refresh_
type str - regions str
- rejection_
reason str - request_
approval_ strtype - resources str
- retried_
on str - review_
state str - revisions str
- scheduled_
drop_ strtime - str
- state str
- subtitle str
- support_
contact str - target_
accounts str - title str
- trial_
details str - uniform_
listing_ strlocator - unpublished_
by_ stradmin_ reasons - updated_
on str - usage_
examples str
- application
Package String - approver
Contact String - business
Needs String - categories String
- comment String
- created
On String - customized
Contact StringInfo - data
Attributes String - data
Dictionary String - data
Preview String - description String
- distribution String
- global
Name String - is
Application Boolean - is
By BooleanRequest - is
Limited BooleanTrial - is
Monetized Boolean - is
Mountless BooleanQueryable - Boolean
- is
Targeted Boolean - last
Committed StringVersion Alias - last
Committed StringVersion Name - last
Committed StringVersion Uri - legacy
Uniform StringListing Locators - limited
Trial StringPlan - listing
Terms String - live
Version StringUri - manifest
Yaml String - monetization
Display StringOrder - name String
- organization
Profile StringName - owner String
- owner
Role StringType - profile String
- published
On String - published
Version StringAlias - published
Version StringName - published
Version StringUri - refresh
Schedule String - refresh
Type String - regions String
- rejection
Reason String - request
Approval StringType - resources String
- retried
On String - review
State String - revisions String
- scheduled
Drop StringTime - String
- state String
- subtitle String
- support
Contact String - target
Accounts String - title String
- trial
Details String - uniform
Listing StringLocator - unpublished
By StringAdmin Reasons - updated
On String - usage
Examples String
GetListingsListingShowOutput
- Comment string
- Created
On string - Detailed
Target stringAccounts - Distribution string
- Global
Name string - Is
Application bool - Is
By boolRequest - Is
Limited boolTrial - Is
Monetized bool - Is
Mountless boolQueryable - Is
Targeted bool - Name string
- Organization
Profile stringName - Owner string
- Owner
Role stringType - Profile string
- Published
On string - Regions string
- Rejected
On string - Review
State string - State string
- Subtitle string
- Target
Accounts string - Title string
- Uniform
Listing stringLocator - Updated
On string
- Comment string
- Created
On string - Detailed
Target stringAccounts - Distribution string
- Global
Name string - Is
Application bool - Is
By boolRequest - Is
Limited boolTrial - Is
Monetized bool - Is
Mountless boolQueryable - Is
Targeted bool - Name string
- Organization
Profile stringName - Owner string
- Owner
Role stringType - Profile string
- Published
On string - Regions string
- Rejected
On string - Review
State string - State string
- Subtitle string
- Target
Accounts string - Title string
- Uniform
Listing stringLocator - Updated
On string
- comment String
- created
On String - detailed
Target StringAccounts - distribution String
- global
Name String - is
Application Boolean - is
By BooleanRequest - is
Limited BooleanTrial - is
Monetized Boolean - is
Mountless BooleanQueryable - is
Targeted Boolean - name String
- organization
Profile StringName - owner String
- owner
Role StringType - profile String
- published
On String - regions String
- rejected
On String - review
State String - state String
- subtitle String
- target
Accounts String - title String
- uniform
Listing StringLocator - updated
On String
- comment string
- created
On string - detailed
Target stringAccounts - distribution string
- global
Name string - is
Application boolean - is
By booleanRequest - is
Limited booleanTrial - is
Monetized boolean - is
Mountless booleanQueryable - is
Targeted boolean - name string
- organization
Profile stringName - owner string
- owner
Role stringType - profile string
- published
On string - regions string
- rejected
On string - review
State string - state string
- subtitle string
- target
Accounts string - title string
- uniform
Listing stringLocator - updated
On string
- comment str
- created_
on str - detailed_
target_ straccounts - distribution str
- global_
name str - is_
application bool - is_
by_ boolrequest - is_
limited_ booltrial - is_
monetized bool - is_
mountless_ boolqueryable - is_
targeted bool - name str
- organization_
profile_ strname - owner str
- owner_
role_ strtype - profile str
- published_
on str - regions str
- rejected_
on str - review_
state str - state str
- subtitle str
- target_
accounts str - title str
- uniform_
listing_ strlocator - updated_
on str
- comment String
- created
On String - detailed
Target StringAccounts - distribution String
- global
Name String - is
Application Boolean - is
By BooleanRequest - is
Limited BooleanTrial - is
Monetized Boolean - is
Mountless BooleanQueryable - is
Targeted Boolean - name String
- organization
Profile StringName - owner String
- owner
Role StringType - profile String
- published
On String - regions String
- rejected
On String - review
State String - state String
- subtitle String
- target
Accounts String - title String
- uniform
Listing StringLocator - updated
On String
Package Details
- Repository
- Snowflake pulumi/pulumi-snowflake
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
snowflakeTerraform Provider.
