Accepts automatically generated business-friendly metadata for your Amazon DataZone assets.

Accepts a subscription request to a specific asset.

Adds the owner of an entity (a domain unit).

Adds a policy grant (an authorization policy) to a specified entity, including domain units, environment blueprint configurations, or environment profiles.

Associates the environment role in Amazon DataZone.

Associates governed terms with an asset.

Cancels the metadata generation run.

Prerequisites:

• The run must exist and be in a cancelable status (e.g., SUBMITTED, IN_PROGRESS).

• Runs in SUCCEEDED status cannot be cancelled.

• User must have access to the run and cancel permissions.

Cancels the subscription to the specified asset.

Creates an account pool.

Creates an asset in Amazon DataZone catalog.

Before creating assets, make sure that the following requirements are met:

• --domain-identifier must refer to an existing domain.

• --owning-project-identifier must be a valid project within the domain.

• Asset type must be created beforehand using create-asset-type, or be a supported system-defined type. For more information, see create-asset-type. * --type-revision (if used) must match a valid revision of the asset type.

• formsInput is required when it is associated as required in the asset-type. For more information, see create-form-type.

• Form content must include all required fields as per the form schema (e.g., bucketArn).

You must invoke the following pre-requisite commands before invoking this API:

CreateFormType CreateAssetType

Creates a data asset filter.

Asset filters provide a sophisticated way to create controlled views of data assets by selecting specific columns or applying row-level filters. This capability is crucial for organizations that need to share data while maintaining security and privacy controls. For example, your database might be filtered to show only non-PII fields to certain users, or sales data might be filtered by region for different regional teams. Asset filters enable fine-grained access control while maintaining a single source of truth.

Prerequisites:

• A valid domain (--domain-identifier) must exist.

• A data asset (--asset-identifier) must already be created under that domain.

• The asset must have the referenced columns available in its schema for column-based filtering.

• You cannot specify both (columnConfiguration, rowConfiguration)at the same time.

Creates a revision of the asset.

Asset revisions represent new versions of existing assets, capturing changes to either the underlying data or its metadata. They maintain a historical record of how assets evolve over time, who made changes, and when those changes occurred. This versioning capability is crucial for governance and compliance, allowing organizations to track changes, understand their impact, and roll back if necessary.

Prerequisites:

• Asset must already exist in the domain with identifier.

• formsInput is required when asset has the form type. typeRevision should be the latest version of form type.

• The form content must include all required fields (e.g., bucketArn for S3ObjectCollectionForm).

• The owning project of the original asset must still exist and be active.

• User must have write access to the project and domain.

Creates a custom asset type.

Prerequisites:

• The formsInput field is required, however, can be passed as empty (e.g. -forms-input {}).

• You must have CreateAssetType permissions.

• The domain-identifier and owning-project-identifier must be valid and active.

• The name of the asset type must be unique within the domain — duplicate names will cause failure.

• JSON input must be valid — incorrect formatting causes Invalid JSON errors.

Creates a new connection.

In Amazon DataZone, a connection enables you to connect your resources (domains, projects, and environments) to external resources and services.

Creates a data product.

A data product is a comprehensive package that combines data assets with their associated metadata, documentation, and access controls. It's designed to serve specific business needs or use cases, making it easier for users to find and consume data appropriately. Data products include important information about data quality, freshness, and usage guidelines, effectively bridging the gap between data producers and consumers while ensuring proper governance.

Prerequisites:

• The domain must exist and be accessible.

• The owning project must be valid and active.

• The name must be unique within the domain (no existing data product with the same name).

• User must have create permissions for data products in the project.

Creates a data product revision.

Prerequisites:

• The original data product must exist in the given domain.

• User must have permissions on the data product.

• The domain must be valid and accessible.

• The new revision name must comply with naming constraints (if required).

Creates an Amazon DataZone data source.

Creates an Amazon DataZone domain.

Creates a domain unit in Amazon DataZone.

Create an Amazon DataZone environment.

Creates an action for the environment, for example, creates a console link for an analytics tool that is available in this environment.

Creates a Amazon DataZone blueprint.

Creates an Amazon DataZone environment profile.

Creates a metadata form type.

Prerequisites:

• The domain must exist and be in an ENABLED state.

• The owning project must exist and be accessible.

• The name must be unique within the domain.

