DataZone class
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.
Constructors
- DataZone({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
acceptPredictions(
{required String domainIdentifier, required String identifier, List< AcceptChoice> ? acceptChoices, AcceptRule? acceptRule, String? clientToken, String? revision}) → Future<AcceptPredictionsOutput> - Accepts automatically generated business-friendly metadata for your Amazon DataZone assets.
-
acceptSubscriptionRequest(
{required String domainIdentifier, required String identifier, List< AssetPermission> ? assetPermissions, List<AcceptedAssetScope> ? assetScopes, String? decisionComment}) → Future<AcceptSubscriptionRequestOutput> - Accepts a subscription request to a specific asset.
-
addEntityOwner(
{required String domainIdentifier, required String entityIdentifier, required DataZoneEntityType entityType, required OwnerProperties owner, String? clientToken}) → Future< void> - Adds the owner of an entity (a domain unit).
-
addPolicyGrant(
{required PolicyGrantDetail detail, required String domainIdentifier, required String entityIdentifier, required TargetEntityType entityType, required ManagedPolicyType policyType, required PolicyGrantPrincipal principal, String? clientToken}) → Future< AddPolicyGrantOutput> - Adds a policy grant (an authorization policy) to a specified entity, including domain units, environment blueprint configurations, or environment profiles.
-
associateEnvironmentRole(
{required String domainIdentifier, required String environmentIdentifier, required String environmentRoleArn}) → Future< void> - Associates the environment role in Amazon DataZone.
-
associateGovernedTerms(
{required String domainIdentifier, required String entityIdentifier, required GovernedEntityType entityType, required List< String> governedGlossaryTerms}) → Future<void> - Associates governed terms with an asset.
-
batchGetAttributesMetadata(
{required List< String> attributeIdentifiers, required String domainIdentifier, required String entityIdentifier, required AttributeEntityType entityType, String? entityRevision}) → Future<BatchGetAttributesMetadataOutput> - Gets the attribute metadata.
-
batchPutAttributesMetadata(
{required List< AttributeInput> attributes, required String domainIdentifier, required String entityIdentifier, required AttributeEntityType entityType, String? clientToken}) → Future<BatchPutAttributesMetadataOutput> - Writes the attribute metadata.
-
cancelMetadataGenerationRun(
{required String domainIdentifier, required String identifier}) → Future< void> - Cancels the metadata generation run.
-
cancelSubscription(
{required String domainIdentifier, required String identifier}) → Future< CancelSubscriptionOutput> - Cancels the subscription to the specified asset.
-
close(
) → void - Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.
-
createAccountPool(
{required AccountSource accountSource, required String domainIdentifier, required String name, required ResolutionStrategy resolutionStrategy, String? description}) → Future< CreateAccountPoolOutput> - Creates an account pool.
-
createAsset(
{required String domainIdentifier, required String name, required String owningProjectIdentifier, required String typeIdentifier, String? clientToken, String? description, String? externalIdentifier, List< FormInput> ? formsInput, List<String> ? glossaryTerms, PredictionConfiguration? predictionConfiguration, String? typeRevision}) → Future<CreateAssetOutput> - Creates an asset in Amazon DataZone catalog.
-
createAssetFilter(
{required String assetIdentifier, required AssetFilterConfiguration configuration, required String domainIdentifier, required String name, String? clientToken, String? description}) → Future< CreateAssetFilterOutput> - Creates a data asset filter.
-
createAssetRevision(
{required String domainIdentifier, required String identifier, required String name, String? clientToken, String? description, List< FormInput> ? formsInput, List<String> ? glossaryTerms, PredictionConfiguration? predictionConfiguration, String? typeRevision}) → Future<CreateAssetRevisionOutput> - Creates a revision of the asset.
-
createAssetType(
{required String domainIdentifier, required Map< String, FormEntryInput> formsInput, required String name, required String owningProjectIdentifier, String? description}) → Future<CreateAssetTypeOutput> - Creates a custom asset type.
-
createConnection(
{required String domainIdentifier, required String name, AwsLocation? awsLocation, String? clientToken, List< Configuration> ? configurations, String? description, bool? enableTrustedIdentityPropagation, String? environmentIdentifier, ConnectionPropertiesInput? props, ConnectionScope? scope}) → Future<CreateConnectionOutput> - Creates a new connection. In Amazon DataZone, a connection enables you to connect your resources (domains, projects, and environments) to external resources and services.
-
createDataProduct(
{required String domainIdentifier, required String name, required String owningProjectIdentifier, String? clientToken, String? description, List< FormInput> ? formsInput, List<String> ? glossaryTerms, List<DataProductItem> ? items}) → Future<CreateDataProductOutput> - Creates a data product.
-
createDataProductRevision(
{required String domainIdentifier, required String identifier, required String name, String? clientToken, String? description, List< FormInput> ? formsInput, List<String> ? glossaryTerms, List<DataProductItem> ? items}) → Future<CreateDataProductRevisionOutput> - Creates a data product revision.
-
createDataSource(
{required String domainIdentifier, required String name, required String projectIdentifier, required String type, List< FormInput> ? assetFormsInput, String? clientToken, DataSourceConfigurationInput? configuration, String? connectionIdentifier, String? description, EnableSetting? enableSetting, String? environmentIdentifier, bool? publishOnImport, RecommendationConfiguration? recommendation, ScheduleConfiguration? schedule}) → Future<CreateDataSourceOutput> - Creates an Amazon DataZone data source.
-
createDomain(
{required String name, String? clientToken, String? description, String? domainExecutionRole, DomainVersion? domainVersion, String? kmsKeyIdentifier, String? serviceRole, SingleSignOn? singleSignOn, Map< String, String> ? tags}) → Future<CreateDomainOutput> - Creates an Amazon DataZone domain.
-
createDomainUnit(
{required String domainIdentifier, required String name, required String parentDomainUnitIdentifier, String? clientToken, String? description}) → Future< CreateDomainUnitOutput> - Creates a domain unit in Amazon DataZone.
-
createEnvironment(
{required String domainIdentifier, required String name, required String projectIdentifier, int? deploymentOrder, String? description, String? environmentAccountIdentifier, String? environmentAccountRegion, String? environmentBlueprintIdentifier, String? environmentConfigurationId, String? environmentConfigurationName, String? environmentProfileIdentifier, List< String> ? glossaryTerms, List<EnvironmentParameter> ? userParameters}) → Future<CreateEnvironmentOutput> - Create an Amazon DataZone environment.
-
createEnvironmentAction(
{required String domainIdentifier, required String environmentIdentifier, required String name, required ActionParameters parameters, String? description}) → Future< CreateEnvironmentActionOutput> - Creates an action for the environment, for example, creates a console link for an analytics tool that is available in this environment.
-
createEnvironmentBlueprint(
{required String domainIdentifier, required String name, required ProvisioningProperties provisioningProperties, String? description, List< CustomParameter> ? userParameters}) → Future<CreateEnvironmentBlueprintOutput> - Creates a Amazon DataZone blueprint.
-
createEnvironmentProfile(
{required String domainIdentifier, required String environmentBlueprintIdentifier, required String name, required String projectIdentifier, String? awsAccountId, String? awsAccountRegion, String? description, List< EnvironmentParameter> ? userParameters}) → Future<CreateEnvironmentProfileOutput> - Creates an Amazon DataZone environment profile.
-
createFormType(
{required String domainIdentifier, required Model model, required String name, required String owningProjectIdentifier, String? description, FormTypeStatus? status}) → Future< CreateFormTypeOutput> - Creates a metadata form type.
-
createGlossary(
{required String domainIdentifier, required String name, required String owningProjectIdentifier, String? clientToken, String? description, GlossaryStatus? status, List< GlossaryUsageRestriction> ? usageRestrictions}) → Future<CreateGlossaryOutput> - Creates an Amazon DataZone business glossary.
-
createGlossaryTerm(
{required String domainIdentifier, required String glossaryIdentifier, required String name, String? clientToken, String? longDescription, String? shortDescription, GlossaryTermStatus? status, TermRelations? termRelations}) → Future< CreateGlossaryTermOutput> - Creates a business glossary term.
-
createGroupProfile(
{required String domainIdentifier, String? clientToken, String? groupIdentifier, String? rolePrincipalArn}) → Future< CreateGroupProfileOutput> - Creates a group profile in Amazon DataZone.
-
createListingChangeSet(
{required ChangeAction action, required String domainIdentifier, required String entityIdentifier, required EntityType entityType, String? clientToken, String? entityRevision}) → Future< CreateListingChangeSetOutput> - Publishes a listing (a record of an asset at a given time) or removes a listing from the catalog.
-
createNotebook(
{required String domainIdentifier, required String name, required String owningProjectIdentifier, String? clientToken, String? description, Map< String, String> ? metadata, Map<String, String> ? parameters}) → Future<CreateNotebookOutput> - Creates a notebook in Amazon SageMaker Unified Studio. A notebook is a collaborative document within a project that contains code cells for interactive computing.
-
createProject(
{required String domainIdentifier, required String name, String? description, String? domainUnitId, List< String> ? glossaryTerms, List<ProjectMembershipAssignment> ? membershipAssignments, String? projectCategory, String? projectExecutionRole, String? projectProfileId, Map<String, String> ? resourceTags, List<EnvironmentConfigurationUserParameter> ? userParameters}) → Future<CreateProjectOutput> - Creates an Amazon DataZone project.
-
createProjectMembership(
{required UserDesignation designation, required String domainIdentifier, required Member member, required String projectIdentifier}) → Future< void> - Creates a project membership in Amazon DataZone.
-
createProjectProfile(
{required String domainIdentifier, required String name, bool? allowCustomProjectResourceTags, String? description, String? domainUnitIdentifier, List< EnvironmentConfiguration> ? environmentConfigurations, List<ResourceTagParameter> ? projectResourceTags, String? projectResourceTagsDescription, Status? status}) → Future<CreateProjectProfileOutput> - Creates a project profile.
-
createRule(
{required RuleAction action, required RuleDetail detail, required String domainIdentifier, required String name, required RuleScope scope, required RuleTarget target, String? clientToken, String? description}) → Future< CreateRuleOutput> - 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.
-
createSubscriptionGrant(
{required String domainIdentifier, required String environmentIdentifier, required GrantedEntityInput grantedEntity, List< AssetTargetNameMap> ? assetTargetNames, String? clientToken, String? subscriptionTargetIdentifier}) → Future<CreateSubscriptionGrantOutput> - Creates a subsscription grant in Amazon DataZone.
-
createSubscriptionRequest(
{required String domainIdentifier, required String requestReason, required List< SubscribedListingInput> subscribedListings, required List<SubscribedPrincipalInput> subscribedPrincipals, List<AssetPermission> ? assetPermissions, List<AcceptedAssetScope> ? assetScopes, String? clientToken, List<FormInput> ? metadataForms}) → Future<CreateSubscriptionRequestOutput> - Creates a subscription request in Amazon DataZone.
-
createSubscriptionTarget(
{required List< String> applicableAssetTypes, required List<String> authorizedPrincipals, required String domainIdentifier, required String environmentIdentifier, required String manageAccessRole, required String name, required List<SubscriptionTargetForm> subscriptionTargetConfig, required String type, String? clientToken, String? provider, SubscriptionGrantCreationMode? subscriptionGrantCreationMode}) → Future<CreateSubscriptionTargetOutput> - Creates a subscription target in Amazon DataZone.
-
createUserProfile(
{required String domainIdentifier, required String userIdentifier, String? clientToken, String? sessionName, UserType? userType}) → Future< CreateUserProfileOutput> - Creates a user profile in Amazon DataZone.
-
deleteAccountPool(
{required String domainIdentifier, required String identifier}) → Future< void> - Deletes an account pool.
-
deleteAsset(
{required String domainIdentifier, required String identifier}) → Future< void> - Deletes an asset in Amazon DataZone.
-
deleteAssetFilter(
{required String assetIdentifier, required String domainIdentifier, required String identifier}) → Future< void> - Deletes an asset filter.
-
deleteAssetType(
{required String domainIdentifier, required String identifier}) → Future< void> - Deletes an asset type in Amazon DataZone.
-
deleteConnection(
{required String domainIdentifier, required String identifier}) → Future< DeleteConnectionOutput> - Deletes and connection. In Amazon DataZone, a connection enables you to connect your resources (domains, projects, and environments) to external resources and services.
-
deleteDataExportConfiguration(
{required String domainIdentifier}) → Future< void> - Deletes data export configuration for a domain.
-
deleteDataProduct(
{required String domainIdentifier, required String identifier}) → Future< void> - Deletes a data product in Amazon DataZone.
-
deleteDataSource(
{required String domainIdentifier, required String identifier, String? clientToken, bool? retainPermissionsOnRevokeFailure}) → Future< DeleteDataSourceOutput> - Deletes a data source in Amazon DataZone.
-
deleteDomain(
{required String identifier, String? clientToken, bool? skipDeletionCheck}) → Future< DeleteDomainOutput> - Deletes a Amazon DataZone domain.
-
deleteDomainUnit(
{required String domainIdentifier, required String identifier}) → Future< void> - Deletes a domain unit.
-
deleteEnvironment(
{required String domainIdentifier, required String identifier}) → Future< void> - Deletes an environment in Amazon DataZone.
-
deleteEnvironmentAction(
{required String domainIdentifier, required String environmentIdentifier, required String identifier}) → Future< void> - Deletes an action for the environment, for example, deletes a console link for an analytics tool that is available in this environment.
-
deleteEnvironmentBlueprint(
{required String domainIdentifier, required String identifier}) → Future< void> - Deletes a blueprint in Amazon DataZone.
-
deleteEnvironmentBlueprintConfiguration(
{required String domainIdentifier, required String environmentBlueprintIdentifier}) → Future< void> - Deletes the blueprint configuration in Amazon DataZone.
-
deleteEnvironmentProfile(
{required String domainIdentifier, required String identifier}) → Future< void> - Deletes an environment profile in Amazon DataZone.
-
deleteFormType(
{required String domainIdentifier, required String formTypeIdentifier}) → Future< void> - Deletes and metadata form type in Amazon DataZone.
-
deleteGlossary(
{required String domainIdentifier, required String identifier}) → Future< void> - Deletes a business glossary in Amazon DataZone.
-
deleteGlossaryTerm(
{required String domainIdentifier, required String identifier}) → Future< void> - Deletes a business glossary term in Amazon DataZone.
-
deleteListing(
{required String domainIdentifier, required String identifier}) → Future< void> - Deletes a listing (a record of an asset at a given time).
-
deleteNotebook(
{required String domainIdentifier, required String identifier}) → Future< void> - Deletes a notebook in Amazon SageMaker Unified Studio.
-
deleteProject(
{required String domainIdentifier, required String identifier, bool? skipDeletionCheck}) → Future< void> - Deletes a project in Amazon DataZone.
-
deleteProjectMembership(
{required String domainIdentifier, required Member member, required String projectIdentifier}) → Future< void> - Deletes project membership in Amazon DataZone.
-
deleteProjectProfile(
{required String domainIdentifier, required String identifier}) → Future< void> - Deletes a project profile.
-
deleteRule(
{required String domainIdentifier, required String identifier}) → Future< void> - 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.
-
deleteSubscriptionGrant(
{required String domainIdentifier, required String identifier}) → Future< DeleteSubscriptionGrantOutput> - Deletes and subscription grant in Amazon DataZone.
-
deleteSubscriptionRequest(
{required String domainIdentifier, required String identifier}) → Future< void> - Deletes a subscription request in Amazon DataZone.
-
deleteSubscriptionTarget(
{required String domainIdentifier, required String environmentIdentifier, required String identifier}) → Future< void> - Deletes a subscription target in Amazon DataZone.
-
deleteTimeSeriesDataPoints(
{required String domainIdentifier, required String entityIdentifier, required TimeSeriesEntityType entityType, required String formName, String? clientToken}) → Future< void> - Deletes the specified time series form for the specified asset.
-
disassociateEnvironmentRole(
{required String domainIdentifier, required String environmentIdentifier, required String environmentRoleArn}) → Future< void> - Disassociates the environment role in Amazon DataZone.
-
disassociateGovernedTerms(
{required String domainIdentifier, required String entityIdentifier, required GovernedEntityType entityType, required List< String> governedGlossaryTerms}) → Future<void> - Disassociates restricted terms from an asset.
-
getAccountPool(
{required String domainIdentifier, required String identifier}) → Future< GetAccountPoolOutput> - Gets the details of the account pool.
-
getAsset(
{required String domainIdentifier, required String identifier, String? revision}) → Future< GetAssetOutput> - Gets an Amazon DataZone asset.
-
getAssetFilter(
{required String assetIdentifier, required String domainIdentifier, required String identifier}) → Future< GetAssetFilterOutput> - Gets an asset filter.
-
getAssetType(
{required String domainIdentifier, required String identifier, String? revision}) → Future< GetAssetTypeOutput> - Gets an Amazon DataZone asset type.
-
getConnection(
{required String domainIdentifier, required String identifier, bool? withSecret}) → Future< GetConnectionOutput> - Gets a connection. In Amazon DataZone, a connection enables you to connect your resources (domains, projects, and environments) to external resources and services.
-
getDataExportConfiguration(
{required String domainIdentifier}) → Future< GetDataExportConfigurationOutput> - Gets data export configuration details.
-
getDataProduct(
{required String domainIdentifier, required String identifier, String? revision}) → Future< GetDataProductOutput> - Gets the data product.
-
getDataSource(
{required String domainIdentifier, required String identifier}) → Future< GetDataSourceOutput> - Gets an Amazon DataZone data source.
-
getDataSourceRun(
{required String domainIdentifier, required String identifier}) → Future< GetDataSourceRunOutput> - Gets an Amazon DataZone data source run.
-
getDomain(
{required String identifier}) → Future< GetDomainOutput> - Gets an Amazon DataZone domain.
-
getDomainUnit(
{required String domainIdentifier, required String identifier}) → Future< GetDomainUnitOutput> - Gets the details of the specified domain unit.
-
getEnvironment(
{required String domainIdentifier, required String identifier}) → Future< GetEnvironmentOutput> - Gets an Amazon DataZone environment.
-
getEnvironmentAction(
{required String domainIdentifier, required String environmentIdentifier, required String identifier}) → Future< GetEnvironmentActionOutput> - Gets the specified environment action.
-
getEnvironmentBlueprint(
{required String domainIdentifier, required String identifier}) → Future< GetEnvironmentBlueprintOutput> - Gets an Amazon DataZone blueprint.
-
getEnvironmentBlueprintConfiguration(
{required String domainIdentifier, required String environmentBlueprintIdentifier}) → Future< GetEnvironmentBlueprintConfigurationOutput> - Gets the blueprint configuration in Amazon DataZone.
-
getEnvironmentCredentials(
{required String domainIdentifier, required String environmentIdentifier}) → Future< GetEnvironmentCredentialsOutput> - Gets the credentials of an environment in Amazon DataZone.
-
getEnvironmentProfile(
{required String domainIdentifier, required String identifier}) → Future< GetEnvironmentProfileOutput> - Gets an evinronment profile in Amazon DataZone.
-
getFormType(
{required String domainIdentifier, required String formTypeIdentifier, String? revision}) → Future< GetFormTypeOutput> - Gets a metadata form type in Amazon DataZone.
-
getGlossary(
{required String domainIdentifier, required String identifier}) → Future< GetGlossaryOutput> - Gets a business glossary in Amazon DataZone.
-
getGlossaryTerm(
{required String domainIdentifier, required String identifier}) → Future< GetGlossaryTermOutput> - Gets a business glossary term in Amazon DataZone.
-
getGroupProfile(
{required String domainIdentifier, required String groupIdentifier}) → Future< GetGroupProfileOutput> - Gets a group profile in Amazon DataZone.
-
getIamPortalLoginUrl(
{required String domainIdentifier}) → Future< GetIamPortalLoginUrlOutput> - Gets the data portal URL for the specified Amazon DataZone domain.
-
getJobRun(
{required String domainIdentifier, required String identifier}) → Future< GetJobRunOutput> - The details of the job run.
-
getLineageEvent(
{required String domainIdentifier, required String identifier}) → Future< GetLineageEventOutput> - Describes the lineage event.
-
getLineageNode(
{required String domainIdentifier, required String identifier, DateTime? eventTimestamp}) → Future< GetLineageNodeOutput> - Gets the data lineage node.
-
getListing(
{required String domainIdentifier, required String identifier, String? listingRevision}) → Future< GetListingOutput> - 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.
-
getMetadataGenerationRun(
{required String domainIdentifier, required String identifier, MetadataGenerationRunType? type}) → Future< GetMetadataGenerationRunOutput> - Gets a metadata generation run in Amazon DataZone.
-
getNotebook(
{required String domainIdentifier, required String identifier}) → Future< GetNotebookOutput> - Gets the details of a notebook in Amazon SageMaker Unified Studio.
-
getNotebookExport(
{required String domainIdentifier, required String identifier}) → Future< GetNotebookExportOutput> - Gets the details of a notebook export in Amazon SageMaker Unified Studio.
-
getNotebookRun(
{required String domainIdentifier, required String identifier}) → Future< GetNotebookRunOutput> - Gets the details of a notebook run in Amazon SageMaker Unified Studio.
-
getProject(
{required String domainIdentifier, required String identifier}) → Future< GetProjectOutput> - Gets a project in Amazon DataZone.
-
getProjectProfile(
{required String domainIdentifier, required String identifier}) → Future< GetProjectProfileOutput> - The details of the project profile.
-
getRule(
{required String domainIdentifier, required String identifier, String? revision}) → Future< GetRuleOutput> - 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.
-
getSubscription(
{required String domainIdentifier, required String identifier}) → Future< GetSubscriptionOutput> - Gets a subscription in Amazon DataZone.
-
getSubscriptionGrant(
{required String domainIdentifier, required String identifier}) → Future< GetSubscriptionGrantOutput> - Gets the subscription grant in Amazon DataZone.
-
getSubscriptionRequestDetails(
{required String domainIdentifier, required String identifier}) → Future< GetSubscriptionRequestDetailsOutput> - Gets the details of the specified subscription request.
-
getSubscriptionTarget(
{required String domainIdentifier, required String environmentIdentifier, required String identifier}) → Future< GetSubscriptionTargetOutput> - Gets the subscription target in Amazon DataZone.
-
getTimeSeriesDataPoint(
{required String domainIdentifier, required String entityIdentifier, required TimeSeriesEntityType entityType, required String formName, required String identifier}) → Future< GetTimeSeriesDataPointOutput> - Gets the existing data point for the asset.
-
getUserProfile(
{required String domainIdentifier, required String userIdentifier, String? sessionName, UserProfileType? type}) → Future< GetUserProfileOutput> - Gets a user profile in Amazon DataZone.
-
listAccountPools(
{required String domainIdentifier, int? maxResults, String? name, String? nextToken, SortFieldAccountPool? sortBy, SortOrder? sortOrder}) → Future< ListAccountPoolsOutput> - Lists existing account pools.
-
listAccountsInAccountPool(
{required String domainIdentifier, required String identifier, int? maxResults, String? nextToken}) → Future< ListAccountsInAccountPoolOutput> - Lists the accounts in the specified account pool.
-
listAssetFilters(
{required String assetIdentifier, required String domainIdentifier, int? maxResults, String? nextToken, FilterStatus? status}) → Future< ListAssetFiltersOutput> - Lists asset filters.
-
listAssetRevisions(
{required String domainIdentifier, required String identifier, int? maxResults, String? nextToken}) → Future< ListAssetRevisionsOutput> - Lists the revisions for the asset.
-
listConnections(
{required String domainIdentifier, String? environmentIdentifier, int? maxResults, String? name, String? nextToken, String? projectIdentifier, ConnectionScope? scope, SortFieldConnection? sortBy, SortOrder? sortOrder, ConnectionType? type}) → Future< ListConnectionsOutput> - Lists connections. In Amazon DataZone, a connection enables you to connect your resources (domains, projects, and environments) to external resources and services.
-
listDataProductRevisions(
{required String domainIdentifier, required String identifier, int? maxResults, String? nextToken}) → Future< ListDataProductRevisionsOutput> - Lists data product revisions.
-
listDataSourceRunActivities(
{required String domainIdentifier, required String identifier, int? maxResults, String? nextToken, DataAssetActivityStatus? status}) → Future< ListDataSourceRunActivitiesOutput> - Lists data source run activities.
-
listDataSourceRuns(
{required String dataSourceIdentifier, required String domainIdentifier, int? maxResults, String? nextToken, DataSourceRunStatus? status}) → Future< ListDataSourceRunsOutput> - Lists data source runs in Amazon DataZone.
-
listDataSources(
{required String domainIdentifier, required String projectIdentifier, String? connectionIdentifier, String? environmentIdentifier, int? maxResults, String? name, String? nextToken, DataSourceStatus? status, String? type}) → Future< ListDataSourcesOutput> - Lists data sources in Amazon DataZone.
-
listDomains(
{int? maxResults, String? nextToken, DomainStatus? status}) → Future< ListDomainsOutput> - Lists Amazon DataZone domains.
-
listDomainUnitsForParent(
{required String domainIdentifier, required String parentDomainUnitIdentifier, int? maxResults, String? nextToken}) → Future< ListDomainUnitsForParentOutput> - Lists child domain units for the specified parent domain unit.
-
listEntityOwners(
{required String domainIdentifier, required String entityIdentifier, required DataZoneEntityType entityType, int? maxResults, String? nextToken}) → Future< ListEntityOwnersOutput> - Lists the entity (domain units) owners.
-
listEnvironmentActions(
{required String domainIdentifier, required String environmentIdentifier, int? maxResults, String? nextToken}) → Future< ListEnvironmentActionsOutput> - Lists existing environment actions.
-
listEnvironmentBlueprintConfigurations(
{required String domainIdentifier, int? maxResults, String? nextToken}) → Future< ListEnvironmentBlueprintConfigurationsOutput> - Lists blueprint configurations for a Amazon DataZone environment.
-
listEnvironmentBlueprints(
{required String domainIdentifier, bool? managed, int? maxResults, String? name, String? nextToken}) → Future< ListEnvironmentBlueprintsOutput> - Lists blueprints in an Amazon DataZone environment.
-
listEnvironmentProfiles(
{required String domainIdentifier, String? awsAccountId, String? awsAccountRegion, String? environmentBlueprintIdentifier, int? maxResults, String? name, String? nextToken, String? projectIdentifier}) → Future< ListEnvironmentProfilesOutput> - Lists Amazon DataZone environment profiles.
-
listEnvironments(
{required String domainIdentifier, required String projectIdentifier, String? awsAccountId, String? awsAccountRegion, String? environmentBlueprintIdentifier, String? environmentProfileIdentifier, int? maxResults, String? name, String? nextToken, String? provider, EnvironmentStatus? status}) → Future< ListEnvironmentsOutput> - Lists Amazon DataZone environments.
-
listJobRuns(
{required String domainIdentifier, required String jobIdentifier, int? maxResults, String? nextToken, SortOrder? sortOrder, JobRunStatus? status}) → Future< ListJobRunsOutput> - Lists job runs.
-
listLineageEvents(
{required String domainIdentifier, int? maxResults, String? nextToken, LineageEventProcessingStatus? processingStatus, SortOrder? sortOrder, DateTime? timestampAfter, DateTime? timestampBefore}) → Future< ListLineageEventsOutput> - Lists lineage events.
-
listLineageNodeHistory(
{required String domainIdentifier, required String identifier, EdgeDirection? direction, DateTime? eventTimestampGTE, DateTime? eventTimestampLTE, int? maxResults, String? nextToken, SortOrder? sortOrder}) → Future< ListLineageNodeHistoryOutput> - Lists the history of the specified data lineage node.
-
listMetadataGenerationRuns(
{required String domainIdentifier, int? maxResults, String? nextToken, MetadataGenerationRunStatus? status, String? targetIdentifier, MetadataGenerationRunType? type}) → Future< ListMetadataGenerationRunsOutput> - Lists all metadata generation runs.
-
listNotebookRuns(
{required String domainIdentifier, required String owningProjectIdentifier, int? maxResults, String? nextToken, String? notebookIdentifier, String? scheduleIdentifier, SortOrder? sortOrder, NotebookRunStatus? status}) → Future< ListNotebookRunsOutput> - Lists notebook runs in Amazon SageMaker Unified Studio.
-
listNotebooks(
{required String domainIdentifier, required String owningProjectIdentifier, int? maxResults, String? nextToken, SortKey? sortBy, SortOrder? sortOrder, NotebookStatus? status}) → Future< ListNotebooksOutput> - Lists notebooks in Amazon SageMaker Unified Studio.
-
listNotifications(
{required String domainIdentifier, required NotificationType type, DateTime? afterTimestamp, DateTime? beforeTimestamp, int? maxResults, String? nextToken, List< String> ? subjects, TaskStatus? taskStatus}) → Future<ListNotificationsOutput> - Lists all Amazon DataZone notifications.
-
listPolicyGrants(
{required String domainIdentifier, required String entityIdentifier, required TargetEntityType entityType, required ManagedPolicyType policyType, int? maxResults, String? nextToken}) → Future< ListPolicyGrantsOutput> - Lists policy grants.
-
listProjectMemberships(
{required String domainIdentifier, required String projectIdentifier, int? maxResults, String? nextToken, SortFieldProject? sortBy, SortOrder? sortOrder}) → Future< ListProjectMembershipsOutput> - Lists all members of the specified project.
-
listProjectProfiles(
{required String domainIdentifier, int? maxResults, String? name, String? nextToken, SortFieldProject? sortBy, SortOrder? sortOrder}) → Future< ListProjectProfilesOutput> - Lists project profiles.
-
listProjects(
{required String domainIdentifier, String? groupIdentifier, int? maxResults, String? name, String? nextToken, String? projectCategory, String? userIdentifier}) → Future< ListProjectsOutput> - Lists Amazon DataZone projects.
-
listRules(
{required String domainIdentifier, required String targetIdentifier, required RuleTargetType targetType, RuleAction? action, List< String> ? assetTypes, bool? dataProduct, bool? includeCascaded, int? maxResults, String? nextToken, List<String> ? projectIds, RuleType? ruleType}) → Future<ListRulesOutput> - 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.
-
listSubscriptionGrants(
{required String domainIdentifier, String? environmentId, int? maxResults, String? nextToken, String? owningGroupId, String? owningIamPrincipalArn, String? owningProjectId, String? owningUserId, SortKey? sortBy, SortOrder? sortOrder, String? subscribedListingId, String? subscriptionId, String? subscriptionTargetId}) → Future< ListSubscriptionGrantsOutput> - Lists subscription grants.
-
listSubscriptionRequests(
{required String domainIdentifier, String? approverProjectId, int? maxResults, String? nextToken, String? owningGroupId, String? owningIamPrincipalArn, String? owningProjectId, String? owningUserId, SortKey? sortBy, SortOrder? sortOrder, SubscriptionRequestStatus? status, String? subscribedListingId}) → Future< ListSubscriptionRequestsOutput> - Lists Amazon DataZone subscription requests.
-
listSubscriptions(
{required String domainIdentifier, String? approverProjectId, int? maxResults, String? nextToken, String? owningGroupId, String? owningIamPrincipalArn, String? owningProjectId, String? owningUserId, SortKey? sortBy, SortOrder? sortOrder, SubscriptionStatus? status, String? subscribedListingId, String? subscriptionRequestIdentifier}) → Future< ListSubscriptionsOutput> - Lists subscriptions in Amazon DataZone.
-
listSubscriptionTargets(
{required String domainIdentifier, required String environmentIdentifier, int? maxResults, String? nextToken, SortKey? sortBy, SortOrder? sortOrder}) → Future< ListSubscriptionTargetsOutput> - Lists subscription targets in Amazon DataZone.
-
listTagsForResource(
{required String resourceArn}) → Future< ListTagsForResourceResponse> - Lists tags for the specified resource in Amazon DataZone.
-
listTimeSeriesDataPoints(
{required String domainIdentifier, required String entityIdentifier, required TimeSeriesEntityType entityType, required String formName, DateTime? endedAt, int? maxResults, String? nextToken, DateTime? startedAt}) → Future< ListTimeSeriesDataPointsOutput> - Lists time series data points.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
postLineageEvent(
{required String domainIdentifier, required Uint8List event, String? clientToken}) → Future< PostLineageEventOutput> - Posts a data lineage event.
-
postTimeSeriesDataPoints(
{required String domainIdentifier, required String entityIdentifier, required TimeSeriesEntityType entityType, required List< TimeSeriesDataPointFormInput> forms, String? clientToken}) → Future<PostTimeSeriesDataPointsOutput> - Posts time series data points to Amazon DataZone for the specified asset.
-
putDataExportConfiguration(
{required String domainIdentifier, required bool enableExport, String? clientToken, EncryptionConfiguration? encryptionConfiguration}) → Future< void> - Creates data export configuration details.
-
putEnvironmentBlueprintConfiguration(
{required String domainIdentifier, required List< String> enabledRegions, required String environmentBlueprintIdentifier, bool? allowUserProvidedConfigurations, String? environmentRolePermissionBoundary, Map<String, String> ? globalParameters, String? manageAccessRoleArn, List<ProvisioningConfiguration> ? provisioningConfigurations, String? provisioningRoleArn, Map<String, Map< ? regionalParameters, List<String, String> >PutResourceConfiguration> ? resourceConfigurations}) → Future<PutEnvironmentBlueprintConfigurationOutput> - Writes the configuration for the specified environment blueprint in Amazon DataZone.
-
queryGraph(
{required String domainIdentifier, required List< MatchClause> match, AdditionalAttributes? additionalAttributes, int? maxResults, String? nextToken}) → Future<QueryGraphOutput> - Queries entities in the graph store.
-
rejectPredictions(
{required String domainIdentifier, required String identifier, String? clientToken, List< RejectChoice> ? rejectChoices, RejectRule? rejectRule, String? revision}) → Future<RejectPredictionsOutput> - Rejects automatically generated business-friendly metadata for your Amazon DataZone assets.
-
rejectSubscriptionRequest(
{required String domainIdentifier, required String identifier, String? decisionComment}) → Future< RejectSubscriptionRequestOutput> - Rejects the specified subscription request.
-
removeEntityOwner(
{required String domainIdentifier, required String entityIdentifier, required DataZoneEntityType entityType, required OwnerProperties owner, String? clientToken}) → Future< void> - Removes an owner from an entity.
-
removePolicyGrant(
{required String domainIdentifier, required String entityIdentifier, required TargetEntityType entityType, required ManagedPolicyType policyType, required PolicyGrantPrincipal principal, String? clientToken, String? grantIdentifier}) → Future< void> - Removes a policy grant.
-
revokeSubscription(
{required String domainIdentifier, required String identifier, bool? retainPermissions}) → Future< RevokeSubscriptionOutput> - Revokes a specified subscription in Amazon DataZone.
-
search(
{required String domainIdentifier, required InventorySearchScope searchScope, List< SearchOutputAdditionalAttribute> ? additionalAttributes, FilterClause? filters, int? maxResults, String? nextToken, String? owningProjectIdentifier, List<SearchInItem> ? searchIn, String? searchText, SearchSort? sort}) → Future<SearchOutput> - Searches for assets in Amazon DataZone.
-
searchGroupProfiles(
{required String domainIdentifier, required GroupSearchType groupType, int? maxResults, String? nextToken, String? searchText}) → Future< SearchGroupProfilesOutput> - Searches group profiles in Amazon DataZone.
-
searchListings(
{required String domainIdentifier, List< SearchOutputAdditionalAttribute> ? additionalAttributes, List<AggregationListItem> ? aggregations, FilterClause? filters, int? maxResults, String? nextToken, List<SearchInItem> ? searchIn, String? searchText, SearchSort? sort}) → Future<SearchListingsOutput> - Searches listings in Amazon DataZone.
-
searchTypes(
{required String domainIdentifier, required bool managed, required TypesSearchScope searchScope, FilterClause? filters, int? maxResults, String? nextToken, List< SearchInItem> ? searchIn, String? searchText, SearchSort? sort}) → Future<SearchTypesOutput> - Searches for types in Amazon DataZone.
-
searchUserProfiles(
{required String domainIdentifier, required UserSearchType userType, int? maxResults, String? nextToken, String? searchText}) → Future< SearchUserProfilesOutput> - Searches user profiles in Amazon DataZone.
-
startDataSourceRun(
{required String dataSourceIdentifier, required String domainIdentifier, String? clientToken}) → Future< StartDataSourceRunOutput> - Start the run of the specified data source in Amazon DataZone.
-
startMetadataGenerationRun(
{required String domainIdentifier, required String owningProjectIdentifier, required MetadataGenerationRunTarget target, String? clientToken, MetadataGenerationRunType? type, List< MetadataGenerationRunType> ? types}) → Future<StartMetadataGenerationRunOutput> - Starts the metadata generation run.
-
startNotebookExport(
{required String domainIdentifier, required FileFormat fileFormat, required String notebookIdentifier, required String owningProjectIdentifier, String? clientToken}) → Future< StartNotebookExportOutput> - 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.
-
startNotebookImport(
{required String domainIdentifier, required String name, required String owningProjectIdentifier, required SourceLocation sourceLocation, String? clientToken, String? description}) → Future< StartNotebookImportOutput> - Starts a notebook import in Amazon SageMaker Unified Studio. This operation imports a notebook from an Amazon Simple Storage Service location into a project.
-
startNotebookRun(
{required String domainIdentifier, required String notebookIdentifier, required String owningProjectIdentifier, String? clientToken, ComputeConfig? computeConfiguration, Map< String, String> ? metadata, NetworkConfig? networkConfiguration, Map<String, String> ? parameters, String? scheduleIdentifier, TimeoutConfig? timeoutConfiguration, TriggerSource? triggerSource}) → Future<StartNotebookRunOutput> - 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.
-
stopNotebookRun(
{required String domainIdentifier, required String identifier, String? clientToken}) → Future< StopNotebookRunOutput> - Stops a running notebook run in Amazon SageMaker Unified Studio.
-
tagResource(
{required String resourceArn, required Map< String, String> tags}) → Future<void> - Tags a resource in Amazon DataZone.
-
toString(
) → String -
A string representation of this object.
inherited
-
untagResource(
{required String resourceArn, required List< String> tagKeys}) → Future<void> - Untags a resource in Amazon DataZone.
-
updateAccountPool(
{required String domainIdentifier, required String identifier, AccountSource? accountSource, String? description, String? name, ResolutionStrategy? resolutionStrategy}) → Future< UpdateAccountPoolOutput> - Updates the account pool.
-
updateAssetFilter(
{required String assetIdentifier, required String domainIdentifier, required String identifier, AssetFilterConfiguration? configuration, String? description, String? name}) → Future< UpdateAssetFilterOutput> - Updates an asset filter.
-
updateConnection(
{required String domainIdentifier, required String identifier, AwsLocation? awsLocation, List< Configuration> ? configurations, String? description, ConnectionPropertiesPatch? props}) → Future<UpdateConnectionOutput> - Updates a connection. In Amazon DataZone, a connection enables you to connect your resources (domains, projects, and environments) to external resources and services.
-
updateDataSource(
{required String domainIdentifier, required String identifier, List< FormInput> ? assetFormsInput, DataSourceConfigurationInput? configuration, String? description, EnableSetting? enableSetting, String? name, bool? publishOnImport, RecommendationConfiguration? recommendation, bool? retainPermissionsOnRevokeFailure, ScheduleConfiguration? schedule}) → Future<UpdateDataSourceOutput> - Updates the specified data source in Amazon DataZone.
-
updateDomain(
{required String identifier, String? clientToken, String? description, String? domainExecutionRole, String? name, String? serviceRole, SingleSignOn? singleSignOn}) → Future< UpdateDomainOutput> - Updates a Amazon DataZone domain.
-
updateDomainUnit(
{required String domainIdentifier, required String identifier, String? description, String? name}) → Future< UpdateDomainUnitOutput> - Updates the domain unit.
-
updateEnvironment(
{required String domainIdentifier, required String identifier, String? blueprintVersion, String? description, String? environmentConfigurationName, List< String> ? glossaryTerms, String? name, List<EnvironmentParameter> ? userParameters}) → Future<UpdateEnvironmentOutput> - Updates the specified environment in Amazon DataZone.
-
updateEnvironmentAction(
{required String domainIdentifier, required String environmentIdentifier, required String identifier, String? description, String? name, ActionParameters? parameters}) → Future< UpdateEnvironmentActionOutput> - Updates an environment action.
-
updateEnvironmentBlueprint(
{required String domainIdentifier, required String identifier, String? description, ProvisioningProperties? provisioningProperties, List< CustomParameter> ? userParameters}) → Future<UpdateEnvironmentBlueprintOutput> - Updates an environment blueprint in Amazon DataZone.
-
updateEnvironmentProfile(
{required String domainIdentifier, required String identifier, String? awsAccountId, String? awsAccountRegion, String? description, String? name, List< EnvironmentParameter> ? userParameters}) → Future<UpdateEnvironmentProfileOutput> - Updates the specified environment profile in Amazon DataZone.
-
updateGlossary(
{required String domainIdentifier, required String identifier, String? clientToken, String? description, String? name, GlossaryStatus? status}) → Future< UpdateGlossaryOutput> - Updates the business glossary in Amazon DataZone.
-
updateGlossaryTerm(
{required String domainIdentifier, required String identifier, String? glossaryIdentifier, String? longDescription, String? name, String? shortDescription, GlossaryTermStatus? status, TermRelations? termRelations}) → Future< UpdateGlossaryTermOutput> - Updates a business glossary term in Amazon DataZone.
-
updateGroupProfile(
{required String domainIdentifier, required String groupIdentifier, required GroupProfileStatus status}) → Future< UpdateGroupProfileOutput> - Updates the specified group profile in Amazon DataZone.
-
updateNotebook(
{required String domainIdentifier, required String identifier, List< CellInformation> ? cellOrder, String? clientToken, String? description, EnvironmentConfig? environmentConfiguration, Map<String, String> ? metadata, String? name, Map<String, String> ? parameters, NotebookStatus? status}) → Future<UpdateNotebookOutput> - Updates a notebook in Amazon SageMaker Unified Studio.
-
updateProject(
{required String domainIdentifier, required String identifier, String? description, String? domainUnitId, EnvironmentDeploymentDetails? environmentDeploymentDetails, List< String> ? glossaryTerms, String? name, String? projectProfileVersion, Map<String, String> ? resourceTags, List<EnvironmentConfigurationUserParameter> ? userParameters}) → Future<UpdateProjectOutput> - Updates the specified project in Amazon DataZone.
-
updateProjectProfile(
{required String domainIdentifier, required String identifier, bool? allowCustomProjectResourceTags, String? description, String? domainUnitIdentifier, List< EnvironmentConfiguration> ? environmentConfigurations, String? name, List<ResourceTagParameter> ? projectResourceTags, String? projectResourceTagsDescription, Status? status}) → Future<UpdateProjectProfileOutput> - Updates a project profile.
-
updateRootDomainUnitOwner(
{required String currentOwner, required String domainIdentifier, required String newOwner, String? clientToken}) → Future< void> - Updates the owner of the root domain unit.
-
updateRule(
{required String domainIdentifier, required String identifier, String? description, RuleDetail? detail, bool? includeChildDomainUnits, String? name, RuleScope? scope}) → Future< UpdateRuleOutput> - 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.
-
updateSubscriptionGrantStatus(
{required String assetIdentifier, required String domainIdentifier, required String identifier, required SubscriptionGrantStatus status, FailureCause? failureCause, String? targetName}) → Future< UpdateSubscriptionGrantStatusOutput> - Updates the status of the specified subscription grant status in Amazon DataZone.
-
updateSubscriptionRequest(
{required String domainIdentifier, required String identifier, required String requestReason}) → Future< UpdateSubscriptionRequestOutput> - Updates a specified subscription request in Amazon DataZone.
-
updateSubscriptionTarget(
{required String domainIdentifier, required String environmentIdentifier, required String identifier, List< String> ? applicableAssetTypes, List<String> ? authorizedPrincipals, String? manageAccessRole, String? name, String? provider, SubscriptionGrantCreationMode? subscriptionGrantCreationMode, List<SubscriptionTargetForm> ? subscriptionTargetConfig}) → Future<UpdateSubscriptionTargetOutput> - Updates the specified subscription target in Amazon DataZone.
-
updateUserProfile(
{required String domainIdentifier, required UserProfileStatus status, required String userIdentifier, String? sessionName, UserProfileType? type}) → Future< UpdateUserProfileOutput> - Updates the specified user profile in Amazon DataZone.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited