Amazon DataZone Datazone Environment Blueprints API

openapi: 3.2.0
info:
  title: Amazon DataZone Environment Blueprints API
  version: '2018-05-10'
  description: Generated from AWS's published Smithy model for Amazon DataZone. 5 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 Blueprints
paths:
  /v2/domains/{domainIdentifier}/environment-blueprints:
    post:
      operationId: CreateEnvironmentBlueprint
      summary: Create Environment Blueprint
      description: Creates a Amazon DataZone blueprint.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateEnvironmentBlueprintOutput'
        '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/CreateEnvironmentBlueprintInput'
      tags:
      - Environment Blueprints
    get:
      operationId: ListEnvironmentBlueprints
      summary: List Environment Blueprints
      description: Lists blueprints in an Amazon DataZone environment.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListEnvironmentBlueprintsOutput'
        '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/ListEnvironmentBlueprintsInput'
      tags:
      - Environment Blueprints
  /v2/domains/{domainIdentifier}/environment-blueprints/{identifier}:
    delete:
      operationId: DeleteEnvironmentBlueprint
      summary: Delete Environment Blueprint
      description: Deletes a blueprint 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'
        '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/DeleteEnvironmentBlueprintInput'
      tags:
      - Environment Blueprints
    get:
      operationId: GetEnvironmentBlueprint
      summary: Get Environment Blueprint
      description: Gets an Amazon DataZone blueprint.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetEnvironmentBlueprintOutput'
        '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/GetEnvironmentBlueprintInput'
      tags:
      - Environment Blueprints
    patch:
      operationId: UpdateEnvironmentBlueprint
      summary: Update Environment Blueprint
      description: Updates an environment blueprint in Amazon DataZone.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateEnvironmentBlueprintOutput'
        '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/UpdateEnvironmentBlueprintInput'
      tags:
      - Environment Blueprints
