Amazon DataZone Datazone Environment Blueprint Configurations API

The Datazone Environment Blueprint Configurations API from Amazon DataZone — 2 operation(s) for datazone environment blueprint configurations.

Operations 4

PUT /v2/domains/{domainIdentifier}/environment-blueprint-configurations/{environmentBlueprintIdentifier} Put Environment Blueprint Configuration #
GET /v2/domains/{domainIdentifier}/environment-blueprint-configurations/{environmentBlueprintIdentifier} Get Environment Blueprint Configuration #
DELETE /v2/domains/{domainIdentifier}/environment-blueprint-configurations/{environmentBlueprintIdentifier} Delete Environment Blueprint Configuration #
GET /v2/domains/{domainIdentifier}/environment-blueprint-configurations List Environment Blueprint Configurations #

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-environment-blueprint-configurations-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.

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

OpenAPI Specification

amazon-datazone-environment-blueprint-configurations-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Amazon DataZone Environment Blueprint Configurations API
  version: '2018-05-10'
  description: Generated from AWS's published Smithy model for Amazon DataZone. 4 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://datazone.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Environment Blueprint Configurations
paths:
  /v2/domains/{domainIdentifier}/environment-blueprint-configurations/{environmentBlueprintIdentifier}:
    put:
      operationId: PutEnvironmentBlueprintConfiguration
      summary: Put Environment Blueprint Configuration
      description: Writes the configuration for the specified environment blueprint in Amazon DataZone.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutEnvironmentBlueprintConfigurationOutput'
        '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'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutEnvironmentBlueprintConfigurationInput'
      tags:
      - Environment Blueprint Configurations
    get:
      operationId: GetEnvironmentBlueprintConfiguration
      summary: Get Environment Blueprint Configuration
      description: Gets the blueprint configuration in Amazon DataZone.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetEnvironmentBlueprintConfigurationOutput'
        '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'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetEnvironmentBlueprintConfigurationInput'
      tags:
      - Environment Blueprint Configurations
    delete:
      operationId: DeleteEnvironmentBlueprintConfiguration
      summary: Delete Environment Blueprint Configuration
      description: Deletes the blueprint configuration in Amazon DataZone.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteEnvironmentBlueprintConfigurationOutput'
        '403':
          description: AccessDeniedException; AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteEnvironmentBlueprintConfigurationInput'
      tags:
      - Environment Blueprint Configurations
  /v2/domains/{domainIdentifier}/environment-blueprint-configurations:
    get:
      operationId: ListEnvironmentBlueprintConfigurations
      summary: List Environment Blueprint Configurations
      description: Lists blueprint configurations for a Amazon DataZone environment.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListEnvironmentBlueprintConfigurationsOutput'
        '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'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListEnvironmentBlueprintConfigurationsInput'
      tags:
      - Environment Blueprint Configurations