For custom form types, to indicate that a field should be searchable, annotate it with @amazon.datazone#searchable. By default, searchable fields are indexed for semantic search, where related query terms will match the attribute value even if they are not stemmed or keyword matches. To indicate that a field should be indexed for lexical search (which disables semantic search but supports stemmed and partial matches), annotate it with @amazon.datazone#searchable(modes:["LEXICAL"]). To indicate that a field should be indexed for technical identifier search (for more information on technical identifier search, see: https://aws.amazon.com/blogs/big-data/streamline-data-discovery-with-precise-technical-identifier-search-in-amazon-sagemaker-unified-studio/), annotate it with @amazon.datazone#searchable(modes:["TECHNICAL"]).

To denote that a field will store glossary term ids (which are filterable via the Search/SearchListings APIs), annotate it with @amazon.datazone#glossaryterm("${GLOSSARY_ID}"), where ${GLOSSARY_ID} is the id of the glossary that the glossary terms stored in the field belong to.

Creates an Amazon DataZone business glossary.

Specifies that this is a create glossary policy.

A glossary serves as the central repository for business terminology and definitions within an organization. It helps establish and maintain a common language across different departments and teams, reducing miscommunication and ensuring consistent interpretation of business concepts. Glossaries can include hierarchical relationships between terms, cross-references, and links to actual data assets, making them invaluable for both business users and technical teams trying to understand and use data correctly.

Prerequisites:

• Domain must exist and be in an active state.

• Owning project must exist and be accessible by the caller.

• The glossary name must be unique within the domain.

Creates a business glossary term.

A glossary term represents an individual entry within the Amazon DataZone glossary, serving as a standardized definition for a specific business concept or data element. Each term can include rich metadata such as detailed definitions, synonyms, related terms, and usage examples. Glossary terms can be linked directly to data assets, providing business context to technical data elements. This linking capability helps users understand the business meaning of data fields and ensures consistent interpretation across different systems and teams. Terms can also have relationships with other terms, creating a semantic network that reflects the complexity of business concepts.

Prerequisites:

• Domain must exist.

• Glossary must exist.

• The term name must be unique within the glossary.

• Ensure term does not conflict with existing terms in hierarchy.

Creates a group profile in Amazon DataZone.

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

Creates an Amazon DataZone project.

Creates a project membership in Amazon DataZone.

Creates a project profile.

Creates a rule in Amazon DataZone.

A rule is a formal agreement that enforces specific requirements across user workflows (e.g., publishing assets to the catalog, requesting subscriptions, creating projects) within the Amazon DataZone data portal. These rules help maintain consistency, ensure compliance, and uphold governance standards in data management processes. For instance, a metadata enforcement rule can specify the required information for creating a subscription request or publishing a data asset to the catalog, ensuring alignment with organizational standards.

Creates a subsscription grant in Amazon DataZone.

Creates a subscription request in Amazon DataZone.

Creates a subscription target in Amazon DataZone.

Creates a user profile in Amazon DataZone.

Deletes an account pool.

Deletes an asset in Amazon DataZone.

• --domain-identifier must refer to a valid and existing domain.

• --identifier must refer to an existing asset in the specified domain.

• Asset must not be referenced in any existing asset filters.

• Asset must not be linked to any draft or published data product.

• User must have delete permissions for the domain and project.

Deletes an asset filter.

Prerequisites:

• The asset filter must exist.

• The domain and asset must not have been deleted.

• Ensure the --identifier refers to a valid filter ID.

Deletes an asset type in Amazon DataZone.

Prerequisites:

• The asset type must exist in the domain.

• You must have DeleteAssetType permission.

• The asset type must not be in use (e.g., assigned to any asset). If used, deletion will fail.

• You should retrieve the asset type using get-asset-type to confirm its presence before deletion.

Deletes and connection.

In Amazon DataZone, a connection enables you to connect your resources (domains, projects, and environments) to external resources and services.

Deletes a data product in Amazon DataZone.

Prerequisites:

• The data product must exist and not be deleted or archived.

• The user must have delete permissions for the data product.

• Domain and project must be active.

Deletes a data source in Amazon DataZone.

Deletes a Amazon DataZone domain.

Deletes a domain unit.

Deletes an environment in Amazon DataZone.

Deletes an action for the environment, for example, deletes a console link for an analytics tool that is available in this environment.

Deletes a blueprint in Amazon DataZone.

Deletes the blueprint configuration in Amazon DataZone.

Deletes an environment profile in Amazon DataZone.

Deletes and metadata form type in Amazon DataZone.

Prerequisites:

• The form type must exist in the domain.

