Amazon DataZone Datazone Project Profiles API
The Datazone Project Profiles API from Amazon DataZone — 2 operation(s) for datazone project profiles.
The Datazone Project Profiles API from Amazon DataZone — 2 operation(s) for datazone project profiles.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/amazon-datazone:amazon-datazone-project-profiles-api"
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.
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: 3.2.0
info:
title: Amazon DataZone Project 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: Project Profiles
paths:
/v2/domains/{domainIdentifier}/project-profiles:
post:
operationId: CreateProjectProfile
summary: Create Project Profile
description: Creates a project profile.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateProjectProfileOutput'
'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/CreateProjectProfileInput'
tags:
- Project Profiles
get:
operationId: ListProjectProfiles
summary: List Project Profiles
description: Lists project profiles.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListProjectProfilesOutput'
'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/ListProjectProfilesInput'
tags:
- Project Profiles
/v2/domains/{domainIdentifier}/project-profiles/{identifier}:
delete:
operationId: DeleteProjectProfile
summary: Delete Project Profile
description: Deletes a project profile.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteProjectProfileOutput'
'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/DeleteProjectProfileInput'
tags:
- Project Profiles
get:
operationId: GetProjectProfile
summary: Get Project Profile
description: The details of the project profile.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetProjectProfileOutput'
'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/GetProjectProfileInput'
tags:
- Project Profiles
patch:
operationId: UpdateProjectProfile
summary: Update Project Profile
description: Updates a project profile.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateProjectProfileOutput'
'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/UpdateProjectProfileInput'
tags:
- Project Profiles
components:
schemas:
CreateProjectProfileOutput:
type: object
properties:
domainId:
type: string
description: The ID of the domain where a project profile is created.
id:
type: string
description: Project profile ID.
name:
type: string
description: Project profile name.
description:
type: string
description: A project profile description.
status:
type: string
enum:
- ENABLED
- DISABLED
description: Project profile status.
projectResourceTags:
type: array
items:
$ref: '#/components/schemas/ResourceTagParameter'
description: The resource tags of the project profile.
allowCustomProjectResourceTags:
type: boolean
description: Specifies whether custom project resource tags are supported.
projectResourceTagsDescription:
type: string
description: Field viewable through the UI that provides a project user with the allowed resource tag specifications.
environmentConfigurations:
type: array
items:
$ref: '#/components/schemas/EnvironmentConfiguration'
description: Environment configurations of a project profile.
createdBy:
type: string
description: A user who created a project profile.
createdAt:
type: string
description: A timestamp at which a project profile is created.
lastUpdatedAt:
type: string
description: A timestamp when a project profile was last updated.
domainUnitId:
type: string
description: The ID of the domain unit where a project profile is created.
required:
- domainId
- id
- name
- createdBy
GetProjectProfileInput:
type: object
properties:
domainIdentifier:
type: string
description: The ID of the domain.
identifier:
type: string
description: The ID of the project profile.
required:
- domainIdentifier
- identifier
ValidationException:
type: object
properties:
message:
type: string
required:
- message
DeleteProjectProfileInput:
type: object
properties:
domainIdentifier:
type: string
description: The ID of the domain where a project profile is deleted.
identifier:
type: string
description: The ID of the project profile that is deleted.
required:
- domainIdentifier
- identifier
UpdateProjectProfileInput:
type: object
properties:
domainIdentifier:
type: string
description: The ID of the domain where a project profile is to be updated.
identifier:
type: string
description: The ID of a project profile that is to be updated.
name:
type: string
description: The name of a project profile.
description:
type: string
description: The description of a project profile.
status:
type: string
enum:
- ENABLED
- DISABLED
description: The status of a project profile.
projectResourceTags:
type: array
items:
$ref: '#/components/schemas/ResourceTagParameter'
description: The resource tags of the project profile.
allowCustomProjectResourceTags:
type: boolean
description: Specifies whether custom project resource tags are supported.
projectResourceTagsDescription:
type: string
description: Field viewable through the UI that provides a project user with the allowed resource tag specifications.
environmentConfigurations:
type: array
items:
$ref: '#/components/schemas/EnvironmentConfiguration'
description: The environment configurations of a project profile.
domainUnitIdentifier:
type: string
description: The ID of the domain unit where a project profile is to be updated.
required:
- domainIdentifier
- identifier
AwsAccount:
type: object
properties:
awsAccountId:
type: string
description: The account ID of a project.
awsAccountIdPath:
type: string
description: The account ID path of a project.
description: Exactly one member is set.
UnauthorizedException:
type: object
properties:
message:
type: string
required:
- message
EnvironmentConfigurationParameter:
type: object
properties:
name:
type: string
description: The name of the environment configuration parameter.
value:
type: string
description: The value of the environment configuration parameter.
isEditable:
type: boolean
description: Specifies whether the environment parameter is editable.
ThrottlingException:
type: object
properties:
message:
type: string
required:
- message
CreateProjectProfileInput:
type: object
properties:
domainIdentifier:
type: string
description: A domain ID of the project profile.
name:
type: string
description: Project profile name.
description:
type: string
description: A description of a project profile.
status:
type: string
enum:
- ENABLED
- DISABLED
description: Project profile status.
projectResourceTags:
type: array
items:
$ref: '#/components/schemas/ResourceTagParameter'
description: The resource tags of the project profile.
allowCustomProjectResourceTags:
type: boolean
description: Specifies whether custom project resource tags are supported.
projectResourceTagsDescription:
type: string
description: Field viewable through the UI that provides a project user with the allowed resource tag specifications.
environmentConfigurations:
type: array
items:
$ref: '#/components/schemas/EnvironmentConfiguration'
description: Environment configurations of the project profile.
domainUnitIdentifier:
type: string
description: A domain unit ID of the project profile.
required:
- domainIdentifier
- name
GetProjectProfileOutput:
type: object
properties:
domainId:
type: string
description: The ID of the domain of the project profile.
id:
type: string
description: The ID of the project profile.
name:
type: string
description: The name of the project profile.
description:
type: string
description: The description of the project profile.
status:
type: string
enum:
- ENABLED
- DISABLED
description: The status of the project profile.
projectResourceTags:
type: array
items:
$ref: '#/components/schemas/ResourceTagParameter'
description: The resource tags of the project profile.
allowCustomProjectResourceTags:
type: boolean
description: Specifies whether custom project resource tags are supported.
projectResourceTagsDescription:
type: string
description: Field viewable through the UI that provides a project user with the allowed resource tag specifications.
environmentConfigurations:
type: array
items:
$ref: '#/components/schemas/EnvironmentConfiguration'
description: The environment configurations of the project profile.
createdBy:
type: string
description: The user who created the project profile.
createdAt:
type: string
description: The timestamp of when the project profile was created.
lastUpdatedAt:
type: string
description: The timestamp of when project profile was last updated.
domainUnitId:
type: string
description: The ID of the domain unit of the project profile.
required:
- domainId
- id
- name
- createdBy
DeleteProjectProfileOutput:
type: object
properties: {}
ListProjectProfilesOutput:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/ProjectProfileSummary'
description: The results of the ListProjectProfiles action.
nextToken:
type: string
description: When the number of project 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 project profiles, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListProjectProfiles to list the next set of project profiles.
ListProjectProfilesInput:
type: object
properties:
domainIdentifier:
type: string
description: The ID of the domain where you want to list project profiles.
name:
type: string
description: The name of a project profile.
sortBy:
type: string
enum:
- NAME
description: Specifies by what to sort project profiles.
sortOrder:
type: string
enum:
- ASCENDING
- DESCENDING
description: Specifies the sort order of the project profiles.
nextToken:
type: string
description: When the number of project 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 project profiles, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListProjectProfiles to list the next set of project profiles.
maxResults:
type: integer
description: The maximum number of project profiles to return in a single call to ListProjectProfiles. When the number of project 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 ListProjectProfiles to list the next set of project profiles.
required:
- domainIdentifier
AccessDeniedException:
type: object
properties:
message:
type: string
required:
- message
ResourceTagParameter:
type: object
properties:
key:
type: string
description: The key of the resource tag parameter of the project profile.
value:
type: string
description: The value of the resource tag parameter key of the project profile.
isValueEditable:
type: boolean
description: Specifies whether the value of the resource tag parameter of the project profile is editable at the project level.
required:
- key
- value
- isValueEditable
UpdateProjectProfileOutput:
type: object
properties:
domainId:
type: string
description: The ID of the domain where project profile is to be updated.
id:
type: string
description: The ID of the project profile.
name:
type: string
description: The name of the project profile.
description:
type: string
description: The description of a project profile.
status:
type: string
enum:
- ENABLED
- DISABLED
description: The status of the project profile.
projectResourceTags:
type: array
items:
$ref: '#/components/schemas/ResourceTagParameter'
description: The resource tags of the project profile.
allowCustomProjectResourceTags:
type: boolean
description: Specifies whether custom project resource tags are supported.
projectResourceTagsDescription:
type: string
description: Field viewable through the UI that provides a project user with the allowed resource tag specifications.
environmentConfigurations:
type: array
items:
$ref: '#/components/schemas/EnvironmentConfiguration'
description: The environment configurations of a project profile.
createdBy:
type: string
description: The user who created a project profile.
createdAt:
type: string
description: The timestamp at which a project profile is created.
lastUpdatedAt:
type: string
description: The timestamp at which a project profile was last updated.
domainUnitId:
type: string
description: The domain unit ID of the project profile to be updated.
required:
- domainId
- id
- name
- createdBy
EnvironmentConfigurationParametersDetails:
type: object
properties:
ssmPath:
type: string
description: Ssm path environment configuration parameters.
parameterOverrides:
type: array
items:
$ref: '#/components/schemas/EnvironmentConfigurationParameter'
description: The parameter overrides.
resolvedParameters:
type: array
items:
$ref: '#/components/schemas/EnvironmentConfigurationParameter'
description: The resolved environment configuration parameters.
ProjectProfileSummary:
type: object
properties:
domainId:
type: string
description: The domain ID of the project profile.
id:
type: string
description: The ID of the project profile.
name:
type: string
description: The name of a project profile.
description:
type: string
description: The description of the project profile.
status:
type: string
enum:
- ENABLED
- DISABLED
description: The status of a project profile.
createdBy:
type: string
description: The user who created the project profile.
createdAt:
type: string
description: The timestamp of when the project profile was created.
lastUpdatedAt:
type: string
description: The timestamp at which a project profile was last updated.
domainUnitId:
type: string
description: The domain unit ID of the project profile.
required:
- domainId
- id
- name
- createdBy
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
EnvironmentConfiguration:
type: object
properties:
name:
type: string
description: The environment name.
id:
type: string
description: The environment ID.
environmentBlueprintId:
type: string
description: The environment blueprint ID.
description:
type: string
description: The environment description.
deploymentMode:
type: string
enum:
- ON_CREATE
- ON_DEMAND
description: The deployment mode of the environment.
configurationParameters:
$ref: '#/components/schemas/EnvironmentConfigurationParametersDetails'
awsAccount:
$ref: '#/components/schemas/AwsAccount'
accountPools:
type: array
items:
type: string
description: The account pools used by a custom project profile.
awsRegion:
$ref: '#/components/schemas/Region'
deploymentOrder:
type: integer
description: The deployment order of the environment.
required:
- name
- environmentBlueprintId
ConflictException:
type: object
properties:
message:
type: string
required:
- message
Region:
type: object
properties:
regionName:
type: string
description: The Amazon Web Services Region name.
regionNamePath:
type: string
description: The region name path.
description: Exactly one member is set.
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)