Amazon DataZone

Amazon DataZone Domains API

Operations for managing DataZone domains

GitHub OpenAPI
Business capability
Data Governance Management BC-610.10

Operations 8

GET /v2/domains List Domains #
POST /v2/domains Create Domain #
GET /v2/domains/{domainIdentifier} Get Domain #
PUT /v2/domains/{domainIdentifier} Update Domain #
DELETE /v2/domains/{domainIdentifier} Delete Domain #
GET /v2/domains/{identifier} Get Domain #
PUT /v2/domains/{identifier} Update Domain #
DELETE /v2/domains/{identifier} Delete Domain #

Documentation

📖
Documentation
https://docs.aws.amazon.com/datazone/latest/APIReference/Welcome.html
📖
GettingStarted
https://aws.amazon.com/datazone/getting-started/
📖
APIReference
https://docs.aws.amazon.com/datazone/latest/APIReference/

Specifications

⚙
OpenAPI
https://artifacts.apis.io/amazon-datazone/openapi/amazon-datazone-domains-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/amazon-datazone/json-schema/domain-schema.json
📊
JSONSchema
https://artifacts.apis.io/amazon-datazone/json-schema/project-schema.json
📊
JSONSchema
https://artifacts.apis.io/amazon-datazone/json-schema/asset-schema.json

Other Resources

🔗
Pricing
https://aws.amazon.com/datazone/pricing/
🔗
FAQ
https://aws.amazon.com/datazone/faqs/
🔗
JSONLD
https://artifacts.apis.io/amazon-datazone/json-ld/amazon-datazone-context.jsonld

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/amazon-datazone:amazon-datazone-domains-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

amazon-datazone-domains-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Amazon Datazone Domains API
  version: '1.0'
  description: 'Operations tagged Domains across 2 of this provider''s published API definitions: amazon-datazone-openapi.yml, amazon-datazone-domains-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://datazone.amazonaws.com
  description: Amazon DataZone API
- url: https://datazone.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
tags:
- name: Domains
  description: Operations for managing DataZone domains
paths:
  /v2/domains:
    get:
      operationId: listDomains
      summary: List Domains
      description: Lists all Amazon DataZone domains in the account.
      tags:
      - Domains
      parameters:
      - name: status
        in: query
        schema:
          type: string
          enum:
          - AVAILABLE
          - CREATING
          - CREATION_FAILED
          - DELETED
          - DELETING
          - DELETION_FAILED
      - name: maxResults
        in: query
        schema:
          type: integer
      - name: nextToken
        in: query
        schema:
          type: string
      responses:
        '200':
          description: List of domains returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListDomainsResponse'
              examples:
                default:
                  x-microcks-default: true
                  value:
                    items:
                    - id: dzd_1234567890abcde
                      arn: arn:aws:datazone:us-east-1:123456789012:domain/dzd_1234567890abcde
                      name: EnterpriseDataDomain
                      description: Enterprise data catalog domain
                      status: AVAILABLE
                      createdAt: '2024-01-15T10:00:00Z'
      security:
      - awsSignatureV4: []
    post:
      operationId: createDomain
      summary: Create Domain
      description: Creates a DataZone domain. A domain contains a data catalog for data sharing and governance.
      tags:
      - Domains
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDomainRequest'
            examples:
              default:
                x-microcks-default: true
                value:
                  name: EnterpriseDataDomain
                  description: Enterprise data catalog domain for analytics team
                  domainExecutionRole: arn:aws:iam::123456789012:role/DataZoneDomainExecutionRole
                  tags:
                    Environment: Production
      responses:
        '201':
          description: Domain created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Domain'
              examples:
                default:
                  x-microcks-default: true
                  value:
                    id: dzd_1234567890abcde
                    arn: arn:aws:datazone:us-east-1:123456789012:domain/dzd_1234567890abcde
                    name: EnterpriseDataDomain
                    status: CREATING
                    createdAt: '2024-04-15T10:00:00Z'
      security:
      - awsSignatureV4: []
    servers:
    - url: https://datazone.amazonaws.com
      description: Amazon DataZone API
  /v2/domains/{domainIdentifier}:
    get:
      operationId: getDomain
      summary: Get Domain
      description: Gets the details of a DataZone domain.
      tags:
      - Domains
      parameters:
      - name: domainIdentifier
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Domain details returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Domain'
              examples:
                default:
                  x-microcks-default: true
                  value:
                    id: dzd_1234567890abcde
                    arn: arn:aws:datazone:us-east-1:123456789012:domain/dzd_1234567890abcde
                    name: EnterpriseDataDomain
                    description: Enterprise data catalog domain
                    status: AVAILABLE
                    createdAt: '2024-01-15T10:00:00Z'
        '404':
          description: Domain not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - awsSignatureV4: []
    put:
      operationId: updateDomain
      summary: Update Domain
      description: Updates a DataZone domain.
      tags:
      - Domains
      parameters:
      - name: domainIdentifier
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateDomainRequest'
            examples:
              default:
                x-microcks-default: true
                value:
                  description: Updated enterprise data catalog domain
      responses:
        '200':
          description: Domain updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Domain'
              examples:
                default:
                  x-microcks-default: true
                  value:
                    id: dzd_1234567890abcde
                    name: EnterpriseDataDomain
                    status: AVAILABLE
      security:
      - awsSignatureV4: []
    delete:
      operationId: deleteDomain
      summary: Delete Domain
      description: Deletes a DataZone domain.
      tags:
      - Domains
      parameters:
      - name: domainIdentifier
        in: path
        required: true
        schema:
          type: string
      responses:
        '202':
          description: Domain deletion initiated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteDomainResponse'
              examples:
                default:
                  x-microcks-default: true
                  value:
                    status: DELETING
      security:
      - awsSignatureV4: []
    servers:
    - url: https://datazone.amazonaws.com
      description: Amazon DataZone API
  /v2/domains/{identifier}:
    get:
      operationId: GetDomain
      summary: Get Domain
      description: Gets an Amazon DataZone domain.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetDomainOutput'
        '403':
          description: AccessDeniedException; AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '429':
          description: ThrottlingException; ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetDomainInput'
      tags:
      - Domains
      security:
      - sigv4: []
    put:
      operationId: UpdateDomain
      summary: Update Domain
      description: Updates a Amazon DataZone domain.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateDomainOutput'
        '403':
          description: AccessDeniedException; AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '429':
          description: ThrottlingException; ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateDomainInput'
      tags:
      - Domains
      security:
      - sigv4: []
    delete:
      operationId: DeleteDomain
      summary: Delete Domain
      description: Deletes a Amazon DataZone domain.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteDomainOutput'
        '403':
          description: AccessDeniedException; AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException; ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteDomainInput'
      tags:
      - Domains
      security:
      - sigv4: []
    servers:
    - url: https://datazone.{region}.amazonaws.com
      variables:
        region:
          default: us-east-1