• The form type must not be in use by any asset types or assets.

• The domain must be valid and accessible.

• User must have delete permissions on the form type.

• Any dependencies (such as linked asset types) must be removed first.

Deletes a business glossary in Amazon DataZone.

Prerequisites:

• The glossary must be in DISABLED state.

• The glossary must not have any glossary terms associated with it.

• The glossary must exist in the specified domain.

• The caller must have the datazone:DeleteGlossary permission in the domain and glossary.

• Glossary should not be linked to any active metadata forms.

Deletes a business glossary term in Amazon DataZone.

Prerequisites:

• Glossary term must exist and be active.

• The term must not be linked to other assets or child terms.

• Caller must have delete permissions in the domain/glossary.

• Ensure all associations (such as to assets or parent terms) are removed before deletion.

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

Deletes a project in Amazon DataZone.

Deletes project membership in Amazon DataZone.

Deletes a project profile.

Deletes a rule in Amazon DataZone.

A rule is a formal agreement that enforces specific requirements across user workflows (e.g., publishing assets to the catalog, requesting subscriptions, creating projects) within the Amazon DataZone data portal. These rules help maintain consistency, ensure compliance, and uphold governance standards in data management processes. For instance, a metadata enforcement rule can specify the required information for creating a subscription request or publishing a data asset to the catalog, ensuring alignment with organizational standards.

Deletes and subscription grant in Amazon DataZone.

Deletes a subscription request in Amazon DataZone.

Deletes a subscription target in Amazon DataZone.

Deletes the specified time series form for the specified asset.

Disassociates the environment role in Amazon DataZone.

Disassociates restricted terms from an asset.

Gets the details of the account pool.

Gets an Amazon DataZone asset.

An asset is the fundamental building block in Amazon DataZone, representing any data resource that needs to be cataloged and managed. It can take many forms, from Amazon S3 buckets and database tables to dashboards and machine learning models. Each asset contains comprehensive metadata about the resource, including its location, schema, ownership, and lineage information. Assets are essential for organizing and managing data resources across an organization, making them discoverable and usable while maintaining proper governance.

Before using the Amazon DataZone GetAsset command, ensure the following prerequisites are met:

• Domain identifier must exist and be valid

• Asset identifier must exist

• User must have the required permissions to perform the action

Gets an asset filter.

Prerequisites:

• Domain (--domain-identifier), asset (--asset-identifier), and filter (--identifier) must all exist.

• The asset filter should not have been deleted.

• The asset must still exist (since the filter is linked to it).

Gets an Amazon DataZone asset type.

Asset types define the categories and characteristics of different kinds of data assets within Amazon DataZone.. They determine what metadata fields are required, what operations are possible, and how the asset integrates with other Amazon Web Services services. Asset types can range from built-in types like Amazon S3 buckets and Amazon Web Services Glue tables to custom types defined for specific organizational needs. Understanding asset types is crucial for properly organizing and managing different kinds of data resources.

Prerequisites:

• The asset type with identifier must exist in the domain. ResourceNotFoundException.

• You must have the GetAssetType permission.

• Ensure the domain-identifier value is correct and accessible.

Gets a connection.

In Amazon DataZone, a connection enables you to connect your resources (domains, projects, and environments) to external resources and services.

Gets the data product.

Prerequisites:

• The data product ID must exist.

• The domain must be valid and accessible.

• User must have read or discovery permissions for the data product.

Gets an Amazon DataZone data source.

Gets an Amazon DataZone data source run.

Gets an Amazon DataZone domain.

Gets the details of the specified domain unit.

Gets an Amazon DataZone environment.

Gets the specified environment action.

Gets an Amazon DataZone blueprint.

Gets the blueprint configuration in Amazon DataZone.

Gets the credentials of an environment in Amazon DataZone.

Gets an evinronment profile in Amazon DataZone.

Gets a metadata form type in Amazon DataZone.

Form types define the structure and validation rules for collecting metadata about assets in Amazon DataZone. They act as templates that ensure consistent metadata capture across similar types of assets, while allowing for customization to meet specific organizational needs. Form types can include required fields, validation rules, and dependencies, helping maintain high-quality metadata that makes data assets more discoverable and usable.

• The form type with the specified identifier must exist in the given domain.

• The domain must be valid and active.

• User must have permission on the form type.

• The form type should not be deleted or in an invalid state.

One use case for this API is to determine whether a form field is indexed for search.

