Amazon Web Services, Inc.

Amazon DataZone

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…

Data & analytics#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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.

Endpoints 195

Metadata generation run

  • POSTCancel metadata generation run/v2/domains/:domainIdentifier/metadata-generation-runs/:identifier/cancelCancels the metadata generation run. Prerequisites: The run must exist and be in a cancelable status (e.g., SUBMITTED, IN_PROGRESS). Runs in SUCCEEDED status…
  • GETGet metadata generation run/v2/domains/:domainIdentifier/metadata-generation-runs/:identifier?type=stringGets a metadata generation run in Amazon DataZone. Prerequisites: Valid domain and run identifier. The metadata generation run must exist. User must have read…
  • GETList metadata generation runs/v2/domains/:domainIdentifier/metadata-generation-runs?status=string&type=string&nextToken=string&maxResults=0&targetIdentifier=stringLists all metadata generation runs. Metadata generation runs represent automated processes that leverage AI/ML capabilities to create or enhance asset…
  • POSTStart metadata generation run/v2/domains/:domainIdentifier/metadata-generation-runsStarts the metadata generation run. Prerequisites: Asset must be created and belong to the specified domain and project. Asset type must be supported for…

Asset

  • POSTCreate asset/v2/domains/:domainIdentifier/assetsCreates an asset in Amazon DataZone catalog. Before creating assets, make sure that the following requirements are met: --domain-identifier must refer to an…
  • POSTCreate asset revision/v2/domains/:domainIdentifier/assets/:identifier/revisionsCreates a revision of the asset. Asset revisions represent new versions of existing assets, capturing changes to either the underlying data or its metadata.…
  • GETGet asset/v2/domains/:domainIdentifier/assets/:identifier?revision=stringGets an Amazon DataZone asset. An asset is the fundamental building block in Amazon DataZone, representing any data resource that needs to be cataloged and…
  • DELETEDelete asset/v2/domains/:domainIdentifier/assets/:identifierDeletes an asset in Amazon DataZone. --domain-identifier must refer to a valid and existing domain. --identifier must refer to an existing asset in the…

Asset type

  • POSTCreate asset type/v2/domains/:domainIdentifier/asset-typesCreates a custom asset type. Prerequisites: The formsInput field is required, however, can be passed as empty (e.g. -forms-input {}) . You must have…
  • GETGet asset type/v2/domains/:domainIdentifier/asset-types/:identifier?revision=stringGets an Amazon DataZone asset type. Asset types define the categories and characteristics of different kinds of data assets within Amazon DataZone.. They…
  • DELETEDelete asset type/v2/domains/:domainIdentifier/asset-types/:identifierDeletes an asset type in Amazon DataZone. Prerequisites: The asset type must exist in the domain. You must have DeleteAssetType permission. The asset type…

Data product

  • POSTCreate data product/v2/domains/:domainIdentifier/data-productsCreates a data product. A data product is a comprehensive package that combines data assets with their associated metadata, documentation, and access…
  • POSTCreate data product revision/v2/domains/:domainIdentifier/data-products/:identifier/revisionsCreates a data product revision. Prerequisites: The original data product must exist in the given domain. User must have permissions on the data product. The…
  • GETGet data product/v2/domains/:domainIdentifier/data-products/:identifier?revision=stringGets the data product. Prerequisites: The data product ID must exist. The domain must be valid and accessible. User must have read or discovery permissions…
  • DELETEDelete data product/v2/domains/:domainIdentifier/data-products/:identifierDeletes a data product in Amazon DataZone. Prerequisites: The data product must exist and not be deleted or archived. The user must have delete permissions…

Data source

  • GETList data sources/v2/domains/:domainIdentifier/data-sources?projectIdentifier=string&environmentIdentifier=string&connectionIdentifier=string&type=string&status=string&name=string&nextToken=string&maxResults=0Lists data sources in Amazon DataZone.
  • POSTCreate data source/v2/domains/:domainIdentifier/data-sourcesCreates an Amazon DataZone data source.
  • GETGet data source/v2/domains/:domainIdentifier/data-sources/:identifierGets an Amazon DataZone data source.
  • DELETEDelete data source/v2/domains/:domainIdentifier/data-sources/:identifier?clientToken=string&retainPermissionsOnRevokeFailure=trueDeletes a data source in Amazon DataZone.
  • PATCHUpdate data source/v2/domains/:domainIdentifier/data-sources/:identifierUpdates the specified data source in Amazon DataZone.

