Awso_datazone.ValuesSourceval structure_to_value_aux :
('a * 'b option) list ->
f:(('a * 'b) list -> 'c) ->
[> `Structure of 'c ]val structure_to_wrapped_value :
wrapper:'a ->
response:'a ->
('b * 'c option) list ->
[> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]Specifies the prediction (aka, the automatically generated piece of metadata) and the target (for example, a column name) that can be accepted.
Specifies the rule and the threshold under which a prediction can be accepted.
Accepts automatically generated business-friendly metadata for your Amazon DataZone assets.
The input fails to satisfy the constraints specified by the Amazon Web Services service.
You do not have permission to perform this action.
The request was denied due to request throttling.
The specified resource cannot be found.
The request has failed because of an unknown error, exception or failure.
There is a conflict while performing this action.
You do not have sufficient access to perform this action.
Accepts automatically generated business-friendly metadata for your Amazon DataZone assets.
The asset permissions.
The asset permissions.
The accepted asset scope.
Accepts a subscription request to a specific asset.
The request has exceeded the specified service quota.
The details of a metadata form.
The SSO user profile detail.
The details of the IAM user profile.
The user profile details.
The subscribed user.
The project that has the subscription grant.
The IAM principal that subscribes to the asset.
The group that subscribes to the asset.
The principal that has the subscription grant for the asset.
Details of a glossary term attached to the inventory asset.
The listing of the asset in a data product.
The data product listing.
The asset scope.
The details of the published asset for which the subscription grant is created.
The published asset for which the subscription grant is created.
The details of the published asset for which the subscription grant is created.
Accepts a subscription request to a specific asset.
The account information within an account pool.
The summary of the account pool.
The custom Amazon Web Services Lambda handler within an account pool.
The source of accounts for the account pool. In the current release, it's either a static list of accounts provided by the customer or a custom Amazon Web Services Lambda handler.
The parameters of the console link specified as part of the environment action.
The parameters of the environment action.
The properties of the owner user.
The properties of the domain unit owners group.
The properties of a domain unit's owner.
Adds the owner of an entity (a domain unit).
Adds the owner of an entity (a domain unit).
The all users grant filter.
The user policy grant principal.
The domain unit filter of the project grant filter.
The project grant filter.
The project policy grant principal.
The group principal to whom the policy is granted.
The grant filter for all domain units.
The grant filter for the domain unit. In the current release of Amazon DataZone, the only supported filter is the allDomainUnitsGrantFilter.
The domain unit principal to whom the policy is granted.
The policy grant principal.
Specifies the domain unit(s) whose projects can use this asset type while creating asset or asset revisions.
The details of the override project owners policy grant.
The grant details of the override domain unit owners policy.
The details of the policy grant.
Specifies whether to create a project from project profile policy grant details.
The details of the policy grant.
The details of the policy grant.
The details of the policy grant.
The details of the policy grant.
The details of the policy grant.
The details of the policy grant.
The details of the policy grant.
Adds a policy grant (an authorization policy) to a specified entity, including domain units, environment blueprint configurations, or environment profiles.
Adds a policy grant (an authorization policy) to a specified entity, including domain units, environment blueprint configurations, or environment profiles.
Additional details on the queried entity that can be requested in the response.
An aggregation list item.
An aggregation output item.
The aggregation for an attribute.
The Amazon Q properties of the connection.
The Amazon Q properties of the connection.
The Amazon Q properties of the connection.
Specifies that a value might be not like the expression.
Specifies that a value is not in the expression.
Specifies that a value is not equal to the expression.
Specifies that a value is like the expression.
Specifies that a value is less than or equal to an expression.
Specifies that a value is less than an expression.
Specifies that the expression is null.
Specifies that the expression is not null.
Specifies whether values are in the expression.
Specifies whether the value is greater than or equal to an expression.
Specifies whether the value is greater than an expression.
Specifies whether the value is equal to an expression.
The row filter expression.
module RowFilter : sig ... endThe row filter.
module RowFilterList : sig ... endThe row filter configuration details.
The column configuration of the asset filter.
The configuration details of the asset filter.
The summary of the asset filter.
The summary of the time series data points form.
The offset of a matched term.
A structure indicating matched terms for an attribute.
A rationale indicating why this item was matched by search.
The additional attributes of an inventory asset.
An asset published in an Amazon DataZone catalog.
The details of an asset published in an Amazon DataZone catalog.
Additional attributes of an inventory asset.
The details of an asset published in an Amazon DataZone catalog.
The revision of an inventory asset.
The name map for assets.
The details of the form entry.
The details of the asset type.
The asset type for the rule details.
Associates the environment role in Amazon DataZone.
Associates the environment role in Amazon DataZone.
Associates governed terms with an asset.
Associates governed terms with an asset.
The Amazon Athena properties of a connection.
The Amazon Athena properties of a connection.
The Amazon Athena properties patch of a connection.
The attribute error.
The attribute input.
The OAuth2Client application.
The GlueOAuth2 credentials of a connection.
The authorization code properties of a connection.
The OAuth2 properties.
The authentication configuration of a connection.
The basic authentication credentials of a connection.
The authentication configuration of a connection.
The authentication configuration patch of a connection.
The account ID of a project.
The location of a project.
The results of the BatchGetAttribute action.
Gets the attribute metadata.
Gets the attribute metadata.
The results of the BatchPutAttribute action.
Writes the attribute metadata.
Writes the attribute metadata.
The configuration of the business name generation.
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 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.
Cancels the subscription to the specified asset.
The information about a cell in a notebook run in Amazon SageMaker Unified Studio.
Part of the provisioning properties of the environment blueprint.
The compute configuration for a notebook run in Amazon SageMaker Unified Studio.
The details of the parameters for the configurable environment action.
The configurable action of a Amazon DataZone environment.
The configuration of a connection.
The credentials of a connection.
The MWAA serverless properties.
The Amazon MWAA properties.
The Spark Amazon Web Services Glue args.
The Spark Amazon Web Services Glue properties.
The Spark EMR properties.
The Amazon S3 properties of a connection.
The Amazon Redshift storage properties.
The lineage sync schedule.
The Amaon Redshift lineage sync configuration.
The username and password of a connection.
Amazon Redshift credentials of a connection.
The Amazon Redshift properties.
The MLflow properties of a connection.
The lakehouse properties of a connection.
The IAM properties of a connection.
The hyper pod properties of a Amazon Web Services Glue properties patch.
Physical connection requirements of a connection.
The Amazon Web Services Glue connecton input.
The Amazon Web Services Glue properties of a connection.
The properties of a connection.
The MWAA serverless properties.
The Amazon MWAA properties.
The Spark Amazon Web Services Glue properties.
The managed endpoint credentials of the EMR on EKS cluster.
The Spark EMR properties.
The Amazon S3 properties of a connection.
The Amaon Redshift lineage sync configuration.
The Amazon Redshift properties.
The MLflow properties of a connection.
The lakehouse properties of a connection.
The IAM properties of a connection.
The hyper pod properties of a Amazon Web Services Glue properties patch.
The properties of the Amazon Web Services Glue connection.
The properties of a connection.
The Spark EMR properties patch.
The Amazon S3 properties patch of a connection.
Amazon Redshift properties patch.
The MLflow properties of a connection.
The lakehouse properties of a connection properties patch.
The IAM properties patch of a connection.
The Amazon Web Services Glue connection patch.
The Amazon Web Services Glue properties patch of a connection.
The connection properties patch.
The Amazon Web Services Glue connection.
The physical endpoints of a connection.
The summary of a connection.
Creates an account pool.
Creates an account pool.
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 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.
The configuration of the prediction.
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 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 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 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.
The details of the form entry.
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 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 new connection. In Amazon DataZone, a connection enables you to connect your resources (domains, projects, and environments) to external resources and services.
The data product.
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. 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 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).
The details of the schedule of the data source runs.
The recommendation to be updated as part of the UpdateDataSource action.
The Amazon SageMaker run configuration.
A filter expression in Amazon DataZone.
The relational filter configuration for the data source.
The details of the Amazon Redshift Serverless workgroup storage.
The details of the Amazon Redshift cluster storage.
The details of the Amazon Redshift storage as part of the configuration of an Amazon Redshift data source run.
The details of the credentials required to access an Amazon Redshift cluster.
The configuration details of the Amazon Redshift data source.
The configuration details of the Amazon Web Services Glue data source.
The configuration of the data source.
Creates an Amazon DataZone data source.
The details of the error message that is returned if the operation cannot be successfully completed.
The Amazon SageMaker run configuration.
The configuration details of the Amazon Redshift data source.
The configuration details of the Amazon Web Services Glue data source.
The configuration of the data source.
Creates an Amazon DataZone data source.
The single sign-on details in Amazon DataZone.
Creates an Amazon DataZone domain.
Creates an Amazon DataZone domain.
Creates a domain unit in Amazon DataZone.
The properties of the domain unit user.
The properties of a domain unit group.
The properties of the domain unit owner.
Creates a domain unit in Amazon DataZone.
Creates an action for the environment, for example, creates a console link for an analytics tool that is available in this environment.
Creates an action for the environment, for example, creates a console link for an analytics tool that is available in this environment.
The provisioning properties of an environment blueprint.
The details of user parameters of an environment blueprint.
Creates a Amazon DataZone blueprint.
The deployment properties of the Amazon DataZone blueprint.
Creates a Amazon DataZone blueprint.
The parameter details of an evironment profile.
Create an Amazon DataZone environment.
The details of a provisioned resource of this Amazon DataZone environment.
The failure reasons for the environment deployment.
The details of the last deployment of the environment.
Create an Amazon DataZone environment.
Creates an Amazon DataZone environment profile.
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 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 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.
The details of the term relations.
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 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.
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.
Publishes a listing (a record of an asset at a given time) or removes a listing from the catalog.
Creates a notebook in Amazon SageMaker Unified Studio. A notebook is a collaborative document within a project that contains code cells for interactive computing.
The error details of a notebook in Amazon SageMaker Unified Studio.
The package configuration for a notebook run environment in Amazon SageMaker Unified Studio.
The environment configuration for a notebook run in Amazon SageMaker Unified Studio.
Creates a notebook in Amazon SageMaker Unified Studio. A notebook is a collaborative document within a project that contains code cells for interactive computing.
A map of user or group profiles to designations that need to be assigned in the project.
Specifies the account/Region that is to be used during project creation for a particular blueprint.
The environment configuration user parameters.
Creates an Amazon DataZone project.
Creates a project membership in Amazon DataZone.
Creates a project membership in Amazon DataZone.
The resource tag of the project.
Specifies the error message that is returned if the operation cannot be successfully completed.
The environment deployment details.
Creates an Amazon DataZone project.
The resource tag parameter of the project profile.
The environment configuration parameter.
The details of the environment configuration parameter.
The configuration of an environment.
Creates a project profile.
Creates a project profile.
The target for the domain unit.
The target of the rule.
Specifies projects in which the rule is created.
The reference of a metadata form.
The enforcement details of a metadata form.
The enforcement details of a glossary term.
The details of a rule.
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 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.
A revision to be made to an asset published in a Amazon DataZone catalog.
The details of a listing for which a subscription is to be granted.
Creates a subsscription grant in Amazon DataZone.
Specifies the error message that is returned if the operation cannot be successfully completed.
The details of the asset for which the subscription grant is created.
A revision of an asset published in a Amazon DataZone catalog.
The details of a listing for which a subscription is granted.
Creates a subsscription grant in Amazon DataZone.
The subscribed user.
The project that is to be given a subscription grant.
The details of the subscribed IAM principal.
The details of the subscribed group.
The principal that is to be given a subscriptiong grant.
The published asset for which the subscription grant is to be created.
Creates a subscription request in Amazon DataZone.
Creates a subscription request in Amazon DataZone.
The details of the subscription target configuration.
Creates a subscription target in Amazon DataZone.
Creates a subscription target in Amazon DataZone.
Creates a user profile in Amazon DataZone.
Creates a user profile in Amazon DataZone.
The additional attributes of an Amazon DataZone data product.
The summary of the listing of the data product.
The data product listing.
The results of the data product summary.
The additional attributes of the asset of the data product.
The asset of the data product listing.
The data product.
The data product revision.
The data lineage information.
The activity details of the data source run.
The run lineage summary of a data source.
The asset statistics from the data source run.
The details of a data source run.
The details of the data source.
Deletes an account pool.
Deletes an account pool.
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 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 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 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 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 and connection. In Amazon DataZone, a connection enables you to connect your resources (domains, projects, and environments) to external resources and services.
Deletes data export configuration for a domain. This operation does not delete the S3 table created by the PutDataExportConfiguration operation. To temporarily disable export without deleting the configuration, use the PutDataExportConfiguration operation with the --no-enable-export flag instead. This allows you to re-enable export for the same domain using the --enable-export flag without deleting S3 table.
Deletes data export configuration for a domain. This operation does not delete the S3 table created by the PutDataExportConfiguration operation. To temporarily disable export without deleting the configuration, use the PutDataExportConfiguration operation with the --no-enable-export flag instead. This allows you to re-enable export for the same domain using the --enable-export flag without deleting S3 table.
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 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.
The details for the self granting status.
The details for the self granting status for an Amazon Redshift data source.
The details of the self granting status.
The details for the self granting status for a data source.
Deletes a data source in Amazon DataZone.
Deletes a Amazon DataZone domain.
Deletes a Amazon DataZone domain.
Deletes a domain unit.
Deletes a domain unit.
Deletes an action for the environment, for example, deletes a console link for an analytics tool that is available in this environment.
Deletes the blueprint configuration in Amazon DataZone.
Deletes the blueprint configuration in Amazon DataZone.
Deletes a blueprint in Amazon DataZone.
Deletes an environment 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 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 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 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 listing (a record of an asset at a given time).
Deletes a notebook in Amazon SageMaker Unified Studio.
Deletes a notebook in Amazon SageMaker Unified Studio.
Deletes a project in Amazon DataZone.
Deletes project membership in Amazon DataZone.
Deletes project membership in Amazon DataZone.
Deletes a project in Amazon DataZone.
Deletes a project profile.
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 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 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.
Deletes the specified time series form for the specified asset.
Disassociates the environment role in Amazon DataZone.
Disassociates the environment role in Amazon DataZone.
Disassociates restricted terms from an asset.
Disassociates restricted terms from an asset.
A summary of a Amazon DataZone domain.
The summary of the domain unit.
The encryption configuration details.
The properties of the owner user.
The properties of the domain unit owners group.
The ID of the domain unit owners group.
module FilterClause : sig ... endA search filter clause in Amazon DataZone.
module FilterList : sig ... endThe pattern describing the entities to be matched during the graph query.
The details about the specified action configured for an environment. For example, the details of the specified console links for an analytics tool that is available in this environment.
The Lake Formation configuration of the Data Lake blueprint.
The provisioning configuration of the blueprint.
The configuration details of an environment blueprint.
The details of an environment blueprint summary.
The details of an environment profile.
The details of an environment.
The name identifier.
The open lineage run event summary.
The event summary.
The details of the metadata form type.
Gets the details of the account pool.
Gets the details of the account pool.
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 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. 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 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 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 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 a connection. In Amazon DataZone, a connection enables you to connect your resources (domains, projects, and environments) to external resources and services.
Gets data export configuration details.
Gets data export configuration details.
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 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.
Gets an Amazon DataZone data source run.
Gets an Amazon DataZone data source run.
Gets an Amazon DataZone domain.
Gets an Amazon DataZone domain.
Gets the details of the specified domain unit.
Gets the details of the specified domain unit.
Gets the specified environment action.
Gets the specified environment action.
Gets the blueprint configuration in Amazon DataZone.
Gets the blueprint configuration in Amazon DataZone.
Gets an Amazon DataZone blueprint.
Gets an Amazon DataZone blueprint.
Gets the credentials of an environment in Amazon DataZone.
Gets the credentials of an environment in Amazon DataZone.
Gets an Amazon DataZone environment.
Gets an Amazon DataZone environment.
Gets an evinronment profile 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 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 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 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 a group profile in Amazon DataZone.
Gets the data portal URL for the specified Amazon DataZone domain.
Gets the data portal URL for the specified Amazon DataZone domain.
The details of the job run.
The job run error.
The SQL query run details of a data lineage run.
The data lineage run details.
The details of a job run.
The details of the job run.
Describes the lineage event.
Describes the lineage event.
Gets the data lineage node.
The reference details for the data lineage node.
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.
The details of a listing (aka asset published in a Amazon DataZone catalog).
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.
The statistics of the metadata generation run type.
The asset for which metadata was generated.
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 the details of a notebook export in Amazon SageMaker Unified Studio.
The Amazon Simple Storage Service destination for a notebook export in Amazon SageMaker Unified Studio.
The output location for a notebook export in Amazon SageMaker Unified Studio.
The error details of a failed notebook export in Amazon SageMaker Unified Studio.
Gets the details of a notebook export in Amazon SageMaker Unified Studio.
Gets the details of a notebook in Amazon SageMaker Unified Studio.
Gets the details of a notebook in Amazon SageMaker Unified Studio.
Gets the details of a notebook run in Amazon SageMaker Unified Studio.
The source that triggered a notebook run in Amazon SageMaker Unified Studio.
The timeout configuration for a notebook run in Amazon SageMaker Unified Studio.
The storage configuration for a notebook run in Amazon SageMaker Unified Studio.
The error details of a failed notebook run in Amazon SageMaker Unified Studio.
The network configuration for a notebook run in Amazon SageMaker Unified Studio.
Gets the details of a notebook run in Amazon SageMaker Unified Studio.
Gets a project in Amazon DataZone.
Gets a project in Amazon DataZone.
The details of the project profile.
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 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 the subscription grant in Amazon DataZone.
Gets the subscription grant in Amazon DataZone.
Gets a subscription in Amazon DataZone.
Gets a subscription in Amazon DataZone.
Gets the details of the specified subscription request.
Gets the details of the specified subscription request.
Gets the subscription target in Amazon DataZone.
Gets the subscription target in Amazon DataZone.
Gets the existing data point for the asset.
The time series data points form.
Gets the existing data point for the asset.
Gets a user profile in Amazon DataZone.
Gets a user profile in Amazon DataZone.
The additional attributes of an Amazon DataZone glossary.
The details of a business glossary.
The additional attributes of an Amazon DataZone glossary term.
The details of a business glossary term.
The details of a group in Amazon DataZone.
The details of a group profile.
The job run summary.
The data lineage event summary.
The summary and output forms of a LineageNode
The summary of the data lineage node.
The details of a data lineage node type.
Lists existing account pools.
Lists existing account pools.
Lists the accounts in the specified account pool.
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 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 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 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 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 run activities.
Lists data source runs in Amazon DataZone.
Lists data source runs in Amazon DataZone.
Lists data sources in Amazon DataZone.
Lists data sources in Amazon DataZone.
Lists child domain units for the specified parent domain unit.
Lists child domain units for the specified parent domain unit.
Lists Amazon DataZone domains.
Lists Amazon DataZone domains.
Lists the entity (domain units) owners.
Lists the entity (domain units) owners.
Lists existing environment actions.
Lists existing environment actions.
Lists blueprint configurations for a Amazon DataZone environment.
Lists blueprint configurations for a Amazon DataZone environment.
Lists blueprints in an Amazon DataZone environment.
Lists blueprints in an Amazon DataZone environment.
Lists Amazon DataZone environment profiles.
Lists Amazon DataZone environment profiles.
Lists Amazon DataZone environments.
Lists Amazon DataZone environments.
Lists job runs.
Lists job runs.
Lists lineage events.
Lists lineage events.
Lists the history of the specified data lineage node.
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.
The metadata generation run.
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 notebook runs in Amazon SageMaker Unified Studio.
The summary of a notebook run in Amazon SageMaker Unified Studio.
Lists notebook runs in Amazon SageMaker Unified Studio.
Lists notebooks in Amazon SageMaker Unified Studio.
The summary of a notebook in Amazon SageMaker Unified Studio.
Lists notebooks in Amazon SageMaker Unified Studio.
Lists all Amazon DataZone notifications.
The details of the resource mentioned in a notification.
The details of a notification generated in Amazon DataZone.
Lists all Amazon DataZone notifications.
Lists policy grants.
A member of the policy grant list.
Lists policy grants.
Lists all members of the specified project.
The user details of a project member.
The details about a project member.
The details of a project member.
Lists all members of the specified project.
Lists project profiles.
The summary of a project profile.
Lists project profiles.
Lists Amazon DataZone projects.
The details of a Amazon DataZone project.
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.
The summary of the rule.
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.
The details of the subscription grant.
Lists subscription grants.
Lists Amazon DataZone subscription requests.
The summary of the metadata form.
The details of the subscription request.
Lists Amazon DataZone subscription requests.
Lists subscription targets in Amazon DataZone.
The details of the subscription target.
Lists subscription targets in Amazon DataZone.
Lists subscriptions in Amazon DataZone.
The details of the subscription.
Lists subscriptions in Amazon DataZone.
Lists tags for the specified resource in Amazon DataZone.
Lists tags for the specified resource in Amazon DataZone.
Lists time series data points.
Lists time series data points.
The pattern describing the query's relational traversal.
A clause to match a query pattern
Posts a data lineage event.
Posts a data lineage event.
The time series data points form.
Posts time series data points to Amazon DataZone for the specified asset.
Posts time series data points to Amazon DataZone for the specified asset.
Creates data export configuration details. If you want to temporarily disable export and later re-enable it for the same domain, use the --no-enable-export flag to disable and the --enable-export flag to re-enable. This preserves the configuration and allows you to re-enable export without deleting S3 table. You can enable asset metadata export for only one domain per account per Region. To enable export for a different domain, complete the following steps: Delete the export configuration for the currently enabled domain using the DeleteDataExportConfiguration operation. Delete the asset S3 table under the aws-sagemaker-catalog S3 table bucket. We recommend backing up the S3 table before deletion. Call the PutDataExportConfiguration API to enable export for the new domain.
Creates data export configuration details. If you want to temporarily disable export and later re-enable it for the same domain, use the --no-enable-export flag to disable and the --enable-export flag to re-enable. This preserves the configuration and allows you to re-enable export without deleting S3 table. You can enable asset metadata export for only one domain per account per Region. To enable export for a different domain, complete the following steps: Delete the export configuration for the currently enabled domain using the DeleteDataExportConfiguration operation. Delete the asset S3 table under the aws-sagemaker-catalog S3 table bucket. We recommend backing up the S3 table before deletion. Call the PutDataExportConfiguration API to enable export for the new domain.
Writes the configuration for the specified environment blueprint in Amazon DataZone.
Writes the configuration for the specified environment blueprint in Amazon DataZone.
Queries entities in the graph store.
Resulting entity from the query.
Queries entities in the graph store.
The details of the automatically generated business metadata that is rejected.
Specifies the rule and the threshold under which a prediction can be rejected.
Rejects automatically generated business-friendly metadata for your Amazon DataZone assets.
Rejects automatically generated business-friendly metadata for your Amazon DataZone assets.
Rejects the specified subscription request.
Rejects the specified subscription request.
Removes an owner from an entity.
Removes an owner from an entity.
Removes a policy grant.
Removes a policy grant.
Revokes a specified subscription in Amazon DataZone.
Revokes a specified subscription in Amazon DataZone.
Searches group profiles in Amazon DataZone.
Searches group profiles in Amazon DataZone.
The details of the search.
The details of the way to sort search results.
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. 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.
The details of the search results.
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.
The details of the results of the SearchListings action.
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.
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. 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.
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).
The details of the results of the SearchTypes action.
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.
The details of the user profile.
Searches user profiles in Amazon DataZone.
The source location for a notebook import in Amazon SageMaker Unified Studio.
Start the run of the specified data source 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, BUSINESS_GLOSSARY_ASSOCIATIONS. The user must have permission to run metadata generation in the domain/project.
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, BUSINESS_GLOSSARY_ASSOCIATIONS. The user must have permission to run metadata generation in the domain/project.
Starts a notebook export in Amazon SageMaker Unified Studio. This operation exports a notebook to a specified file format and stores the output in Amazon Simple Storage Service.
Starts a notebook export in Amazon SageMaker Unified Studio. This operation exports a notebook to a specified file format and stores the output in Amazon Simple Storage Service.
Starts a notebook import in Amazon SageMaker Unified Studio. This operation imports a notebook from an Amazon Simple Storage Service location into a project.
Starts a notebook import in Amazon SageMaker Unified Studio. This operation imports a notebook from an Amazon Simple Storage Service location into a project.
Starts a notebook run in Amazon SageMaker Unified Studio. A notebook run represents the execution of an Amazon SageMaker notebook within a project. You can configure compute, network, timeout, and environment settings for the run.
Starts a notebook run in Amazon SageMaker Unified Studio. A notebook run represents the execution of an Amazon SageMaker notebook within a project. You can configure compute, network, timeout, and environment settings for the run.
Stops a running notebook run in Amazon SageMaker Unified Studio.
Stops a running notebook run in Amazon SageMaker Unified Studio.
Tags a resource in Amazon DataZone.
Tags a resource in Amazon DataZone.
Untags a resource in Amazon DataZone.
Untags a resource in Amazon DataZone.
Updates the account pool.
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 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 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 the specified data source in Amazon DataZone.
Updates a Amazon DataZone domain.
Updates a Amazon DataZone domain.
Updates the domain unit.
Updates the domain unit.
Updates an environment action.
Updates an environment action.
Updates an environment blueprint in Amazon DataZone.
Updates an environment blueprint in Amazon DataZone.
Updates the specified environment in Amazon DataZone.
Updates the specified environment in Amazon DataZone.
Updates the specified environment profile 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 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 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 group profile in Amazon DataZone.
Updates a notebook in Amazon SageMaker Unified Studio.
Updates a notebook in Amazon SageMaker Unified Studio.
Updates the specified project in Amazon DataZone.
Updates the specified project in Amazon DataZone.
Updates a project profile.
Updates a project profile.
Updates the owner of the root domain unit.
Updates the owner of the root domain unit.
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 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 the status of the specified subscription grant status in Amazon DataZone.
Updates a specified subscription request in Amazon DataZone.
Updates a specified subscription request in Amazon DataZone.
Updates the specified subscription target in Amazon DataZone.
Updates the specified subscription target in Amazon DataZone.
Updates the specified user profile in Amazon DataZone.
Updates the specified user profile in Amazon DataZone.