- Navigation GuideYou are on a Client landing page. Commands (operations) are listed on this page. The Client constructor type is linked at the bottom.
DataZoneClient
Amazon DataZone is a data management service that enables you to catalog, discover, govern, share, and analyze your data. With Amazon DataZone, you can share and access your data across accounts and supported regions. Amazon DataZone simplifies your experience across Amazon Web Services services, including, but not limited to, Amazon Redshift, Amazon Athena, Amazon Web Services Glue, and Amazon Web Services Lake Formation.
Installation
npm install @aws-sdk/client-datazoneyarn add @aws-sdk/client-datazonepnpm add @aws-sdk/client-datazoneDataZoneClient Operations
Command | Summary |
|---|
Command | Summary |
|---|---|
| AcceptPredictionsCommand | Accepts automatically generated business-friendly metadata for your Amazon DataZone assets. |
| AcceptSubscriptionRequestCommand | Accepts a subscription request to a specific asset. |
| AddEntityOwnerCommand | Adds the owner of an entity (a domain unit). |
| AddPolicyGrantCommand | Adds a policy grant (an authorization policy) to a specified entity, including domain units, environment blueprint configurations, or environment profiles. |
| AssociateEnvironmentRoleCommand | Associates the environment role in Amazon DataZone. |
| CancelMetadataGenerationRunCommand | Cancels the metadata generation run. |
| CancelSubscriptionCommand | Cancels the subscription to the specified asset. |
| CreateAssetCommand | Creates an asset in Amazon DataZone catalog. |
| CreateAssetFilterCommand | Creates a data asset filter. |
| CreateAssetRevisionCommand | Creates a revision of the asset. |
| CreateAssetTypeCommand | Creates a custom asset type. |
| CreateConnectionCommand | Creates a new connection. In Amazon DataZone, a connection enables you to connect your resources (domains, projects, and environments) to external resources and services. |
| CreateDataProductCommand | Creates a data product. |
| CreateDataProductRevisionCommand | Creates a data product revision. |
| CreateDataSourceCommand | Creates an Amazon DataZone data source. |
| CreateDomainCommand | Creates an Amazon DataZone domain. |
| CreateDomainUnitCommand | Creates a domain unit in Amazon DataZone. |
| CreateEnvironmentActionCommand | Creates an action for the environment, for example, creates a console link for an analytics tool that is available in this environment. |
| CreateEnvironmentCommand | Create an Amazon DataZone environment. |
| CreateEnvironmentProfileCommand | Creates an Amazon DataZone environment profile. |
| CreateFormTypeCommand | Creates a metadata form type. |
| CreateGlossaryCommand | Creates an Amazon DataZone business glossary. |
| CreateGlossaryTermCommand | Creates a business glossary term. |
| CreateGroupProfileCommand | Creates a group profile in Amazon DataZone. |
| CreateListingChangeSetCommand | Publishes a listing (a record of an asset at a given time) or removes a listing from the catalog. |
| CreateProjectCommand | Creates an Amazon DataZone project. |
| CreateProjectMembershipCommand | Creates a project membership in Amazon DataZone. |
| CreateProjectProfileCommand | Creates a project profile. |
| CreateRuleCommand | 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. |
| CreateSubscriptionGrantCommand | Creates a subsscription grant in Amazon DataZone. |
| CreateSubscriptionRequestCommand | Creates a subscription request in Amazon DataZone. |
| CreateSubscriptionTargetCommand | Creates a subscription target in Amazon DataZone. |
| CreateUserProfileCommand | Creates a user profile in Amazon DataZone. |
| DeleteAssetCommand | Deletes an asset in Amazon DataZone. |
| DeleteAssetFilterCommand | Deletes an asset filter. |
| DeleteAssetTypeCommand | Deletes an asset type in Amazon DataZone. |
| DeleteConnectionCommand | Deletes and connection. In Amazon DataZone, a connection enables you to connect your resources (domains, projects, and environments) to external resources and services. |
| DeleteDataProductCommand | Deletes a data product in Amazon DataZone. |
| DeleteDataSourceCommand | Deletes a data source in Amazon DataZone. |
| DeleteDomainCommand | Deletes a Amazon DataZone domain. |
| DeleteDomainUnitCommand | Deletes a domain unit. |
| DeleteEnvironmentActionCommand | Deletes an action for the environment, for example, deletes a console link for an analytics tool that is available in this environment. |
| DeleteEnvironmentBlueprintConfigurationCommand | Deletes the blueprint configuration in Amazon DataZone. |
| DeleteEnvironmentCommand | Deletes an environment in Amazon DataZone. |
| DeleteEnvironmentProfileCommand | Deletes an environment profile in Amazon DataZone. |
| DeleteFormTypeCommand | Delets and metadata form type in Amazon DataZone. |
| DeleteGlossaryCommand | Deletes a business glossary in Amazon DataZone. |
| DeleteGlossaryTermCommand | Deletes a business glossary term in Amazon DataZone. |
| DeleteListingCommand | Deletes a listing (a record of an asset at a given time). |
| DeleteProjectCommand | Deletes a project in Amazon DataZone. |
| DeleteProjectMembershipCommand | Deletes project membership in Amazon DataZone. |
| DeleteProjectProfileCommand | Deletes a project profile. |
| DeleteRuleCommand | 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. |
| DeleteSubscriptionGrantCommand | Deletes and subscription grant in Amazon DataZone. |
| DeleteSubscriptionRequestCommand | Deletes a subscription request in Amazon DataZone. |
| DeleteSubscriptionTargetCommand | Deletes a subscription target in Amazon DataZone. |
| DeleteTimeSeriesDataPointsCommand | Deletes the specified time series form for the specified asset. |
| DisassociateEnvironmentRoleCommand | Disassociates the environment role in Amazon DataZone. |
| GetAssetCommand | Gets an Amazon DataZone asset. |
| GetAssetFilterCommand | Gets an asset filter. |
| GetAssetTypeCommand | Gets an Amazon DataZone asset type. |
| GetConnectionCommand | Gets a connection. In Amazon DataZone, a connection enables you to connect your resources (domains, projects, and environments) to external resources and services. |
| GetDataProductCommand | Gets the data product. |
| GetDataSourceCommand | Gets an Amazon DataZone data source. |
| GetDataSourceRunCommand | Gets an Amazon DataZone data source run. |
| GetDomainCommand | Gets an Amazon DataZone domain. |
| GetDomainUnitCommand | Gets the details of the specified domain unit. |
| GetEnvironmentActionCommand | Gets the specified environment action. |
| GetEnvironmentBlueprintCommand | Gets an Amazon DataZone blueprint. |
| GetEnvironmentBlueprintConfigurationCommand | Gets the blueprint configuration in Amazon DataZone. |
| GetEnvironmentCommand | Gets an Amazon DataZone environment. |
| GetEnvironmentCredentialsCommand | Gets the credentials of an environment in Amazon DataZone. |
| GetEnvironmentProfileCommand | Gets an evinronment profile in Amazon DataZone. |
| GetFormTypeCommand | Gets a metadata form type in Amazon DataZone. |
| GetGlossaryCommand | Gets a business glossary in Amazon DataZone. |
| GetGlossaryTermCommand | Gets a business glossary term in Amazon DataZone. |
| GetGroupProfileCommand | Gets a group profile in Amazon DataZone. |
| GetIamPortalLoginUrlCommand | Gets the data portal URL for the specified Amazon DataZone domain. |
| GetJobRunCommand | The details of the job run. |
| GetLineageEventCommand | Describes the lineage event. |
| GetLineageNodeCommand | Gets the data lineage node. |
| GetListingCommand | 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. |
| GetMetadataGenerationRunCommand | Gets a metadata generation run in Amazon DataZone. |
| GetProjectCommand | Gets a project in Amazon DataZone. |
| GetProjectProfileCommand | The details of the project profile. |
| GetRuleCommand | 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. |
| GetSubscriptionCommand | Gets a subscription in Amazon DataZone. |
| GetSubscriptionGrantCommand | Gets the subscription grant in Amazon DataZone. |
| GetSubscriptionRequestDetailsCommand | Gets the details of the specified subscription request. |
| GetSubscriptionTargetCommand | Gets the subscription target in Amazon DataZone. |
| GetTimeSeriesDataPointCommand | Gets the existing data point for the asset. |
| GetUserProfileCommand | Gets a user profile in Amazon DataZone. |
| ListAssetFiltersCommand | Lists asset filters. |
| ListAssetRevisionsCommand | Lists the revisions for the asset. |
| ListConnectionsCommand | Lists connections. In Amazon DataZone, a connection enables you to connect your resources (domains, projects, and environments) to external resources and services. |
| ListDataProductRevisionsCommand | Lists data product revisions. |
| ListDataSourceRunActivitiesCommand | Lists data source run activities. |
| ListDataSourceRunsCommand | Lists data source runs in Amazon DataZone. |
| ListDataSourcesCommand | Lists data sources in Amazon DataZone. |
| ListDomainUnitsForParentCommand | Lists child domain units for the specified parent domain unit. |
| ListDomainsCommand | Lists Amazon DataZone domains. |
| ListEntityOwnersCommand | Lists the entity (domain units) owners. |
| ListEnvironmentActionsCommand | Lists existing environment actions. |
| ListEnvironmentBlueprintConfigurationsCommand | Lists blueprint configurations for a Amazon DataZone environment. |
| ListEnvironmentBlueprintsCommand | Lists blueprints in an Amazon DataZone environment. |
| ListEnvironmentProfilesCommand | Lists Amazon DataZone environment profiles. |
| ListEnvironmentsCommand | Lists Amazon DataZone environments. |
| ListJobRunsCommand | Lists job runs. |
| ListLineageEventsCommand | Lists lineage events. |
| ListLineageNodeHistoryCommand | Lists the history of the specified data lineage node. |
| ListMetadataGenerationRunsCommand | Lists all metadata generation runs. |
| ListNotificationsCommand | Lists all Amazon DataZone notifications. |
| ListPolicyGrantsCommand | Lists policy grants. |
| ListProjectMembershipsCommand | Lists all members of the specified project. |
| ListProjectProfilesCommand | Lists project profiles. |
| ListProjectsCommand | Lists Amazon DataZone projects. |
| ListRulesCommand | 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. |
| ListSubscriptionGrantsCommand | Lists subscription grants. |
| ListSubscriptionRequestsCommand | Lists Amazon DataZone subscription requests. |
| ListSubscriptionTargetsCommand | Lists subscription targets in Amazon DataZone. |
| ListSubscriptionsCommand | Lists subscriptions in Amazon DataZone. |
| ListTagsForResourceCommand | Lists tags for the specified resource in Amazon DataZone. |
| ListTimeSeriesDataPointsCommand | Lists time series data points. |
| PostLineageEventCommand | Posts a data lineage event. |
| PostTimeSeriesDataPointsCommand | Posts time series data points to Amazon DataZone for the specified asset. |
| PutEnvironmentBlueprintConfigurationCommand | Writes the configuration for the specified environment blueprint in Amazon DataZone. |
| RejectPredictionsCommand | Rejects automatically generated business-friendly metadata for your Amazon DataZone assets. |
| RejectSubscriptionRequestCommand | Rejects the specified subscription request. |
| RemoveEntityOwnerCommand | Removes an owner from an entity. |
| RemovePolicyGrantCommand | Removes a policy grant. |
| RevokeSubscriptionCommand | Revokes a specified subscription in Amazon DataZone. |
| SearchCommand | Searches for assets in Amazon DataZone. |
| SearchGroupProfilesCommand | Searches group profiles in Amazon DataZone. |
| SearchListingsCommand | Searches listings (records of an asset at a given time) in Amazon DataZone. |
| SearchTypesCommand | Searches for types in Amazon DataZone. |
| SearchUserProfilesCommand | Searches user profiles in Amazon DataZone. |
| StartDataSourceRunCommand | Start the run of the specified data source in Amazon DataZone. |
| StartMetadataGenerationRunCommand | Starts the metadata generation run. |
| TagResourceCommand | Tags a resource in Amazon DataZone. |
| UntagResourceCommand | Untags a resource in Amazon DataZone. |
| UpdateAssetFilterCommand | Updates an asset filter. |
| UpdateConnectionCommand | Updates a connection. In Amazon DataZone, a connection enables you to connect your resources (domains, projects, and environments) to external resources and services. |
| UpdateDataSourceCommand | Updates the specified data source in Amazon DataZone. |
| UpdateDomainCommand | Updates a Amazon DataZone domain. |
| UpdateDomainUnitCommand | Updates the domain unit. |
| UpdateEnvironmentActionCommand | Updates an environment action. |
| UpdateEnvironmentCommand | Updates the specified environment in Amazon DataZone. |
| UpdateEnvironmentProfileCommand | Updates the specified environment profile in Amazon DataZone. |
| UpdateGlossaryCommand | Updates the business glossary in Amazon DataZone. |
| UpdateGlossaryTermCommand | Updates a business glossary term in Amazon DataZone. |
| UpdateGroupProfileCommand | Updates the specified group profile in Amazon DataZone. |
| UpdateProjectCommand | Updates the specified project in Amazon DataZone. |
| UpdateProjectProfileCommand | Updates a project profile. |
| UpdateRuleCommand | 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. |
| UpdateSubscriptionGrantStatusCommand | Updates the status of the specified subscription grant status in Amazon DataZone. |
| UpdateSubscriptionRequestCommand | Updates a specified subscription request in Amazon DataZone. |
| UpdateSubscriptionTargetCommand | Updates the specified subscription target in Amazon DataZone. |
| UpdateUserProfileCommand | Updates the specified user profile in Amazon DataZone. |
DataZoneClient Configuration
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
defaultsModeOptional | DefaultsMode | Provider<DefaultsMode> | The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK. |
disableHostPrefixOptional | boolean | Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation. |
extensionsOptional | RuntimeExtension[] | Optional extensions |
loggerOptional | Logger | Optional logger for logging debug/info/warn/error. |
maxAttemptsOptional | number | Provider<number> | Value for how many times a request will be made at most in case of retry. |
profileOptional | string | Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options. |
regionOptional | string | Provider<string> | The AWS region to which this client will send requests |
requestHandlerOptional | __HttpHandlerUserInput | The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs. |
retryModeOptional | string | Provider<string> | Specifies which retry algorithm to use. |
useDualstackEndpointOptional | boolean | Provider<boolean> | Enables IPv6/IPv4 dualstack endpoint. |
useFipsEndpointOptional | boolean | Provider<boolean> | Enables FIPS compatible endpoints. |
Additional config fields are described in the full configuration type: DataZoneClientConfig