Amazon DataZone

Amazon DataZone Environments API

Operations for managing data environments

GitHub OpenAPI

Operations 5

GET /v2/domains/{domainIdentifier}/environments List Environments #
POST /v2/domains/{domainIdentifier}/environments Create Environment #
DELETE /v2/domains/{domainIdentifier}/environments/{identifier} Delete Environment #
GET /v2/domains/{domainIdentifier}/environments/{identifier} Get Environment #
PATCH /v2/domains/{domainIdentifier}/environments/{identifier} Update Environment #

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-environments-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-environments-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-environments-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Amazon Datazone Environments API
  version: '1.0'
  description: 'Operations tagged Environments across 2 of this provider''s published API definitions: amazon-datazone-openapi.yml, amazon-datazone-environments-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: Environments
  description: Operations for managing data environments
paths:
  /v2/domains/{domainIdentifier}/environments:
    get:
      operationId: listEnvironments
      summary: List Environments
      description: Lists environments in a DataZone domain.
      tags:
      - Environments
      parameters:
      - name: domainIdentifier
        in: path
        required: true
        schema:
          type: string
      - name: projectIdentifier
        in: query
        required: true
        schema:
          type: string
      - name: maxResults
        in: query
        schema:
          type: integer
      responses:
        '200':
          description: List of environments returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListEnvironmentsResponse'
              examples:
                default:
                  x-microcks-default: true
                  value:
                    items:
                    - id: env_001abc
                      domainId: dzd_1234567890abcde
                      projectId: prj_abc123
                      name: ProductionAnalyticsEnvironment
                      status: ACTIVE
                      createdAt: '2024-02-15T10:00:00Z'
      security:
      - awsSignatureV4: []
    post:
      operationId: createEnvironment
      summary: Create Environment
      description: Creates an environment in a DataZone project for data access and analytics.
      tags:
      - Environments
      parameters:
      - name: domainIdentifier
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateEnvironmentRequest'
            examples:
              default:
                x-microcks-default: true
                value:
                  name: ProductionAnalyticsEnvironment
                  description: Production analytics environment with Athena and Glue access
                  domainIdentifier: dzd_1234567890abcde
                  projectIdentifier: prj_abc123
                  environmentProfileIdentifier: envprofile_001
      responses:
        '201':
          description: Environment created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Environment'
              examples:
                default:
                  x-microcks-default: true
                  value:
                    id: env_002xyz
                    domainId: dzd_1234567890abcde
                    projectId: prj_abc123
                    name: ProductionAnalyticsEnvironment
                    status: CREATING
                    createdAt: '2024-04-15T14:00:00Z'
      security:
      - awsSignatureV4: []
    servers:
    - url: https://datazone.amazonaws.com
      description: Amazon DataZone API
  /v2/domains/{domainIdentifier}/environments/{identifier}:
    delete:
      operationId: DeleteEnvironment
      summary: Delete Environment
      description: Deletes an environment in Amazon DataZone.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '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'
        '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/DeleteEnvironmentInput'
      tags:
      - Environments
      security:
      - sigv4: []
    get:
      operationId: GetEnvironment
      summary: Get Environment
      description: Gets an Amazon DataZone environment.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetEnvironmentOutput'
        '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'
        '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/GetEnvironmentInput'
      tags:
      - Environments
      security:
      - sigv4: []
    patch:
      operationId: UpdateEnvironment
      summary: Update Environment
      description: Updates the specified environment in Amazon DataZone.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateEnvironmentOutput'
        '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'
        '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/UpdateEnvironmentInput'
      tags:
      - Environments
      security:
      - sigv4: []
    servers:
    - url: https://datazone.{region}.amazonaws.com
      variables:
        region:
          default: us-east-1