A searchable field will be annotated with @amazon.datazone#searchable. By default, searchable fields are indexed for semantic search, where related query terms will match the attribute value even if they are not stemmed or keyword matches. If a field is indexed technical identifier search, it will be annotated with @amazon.datazone#searchable(modes:["TECHNICAL"]). If a field is indexed for lexical search (supports stemmed and prefix matches but not semantic matches), it will be annotated with @amazon.datazone#searchable(modes:["LEXICAL"]).

A field storing glossary term IDs (which is filterable) will be annotated with @amazon.datazone#glossaryterm("${glossaryId}").

Gets a business glossary in Amazon DataZone.

Prerequisites:

• The specified glossary ID must exist and be associated with the given domain.

• The caller must have the datazone:GetGlossary permission on the domain.

Gets a business glossary term in Amazon DataZone.

Prerequisites:

• Glossary term with identifier must exist in the domain.

• User must have permission on the glossary term.

• Domain must be accessible and active.

Gets a group profile in Amazon DataZone.

Gets the data portal URL for the specified Amazon DataZone domain.

The details of the job run.

Describes the lineage event.

Gets the data lineage node.

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.

Gets a metadata generation run in Amazon DataZone.

Prerequisites:

• Valid domain and run identifier.

• The metadata generation run must exist.

• User must have read access to the metadata run.

Gets a project in Amazon DataZone.

The details of the project profile.

Gets the details of a rule in Amazon DataZone.

A rule is a formal agreement that enforces specific requirements across user workflows (e.g., publishing assets to the catalog, requesting subscriptions, creating projects) within the Amazon DataZone data portal. These rules help maintain consistency, ensure compliance, and uphold governance standards in data management processes. For instance, a metadata enforcement rule can specify the required information for creating a subscription request or publishing a data asset to the catalog, ensuring alignment with organizational standards.

Gets a subscription in Amazon DataZone.

Gets the subscription grant in Amazon DataZone.

Gets the details of the specified subscription request.

Gets the subscription target in Amazon DataZone.

Gets the existing data point for the asset.

Gets a user profile in Amazon DataZone.

Lists existing account pools.

Lists the accounts in the specified account pool.

Lists asset filters.

Prerequisites:

• A valid domain and asset must exist.

• The asset must have at least one filter created to return results.

Lists the revisions for the asset.

Prerequisites:

• The asset must exist in the domain.

• There must be at least one revision of the asset (which happens automatically after creation).

• The domain must be valid and active.

• User must have permissions on the asset and domain.

Lists connections.

In Amazon DataZone, a connection enables you to connect your resources (domains, projects, and environments) to external resources and services.

Lists data product revisions.

Prerequisites:

• The data product ID must exist within the domain.

• User must have view permissions on the data product.

• The domain must be in a valid and accessible state.

Lists data source run activities.

Lists data source runs in Amazon DataZone.

Lists data sources in Amazon DataZone.

Lists child domain units for the specified parent domain unit.

Lists Amazon DataZone domains.

Lists the entity (domain units) owners.

Lists existing environment actions.

Lists blueprint configurations for a Amazon DataZone environment.

Lists blueprints in an Amazon DataZone environment.

Lists Amazon DataZone environment profiles.

Lists Amazon DataZone environments.

Lists job runs.

Lists lineage events.

Lists the history of the specified data lineage node.

Lists all metadata generation runs.

Metadata generation runs represent automated processes that leverage AI/ML capabilities to create or enhance asset metadata at scale. This feature helps organizations maintain comprehensive and consistent metadata across large numbers of assets without manual intervention. It can automatically generate business descriptions, tags, and other metadata elements, significantly reducing the time and effort required for metadata management while improving consistency and completeness.

Prerequisites:

• Valid domain identifier.

• User must have access to metadata generation runs in the domain.

Lists all Amazon DataZone notifications.

Lists policy grants.

Lists all members of the specified project.

Lists project profiles.

Lists Amazon DataZone projects.

Lists existing rules.

In Amazon DataZone, a rule is a formal agreement that enforces specific requirements across user workflows (e.g., publishing assets to the catalog, requesting subscriptions, creating projects) within the Amazon DataZone data portal. These rules help maintain consistency, ensure compliance, and uphold governance standards in data management processes. For instance, a metadata enforcement rule can specify the required information for creating a subscription request or publishing a data asset to the catalog, ensuring alignment with organizational standards.

Lists subscription grants.

Lists Amazon DataZone subscription requests.

Lists subscription targets in Amazon DataZone.

