listings

Creates, updates, deletes, gets or lists a listings resource.

Overview

Name	listings
Type	Resource
Id	aws.datazone.listings

Fields

The following fields are returned by SELECT queries:

get_listing

Name	Datatype	Description
id	string	The ID of the listing. (pattern: <code>[a-zA-Z0-9_-]{1,36}</code>)
name	string	The name of the listing.
created_at	string (date-time)	The timestamp of when the listing was created.
created_by	string	The Amazon DataZone user who created the listing.
description	string	The description of the listing.
domain_id	string	The ID of the Amazon DataZone domain. (pattern: <code>dzd[-][a-zA-Z0-9-]{1,36}</code>)
item	object	The details of a listing.
listing_revision	string	The revision of a listing.
status	string	The status of the listing. (CREATING, ACTIVE, INACTIVE)
updated_at	string (date-time)	The timestamp of when the listing was updated.
updated_by	string	The Amazon DataZone user who updated the listing.

search_listings

Name	Datatype	Description
asset_listing	object	The asset listing included in the results of the SearchListings action.
data_product_listing	object	The data product listing.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_listing	select	domain_identifier, identifier, region	listingRevision	Gets a listing (a record of an asset at a given time). If you specify a listing version, only details that are specific to that version are returned.
search_listings	select	domain_identifier, region		Searches listings in Amazon DataZone. SearchListings is a powerful capability that enables users to discover and explore published assets and data products across their organization. It provides both basic and advanced search functionality, allowing users to find resources based on names, descriptions, metadata, and other attributes. SearchListings also supports filtering using various criteria such as creation date, owner, or status. This API is essential for making the wealth of data resources in an organization discoverable and usable, helping users find the right data for their needs quickly and efficiently. SearchListings returns results in a paginated format. When the result set is large, the response will include a nextToken, which can be used to retrieve the next page of results. The SearchListings API gives users flexibility in specifying what kind of search is run. To run a standard free-text search, the searchText parameter must be supplied. By default, all searchable fields are indexed for semantic search and will return semantic matches for SearchListings queries. To prevent semantic search indexing for a custom form attribute, see the CreateFormType API documentation. To run a lexical search query, enclose the query with double quotes (""). This will disable semantic search even for fields that have semantic search enabled and will only return results that contain the keywords wrapped by double quotes (order of tokens in the query is not enforced). Free-text search is supported for all attributes annotated with @amazon.datazone#searchable. To run a filtered search, provide filter clause using the filters parameter. To filter on glossary terms, use the special attribute __DataZoneGlossaryTerms. To filter on an indexed numeric attribute (i.e., a numeric attribute annotated with @amazon.datazone#sortable), provide a filter using the intValue parameter. The filters parameter can also be used to run more advanced free-text searches that target specific attributes (attributes must be annotated with @amazon.datazone#searchable for free-text search). Create/update timestamp filtering is supported using the special creationTime/lastUpdatedTime attributes. Filter types can be mixed and matched to power complex queries. To find out whether an attribute has been annotated and indexed for a given search type, use the GetFormType API to retrieve the form containing the attribute.
create_listing_change_set	insert	domain_identifier, region, entityIdentifier, entityType, action		Publishes a listing (a record of an asset at a given time) or removes a listing from the catalog.
delete_listing	delete	domain_identifier, identifier, region		Deletes a listing (a record of an asset at a given time).

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
domain_identifier	string	The ID of the Amazon DataZone domain.
identifier	string	The ID of the listing to be deleted.
region	string	AWS region (default: us-east-1)
listingRevision	string	The revision of the listing.

SELECT examples

get_listing

Gets a listing (a record of an asset at a given time). If you specify a listing version, only details that are specific to that version are returned.

SELECT
id,
name,
created_at,
created_by,
description,
domain_id,
item,
listing_revision,
status,
updated_at,
updated_by
FROM aws.datazone.listings
WHERE domain_identifier = '{{ domain_identifier }}' -- required
AND identifier = '{{ identifier }}' -- required
AND region = '{{ region }}' -- required
AND listingRevision = '{{ listingRevision }}'
;

search_listings

Searches listings in Amazon DataZone. SearchListings is a powerful capability that enables users to discover and explore published assets and data products across their organization. It provides both basic and advanced search functionality, allowing users to find resources based on names, descriptions, metadata, and other attributes. SearchListings also supports filtering using various criteria such as creation date, owner, or status. This API is essential for making the wealth of data resources in an organization discoverable and usable, helping users find the right data for their needs quickly and efficiently. SearchListings returns results in a paginated format. When the result set is large, the response will include a nextToken, which can be used to retrieve the next page of results. The SearchListings API gives users flexibility in specifying what kind of search is run. To run a standard free-text search, the searchText parameter must be supplied. By default, all searchable fields are indexed for semantic search and will return semantic matches for SearchListings queries. To prevent semantic search indexing for a custom form attribute, see the CreateFormType API documentation. To run a lexical search query, enclose the query with double quotes (""). This will disable semantic search even for fields that have semantic search enabled and will only return results that contain the keywords wrapped by double quotes (order of tokens in the query is not enforced). Free-text search is supported for all attributes annotated with @amazon.datazone#searchable. To run a filtered search, provide filter clause using the filters parameter. To filter on glossary terms, use the special attribute __DataZoneGlossaryTerms. To filter on an indexed numeric attribute (i.e., a numeric attribute annotated with @amazon.datazone#sortable), provide a filter using the intValue parameter. The filters parameter can also be used to run more advanced free-text searches that target specific attributes (attributes must be annotated with @amazon.datazone#searchable for free-text search). Create/update timestamp filtering is supported using the special creationTime/lastUpdatedTime attributes. Filter types can be mixed and matched to power complex queries. To find out whether an attribute has been annotated and indexed for a given search type, use the GetFormType API to retrieve the form containing the attribute.

SELECT
asset_listing,
data_product_listing
FROM aws.datazone.listings
WHERE domain_identifier = '{{ domain_identifier }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples

create_listing_change_set

Publishes a listing (a record of an asset at a given time) or removes a listing from the catalog.

INSERT INTO aws.datazone.listings (
entityIdentifier,
entityType,
entityRevision,
action,
clientToken,
domain_identifier,
region
)
SELECT 
'{{ entityIdentifier }}' /* required */,
'{{ entityType }}' /* required */,
'{{ entityRevision }}',
'{{ action }}' /* required */,
'{{ clientToken }}',
'{{ domain_identifier }}',
'{{ region }}'
RETURNING
listing_id,
listing_revision,
status
;

Manifest

# Description fields are for documentation purposes
- name: listings
props:
  - name: domain_identifier
    value: "{{ domain_identifier }}"
    description: Required parameter for the listings resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the listings resource.
  - name: entityIdentifier
    value: "{{ entityIdentifier }}"
  - name: entityType
    value: "{{ entityType }}"
    valid_values: ['ASSET', 'DATA_PRODUCT']
  - name: entityRevision
    value: "{{ entityRevision }}"
  - name: action
    value: "{{ action }}"
    valid_values: ['PUBLISH', 'UNPUBLISH']
  - name: clientToken
    value: "{{ clientToken }}"

DELETE examples

delete_listing

Deletes a listing (a record of an asset at a given time).

DELETE FROM aws.datazone.listings
WHERE domain_identifier = '{{ domain_identifier }}' --required
AND identifier = '{{ identifier }}' --required
AND region = '{{ region }}' --required
;