components:
  schemas:
    UpdateEnvironmentBlueprintOutput:
      type: object
      properties:
        id:
          type: string
          description: The identifier of the blueprint to be updated.
        name:
          type: string
          description: The name to be updated as part of the UpdateEnvironmentBlueprint action.
        description:
          type: string
          description: The description to be updated as part of the UpdateEnvironmentBlueprint action.
        provider:
          type: string
          description: The provider of the blueprint to be udpated.
        provisioningProperties:
          $ref: '#/components/schemas/ProvisioningProperties'
        deploymentProperties:
          $ref: '#/components/schemas/DeploymentProperties'
        userParameters:
          type: array
          items:
            $ref: '#/components/schemas/CustomParameter'
          description: The user parameters to be updated as part of the UpdateEnvironmentBlueprint action.
        glossaryTerms:
          type: array
          items:
            type: string
          description: The glossary terms to be updated as part of the UpdateEnvironmentBlueprint action.
        blueprintCategory:
          type: string
          enum:
          - TOOLING
          description: The category of the environment blueprint. The only valid value is TOOLING.
        createdAt:
          type: string
          description: The timestamp of when the environment blueprint was created.
        updatedAt:
          type: string
          description: The timestamp of when the blueprint was updated.
      required:
      - id
      - name
      - provider
      - provisioningProperties
    ValidationException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    GetEnvironmentBlueprintInput:
      type: object
      properties:
        domainIdentifier:
          type: string
          description: The identifier of the domain in which this blueprint exists.
        identifier:
          type: string
          description: The ID of this Amazon DataZone blueprint.
      required:
      - domainIdentifier
      - identifier
    UpdateEnvironmentBlueprintInput:
      type: object
      properties:
        domainIdentifier:
          type: string
          description: The identifier of the Amazon DataZone domain in which an environment blueprint is to be updated.
        identifier:
          type: string
          description: The identifier of the environment blueprint to be updated.
        description:
          type: string
          description: The description to be updated as part of the UpdateEnvironmentBlueprint action.
        provisioningProperties:
          $ref: '#/components/schemas/ProvisioningProperties'
        userParameters:
          type: array
          items:
            $ref: '#/components/schemas/CustomParameter'
          description: The user parameters to be updated as part of the UpdateEnvironmentBlueprint action.
        blueprintCategory:
          type: string
          enum:
          - TOOLING
          description: The category to update. The only valid value is TOOLING.
      required:
      - domainIdentifier
      - identifier
    ListEnvironmentBlueprintsOutput:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/EnvironmentBlueprintSummary'
          description: The results of the ListEnvironmentBlueprints action.
        nextToken:
          type: string
          description: When the number of blueprints in the environment 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 blueprints in the environment, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListEnvironmentBlueprintsto list the next set of blueprints.
      required:
      - items
    CreateEnvironmentBlueprintInput:
      type: object
      properties:
        domainIdentifier:
          type: string
          description: The identifier of the domain in which this blueprint is created.
        name:
          type: string
          description: The name of this Amazon DataZone blueprint.
        description:
          type: string
          description: The description of the Amazon DataZone blueprint.
        provisioningProperties:
          $ref: '#/components/schemas/ProvisioningProperties'
        userParameters:
          type: array
          items:
            $ref: '#/components/schemas/CustomParameter'
          description: The user parameters of this Amazon DataZone blueprint.
        blueprintCategory:
          type: string
          enum:
          - TOOLING
          description: The category of the Amazon DataZone blueprint. The only valid value is TOOLING, which creates a blueprint that provisions the tooling resources of a project.
      required:
      - domainIdentifier
      - name
      - provisioningProperties
    CreateEnvironmentBlueprintOutput:
      type: object
      properties:
        id:
          type: string
          description: The ID of this Amazon DataZone blueprint.
        name:
          type: string
          description: The name of this Amazon DataZone blueprint.
        description:
          type: string
          description: The description of this Amazon DataZone blueprint.
        provider:
          type: string
          description: The provider of this Amazon DataZone blueprint.
        provisioningProperties:
          $ref: '#/components/schemas/ProvisioningProperties'
        deploymentProperties:
          $ref: '#/components/schemas/DeploymentProperties'
        userParameters:
          type: array
          items:
            $ref: '#/components/schemas/CustomParameter'
          description: The user parameters of this Amazon DataZone blueprint.
        glossaryTerms:
          type: array
          items:
            type: string
          description: The glossary terms attached to this Amazon DataZone blueprint.
        blueprintCategory:
          type: string
          enum:
          - TOOLING
          description: The category of the Amazon DataZone blueprint. The only valid value is TOOLING, which indicates a blueprint that provisions the tooling resources of a project.
        createdAt:
          type: string
          description: The timestamp at which the environment blueprint was created.
        updatedAt:
          type: string
          description: The timestamp of when this blueprint was updated.
      required:
      - id
      - name
      - provider
      - provisioningProperties
    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.
    UnauthorizedException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    GetEnvironmentBlueprintOutput:
      type: object
      properties:
        id:
          type: string
          description: The ID of this Amazon DataZone blueprint.
        name:
          type: string
          description: The name of this Amazon DataZone blueprint.
        description:
          type: string
          description: The description of this Amazon DataZone blueprint.
        provider:
          type: string
          description: The provider of this Amazon DataZone blueprint.
        provisioningProperties:
          $ref: '#/components/schemas/ProvisioningProperties'
        deploymentProperties:
          $ref: '#/components/schemas/DeploymentProperties'
        userParameters:
          type: array
          items:
            $ref: '#/components/schemas/CustomParameter'
          description: The user parameters of this blueprint.
        glossaryTerms:
          type: array
          items:
            type: string
          description: The glossary terms attached to this Amazon DataZone blueprint.
        blueprintCategory:
          type: string
          enum:
          - TOOLING
          description: The category of this Amazon DataZone blueprint. The only valid value is TOOLING, which indicates a blueprint that provisions the tooling resources of a project.
        createdAt:
          type: string
          description: A timestamp of when this blueprint was created.
        updatedAt:
          type: string
          description: The timestamp of when this blueprint was updated.
      required:
      - id
      - name
      - provider
      - provisioningProperties
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ListEnvironmentBlueprintsInput:
      type: object
      properties:
        domainIdentifier:
          type: string
          description: The identifier of the Amazon DataZone domain.
        maxResults:
          type: integer
          description: The maximum number of blueprints to return in a single call to ListEnvironmentBlueprints. When the number of blueprints 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 ListEnvironmentBlueprints to list the next set of blueprints.
        nextToken:
          type: string
          description: When the number of blueprints in the environment 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 blueprints in the environment, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListEnvironmentBlueprintsto list the next set of blueprints.
        name:
          type: string
          description: The name of the Amazon DataZone environment.
        managed:
          type: boolean
          description: Specifies whether the environment blueprint is managed by Amazon DataZone.
      required:
      - domainIdentifier
    EnvironmentBlueprintSummary:
      type: object
      properties:
        id:
          type: string
          description: The identifier of the blueprint.
        name:
          type: string
          description: The name of the blueprint.
        description:
          type: string
          description: The description of a blueprint.
        provider:
          type: string
          description: The provider of the blueprint.
        provisioningProperties:
          $ref: '#/components/schemas/ProvisioningProperties'
        createdAt:
          type: string
          description: The timestamp of when an environment blueprint was created.
        updatedAt:
          type: string
          description: The timestamp of when the blueprint was enabled.
        blueprintCategory:
          type: string
          enum:
          - TOOLING
          description: The category of the environment blueprint. The only valid value is TOOLING.
      required:
      - id
      - name
      - provider
      - provisioningProperties
    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
    DeleteEnvironmentBlueprintInput:
      type: object
      properties:
        domainIdentifier:
          type: string
          description: The ID of the Amazon DataZone domain in which the blueprint is deleted.
        identifier:
          type: string
          description: The ID of the blueprint that is 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.
    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:
    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)