components:
  schemas:
    Environment:
      description: A DataZone environment that provides data access capabilities for a project.
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the environment
        domainId:
          type: string
        projectId:
          type: string
        name:
          type: string
          description: The name of the environment
        description:
          type: string
        status:
          type: string
          enum:
          - ACTIVE
          - CREATING
          - UPDATING
          - DELETING
          - DELETED
          - CREATE_FAILED
          - DELETE_FAILED
          - UPDATE_FAILED
          - DISABLED
          - EXPIRED
          - INACCESSIBLE
          - SUSPENDED
        createdAt:
          type: string
          format: date-time
    CreateEnvironmentRequest:
      description: Request body for creating a DataZone environment.
      type: object
      required:
      - name
      - domainIdentifier
      - projectIdentifier
      - environmentProfileIdentifier
      properties:
        name:
          type: string
        description:
          type: string
        domainIdentifier:
          type: string
        projectIdentifier:
          type: string
        environmentProfileIdentifier:
          type: string
    ListEnvironmentsResponse:
      description: Response containing a list of environments.
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/Environment'
        nextToken:
          type: string
    ConfigurableEnvironmentAction:
      type: object
      properties:
        type:
          type: string
          description: The type of a configurable action in a Amazon DataZone environment.
        auth:
          type: string
          enum:
          - IAM
          - HTTPS
          description: The authentication type of a configurable action of a Amazon DataZone environment.
        parameters:
          type: array
          items:
            $ref: '#/components/schemas/ConfigurableActionParameter'
          description: The parameters of a configurable action in a Amazon DataZone environment.
      required:
      - type
      - parameters
    ValidationException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    UpdateEnvironmentInput:
      type: object
      properties:
        domainIdentifier:
          type: string
          description: The identifier of the domain in which the environment is to be updated.
        identifier:
          type: string
          description: The identifier of the environment that is to be updated.
        name:
          type: string
          description: The name to be updated as part of the UpdateEnvironment action.
        description:
          type: string
          description: The description to be updated as part of the UpdateEnvironment action.
        glossaryTerms:
          type: array
          items:
            type: string
          description: The glossary terms to be updated as part of the UpdateEnvironment action.
        blueprintVersion:
          type: string
          description: 'The blueprint version to which the environment should be updated. You can only specify the following string for this parameter: latest.'
        userParameters:
          type: array
          items:
            $ref: '#/components/schemas/EnvironmentParameter'
          description: The user parameters of the environment.
        environmentConfigurationName:
          type: string
          description: The configuration name of the environment.
      required:
      - domainIdentifier
      - identifier
    Resource:
      type: object
      properties:
        provider:
          type: string
          description: The provider of a provisioned resource of this Amazon DataZone environment.
        name:
          type: string
          description: The name of a provisioned resource of this Amazon DataZone environment.
        value:
          type: string
          description: The value of a provisioned resource of this Amazon DataZone environment.
        type:
          type: string
          description: The type of a provisioned resource of this Amazon DataZone environment.
      required:
      - value
      - type
    DeploymentProperties:
      type: object
      properties:
        startTimeoutMinutes:
          type: integer
          description: The start timeout of the environment blueprint deployment.
        endTimeoutMinutes:
          type: integer
          description: The end timeout of the environment blueprint deployment.
    GetEnvironmentInput:
      type: object
      properties:
        domainIdentifier:
          type: string
          description: The ID of the Amazon DataZone domain where the environment exists.
        identifier:
          type: string
          description: The ID of the Amazon DataZone environment.
      required:
      - domainIdentifier
      - identifier
    Deployment:
      type: object
      properties:
        deploymentId:
          type: string
          description: The identifier of the last deployment of the environment.
        deploymentType:
          type: string
          enum:
          - CREATE
          - UPDATE
          - DELETE
          description: The type of the last deployment of the environment.
        deploymentStatus:
          type: string
          enum:
          - IN_PROGRESS
          - SUCCESSFUL
          - FAILED
          - PENDING_DEPLOYMENT
          description: The status of the last deployment of the environment.
        failureReason:
          $ref: '#/components/schemas/EnvironmentError'
        messages:
          type: array
          items:
            type: string
          description: The messages of the last deployment of the environment.
        isDeploymentComplete:
          type: boolean
          description: Specifies whether the last deployment of the environment is complete.
    ConfigurableActionParameter:
      type: object
      properties:
        key:
          type: string
          description: The key of the configurable action parameter.
        value:
          type: string
          description: The value of the configurable action parameter.
    UpdateEnvironmentOutput:
      type: object
      properties:
        projectId:
          type: string
          description: The project identifier of the environment.
        id:
          type: string
          description: The identifier of the environment that is to be updated.
        domainId:
          type: string
          description: The identifier of the domain in which the environment is to be updated.
        createdBy:
          type: string
          description: The Amazon DataZone user who created the environment.
        createdAt:
          type: string
          description: The timestamp of when the environment was created.
        updatedAt:
          type: string
          description: The timestamp of when the environment was updated.
        name:
          type: string
          description: The name to be updated as part of the UpdateEnvironment action.
        description:
          type: string
          description: The description to be updated as part of the UpdateEnvironment action.
        environmentProfileId:
          type: string
          description: The profile identifier of the environment.
        awsAccountId:
          type: string
          description: The identifier of the Amazon Web Services account in which the environment is to be updated.
        awsAccountRegion:
          type: string
          description: The Amazon Web Services Region in which the environment is updated.
        provider:
          type: string
          description: The provider identifier of the environment.
        provisionedResources:
          type: array
          items:
            $ref: '#/components/schemas/Resource'
          description: The provisioned resources to be updated as part of the UpdateEnvironment action.
        status:
          type: string
          enum:
          - ACTIVE
          - CREATING
          - UPDATING
          - DELETING
          - CREATE_FAILED
          - UPDATE_FAILED
          - DELETE_FAILED
          - VALIDATION_FAILED
          - SUSPENDED
          - DISABLED
          - EXPIRED
          - DELETED
          - INACCESSIBLE
          description: The status to be updated as part of the UpdateEnvironment action.
        environmentActions:
          type: array
          items:
            $ref: '#/components/schemas/ConfigurableEnvironmentAction'
          description: The environment actions to be updated as part of the UpdateEnvironment action.
        glossaryTerms:
          type: array
          items:
            type: string
          description: The glossary terms to be updated as part of the UpdateEnvironment action.
        userParameters:
          type: array
          items:
            $ref: '#/components/schemas/CustomParameter'
          description: The user parameters to be updated as part of the UpdateEnvironment action.
        lastDeployment:
          $ref: '#/components/schemas/Deployment'
        provisioningProperties:
          $ref: '#/components/schemas/ProvisioningProperties'
        deploymentProperties:
          $ref: '#/components/schemas/DeploymentProperties'
        environmentBlueprintId:
          type: string
          description: The blueprint identifier of the environment.
        environmentConfigurationId:
          type: string
          description: The configuration ID of the environment.
        environmentConfigurationName:
          type: string
          description: The configuration name of the environment.
      required:
      - projectId
      - domainId
      - createdBy
      - name
      - provider
    UnauthorizedException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    EnvironmentParameter:
      type: object
      properties:
        name:
          type: string
          description: The name of an environment profile parameter.
        value:
          type: string
          description: The value of an environment profile parameter.
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    EnvironmentError:
      type: object
      properties:
        code:
          type: string
          description: The error code for the failure reason for the environment deployment.
        message:
          type: string
          description: The error message for the failure reason for the environment deployment.
      required:
      - message
    CustomParameter:
      type: object
      properties:
        keyName:
          type: string
          description: The key name of the parameter.
        description:
          type: string
          description: The description of the parameter.
        fieldType:
          type: string
          description: The filed type of the parameter.
        defaultValue:
          type: string
          description: The default value of the parameter.
        isEditable:
          type: boolean
          description: Specifies whether the parameter is editable.
        isOptional:
          type: boolean
          description: Specifies whether the custom parameter is optional.
        isUpdateSupported:
          type: boolean
          description: Specifies whether a parameter value can be updated after creation.
      required:
      - keyName
      - fieldType
    CloudFormationProperties:
      type: object
      properties:
        templateUrl:
          type: string
          description: The template URL of the cloud formation provisioning properties of the environment blueprint.
      required:
      - templateUrl
    DeleteEnvironmentInput:
      type: object
      properties:
        domainIdentifier:
          type: string
          description: The ID of the Amazon DataZone domain in which the environment is deleted.
        identifier:
          type: string
          description: The identifier of the environment that is to be deleted.
      required:
      - domainIdentifier
      - identifier
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ProvisioningProperties:
      type: object
      properties:
        cloudFormation:
          $ref: '#/components/schemas/CloudFormationProperties'
      description: Exactly one member is set.
    GetEnvironmentOutput:
      type: object
      properties:
        projectId:
          type: string
          description: The ID of the Amazon DataZone project in which this environment is created.
        id:
          type: string
          description: The ID of the environment.
        domainId:
          type: string
          description: The ID of the Amazon DataZone domain where the environment exists.
        createdBy:
          type: string
          description: The Amazon DataZone user who created the environment.
        createdAt:
          type: string
          description: The timestamp of when the environment was created.
        updatedAt:
          type: string
          description: The timestamp of when this environment was updated.
        name:
          type: string
          description: The name of the environment.
        description:
          type: string
          description: The description of the environment.
        environmentProfileId:
          type: string
          description: The ID of the environment profile with which the environment is created.
        awsAccountId:
          type: string
          description: The ID of the Amazon Web Services account where the environment exists.
        awsAccountRegion:
          type: string
          description: The Amazon Web Services region where the environment exists.
        provider:
          type: string
          description: The provider of this Amazon DataZone environment.
        provisionedResources:
          type: array
          items:
            $ref: '#/components/schemas/Resource'
          description: The provisioned resources of this Amazon DataZone environment.
        status:
          type: string
          enum:
          - ACTIVE
          - CREATING
          - UPDATING
          - DELETING
          - CREATE_FAILED
          - UPDATE_FAILED
          - DELETE_FAILED
          - VALIDATION_FAILED
          - SUSPENDED
          - DISABLED
          - EXPIRED
          - DELETED
          - INACCESSIBLE
          description: The status of this Amazon DataZone environment.
        environmentActions:
          type: array
          items:
            $ref: '#/components/schemas/ConfigurableEnvironmentAction'
          description: The actions of the environment.
        glossaryTerms:
          type: array
          items:
            type: string
          description: The business glossary terms that can be used in this environment.
        userParameters:
          type: array
          items:
            $ref: '#/components/schemas/CustomParameter'
          description: The user parameters of this Amazon DataZone environment.
        lastDeployment:
          $ref: '#/components/schemas/Deployment'
        provisioningProperties:
          $ref: '#/components/schemas/ProvisioningProperties'
        deploymentProperties:
          $ref: '#/components/schemas/DeploymentProperties'
        environmentBlueprintId:
          type: string
          description: The blueprint with which the environment is created.
        environmentConfigurationId:
          type: string
          description: The configuration ID that is used to create the environment.
        environmentConfigurationName:
          type: string
          description: The configuration name that is used to create the environment.
      required:
      - projectId
      - domainId
      - createdBy
      - name
      - provider
    InternalServerException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ServiceQuotaExceededException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ConflictException:
      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-environments-api-openapi.yml