Domain

  • GETList domains/v2/domains?status=string&maxResults=0&nextToken=stringLists Amazon DataZone domains.
  • POSTCreate domain/v2/domainsCreates an Amazon DataZone domain.
  • GETGet domain/v2/domains/:identifierGets an Amazon DataZone domain.
  • PUTUpdate domain/v2/domains/:identifier?clientToken=stringUpdates a Amazon DataZone domain.
  • DELETEDelete domain/v2/domains/:identifier?clientToken=string&skipDeletionCheck=true&cascadeDelete=trueDeletes a Amazon DataZone domain.

Domain unit

  • GETList domain units for parent/v2/domains/:domainIdentifier/domain-units?parentDomainUnitIdentifier=string&maxResults=0&nextToken=stringLists child domain units for the specified parent domain unit.
  • POSTCreate domain unit/v2/domains/:domainIdentifier/domain-unitsCreates a domain unit in Amazon DataZone.
  • GETGet domain unit/v2/domains/:domainIdentifier/domain-units/:identifierGets the details of the specified domain unit.
  • PUTUpdate domain unit/v2/domains/:domainIdentifier/domain-units/:identifierUpdates the domain unit.
  • DELETEDelete domain unit/v2/domains/:domainIdentifier/domain-units/:identifierDeletes a domain unit.

Form type

  • POSTCreate form type/v2/domains/:domainIdentifier/form-typesCreates 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…
  • GETGet form type/v2/domains/:domainIdentifier/form-types/:formTypeIdentifier?revision=stringGets a metadata form type in Amazon DataZone. Form types define the structure and validation rules for collecting metadata about assets in Amazon DataZone.…
  • DELETEDelete form type/v2/domains/:domainIdentifier/form-types/:formTypeIdentifierDeletes 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…

Glossary

  • POSTCreate glossary/v2/domains/:domainIdentifier/glossariesCreates an Amazon DataZone business glossary. Specifies that this is a create glossary policy. A glossary serves as the central repository for business…
  • GETGet glossary/v2/domains/:domainIdentifier/glossaries/:identifierGets a business glossary in Amazon DataZone. Prerequisites: The specified glossary ID must exist and be associated with the given domain. The caller must have…
  • DELETEDelete glossary/v2/domains/:domainIdentifier/glossaries/:identifierDeletes a business glossary in Amazon DataZone. Prerequisites: The glossary must be in DISABLED state. The glossary must not have any glossary terms…
  • PATCHUpdate glossary/v2/domains/:domainIdentifier/glossaries/:identifierUpdates the business glossary in Amazon DataZone. Prerequisites: The glossary must exist in the given domain. The caller must have the datazone:UpdateGlossary…

Glossary term

  • POSTCreate glossary term/v2/domains/:domainIdentifier/glossary-termsCreates a business glossary term. A glossary term represents an individual entry within the Amazon DataZone glossary, serving as a standardized definition for…
  • GETGet glossary term/v2/domains/:domainIdentifier/glossary-terms/:identifierGets a business glossary term in Amazon DataZone. Prerequisites: Glossary term with identifier must exist in the domain. User must have permission on the…
  • DELETEDelete glossary term/v2/domains/:domainIdentifier/glossary-terms/:identifierDeletes 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…
  • PATCHUpdate glossary term/v2/domains/:domainIdentifier/glossary-terms/:identifierUpdates a business glossary term in Amazon DataZone. Prerequisites: Glossary term must exist in the specified domain. New name must not conflict with existing…

Notebook

  • GETList notebooks/v2/domains/:domainIdentifier/notebooks?owningProjectIdentifier=string&maxResults=0&sortOrder=string&sortBy=string&status=string&type=string&nextToken=stringLists notebooks in Amazon SageMaker Unified Studio.
  • POSTCreate notebook/v2/domains/:domainIdentifier/notebooksCreates a notebook in Amazon SageMaker Unified Studio. A notebook is a collaborative document within a project that contains code cells for interactive…
  • GETGet notebook/v2/domains/:domainIdentifier/notebooks/:identifierGets the details of a notebook in Amazon SageMaker Unified Studio.
  • DELETEDelete notebook/v2/domains/:domainIdentifier/notebooks/:identifierDeletes a notebook in Amazon SageMaker Unified Studio.
  • PATCHUpdate notebook/v2/domains/:domainIdentifier/notebooks/:identifierUpdates a notebook in Amazon SageMaker Unified Studio.