components:
  schemas:
    ValidationException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    PutEnvironmentBlueprintConfigurationOutput:
      type: object
      properties:
        domainId:
          type: string
          description: The identifier of the Amazon DataZone domain.
        environmentBlueprintId:
          type: string
          description: The identifier of the environment blueprint.
        provisioningRoleArn:
          type: string
          description: The ARN of the provisioning role.
        environmentRolePermissionBoundary:
          type: string
          description: The environment role permissions boundary.
        manageAccessRoleArn:
          type: string
          description: The ARN of the manage access role.
        enabledRegions:
          type: array
          items:
            type: string
          description: Specifies the enabled Amazon Web Services Regions.
        regionalParameters:
          type: object
          additionalProperties:
            type: object
            additionalProperties:
              type: string
          description: The regional parameters in the environment blueprint.
        allowUserProvidedConfigurations:
          type: boolean
          description: Specifies whether user-provided resource configurations are allowed for the environment blueprint.
        createdAt:
          type: string
          description: The timestamp of when the environment blueprint was created.
        updatedAt:
          type: string
          description: The timestamp of when the environment blueprint was updated.
        resourceConfigurations:
          type: array
          items:
            $ref: '#/components/schemas/ResourceConfiguration'
          description: The resource configurations of the environment blueprint.
        provisioningConfigurations:
          type: array
          items:
            $ref: '#/components/schemas/ProvisioningConfiguration'
          description: The provisioning configuration of a blueprint.
      required:
      - domainId
      - environmentBlueprintId
    PutResourceConfiguration:
      type: object
      properties:
        name:
          type: string
          description: The name of the resource configuration.
        description:
          type: string
          description: The description of the resource configuration.
        region:
          type: string
          description: The Amazon Web Services Region of the resource configuration.
        parameters:
          type: object
          additionalProperties:
            type: string
          description: The parameters of the resource configuration.
      required:
      - name
      - region
      - parameters
    ResourceConfiguration:
      type: object
      properties:
        identifier:
          type: string
          description: The identifier of the resource configuration.
        name:
          type: string
          description: The name of the resource configuration.
        description:
          type: string
          description: The description of the resource configuration.
        region:
          type: string
          description: The Amazon Web Services Region of the resource configuration.
        parameters:
          type: object
          additionalProperties:
            type: string
          description: The parameters of the resource configuration.
      required:
      - identifier
      - name
      - region
      - parameters
    GetEnvironmentBlueprintConfigurationInput:
      type: object
      properties:
        domainIdentifier:
          type: string
          description: The ID of the Amazon DataZone domain where this blueprint exists.
        environmentBlueprintIdentifier:
          type: string
          description: He ID of the blueprint.
      required:
      - domainIdentifier
      - environmentBlueprintIdentifier
    LakeFormationConfiguration:
      type: object
      properties:
        locationRegistrationRole:
          type: string
          description: The role that is used to manage read/write access to the chosen Amazon S3 bucket(s) for Data Lake using Amazon Web Services Lake Formation hybrid access mode.
        locationRegistrationExcludeS3Locations:
          type: array
          items:
            type: string
          description: Specifies certain Amazon S3 locations if you do not want Amazon DataZone to automatically register them in hybrid mode.
    GetEnvironmentBlueprintConfigurationOutput:
      type: object
      properties:
        domainId:
          type: string
          description: The ID of the Amazon DataZone domain where this blueprint exists.
        environmentBlueprintId:
          type: string
          description: The ID of the blueprint.
        provisioningRoleArn:
          type: string
          description: The ARN of the provisioning role with which this blueprint is created.
        environmentRolePermissionBoundary:
          type: string
          description: The environment role permissions boundary.
        manageAccessRoleArn:
          type: string
          description: The ARN of the manage access role with which this blueprint is created.
        enabledRegions:
          type: array
          items:
            type: string
          description: The Amazon Web Services regions in which this blueprint is enabled.
        regionalParameters:
          type: object
          additionalProperties:
            type: object
            additionalProperties:
              type: string
          description: The regional parameters of the blueprint.
        allowUserProvidedConfigurations:
          type: boolean
          description: Specifies whether user-provided resource configurations are allowed for the environment blueprint.
        createdAt:
          type: string
          description: The timestamp of when this blueprint was created.
        updatedAt:
          type: string
          description: The timestamp of when this blueprint was upated.
        resourceConfigurations:
          type: array
          items:
            $ref: '#/components/schemas/ResourceConfiguration'
          description: The resource configurations of the environment blueprint.
        provisioningConfigurations:
          type: array
          items:
            $ref: '#/components/schemas/ProvisioningConfiguration'
          description: The provisioning configuration of a blueprint.
      required:
      - domainId
      - environmentBlueprintId
    UnauthorizedException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ListEnvironmentBlueprintConfigurationsInput:
      type: object
      properties:
        domainIdentifier:
          type: string
          description: The identifier of the Amazon DataZone domain.
        maxResults:
          type: integer
          description: The maximum number of blueprint configurations to return in a single call to ListEnvironmentBlueprintConfigurations. When the number of configurations to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListEnvironmentBlueprintConfigurations to list the next set of configurations.
        nextToken:
          type: string
          description: When the number of blueprint configurations is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of configurations, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListEnvironmentBlueprintConfigurations to list the next set of configurations.
      required:
      - domainIdentifier
    DeleteEnvironmentBlueprintConfigurationOutput:
      type: object
      properties: {}
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    PutEnvironmentBlueprintConfigurationInput:
      type: object
      properties:
        domainIdentifier:
          type: string
          description: The identifier of the Amazon DataZone domain.
        environmentBlueprintIdentifier:
          type: string
          description: The identifier of the environment blueprint.
        provisioningRoleArn:
          type: string
          description: The ARN of the provisioning role.
        manageAccessRoleArn:
          type: string
          description: The ARN of the manage access role.
        environmentRolePermissionBoundary:
          type: string
          description: The environment role permissions boundary.
        enabledRegions:
          type: array
          items:
            type: string
          description: Specifies the enabled Amazon Web Services Regions.
        regionalParameters:
          type: object
          additionalProperties:
            type: object
            additionalProperties:
              type: string
          description: The regional parameters in the environment blueprint.
        resourceConfigurations:
          type: array
          items:
            $ref: '#/components/schemas/PutResourceConfiguration'
          description: The resource configurations of the environment blueprint.
        allowUserProvidedConfigurations:
          type: boolean
          description: Specifies whether user-provided resource configurations are allowed for the environment blueprint.
        globalParameters:
          type: object
          additionalProperties:
            type: string
          description: Region-agnostic environment blueprint parameters.
        provisioningConfigurations:
          type: array
          items:
            $ref: '#/components/schemas/ProvisioningConfiguration'
          description: The provisioning configuration of a blueprint.
      required:
      - domainIdentifier
      - environmentBlueprintIdentifier
      - enabledRegions
    ListEnvironmentBlueprintConfigurationsOutput:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/EnvironmentBlueprintConfigurationItem'
          description: The results of the ListEnvironmentBlueprintConfigurations action.
        nextToken:
          type: string
          description: When the number of blueprint configurations is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of configurations, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListEnvironmentBlueprintConfigurations to list the next set of configurations.
    ProvisioningConfiguration:
      type: object
      properties:
        lakeFormationConfiguration:
          $ref: '#/components/schemas/LakeFormationConfiguration'
      description: Exactly one member is set.
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    EnvironmentBlueprintConfigurationItem:
      type: object
      properties:
        domainId:
          type: string
          description: The identifier of the Amazon DataZone domain in which an environment blueprint exists.
        environmentBlueprintId:
          type: string
          description: The identifier of the environment blueprint.
        provisioningRoleArn:
          type: string
          description: The ARN of the provisioning role specified in the environment blueprint configuration.
        environmentRolePermissionBoundary:
          type: string
          description: The environment role permission boundary.
        manageAccessRoleArn:
          type: string
          description: The ARN of the manage access role specified in the environment blueprint configuration.
        enabledRegions:
          type: array
          items:
            type: string
          description: The enabled Amazon Web Services Regions specified in a blueprint configuration.
        regionalParameters:
          type: object
          additionalProperties:
            type: object
            additionalProperties:
              type: string
          description: The regional parameters of the environment blueprint.
        allowUserProvidedConfigurations:
          type: boolean
          description: Specifies whether user-provided resource configurations are allowed for the environment blueprint.
        createdAt:
          type: string
          description: The timestamp of when an environment blueprint was created.
        updatedAt:
          type: string
          description: The timestamp of when the environment blueprint was updated.
        resourceConfigurations:
          type: array
          items:
            $ref: '#/components/schemas/ResourceConfiguration'
          description: The resource configurations of the environment blueprint.
        provisioningConfigurations:
          type: array
          items:
            $ref: '#/components/schemas/ProvisioningConfiguration'
          description: The provisioning configuration of a blueprint.
      required:
      - domainId
      - environmentBlueprintId
    DeleteEnvironmentBlueprintConfigurationInput:
      type: object
      properties:
        domainIdentifier:
          type: string
          description: The ID of the Amazon DataZone domain in which the blueprint configuration is deleted.
        environmentBlueprintIdentifier:
          type: string
          description: The ID of the blueprint the configuration of which is deleted.
      required:
      - domainIdentifier
      - environmentBlueprintIdentifier
    InternalServerException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ConflictException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
  securitySchemes:
    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-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/datazone/service/2018-05-10/datazone-2018-05-10.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)