Lists subscriptions in Amazon DataZone.

Lists tags for the specified resource in Amazon DataZone.

Lists time series data points.

Posts a data lineage event.

Posts time series data points to Amazon DataZone for the specified asset.

Writes the configuration for the specified environment blueprint in Amazon DataZone.

Rejects automatically generated business-friendly metadata for your Amazon DataZone assets.

Rejects the specified subscription request.

Removes an owner from an entity.

Removes a policy grant.

Revokes a specified subscription in Amazon DataZone.

Searches for assets in Amazon DataZone.

Search in Amazon DataZone is a powerful capability that enables users to discover and explore data assets, glossary terms, 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. Search can be scoped to specific types of resources (like assets, glossary terms, or data products) and can be filtered using various criteria such as creation date, owner, or status. The search functionality 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.

Many search commands in Amazon DataZone are paginated, including search and search-types. When the result set is large, Amazon DataZone returns a nextToken in the response. This token can be used to retrieve the next page of results.

Prerequisites:

• The --domain-identifier must refer to an existing Amazon DataZone domain.

• --search-scope must be one of: ASSET, GLOSSARY_TERM, DATA_PRODUCT, or GLOSSARY.

• The user must have search permissions in the specified domain.

• If using --filters, ensure that the JSON is well-formed and that each filter includes valid attribute and value keys.

• For paginated results, be prepared to use --next-token to fetch additional pages.

Searches group profiles in Amazon DataZone.

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 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 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.

Searches for types in Amazon DataZone.

Prerequisites:

• The --domain-identifier must refer to an existing Amazon DataZone domain.

• --search-scope must be one of the valid values including: ASSET_TYPE, GLOSSARY_TERM_TYPE, DATA_PRODUCT_TYPE.

• The --managed flag must be present without a value.

• The user must have permissions for form or asset types in the domain.

• If using --filters, ensure that the JSON is valid.

• Filters contain correct structure (attribute, value, operator).

Searches user profiles in Amazon DataZone.

Start the run of the specified data source in Amazon DataZone.

Starts the metadata generation run.

Prerequisites:

• Asset must be created and belong to the specified domain and project.

• Asset type must be supported for metadata generation (e.g., Amazon Web Services Glue table).

• Asset must have a structured schema with valid rows and columns.

• Valid values for --type: BUSINESS_DESCRIPTIONS, BUSINESS_NAMES.

• The user must have permission to run metadata generation in the domain/project.

Tags a resource in Amazon DataZone.

Untags a resource in Amazon DataZone.

Updates the account pool.

Updates an asset filter.

Prerequisites:

• The domain, asset, and asset filter identifier must all exist.

• The asset must contain the columns being referenced in the update.

• If applying a row filter, ensure the column referenced in the expression exists in the asset schema.

Updates a connection.

In Amazon DataZone, a connection enables you to connect your resources (domains, projects, and environments) to external resources and services.

Updates the specified data source in Amazon DataZone.

Updates a Amazon DataZone domain.

Updates the domain unit.

Updates the specified environment in Amazon DataZone.

Updates an environment action.

Updates an environment blueprint in Amazon DataZone.

Updates the specified environment profile in Amazon DataZone.

Updates the business glossary in Amazon DataZone.

Prerequisites:

• The glossary must exist in the given domain.

• The caller must have the datazone:UpdateGlossary permission to update it.

• When updating the name, the new name must be unique within the domain.

• The glossary must not be deleted or in a terminal state.

Updates a business glossary term in Amazon DataZone.

Prerequisites:

• Glossary term must exist in the specified domain.

• New name must not conflict with existing terms in the same glossary.

• User must have permissions on the term.

• The term must not be in DELETED status.

Updates the specified group profile in Amazon DataZone.

Updates the specified project in Amazon DataZone.

Updates a project profile.

Updates a rule.

In Amazon DataZone, a rule is a formal agreement that enforces specific requirements across user workflows (e.g., publishing assets to the catalog, requesting subscriptions, creating projects) within the Amazon DataZone data portal. These rules help maintain consistency, ensure compliance, and uphold governance standards in data management processes. For instance, a metadata enforcement rule can specify the required information for creating a subscription request or publishing a data asset to the catalog, ensuring alignment with organizational standards.

Updates the status of the specified subscription grant status in Amazon DataZone.

Updates a specified subscription request in Amazon DataZone.

Updates the specified subscription target in Amazon DataZone.

Updates the specified user profile in Amazon DataZone.