Rule

  • POSTCreate rule/v2/domains/:domainIdentifier/rulesCreates a rule in Amazon DataZone. A rule is a formal agreement that enforces specific requirements across user workflows (e.g., publishing assets to the…
  • GETGet rule/v2/domains/:domainIdentifier/rules/:identifier?revision=stringGets 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…
  • DELETEDelete rule/v2/domains/:domainIdentifier/rules/:identifierDeletes a rule in Amazon DataZone. A rule is a formal agreement that enforces specific requirements across user workflows (e.g., publishing assets to the…
  • PATCHUpdate rule/v2/domains/:domainIdentifier/rules/:identifierUpdates a rule. In Amazon DataZone, a rule is a formal agreement that enforces specific requirements across user workflows (e.g., publishing assets to the…
  • GETList rules/v2/domains/:domainIdentifier/list-rules/:targetType/:targetIdentifier?ruleType=string&ruleAction=string&projectIds=&assetTypes=&dataProduct=true&includeCascaded=true&maxResults=0&nextToken=stringLists existing rules. In Amazon DataZone, a rule is a formal agreement that enforces specific requirements across user workflows (e.g., publishing assets to…

Environment blueprint configuration

  • GETGet environment blueprint configuration/v2/domains/:domainIdentifier/environment-blueprint-configurations/:environmentBlueprintIdentifierGets the blueprint configuration in Amazon DataZone.
  • PUTPut environment blueprint configuration/v2/domains/:domainIdentifier/environment-blueprint-configurations/:environmentBlueprintIdentifierWrites the configuration for the specified environment blueprint in Amazon DataZone.
  • DELETEDelete environment blueprint configuration/v2/domains/:domainIdentifier/environment-blueprint-configurations/:environmentBlueprintIdentifierDeletes the blueprint configuration in Amazon DataZone.
  • GETList environment blueprint configurations/v2/domains/:domainIdentifier/environment-blueprint-configurations?maxResults=0&nextToken=stringLists blueprint configurations for a Amazon DataZone environment.

Listing

  • GETGet listing/v2/domains/:domainIdentifier/listings/:identifier?listingRevision=stringGets 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.
  • DELETEDelete listing/v2/domains/:domainIdentifier/listings/:identifierDeletes a listing (a record of an asset at a given time).

Data source run

  • GETGet data source run/v2/domains/:domainIdentifier/data-source-runs/:identifierGets an Amazon DataZone data source run.
  • GETList data source runs/v2/domains/:domainIdentifier/data-sources/:dataSourceIdentifier/runs?status=string&nextToken=string&maxResults=0Lists data source runs in Amazon DataZone.
  • POSTStart data source run/v2/domains/:domainIdentifier/data-sources/:dataSourceIdentifier/runsStart the run of the specified data source in Amazon DataZone.

Notebook export

  • GETGet notebook export/v2/domains/:domainIdentifier/notebook-exports/:identifierGets the details of a notebook export in Amazon SageMaker Unified Studio.
  • POSTStart notebook export/v2/domains/:domainIdentifier/notebook-exportsStarts a notebook export in Amazon SageMaker Unified Studio. This operation exports a notebook to a specified file format and stores the output in Amazon…

Notebook run

  • GETGet notebook run/v2/domains/:domainIdentifier/notebook-runs/:identifierGets the details of a notebook run in Amazon SageMaker Unified Studio.
  • GETList notebook runs/v2/domains/:domainIdentifier/notebook-runs?owningProjectIdentifier=string&notebookIdentifier=string&status=string&scheduleIdentifier=string&maxResults=0&sortOrder=string&nextToken=stringLists notebook runs in Amazon SageMaker Unified Studio.
  • POSTStart notebook run/v2/domains/:domainIdentifier/notebook-runsStarts a notebook run in Amazon SageMaker Unified Studio. A notebook run represents the execution of an Amazon SageMaker notebook within a project. You can…
  • PUTStop notebook run/v2/domains/:domainIdentifier/notebook-runs/:identifier/stopStops a running notebook run in Amazon SageMaker Unified Studio.
  • PUTAccept predictions/v2/domains/:domainIdentifier/assets/:identifier/accept-predictions?revision=stringAccepts automatically generated business-friendly metadata for your Amazon DataZone assets.
  • PUTAccept subscription request/v2/domains/:domainIdentifier/subscription-requests/:identifier/acceptAccepts a subscription request to a specific asset.
  • POSTAdd entity owner/v2/domains/:domainIdentifier/entities/:entityType/:entityIdentifier/addOwnerAdds the owner of an entity (a domain unit).
  • POSTAdd policy grant/v2/domains/:domainIdentifier/policies/managed/:entityType/:entityIdentifier/addGrantAdds a policy grant (an authorization policy) to a specified entity, including domain units, environment blueprint configurations, or environment profiles.
  • PUTAssociate environment role/v2/domains/:domainIdentifier/environments/:environmentIdentifier/roles/:environmentRoleArnAssociates the environment role in Amazon DataZone.
  • DELETEDisassociate environment role/v2/domains/:domainIdentifier/environments/:environmentIdentifier/roles/:environmentRoleArnDisassociates the environment role in Amazon DataZone.
  • PATCHAssociate governed terms/v2/domains/:domainIdentifier/entities/:entityType/:entityIdentifier/associate-governed-termsAssociates governed terms with an asset.
  • GETBatch get attributes metadata/v2/domains/:domainIdentifier/entities/:entityType/:entityIdentifier/attributes-metadata?entityRevision=string&attributeIdentifier=Gets the attribute metadata.
  • PUTBatch put attributes metadata/v2/domains/:domainIdentifier/entities/:entityType/:entityIdentifier/attributes-metadataWrites the attribute metadata.
  • PUTCancel subscription/v2/domains/:domainIdentifier/subscriptions/:identifier/cancelCancels the subscription to the specified asset.
  • GETList account pools/v2/domains/:domainIdentifier/account-pools?name=string&sortBy=string&sortOrder=string&nextToken=string&maxResults=0Lists existing account pools.
  • POSTCreate account pool/v2/domains/:domainIdentifier/account-poolsCreates an account pool.
  • GETList asset filters/v2/domains/:domainIdentifier/assets/:assetIdentifier/filters?status=string&nextToken=string&maxResults=0Lists asset filters. Prerequisites: A valid domain and asset must exist. The asset must have at least one filter created to return results.
  • POSTCreate asset filter/v2/domains/:domainIdentifier/assets/:assetIdentifier/filtersCreates a data asset filter. Asset filters provide a sophisticated way to create controlled views of data assets by selecting specific columns or applying…
  • GETList asset revisions/v2/domains/:domainIdentifier/assets/:identifier/revisions?nextToken=string&maxResults=0Lists 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…
  • GETList connections/v2/domains/:domainIdentifier/connections?maxResults=0&nextToken=string&sortBy=string&sortOrder=string&name=string&environmentIdentifier=string&projectIdentifier=string&type=string&scope=stringLists connections. In Amazon DataZone, a connection enables you to connect your resources (domains, projects, and environments) to external resources and…
  • POSTCreate connection/v2/domains/:domainIdentifier/connectionsCreates a new connection. In Amazon DataZone, a connection enables you to connect your resources (domains, projects, and environments) to external resources…
  • GETList data product revisions/v2/domains/:domainIdentifier/data-products/:identifier/revisions?maxResults=0&nextToken=stringLists data product revisions. Prerequisites: The data product ID must exist within the domain. User must have view permissions on the data product. The domain…
  • GETList designations/v2/domains/:domainIdentifier/designations?nextToken=string&maxResults=0Lists the designations in a domain. The response returns system-managed designations first, followed by user-created designations in alphabetical order by…
  • POSTCreate designation/v2/domains/:domainIdentifier/designationsCreates a new user-defined designation with a Cedar permit policy. The designation defines a named role that can be assigned to project members through…
  • GETList environments/v2/domains/:domainIdentifier/environments?awsAccountId=string&status=string&awsAccountRegion=string&projectIdentifier=string&environmentProfileIdentifier=string&environmentBlueprintIdentifier=string&provider=string&name=string&maxResults=0&nextToken=stringLists Amazon DataZone environments.
  • POSTCreate environment/v2/domains/:domainIdentifier/environmentsCreate an Amazon DataZone environment.
  • GETList environment actions/v2/domains/:domainIdentifier/environments/:environmentIdentifier/actions?nextToken=string&maxResults=0Lists existing environment actions.
  • POSTCreate environment action/v2/domains/:domainIdentifier/environments/:environmentIdentifier/actionsCreates an action for the environment, for example, creates a console link for an analytics tool that is available in this environment.
  • GETList environment blueprints/v2/domains/:domainIdentifier/environment-blueprints?maxResults=0&nextToken=string&name=string&managed=trueLists blueprints in an Amazon DataZone environment.
  • POSTCreate environment blueprint/v2/domains/:domainIdentifier/environment-blueprintsCreates a Amazon DataZone blueprint.
  • GETList environment profiles/v2/domains/:domainIdentifier/environment-profiles?awsAccountId=string&awsAccountRegion=string&environmentBlueprintIdentifier=string&projectIdentifier=string&name=string&nextToken=string&maxResults=0Lists Amazon DataZone environment profiles.
  • POSTCreate environment profile/v2/domains/:domainIdentifier/environment-profilesCreates an Amazon DataZone environment profile.
  • POSTCreate group profile/v2/domains/:domainIdentifier/group-profilesCreates a group profile in Amazon DataZone.
  • POSTCreate listing change set/v2/domains/:domainIdentifier/listings/change-setPublishes a listing (a record of an asset at a given time) or removes a listing from the catalog.
  • GETList projects/v2/domains/:domainIdentifier/projects?userIdentifier=string&groupIdentifier=string&name=string&projectCategory=string&nextToken=string&maxResults=0Lists Amazon DataZone projects.
  • POSTCreate project/v2/domains/:domainIdentifier/projectsCreates an Amazon DataZone project.
  • POSTCreate project membership/v2/domains/:domainIdentifier/projects/:projectIdentifier/createMembershipCreates a project membership in Amazon DataZone.
  • GETList project profiles/v2/domains/:domainIdentifier/project-profiles?name=string&sortBy=string&sortOrder=string&nextToken=string&maxResults=0Lists project profiles.
  • POSTCreate project profile/v2/domains/:domainIdentifier/project-profilesCreates a project profile.
  • GETList subscription grants/v2/domains/:domainIdentifier/subscription-grants?environmentId=string&subscriptionTargetId=string&subscribedListingId=string&subscriptionId=string&owningProjectId=string&owningIamPrincipalArn=string&owningUserId=string&owningGroupId=string&sortBy=string&sortOrder=string&maxResults=0&nextToken=stringLists subscription grants.
  • POSTCreate subscription grant/v2/domains/:domainIdentifier/subscription-grantsCreates a subsscription grant in Amazon DataZone.
  • GETList subscription requests/v2/domains/:domainIdentifier/subscription-requests?status=string&subscribedListingId=string&owningProjectId=string&owningIamPrincipalArn=string&approverProjectId=string&owningUserId=string&owningGroupId=string&sortBy=string&sortOrder=string&maxResults=0&nextToken=stringLists Amazon DataZone subscription requests.
  • POSTCreate subscription request/v2/domains/:domainIdentifier/subscription-requestsCreates a subscription request in Amazon DataZone.
  • GETList subscription targets/v2/domains/:domainIdentifier/environments/:environmentIdentifier/subscription-targets?sortBy=string&sortOrder=string&maxResults=0&nextToken=stringLists subscription targets in Amazon DataZone.
  • POSTCreate subscription target/v2/domains/:domainIdentifier/environments/:environmentIdentifier/subscription-targetsCreates a subscription target in Amazon DataZone.
  • POSTCreate user profile/v2/domains/:domainIdentifier/user-profilesCreates a user profile in Amazon DataZone.
  • GETGet account pool/v2/domains/:domainIdentifier/account-pools/:identifierGets the details of the account pool.
  • DELETEDelete account pool/v2/domains/:domainIdentifier/account-pools/:identifierDeletes an account pool.
  • PATCHUpdate account pool/v2/domains/:domainIdentifier/account-pools/:identifierUpdates the account pool.
  • GETGet asset filter/v2/domains/:domainIdentifier/assets/:assetIdentifier/filters/:identifierGets an asset filter. Prerequisites: Domain ( --domain-identifier ), asset ( --asset-identifier ), and filter ( --identifier ) must all exist. The asset…
  • DELETEDelete asset filter/v2/domains/:domainIdentifier/assets/:assetIdentifier/filters/:identifierDeletes an asset filter. Prerequisites: The asset filter must exist. The domain and asset must not have been deleted. Ensure the --identifier refers to a…
  • PATCHUpdate asset filter/v2/domains/:domainIdentifier/assets/:assetIdentifier/filters/:identifierUpdates an asset filter. Prerequisites: The domain, asset, and asset filter identifier must all exist. The asset must contain the columns being referenced in…
  • GETGet connection/v2/domains/:domainIdentifier/connections/:identifier?withSecret=trueGets a connection. In Amazon DataZone, a connection enables you to connect your resources (domains, projects, and environments) to external resources and…
  • DELETEDelete connection/v2/domains/:domainIdentifier/connections/:identifierDeletes and connection. In Amazon DataZone, a connection enables you to connect your resources (domains, projects, and environments) to external resources and…
  • PATCHUpdate connection/v2/domains/:domainIdentifier/connections/:identifierUpdates a connection. In Amazon DataZone, a connection enables you to connect your resources (domains, projects, and environments) to external resources and…
  • GETGet data export configuration/v2/domains/:domainIdentifier/data-export-configurationGets data export configuration details.
  • PUTPut data export configuration/v2/domains/:domainIdentifier/data-export-configurationCreates 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…
  • DELETEDelete data export configuration/v2/domains/:domainIdentifier/data-export-configurationDeletes data export configuration for a domain. This operation does not delete the S3 table created by the PutDataExportConfiguration operation. To…
  • GETGet designation/v2/domains/:domainIdentifier/designations/:identifierGets the details of a designation, including its Cedar permit policy. Returns the full designation record for both system-managed and user-created designations.
  • DELETEDelete designation/v2/domains/:domainIdentifier/designations/:identifierDeletes a user-created designation. Managed designations cannot be deleted. The call fails if the designation has deletionProtection enabled or if any project…
  • PATCHUpdate designation/v2/domains/:domainIdentifier/designations/:identifierUpdates an existing user-created designation. Managed designations cannot be modified. Omit a field to leave its current value unchanged.
  • GETGet environment/v2/domains/:domainIdentifier/environments/:identifierGets an Amazon DataZone environment.
  • DELETEDelete environment/v2/domains/:domainIdentifier/environments/:identifierDeletes an environment in Amazon DataZone.
  • PATCHUpdate environment/v2/domains/:domainIdentifier/environments/:identifierUpdates the specified environment in Amazon DataZone.
  • GETGet environment action/v2/domains/:domainIdentifier/environments/:environmentIdentifier/actions/:identifierGets the specified environment action.
  • DELETEDelete environment action/v2/domains/:domainIdentifier/environments/:environmentIdentifier/actions/:identifierDeletes an action for the environment, for example, deletes a console link for an analytics tool that is available in this environment.
  • PATCHUpdate environment action/v2/domains/:domainIdentifier/environments/:environmentIdentifier/actions/:identifierUpdates an environment action.
  • GETGet environment blueprint/v2/domains/:domainIdentifier/environment-blueprints/:identifierGets an Amazon DataZone blueprint.
  • DELETEDelete environment blueprint/v2/domains/:domainIdentifier/environment-blueprints/:identifierDeletes a blueprint in Amazon DataZone.
  • PATCHUpdate environment blueprint/v2/domains/:domainIdentifier/environment-blueprints/:identifierUpdates an environment blueprint in Amazon DataZone.
  • GETGet environment profile/v2/domains/:domainIdentifier/environment-profiles/:identifierGets an evinronment profile in Amazon DataZone.
  • DELETEDelete environment profile/v2/domains/:domainIdentifier/environment-profiles/:identifierDeletes an environment profile in Amazon DataZone.
  • PATCHUpdate environment profile/v2/domains/:domainIdentifier/environment-profiles/:identifierUpdates the specified environment profile in Amazon DataZone.
  • GETGet lineage event/v2/domains/:domainIdentifier/lineage/events/:identifierDescribes the lineage event.
  • DELETEDelete lineage event/v2/domains/:domainIdentifier/lineage/events/:identifierDeletes the specified lineage event.
  • GETGet project/v2/domains/:domainIdentifier/projects/:identifierGets a project in Amazon DataZone.
  • DELETEDelete project/v2/domains/:domainIdentifier/projects/:identifier?skipDeletionCheck=trueDeletes a project in Amazon DataZone.
  • PATCHUpdate project/v2/domains/:domainIdentifier/projects/:identifierUpdates the specified project in Amazon DataZone.
  • POSTDelete project membership/v2/domains/:domainIdentifier/projects/:projectIdentifier/deleteMembershipDeletes project membership in Amazon DataZone.
  • GETGet project profile/v2/domains/:domainIdentifier/project-profiles/:identifierThe details of the project profile.
  • DELETEDelete project profile/v2/domains/:domainIdentifier/project-profiles/:identifierDeletes a project profile.
  • PATCHUpdate project profile/v2/domains/:domainIdentifier/project-profiles/:identifierUpdates a project profile.
  • GETGet subscription grant/v2/domains/:domainIdentifier/subscription-grants/:identifierGets the subscription grant in Amazon DataZone.
  • DELETEDelete subscription grant/v2/domains/:domainIdentifier/subscription-grants/:identifierDeletes and subscription grant in Amazon DataZone.
  • GETGet subscription request details/v2/domains/:domainIdentifier/subscription-requests/:identifierGets the details of the specified subscription request.
  • DELETEDelete subscription request/v2/domains/:domainIdentifier/subscription-requests/:identifierDeletes a subscription request in Amazon DataZone.
  • PATCHUpdate subscription request/v2/domains/:domainIdentifier/subscription-requests/:identifierUpdates a specified subscription request in Amazon DataZone.
  • GETGet subscription target/v2/domains/:domainIdentifier/environments/:environmentIdentifier/subscription-targets/:identifierGets the subscription target in Amazon DataZone.
  • DELETEDelete subscription target/v2/domains/:domainIdentifier/environments/:environmentIdentifier/subscription-targets/:identifierDeletes a subscription target in Amazon DataZone.
  • PATCHUpdate subscription target/v2/domains/:domainIdentifier/environments/:environmentIdentifier/subscription-targets/:identifierUpdates the specified subscription target in Amazon DataZone.
  • GETList time series data points/v2/domains/:domainIdentifier/entities/:entityType/:entityIdentifier/time-series-data-points?formName=string&startedAt=string&endedAt=string&nextToken=string&maxResults=0Lists time series data points.
  • POSTPost time series data points/v2/domains/:domainIdentifier/entities/:entityType/:entityIdentifier/time-series-data-pointsPosts time series data points to Amazon DataZone for the specified asset.
  • DELETEDelete time series data points/v2/domains/:domainIdentifier/entities/:entityType/:entityIdentifier/time-series-data-points?formName=string&clientToken=stringDeletes the specified time series form for the specified asset.
  • PATCHDisassociate governed terms/v2/domains/:domainIdentifier/entities/:entityType/:entityIdentifier/disassociate-governed-termsDisassociates restricted terms from an asset.
  • GETGet environment credentials/v2/domains/:domainIdentifier/environments/:environmentIdentifier/credentialsGets the credentials of an environment in Amazon DataZone.
  • GETGet group profile/v2/domains/:domainIdentifier/group-profiles/:groupIdentifierGets a group profile in Amazon DataZone.
  • PUTUpdate group profile/v2/domains/:domainIdentifier/group-profiles/:groupIdentifierUpdates the specified group profile in Amazon DataZone.
  • POSTGet iam portal login url/v2/domains/:domainIdentifier/get-portal-login-urlGets the data portal URL for the specified Amazon DataZone domain.
  • GETGet job run/v2/domains/:domainIdentifier/jobRuns/:identifierThe details of the job run.
  • GETGet lineage node/v2/domains/:domainIdentifier/lineage/nodes/:identifier?timestamp=stringGets the data lineage node.
  • GETGet subscription/v2/domains/:domainIdentifier/subscriptions/:identifierGets a subscription in Amazon DataZone.
  • GETGet time series data point/v2/domains/:domainIdentifier/entities/:entityType/:entityIdentifier/time-series-data-points/:identifier?formName=stringGets the existing data point for the asset.
  • GETGet user profile/v2/domains/:domainIdentifier/user-profiles/:userIdentifier?type=string&sessionName=stringGets a user profile in Amazon DataZone.
  • PUTUpdate user profile/v2/domains/:domainIdentifier/user-profiles/:userIdentifierUpdates the specified user profile in Amazon DataZone.
  • GETList accounts in account pool/v2/domains/:domainIdentifier/account-pools/:identifier/accounts?nextToken=string&maxResults=0Lists the accounts in the specified account pool.
  • GETList data source run activities/v2/domains/:domainIdentifier/data-source-runs/:identifier/activities?status=string&nextToken=string&maxResults=0Lists data source run activities.
  • GETList entity owners/v2/domains/:domainIdentifier/entities/:entityType/:entityIdentifier/owners?maxResults=0&nextToken=stringLists the entity (domain units) owners.
  • GETList job runs/v2/domains/:domainIdentifier/jobs/:jobIdentifier/runs?status=string&sortOrder=string&nextToken=string&maxResults=0Lists job runs.
  • GETList lineage events/v2/domains/:domainIdentifier/lineage/events?maxResults=0&timestampAfter=string&timestampBefore=string&processingStatus=string&sortOrder=string&nextToken=stringLists lineage events.
  • POSTPost lineage event/v2/domains/:domainIdentifier/lineage/eventsPosts a data lineage event.
  • GETList lineage node history/v2/domains/:domainIdentifier/lineage/nodes/:identifier/history?maxResults=0&nextToken=string&direction=string&timestampGTE=string&timestampLTE=string&sortOrder=stringLists the history of the specified data lineage node.
  • GETList notifications/v2/domains/:domainIdentifier/notifications?type=string&afterTimestamp=string&beforeTimestamp=string&subjects=&taskStatus=string&maxResults=0&nextToken=stringLists all Amazon DataZone notifications.
  • GETList policy grants/v2/domains/:domainIdentifier/policies/managed/:entityType/:entityIdentifier/grants?policyType=string&maxResults=0&nextToken=stringLists policy grants.
  • GETList project memberships/v2/domains/:domainIdentifier/projects/:projectIdentifier/memberships?sortBy=string&sortOrder=string&nextToken=string&maxResults=0Lists all members of the specified project.
  • GETList subscriptions/v2/domains/:domainIdentifier/subscriptions?subscriptionRequestIdentifier=string&status=string&subscribedListingId=string&owningProjectId=string&owningIamPrincipalArn=string&owningUserId=string&owningGroupId=string&approverProjectId=string&sortBy=string&sortOrder=string&maxResults=0&nextToken=stringLists subscriptions in Amazon DataZone.
  • GETList tags for resource/tags/:resourceArnLists tags for the specified resource in Amazon DataZone.
  • POSTTag resource/tags/:resourceArnTags a resource in Amazon DataZone.
  • DELETEUntag resource/tags/:resourceArn?tagKeys=Untags a resource in Amazon DataZone.
  • POSTQuery graph/v2/domains/:domainIdentifier/graph/query?maxResults=0&nextToken=stringQueries entities in the graph store.
  • PUTReject predictions/v2/domains/:domainIdentifier/assets/:identifier/reject-predictions?revision=stringRejects automatically generated business-friendly metadata for your Amazon DataZone assets.
  • PUTReject subscription request/v2/domains/:domainIdentifier/subscription-requests/:identifier/rejectRejects the specified subscription request.
  • POSTRemove entity owner/v2/domains/:domainIdentifier/entities/:entityType/:entityIdentifier/removeOwnerRemoves an owner from an entity.
  • POSTRemove policy grant/v2/domains/:domainIdentifier/policies/managed/:entityType/:entityIdentifier/removeGrantRemoves a policy grant.
  • PUTRevoke subscription/v2/domains/:domainIdentifier/subscriptions/:identifier/revokeRevokes a specified subscription in Amazon DataZone.
  • POSTSearch/v2/domains/:domainIdentifier/searchSearches for assets in Amazon DataZone. Search in Amazon DataZone is a powerful capability that enables users to discover and explore data assets, glossary…
  • POSTSearch group profiles/v2/domains/:domainIdentifier/search-group-profilesSearches group profiles in Amazon DataZone.
  • POSTSearch listings/v2/domains/:domainIdentifier/listings/searchSearches listings in Amazon DataZone. SearchListings is a powerful capability that enables users to discover and explore published assets and data products…
  • POSTSearch types/v2/domains/:domainIdentifier/types-searchSearches for types in Amazon DataZone. Prerequisites: The --domain-identifier must refer to an existing Amazon DataZone domain. --search-scope must be one of…
  • POSTSearch user profiles/v2/domains/:domainIdentifier/search-user-profilesSearches user profiles in Amazon DataZone.
  • POSTStart notebook import/v2/domains/:domainIdentifier/notebook-importsStarts a notebook import in Amazon SageMaker Unified Studio. This operation imports a notebook from an Amazon Simple Storage Service location into a project.
  • POSTStart notebook sync/v2/domains/:domainIdentifier/notebook-syncsStarts a notebook sync in Amazon SageMaker Unified Studio. This operation syncs a notebook from a Git repository into a project.
  • PATCHUpdate root domain unit owner/v2/domains/:domainIdentifier/root-domain-unit-ownerUpdates the owner of the root domain unit.
  • PATCHUpdate subscription grant status/v2/domains/:domainIdentifier/subscription-grants/:identifier/status/:assetIdentifierUpdates the status of the specified subscription grant status in Amazon DataZone.

API details

Base URL
https://datazone.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
195 operations on 115 pathsGET 76POST 52DELETE 31PATCH 21PUT 15
Main resources
Data source 5Domain 5Domain unit 5Notebook 5Rule 5Asset 4Data product 4Environment blueprint configuration 4Glossary 4Glossary term 4
Description format
AWS Smithy model, API version 2018-05-10

How to test the Amazon DataZone in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon DataZone collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Cancel metadata generation run” (POST /v2/domains/:domainIdentifier/metadata-generation-runs/:identifier/cancel), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Amazon DataZone?

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… It is listed under Data & analytics and has 195 endpoints.

Who publishes the Amazon DataZone?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Amazon DataZone?

Requests go to https://datazone.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the Amazon DataZone?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the Amazon DataZone have?

195 operations on 115 paths (76 GET, 52 POST, 31 DELETE, 21 PATCH, 15 PUT). The largest groups are Data source, Domain, Domain unit, Notebook.

Is forking the Amazon DataZone free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.