Amazon DataZone Datazone Environment Profiles API
The Datazone Environment Profiles API from Amazon DataZone — 2 operation(s) for datazone environment profiles.
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-datazone:amazon-datazone-environment-profiles-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
openapi: 3.2.0
info:
title: Amazon DataZone Environment Profiles 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 Profiles
paths:
/v2/domains/{domainIdentifier}/environment-profiles:
post:
operationId: CreateEnvironmentProfile
summary: Create Environment Profile
description: Creates an Amazon DataZone environment profile.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateEnvironmentProfileOutput'
'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/CreateEnvironmentProfileInput'
tags:
- Environment Profiles
get:
operationId: ListEnvironmentProfiles
summary: List Environment Profiles
description: Lists Amazon DataZone environment profiles.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListEnvironmentProfilesOutput'
'403':
description: AccessDeniedException; AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'500':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'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/ListEnvironmentProfilesInput'
tags:
- Environment Profiles
/v2/domains/{domainIdentifier}/environment-profiles/{identifier}:
delete:
operationId: DeleteEnvironmentProfile
summary: Delete Environment Profile
description: Deletes an environment profile 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/DeleteEnvironmentProfileInput'
tags:
- Environment Profiles
get:
operationId: GetEnvironmentProfile
summary: Get Environment Profile
description: Gets an evinronment profile in Amazon DataZone.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetEnvironmentProfileOutput'
'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/GetEnvironmentProfileInput'
tags:
- Environment Profiles
patch:
operationId: UpdateEnvironmentProfile
summary: Update Environment Profile
description: Updates the specified environment profile in Amazon DataZone.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateEnvironmentProfileOutput'
'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/UpdateEnvironmentProfileInput'
tags:
- Environment Profiles
components:
schemas:
ValidationException:
type: object
properties:
message:
type: string
required:
- message
EnvironmentProfileSummary:
type: object
properties:
id:
type: string
description: The identifier of the environment profile.
domainId:
type: string
description: The identifier of the Amazon DataZone domain in which the environment profile exists.
awsAccountId:
type: string
description: The identifier of an Amazon Web Services account in which an environment profile exists.
awsAccountRegion:
type: string
description: The Amazon Web Services Region in which an environment profile exists.
createdBy:
type: string
description: The Amazon DataZone user who created the environment profile.
createdAt:
type: string
description: The timestamp of when an environment profile was created.
updatedAt:
type: string
description: The timestamp of when the environment profile was updated.
name:
type: string
description: The name of the environment profile.
description:
type: string
description: The description of the environment profile.
environmentBlueprintId:
type: string
description: The identifier of a blueprint with which an environment profile is created.
projectId:
type: string
description: The identifier of a project in which an environment profile exists.
required:
- id
- domainId
- createdBy
- name
- environmentBlueprintId
UpdateEnvironmentProfileInput:
type: object
properties:
domainIdentifier:
type: string
description: The identifier of the Amazon DataZone domain in which an environment profile is to be updated.
identifier:
type: string
description: The identifier of the environment profile that is to be updated.
name:
type: string
description: The name to be updated as part of the UpdateEnvironmentProfile action.
description:
type: string
description: The description to be updated as part of the UpdateEnvironmentProfile action.
userParameters:
type: array
items:
$ref: '#/components/schemas/EnvironmentParameter'
description: The user parameters to be updated as part of the UpdateEnvironmentProfile action.
awsAccountId:
type: string
description: The Amazon Web Services account in which a specified environment profile is to be udpated.
awsAccountRegion:
type: string
description: The Amazon Web Services Region in which a specified environment profile is to be updated.
required:
- domainIdentifier
- identifier
DeleteEnvironmentProfileInput:
type: object
properties:
domainIdentifier:
type: string
description: The ID of the Amazon DataZone domain in which the environment profile is deleted.
identifier:
type: string
description: The ID of the environment profile that is deleted.
required:
- domainIdentifier
- identifier
UnauthorizedException:
type: object
properties:
message:
type: string
required:
- message
GetEnvironmentProfileOutput:
type: object
properties:
id:
type: string
description: The ID of the environment profile.
domainId:
type: string
description: The ID of the Amazon DataZone domain in which this environment profile exists.
awsAccountId:
type: string
description: The ID of the Amazon Web Services account where this environment profile exists.
awsAccountRegion:
type: string
description: The Amazon Web Services region where this environment profile exists.
createdBy:
type: string
description: The Amazon DataZone user who created this environment profile.
createdAt:
type: string
description: The timestamp of when this environment profile was created.
updatedAt:
type: string
description: The timestamp of when this environment profile was upated.
name:
type: string
description: The name of the environment profile.
description:
type: string
description: The description of the environment profile.
environmentBlueprintId:
type: string
description: The ID of the blueprint with which this environment profile is created.
projectId:
type: string
description: The ID of the Amazon DataZone project in which this environment profile is created.
userParameters:
type: array
items:
$ref: '#/components/schemas/CustomParameter'
description: The user parameters of the environment profile.
required:
- id
- domainId
- createdBy
- name
- environmentBlueprintId
UpdateEnvironmentProfileOutput:
type: object
properties:
id:
type: string
description: The identifier of the environment profile that is to be udpated.
domainId:
type: string
description: The identifier of the Amazon DataZone domain in which the environment profile is to be updated.
awsAccountId:
type: string
description: The Amazon Web Services account in which a specified environment profile is to be udpated.
awsAccountRegion:
type: string
description: The Amazon Web Services Region in which a specified environment profile is to be updated.
createdBy:
type: string
description: The Amazon DataZone user who created the environment profile.
createdAt:
type: string
description: The timestamp of when the environment profile was created.
updatedAt:
type: string
description: The timestamp of when the environment profile was updated.
name:
type: string
description: The name to be updated as part of the UpdateEnvironmentProfile action.
description:
type: string
description: The description to be updated as part of the UpdateEnvironmentProfile action.
environmentBlueprintId:
type: string
description: The identifier of the blueprint of the environment profile that is to be updated.
projectId:
type: string
description: The identifier of the project of the environment profile that is to be updated.
userParameters:
type: array
items:
$ref: '#/components/schemas/CustomParameter'
description: The user parameters to be updated as part of the UpdateEnvironmentProfile action.
required:
- id
- domainId
- createdBy
- name
- environmentBlueprintId
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.
CreateEnvironmentProfileInput:
type: object
properties:
domainIdentifier:
type: string
description: The ID of the Amazon DataZone domain in which this environment profile is created.
name:
type: string
description: The name of this Amazon DataZone environment profile.
description:
type: string
description: The description of this Amazon DataZone environment profile.
environmentBlueprintIdentifier:
type: string
description: The ID of the blueprint with which this environment profile is created.
projectIdentifier:
type: string
description: The identifier of the project in which to create the environment profile.
userParameters:
type: array
items:
$ref: '#/components/schemas/EnvironmentParameter'
description: The user parameters of this Amazon DataZone environment profile.
awsAccountId:
type: string
description: The Amazon Web Services account in which the Amazon DataZone environment is created.
awsAccountRegion:
type: string
description: The Amazon Web Services region in which this environment profile is created.
required:
- domainIdentifier
- name
- environmentBlueprintIdentifier
- projectIdentifier
ThrottlingException:
type: object
properties:
message:
type: string
required:
- message
GetEnvironmentProfileInput:
type: object
properties:
domainIdentifier:
type: string
description: The ID of the Amazon DataZone domain in which this environment profile exists.
identifier:
type: string
description: The ID of the environment profile.
required:
- domainIdentifier
- identifier
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
CreateEnvironmentProfileOutput:
type: object
properties:
id:
type: string
description: The ID of this Amazon DataZone environment profile.
domainId:
type: string
description: The ID of the Amazon DataZone domain in which this environment profile is created.
awsAccountId:
type: string
description: The Amazon Web Services account ID in which this Amazon DataZone environment profile is created.
awsAccountRegion:
type: string
description: The Amazon Web Services region in which this Amazon DataZone environment profile is created.
createdBy:
type: string
description: The Amazon DataZone user who created this environment profile.
createdAt:
type: string
description: The timestamp of when this environment profile was created.
updatedAt:
type: string
description: The timestamp of when this environment profile was updated.
name:
type: string
description: The name of this Amazon DataZone environment profile.
description:
type: string
description: The description of this Amazon DataZone environment profile.
environmentBlueprintId:
type: string
description: The ID of the blueprint with which this environment profile is created.
projectId:
type: string
description: The ID of the Amazon DataZone project in which this environment profile is created.
userParameters:
type: array
items:
$ref: '#/components/schemas/CustomParameter'
description: The user parameters of this Amazon DataZone environment profile.
required:
- id
- domainId
- createdBy
- name
- environmentBlueprintId
AccessDeniedException:
type: object
properties:
message:
type: string
required:
- message
ListEnvironmentProfilesInput:
type: object
properties:
domainIdentifier:
type: string
description: The identifier of the Amazon DataZone domain.
awsAccountId:
type: string
description: The identifier of the Amazon Web Services account where you want to list environment profiles.
awsAccountRegion:
type: string
description: The Amazon Web Services region where you want to list environment profiles.
environmentBlueprintIdentifier:
type: string
description: The identifier of the blueprint that was used to create the environment profiles that you want to list.
projectIdentifier:
type: string
description: The identifier of the Amazon DataZone project.
name:
type: string
nextToken:
type: string
description: When the number of environment profiles 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 environment profiles, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListEnvironmentProfiles to list the next set of environment profiles.
maxResults:
type: integer
description: The maximum number of environment profiles to return in a single call to ListEnvironmentProfiles. When the number of environment profiles 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 ListEnvironmentProfiles to list the next set of environment profiles.
required:
- domainIdentifier
ListEnvironmentProfilesOutput:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/EnvironmentProfileSummary'
description: The results of the ListEnvironmentProfiles action.
nextToken:
type: string
description: When the number of environment profiles 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 environment profiles, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListEnvironmentProfiles to list the next set of environment profiles.
required:
- items
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)