Amazon DataZone Datazone Subscription Targets API
The Datazone Subscription Targets API from Amazon DataZone — 2 operation(s) for datazone subscription targets.
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-subscription-targets-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 Subscription Targets 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: Subscription Targets
paths:
/v2/domains/{domainIdentifier}/environments/{environmentIdentifier}/subscription-targets:
post:
operationId: CreateSubscriptionTarget
summary: Create Subscription Target
description: Creates a subscription target in Amazon DataZone.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateSubscriptionTargetOutput'
'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/CreateSubscriptionTargetInput'
tags:
- Subscription Targets
get:
operationId: ListSubscriptionTargets
summary: List Subscription Targets
description: Lists subscription targets in Amazon DataZone.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListSubscriptionTargetsOutput'
'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/ListSubscriptionTargetsInput'
tags:
- Subscription Targets
/v2/domains/{domainIdentifier}/environments/{environmentIdentifier}/subscription-targets/{identifier}:
delete:
operationId: DeleteSubscriptionTarget
summary: Delete Subscription Target
description: Deletes a subscription target 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/DeleteSubscriptionTargetInput'
tags:
- Subscription Targets
get:
operationId: GetSubscriptionTarget
summary: Get Subscription Target
description: Gets the subscription target in Amazon DataZone.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetSubscriptionTargetOutput'
'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/GetSubscriptionTargetInput'
tags:
- Subscription Targets
patch:
operationId: UpdateSubscriptionTarget
summary: Update Subscription Target
description: Updates the specified subscription target in Amazon DataZone.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateSubscriptionTargetOutput'
'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/UpdateSubscriptionTargetInput'
tags:
- Subscription Targets
components:
schemas:
SubscriptionTargetForm:
type: object
properties:
formName:
type: string
description: The form name included in the subscription target configuration.
content:
type: string
description: The content of the subscription target configuration.
required:
- formName
- content
SubscriptionTargetSummary:
type: object
properties:
id:
type: string
description: The identifier of the subscription target.
authorizedPrincipals:
type: array
items:
type: string
description: The authorized principals included in the subscription target.
domainId:
type: string
description: The identifier of the Amazon DataZone domain in which the subscription target exists.
projectId:
type: string
description: The identifier of the project specified in the subscription target.
environmentId:
type: string
description: The identifier of the environment of the subscription target.
name:
type: string
description: The name of the subscription target.
type:
type: string
description: The type of the subscription target.
createdBy:
type: string
description: The Amazon DataZone user who created the subscription target.
updatedBy:
type: string
description: The Amazon DataZone user who updated the subscription target.
createdAt:
type: string
format: date-time
description: The timestamp of when the subscription target was created.
updatedAt:
type: string
format: date-time
description: The timestamp of when the subscription target was updated.
manageAccessRole:
type: string
description: The manage access role specified in the subscription target.
applicableAssetTypes:
type: array
items:
type: string
description: The asset types included in the subscription target.
subscriptionTargetConfig:
type: array
items:
$ref: '#/components/schemas/SubscriptionTargetForm'
description: The configuration of the subscription target.
provider:
type: string
description: The provider of the subscription target.
subscriptionGrantCreationMode:
type: string
enum:
- AUTOMATIC
- MANUAL
description: Determines the subscription grant creation mode for this target, defining if grants are auto-created upon subscription approval or managed manually.
required:
- id
- authorizedPrincipals
- domainId
- projectId
- environmentId
- name
- type
- createdBy
- createdAt
- applicableAssetTypes
- subscriptionTargetConfig
- provider
GetSubscriptionTargetOutput:
type: object
properties:
id:
type: string
description: The ID of the subscription target.
authorizedPrincipals:
type: array
items:
type: string
description: The authorized principals of the subscription target.
domainId:
type: string
description: The ID of the Amazon DataZone domain in which the subscription target exists.
projectId:
type: string
description: The ID of the project associated with the subscription target.
environmentId:
type: string
description: The ID of the environment associated with the subscription target.
name:
type: string
description: The name of the subscription target.
type:
type: string
description: The type of the subscription target.
createdBy:
type: string
description: The Amazon DataZone user who created the subscription target.
updatedBy:
type: string
description: The Amazon DataZone user who updated the subscription target.
createdAt:
type: string
format: date-time
description: The timestamp of when the subscription target was created.
updatedAt:
type: string
format: date-time
description: The timestamp of when the subscription target was updated.
manageAccessRole:
type: string
description: The manage access role with which the subscription target was created.
applicableAssetTypes:
type: array
items:
type: string
description: The asset types associated with the subscription target.
subscriptionTargetConfig:
type: array
items:
$ref: '#/components/schemas/SubscriptionTargetForm'
description: The configuration of teh subscription target.
provider:
type: string
description: The provider of the subscription target.
subscriptionGrantCreationMode:
type: string
enum:
- AUTOMATIC
- MANUAL
description: Determines the subscription grant creation mode for this target, defining if grants are auto-created upon subscription approval or managed manually.
required:
- id
- authorizedPrincipals
- domainId
- projectId
- environmentId
- name
- type
- createdBy
- createdAt
- applicableAssetTypes
- subscriptionTargetConfig
- provider
ValidationException:
type: object
properties:
message:
type: string
required:
- message
CreateSubscriptionTargetInput:
type: object
properties:
domainIdentifier:
type: string
description: The ID of the Amazon DataZone domain in which subscription target is created.
environmentIdentifier:
type: string
description: The ID of the environment in which subscription target is created.
name:
type: string
description: The name of the subscription target.
type:
type: string
description: The type of the subscription target.
subscriptionTargetConfig:
type: array
items:
$ref: '#/components/schemas/SubscriptionTargetForm'
description: The configuration of the subscription target.
authorizedPrincipals:
type: array
items:
type: string
description: The authorized principals of the subscription target.
manageAccessRole:
type: string
description: The manage access role that is used to create the subscription target.
applicableAssetTypes:
type: array
items:
type: string
description: The asset types that can be included in the subscription target.
provider:
type: string
description: The provider of the subscription target.
clientToken:
type: string
description: A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.
subscriptionGrantCreationMode:
type: string
enum:
- AUTOMATIC
- MANUAL
description: Determines the subscription grant creation mode for this target, defining if grants are auto-created upon subscription approval or managed manually.
required:
- domainIdentifier
- environmentIdentifier
- name
- type
- subscriptionTargetConfig
- authorizedPrincipals
- manageAccessRole
- applicableAssetTypes
UnauthorizedException:
type: object
properties:
message:
type: string
required:
- message
GetSubscriptionTargetInput:
type: object
properties:
domainIdentifier:
type: string
description: The ID of the Amazon DataZone domain in which the subscription target exists.
environmentIdentifier:
type: string
description: The ID of the environment associated with the subscription target.
identifier:
type: string
description: The ID of the subscription target.
required:
- domainIdentifier
- environmentIdentifier
- identifier
ThrottlingException:
type: object
properties:
message:
type: string
required:
- message
UpdateSubscriptionTargetOutput:
type: object
properties:
id:
type: string
description: Identifier of the subscription target that is to be updated.
authorizedPrincipals:
type: array
items:
type: string
description: The authorized principals to be updated as part of the UpdateSubscriptionTarget action. Updates are supported in batches of 5 at a time.
domainId:
type: string
description: The identifier of the Amazon DataZone domain in which a subscription target is to be updated.
projectId:
type: string
description: The identifier of the project in which a subscription target is to be updated.
environmentId:
type: string
description: The identifier of the environment in which a subscription target is to be updated.
name:
type: string
description: The name to be updated as part of the UpdateSubscriptionTarget action.
type:
type: string
description: The type to be updated as part of the UpdateSubscriptionTarget action.
createdBy:
type: string
description: The Amazon DataZone user who created the subscription target.
updatedBy:
type: string
description: The Amazon DataZone user who updated the subscription target.
createdAt:
type: string
format: date-time
description: The timestamp of when a subscription target was created.
updatedAt:
type: string
format: date-time
description: The timestamp of when the subscription target was updated.
manageAccessRole:
type: string
description: The manage access role to be updated as part of the UpdateSubscriptionTarget action.
applicableAssetTypes:
type: array
items:
type: string
description: The applicable asset types to be updated as part of the UpdateSubscriptionTarget action.
subscriptionTargetConfig:
type: array
items:
$ref: '#/components/schemas/SubscriptionTargetForm'
description: The configuration to be updated as part of the UpdateSubscriptionTarget action.
provider:
type: string
description: The provider to be updated as part of the UpdateSubscriptionTarget action.
subscriptionGrantCreationMode:
type: string
enum:
- AUTOMATIC
- MANUAL
description: Determines the subscription grant creation mode for this target, defining if grants are auto-created upon subscription approval or managed manually.
required:
- id
- authorizedPrincipals
- domainId
- projectId
- environmentId
- name
- type
- createdBy
- createdAt
- applicableAssetTypes
- subscriptionTargetConfig
- provider
ListSubscriptionTargetsInput:
type: object
properties:
domainIdentifier:
type: string
description: The identifier of the Amazon DataZone domain where you want to list subscription targets.
environmentIdentifier:
type: string
description: The identifier of the environment where you want to list subscription targets.
sortBy:
type: string
enum:
- CREATED_AT
- UPDATED_AT
description: Specifies the way in which the results of this action are to be sorted.
sortOrder:
type: string
enum:
- ASCENDING
- DESCENDING
description: Specifies the sort order for the results of this action.
maxResults:
type: integer
description: The maximum number of subscription targets to return in a single call to ListSubscriptionTargets. When the number of subscription targets 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 ListSubscriptionTargets to list the next set of subscription targets.
nextToken:
type: string
description: When the number of subscription targets 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 subscription targets, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListSubscriptionTargets to list the next set of subscription targets.
required:
- domainIdentifier
- environmentIdentifier
UpdateSubscriptionTargetInput:
type: object
properties:
domainIdentifier:
type: string
description: The identifier of the Amazon DataZone domain in which a subscription target is to be updated.
environmentIdentifier:
type: string
description: The identifier of the environment in which a subscription target is to be updated.
identifier:
type: string
description: Identifier of the subscription target that is to be updated.
name:
type: string
description: The name to be updated as part of the UpdateSubscriptionTarget action.
authorizedPrincipals:
type: array
items:
type: string
description: The authorized principals to be updated as part of the UpdateSubscriptionTarget action.
applicableAssetTypes:
type: array
items:
type: string
description: The applicable asset types to be updated as part of the UpdateSubscriptionTarget action.
subscriptionTargetConfig:
type: array
items:
$ref: '#/components/schemas/SubscriptionTargetForm'
description: The configuration to be updated as part of the UpdateSubscriptionTarget action.
manageAccessRole:
type: string
description: The manage access role to be updated as part of the UpdateSubscriptionTarget action.
provider:
type: string
description: The provider to be updated as part of the UpdateSubscriptionTarget action.
subscriptionGrantCreationMode:
type: string
enum:
- AUTOMATIC
- MANUAL
description: Determines the subscription grant creation mode for this target, defining if grants are auto-created upon subscription approval or managed manually.
required:
- domainIdentifier
- environmentIdentifier
- identifier
DeleteSubscriptionTargetInput:
type: object
properties:
domainIdentifier:
type: string
description: The ID of the Amazon DataZone domain in which the subscription target is deleted.
environmentIdentifier:
type: string
description: The ID of the Amazon DataZone environment in which the subscription target is deleted.
identifier:
type: string
description: The ID of the subscription target that is deleted.
required:
- domainIdentifier
- environmentIdentifier
- identifier
ListSubscriptionTargetsOutput:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/SubscriptionTargetSummary'
description: The results of the ListSubscriptionTargets action.
nextToken:
type: string
description: When the number of subscription targets 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 subscription targets, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListSubscriptionTargets to list the next set of subscription targets.
required:
- items
CreateSubscriptionTargetOutput:
type: object
properties:
id:
type: string
description: The ID of the subscription target.
authorizedPrincipals:
type: array
items:
type: string
description: The authorised principals of the subscription target.
domainId:
type: string
description: The ID of the Amazon DataZone domain in which the subscription target was created.
projectId:
type: string
description: ???
environmentId:
type: string
description: The ID of the environment in which the subscription target was created.
name:
type: string
description: The name of the subscription target.
type:
type: string
description: The type of the subscription target.
createdBy:
type: string
description: The Amazon DataZone user who created the subscription target.
updatedBy:
type: string
description: The Amazon DataZone user who updated the subscription target.
createdAt:
type: string
format: date-time
description: The timestamp of when the subscription target was created.
updatedAt:
type: string
format: date-time
description: The timestamp of when the subscription target was updated.
manageAccessRole:
type: string
description: The manage access role with which the subscription target was created.
applicableAssetTypes:
type: array
items:
type: string
description: The asset types that can be included in the subscription target.
subscriptionTargetConfig:
type: array
items:
$ref: '#/components/schemas/SubscriptionTargetForm'
description: The configuration of the subscription target.
provider:
type: string
description: The provider of the subscription target.
subscriptionGrantCreationMode:
type: string
enum:
- AUTOMATIC
- MANUAL
description: Determines the subscription grant creation mode for this target, defining if grants are auto-created upon subscription approval or managed manually.
required:
- id
- authorizedPrincipals
- domainId
- projectId
- environmentId
- name
- type
- createdBy
- createdAt
- applicableAssetTypes
- subscriptionTargetConfig
- provider
ResourceNotFoundException:
type: object
properties:
message:
type: string
required:
- message
InternalServerException:
type: object
properties:
message:
type: string
required:
- message
ConflictException:
type: object
properties:
message:
type: string
required:
- message
AccessDeniedException:
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)