Amazon DataZone Datazone Designations API
The Datazone Designations API from Amazon DataZone — 2 operation(s) for datazone designations.
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-designations-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 Designations 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: Designations
paths:
/v2/domains/{domainIdentifier}/designations:
post:
operationId: CreateDesignation
summary: Create Designation
description: Creates a new user-defined designation with a Cedar permit policy. The designation defines a named role that can be assigned to project members.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateDesignationOutput'
'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/CreateDesignationInput'
tags:
- Designations
get:
operationId: ListDesignations
summary: List Designations
description: Lists the designations in a domain. Returns system-managed designations first, followed by user-created designations sorted alphabetically by name.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListDesignationsOutput'
'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/ListDesignationsInput'
tags:
- Designations
/v2/domains/{domainIdentifier}/designations/{identifier}:
delete:
operationId: DeleteDesignation
summary: Delete Designation
description: Deletes a designation. Managed designations cannot be deleted. This operation is idempotent.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteDesignationOutput'
'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/DeleteDesignationInput'
tags:
- Designations
get:
operationId: GetDesignation
summary: Get Designation
description: Gets the details of a designation, including its Cedar policy.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetDesignationOutput'
'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/GetDesignationInput'
tags:
- Designations
patch:
operationId: UpdateDesignation
summary: Update Designation
description: Updates an existing designation. Managed designations cannot be modified.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateDesignationOutput'
'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/UpdateDesignationInput'
tags:
- Designations
components:
schemas:
CreateDesignationOutput:
type: object
properties:
domainId:
type: string
description: The identifier of the Amazon DataZone domain in which the designation was created.
id:
type: string
description: The unique ID of the designation.
name:
type: string
description: The name of the designation. The name is unique within the domain.
description:
type: string
description: A human-readable description of the designation and its intended use.
designationType:
type: string
enum:
- MANAGED
- USER_CREATED
description: The classification of this designation. MANAGED designations are system-defined and cannot be modified or deleted.
policy:
type: string
description: The Cedar permit policy that governs what actions holders of this designation are allowed to perform.
deletionProtection:
type: boolean
description: Whether deletion protection is enabled for this designation. When true, DeleteDesignation is rejected until protection is disabled via UpdateDesignation.
createdBy:
type: string
description: The identifier of the Amazon DataZone user who created the designation.
createdAt:
type: string
description: The date and time when the designation was created.
lastUpdatedAt:
type: string
description: The date and time when the designation was last updated.
required:
- domainId
- id
- name
- designationType
- policy
- deletionProtection
- createdBy
ValidationException:
type: object
properties:
message:
type: string
required:
- message
DesignationSummary:
type: object
properties:
domainId:
type: string
description: The identifier of the Amazon DataZone domain that contains the designation.
id:
type: string
description: The unique ID of the designation.
name:
type: string
description: The name of the designation. The name is unique within the domain.
description:
type: string
description: A human-readable description of the designation and its intended use.
designationType:
type: string
enum:
- MANAGED
- USER_CREATED
description: The classification of this designation.
deletionProtection:
type: boolean
description: Whether deletion protection is enabled for this designation.
createdBy:
type: string
description: The identifier of the Amazon DataZone user who created the designation.
createdAt:
type: string
description: The date and time when the designation was created.
updatedAt:
type: string
description: The date and time when the designation was last updated.
required:
- domainId
- id
- name
- deletionProtection
- createdBy
CreateDesignationInput:
type: object
properties:
domainIdentifier:
type: string
description: The identifier of the Amazon DataZone domain in which the designation is created.
name:
type: string
description: The name of the designation. The name must be unique within the domain.
description:
type: string
description: A human-readable description of the designation and its intended use.
policy:
type: string
description: The Cedar permit policy that defines what actions holders of this designation are allowed to perform.
deletionProtection:
type: boolean
description: Whether deletion protection is enabled for this designation. Defaults to true when omitted.
required:
- domainIdentifier
- name
- policy
ListDesignationsOutput:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/DesignationSummary'
description: The designation summaries that ListDesignations returned. Each item contains summary information about a designation in the domain.
nextToken:
type: string
description: A pagination token that indicates that more results are available. Pass this token to a subsequent call to ListDesignations to retrieve the next page of results. If there are no more results, this value is null.
UnauthorizedException:
type: object
properties:
message:
type: string
required:
- message
UpdateDesignationOutput:
type: object
properties:
domainId:
type: string
description: The identifier of the Amazon DataZone domain that contains the designation.
id:
type: string
description: The unique ID of the designation.
name:
type: string
description: The name of the designation. The name is unique within the domain.
description:
type: string
description: A human-readable description of the designation and its intended use.
designationType:
type: string
enum:
- MANAGED
- USER_CREATED
description: The classification of this designation. MANAGED designations are system-defined and cannot be modified or deleted.
policy:
type: string
description: The Cedar permit policy that governs what actions holders of this designation are allowed to perform.
deletionProtection:
type: boolean
description: Whether deletion protection is enabled for this designation. When true, DeleteDesignation is rejected until protection is disabled via UpdateDesignation.
createdBy:
type: string
description: The identifier of the Amazon DataZone user who created the designation.
createdAt:
type: string
description: The date and time when the designation was created.
lastUpdatedAt:
type: string
description: The date and time when the designation was last updated.
required:
- domainId
- id
- name
- designationType
- policy
- deletionProtection
- createdBy
ThrottlingException:
type: object
properties:
message:
type: string
required:
- message
DeleteDesignationOutput:
type: object
properties: {}
GetDesignationOutput:
type: object
properties:
domainId:
type: string
description: The identifier of the Amazon DataZone domain that contains the designation.
id:
type: string
description: The unique ID of the designation.
name:
type: string
description: The name of the designation. The name is unique within the domain.
description:
type: string
description: A human-readable description of the designation and its intended use.
designationType:
type: string
enum:
- MANAGED
- USER_CREATED
description: The classification of this designation. MANAGED designations are system-defined and cannot be modified or deleted.
policy:
type: string
description: The Cedar permit policy that governs what actions holders of this designation are allowed to perform.
deletionProtection:
type: boolean
description: Whether deletion protection is enabled for this designation. When true, DeleteDesignation is rejected until protection is disabled via UpdateDesignation.
createdBy:
type: string
description: The identifier of the Amazon DataZone user who created the designation.
createdAt:
type: string
description: The date and time when the designation was created.
lastUpdatedAt:
type: string
description: The date and time when the designation was last updated.
required:
- domainId
- id
- name
- designationType
- policy
- deletionProtection
- createdBy
DeleteDesignationInput:
type: object
properties:
domainIdentifier:
type: string
description: The identifier of the Amazon DataZone domain that contains the designation to delete.
identifier:
type: string
description: The unique ID of the designation to delete.
required:
- domainIdentifier
- identifier
GetDesignationInput:
type: object
properties:
domainIdentifier:
type: string
description: The identifier of the Amazon DataZone domain that contains the designation.
identifier:
type: string
description: The unique ID of the designation to retrieve.
required:
- domainIdentifier
- identifier
AccessDeniedException:
type: object
properties:
message:
type: string
required:
- message
ListDesignationsInput:
type: object
properties:
domainIdentifier:
type: string
description: The identifier of the Amazon DataZone domain that contains the designations to list.
nextToken:
type: string
description: If the results exceed the value of MaxResults, the previous call returns a pagination token. Specify this token in a subsequent call to ListDesignations to retrieve the next set of results. If not specified, the operation returns the first page of results.
maxResults:
type: integer
description: The maximum number of designations to return in a single call to ListDesignations. If the number of designations exceeds MaxResults, the response includes a NextToken value. Use that token in a subsequent call to ListDesignations to retrieve the next set of designations. The default value is 20.
required:
- domainIdentifier
InternalServerException:
type: object
properties:
message:
type: string
required:
- message
UpdateDesignationInput:
type: object
properties:
domainIdentifier:
type: string
description: The identifier of the Amazon DataZone domain that contains the designation to update.
identifier:
type: string
description: The unique ID of the designation to update.
name:
type: string
description: The updated name of the designation. The name must be unique within the domain.
description:
type: string
description: The updated human-readable description of the designation and its intended use.
policy:
type: string
description: The updated Cedar permit policy.
deletionProtection:
type: boolean
description: Whether deletion protection is enabled for this designation. Omit to keep the existing value.
required:
- domainIdentifier
- identifier
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)