components:
  schemas:
    DeleteDomainResponse:
      description: Response after initiating domain deletion.
      type: object
      properties:
        status:
          type: string
    ListDomainsResponse:
      description: Response containing a list of DataZone domains.
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/Domain'
        nextToken:
          type: string
    UpdateDomainRequest:
      description: Request body for updating a DataZone domain.
      type: object
      properties:
        name:
          type: string
        description:
          type: string
    Error:
      description: Standard error response from the DataZone API.
      type: object
      properties:
        message:
          type: string
          description: A human-readable error message
        code:
          type: string
          description: An error code identifying the type of error
    Domain:
      description: A DataZone domain that serves as the organizational boundary for data catalog and governance.
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the domain
        arn:
          type: string
          description: The ARN of the DataZone domain. This ARN uniquely identifies the domain.
        name:
          type: string
          description: The name of the domain
        description:
          type: string
          description: The description of the domain
        status:
          type: string
          description: The current status of the domain
          enum:
          - AVAILABLE
          - CREATING
          - CREATION_FAILED
          - DELETED
          - DELETING
          - DELETION_FAILED
        portalUrl:
          type: string
          description: The URL of the DataZone portal for this domain
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    CreateDomainRequest:
      description: Request body for creating a DataZone domain.
      type: object
      required:
      - name
      - domainExecutionRole
      properties:
        name:
          type: string
        description:
          type: string
        domainExecutionRole:
          type: string
          description: The ARN of the IAM role for DataZone to use when executing domain operations
        tags:
          type: object
          additionalProperties:
            type: string
    SingleSignOn:
      type: object
      properties:
        type:
          type: string
          enum:
          - IAM_IDC
          - DISABLED
          description: The type of single sign-on in Amazon DataZone.
        userAssignment:
          type: string
          enum:
          - AUTOMATIC
          - MANUAL
          description: The single sign-on user assignment in Amazon DataZone.
        idcInstanceArn:
          type: string
          description: The ARN of the IDC instance.
    DeleteDomainInput:
      type: object
      properties:
        identifier:
          type: string
          description: The identifier of the Amazon Web Services domain that is to be deleted.
        clientToken:
          type: string
          description: A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.
        skipDeletionCheck:
          type: boolean
          description: Specifies whether to skip the check that prevents deletion of a domain that still contains resources. When you use this parameter, Amazon DataZone deletes the domain but might not remove its associated resources, which can leave orphaned resources behind. To delete a domain and fully clean up its associated resources, use cascadeDelete instead. You can't use this parameter together with cascadeDelete.
        cascadeDelete:
          type: boolean
          description: Specifies whether to delete the domain along with all of its associated resources. When you use this parameter, Amazon DataZone deletes the domain and cleanly removes its associated resources without leaving orphaned resources behind. Amazon DataZone reports deletion progress in the deleteProgress field. Amazon DataZone reports any resources that it can't delete in the failureReasons field of the GetDomain response. You can't use this parameter together with skipDeletionCheck. If you don't specify a value, the default is false.
      required:
      - identifier
    ValidationException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    UpdateDomainInput:
      type: object
      properties:
        identifier:
          type: string
          description: The ID of the Amazon Web Services domain that is to be updated.
        description:
          type: string
          description: The description to be updated as part of the UpdateDomain action.
        singleSignOn:
          $ref: '#/components/schemas/SingleSignOn'
        domainExecutionRole:
          type: string
          description: The domain execution role to be updated as part of the UpdateDomain action.
        serviceRole:
          type: string
          description: The service role of the domain.
        name:
          type: string
          description: The name to be updated as part of the UpdateDomain action.
        clientToken:
          type: string
          description: A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.
      required:
      - identifier
    DeleteDomainOutput:
      type: object
      properties:
        status:
          type: string
          enum:
          - CREATING
          - AVAILABLE
          - CREATION_FAILED
          - DELETING
          - DELETED
          - DELETION_FAILED
          description: The status of the domain.
      required:
      - status
    GetDomainInput:
      type: object
      properties:
        identifier:
          type: string
          description: The identifier of the specified Amazon DataZone domain.
      required:
      - identifier
    FailureReason:
      type: object
      properties:
        id:
          type: string
          description: The identifier of the resource that failed to delete.
        message:
          type: string
          description: The error message associated with the resource that failed to delete.
    UnauthorizedException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    UpdateDomainOutput:
      type: object
      properties:
        id:
          type: string
          description: The identifier of the Amazon DataZone domain.
        rootDomainUnitId:
          type: string
          description: The ID of the root domain unit.
        description:
          type: string
          description: The description to be updated as part of the UpdateDomain action.
        singleSignOn:
          $ref: '#/components/schemas/SingleSignOn'
        domainExecutionRole:
          type: string
          description: The domain execution role to be updated as part of the UpdateDomain action.
        serviceRole:
          type: string
          description: The service role of the domain.
        name:
          type: string
          description: The name to be updated as part of the UpdateDomain action.
        lastUpdatedAt:
          type: string
          format: date-time
          description: Specifies the timestamp of when the domain was last updated.
      required:
      - id
    DeleteProgress:
      type: object
      properties:
        successfullyDeletedProjectCount:
          type: integer
          description: The number of projects that Amazon DataZone successfully deleted during the domain deletion.
    GetDomainOutput:
      type: object
      properties:
        id:
          type: string
          description: The identifier of the specified Amazon DataZone domain.
        rootDomainUnitId:
          type: string
          description: The ID of the root domain in Amazon Datazone.
        name:
          type: string
          description: The name of the Amazon DataZone domain.
        description:
          type: string
          description: The description of the Amazon DataZone domain.
        singleSignOn:
          $ref: '#/components/schemas/SingleSignOn'
        domainExecutionRole:
          type: string
          description: The domain execution role with which the Amazon DataZone domain is created.
        arn:
          type: string
          description: The ARN of the specified Amazon DataZone domain.
        kmsKeyIdentifier:
          type: string
          description: The identifier of the Amazon Web Services Key Management Service (KMS) key that is used to encrypt the Amazon DataZone domain, metadata, and reporting data.
        status:
          type: string
          enum:
          - CREATING
          - AVAILABLE
          - CREATION_FAILED
          - DELETING
          - DELETED
          - DELETION_FAILED
          description: The status of the specified Amazon DataZone domain.
        portalUrl:
          type: string
          description: The URL of the data portal for this Amazon DataZone domain.
        createdAt:
          type: string
          format: date-time
          description: The timestamp of when the Amazon DataZone domain was created.
        lastUpdatedAt:
          type: string
          format: date-time
          description: The timestamp of when the Amazon DataZone domain was last updated.
        tags:
          type: object
          additionalProperties:
            type: string
          description: The tags specified for the Amazon DataZone domain.
        domainVersion:
          type: string
          enum:
          - V1
          - V2
          description: The version of the domain.
        serviceRole:
          type: string
          description: The service role of the domain.
        failureReasons:
          type: array
          items:
            $ref: '#/components/schemas/FailureReason'
          description: The list of failure reasons for resources that Amazon DataZone could not delete during a cascade deletion of the domain.
        deleteProgress:
          $ref: '#/components/schemas/DeleteProgress'
      required:
      - id
      - domainExecutionRole
      - status
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    InternalServerException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ServiceQuotaExceededException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ConflictException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
  securitySchemes:
    awsSignatureV4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4 authentication
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: datazone
x-refined-from:
- amazon-datazone-openapi.yml
- amazon-datazone-domains-api-openapi.yml