Amazon DataZone Datazone Subscription Requests API
The Datazone Subscription Requests API from Amazon DataZone — 2 operation(s) for datazone subscription requests.
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-requests-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 Requests 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 Requests
paths:
/v2/domains/{domainIdentifier}/subscription-requests/{identifier}:
delete:
operationId: DeleteSubscriptionRequest
summary: Delete Subscription Request
description: Deletes a subscription request 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/DeleteSubscriptionRequestInput'
tags:
- Subscription Requests
get:
operationId: GetSubscriptionRequestDetails
summary: Get Subscription Request Details
description: Gets the details of the specified subscription request.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetSubscriptionRequestDetailsOutput'
'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/GetSubscriptionRequestDetailsInput'
tags:
- Subscription Requests
patch:
operationId: UpdateSubscriptionRequest
summary: Update Subscription Request
description: Updates a specified subscription request in Amazon DataZone.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateSubscriptionRequestOutput'
'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/UpdateSubscriptionRequestInput'
tags:
- Subscription Requests
components:
schemas:
ValidationException:
type: object
properties:
message:
type: string
required:
- message
SubscribedIamPrincipal:
type: object
properties:
principalArn:
type: string
description: The ARN of the subscribed IAM principal.
UpdateSubscriptionRequestInput:
type: object
properties:
domainIdentifier:
type: string
description: The identifier of the Amazon DataZone domain in which a subscription request is to be updated.
identifier:
type: string
description: The identifier of the subscription request that is to be updated.
requestReason:
type: string
description: The reason for the UpdateSubscriptionRequest action.
required:
- domainIdentifier
- identifier
- requestReason
DeleteSubscriptionRequestInput:
type: object
properties:
domainIdentifier:
type: string
description: The ID of the Amazon DataZone domain in which the subscription request is deleted.
identifier:
type: string
description: The ID of the subscription request that is deleted.
required:
- domainIdentifier
- identifier
SubscribedProductListing:
type: object
properties:
entityId:
type: string
description: The ID of the data product listing.
entityRevision:
type: string
description: The revision of the data product listing.
glossaryTerms:
type: array
items:
$ref: '#/components/schemas/DetailedGlossaryTerm'
description: The glossary terms of the data product listing.
name:
type: string
description: The name of the data product listing.
description:
type: string
description: The description of the data product listing.
assetListings:
type: array
items:
$ref: '#/components/schemas/AssetInDataProductListingItem'
description: The data assets of the data product listing.
UpdateSubscriptionRequestOutput:
type: object
properties:
id:
type: string
description: The identifier of the subscription request that is to be updated.
createdBy:
type: string
description: The Amazon DataZone user who created the subscription request.
updatedBy:
type: string
description: The Amazon DataZone user who updated the subscription request.
domainId:
type: string
description: The identifier of the Amazon DataZone domain in which a subscription request is to be updated.
status:
type: string
enum:
- PENDING
- ACCEPTED
- REJECTED
description: The status of the subscription request.
createdAt:
type: string
format: date-time
description: The timestamp of when the subscription request was created.
updatedAt:
type: string
format: date-time
description: The timestamp of when the subscription request was updated.
requestReason:
type: string
description: The reason for the UpdateSubscriptionRequest action.
subscribedPrincipals:
type: array
items:
$ref: '#/components/schemas/SubscribedPrincipal'
description: The subscribed principals of the subscription request.
subscribedListings:
type: array
items:
$ref: '#/components/schemas/SubscribedListing'
description: The subscribed listings of the subscription request.
reviewerId:
type: string
description: The identifier of the Amazon DataZone user who reviews the subscription request.
decisionComment:
type: string
description: The decision comment of the UpdateSubscriptionRequest action.
existingSubscriptionId:
type: string
description: The ID of the existing subscription.
metadataForms:
type: array
items:
$ref: '#/components/schemas/FormOutput'
description: Metadata forms included in the subscription request.
required:
- id
- createdBy
- domainId
- status
- createdAt
- updatedAt
- requestReason
- subscribedPrincipals
- subscribedListings
DetailedGlossaryTerm:
type: object
properties:
name:
type: string
description: The name of a glossary term attached to the inventory asset.
shortDescription:
type: string
description: The shoft description of a glossary term attached to the inventory asset.
SubscribedGroup:
type: object
properties:
id:
type: string
description: The ID of the subscribed group.
name:
type: string
description: The name of the subscribed group.
AssetScope:
type: object
properties:
assetId:
type: string
description: The asset ID of the asset scope.
filterIds:
type: array
items:
type: string
description: The filter IDs of the asset scope.
status:
type: string
description: The status of the asset scope.
scopeName:
type: string
description: The name of the materialized asset scope.
errorMessage:
type: string
description: The error message of the asset scope.
required:
- assetId
- filterIds
- status
UnauthorizedException:
type: object
properties:
message:
type: string
required:
- message
ThrottlingException:
type: object
properties:
message:
type: string
required:
- message
SubscribedUser:
type: object
properties:
id:
type: string
description: The ID of the subscribed user.
details:
$ref: '#/components/schemas/UserProfileDetails'
UserProfileDetails:
type: object
properties:
iam:
$ref: '#/components/schemas/IamUserProfileDetails'
sso:
$ref: '#/components/schemas/SsoUserProfileDetails'
description: Exactly one member is set.
IamUserProfileDetails:
type: object
properties:
arn:
type: string
description: The ARN of the IAM user.
principalId:
type: string
description: The principal ID as part of the IAM user profile details.
sessionName:
type: string
description: The session name for IAM role sessions.
groupProfileId:
type: string
description: The identifier of the group profile associated with the IAM user profile. This links the user to a specific group profile within the Amazon DataZone domain.
Permissions:
type: object
properties:
s3:
type: array
items:
type: string
enum:
- READ
- WRITE
description: The S3 details of the asset permissions.
description: Exactly one member is set.
SubscribedPrincipal:
type: object
properties:
project:
$ref: '#/components/schemas/SubscribedProject'
user:
$ref: '#/components/schemas/SubscribedUser'
group:
$ref: '#/components/schemas/SubscribedGroup'
iam:
$ref: '#/components/schemas/SubscribedIamPrincipal'
description: Exactly one member is set.
SsoUserProfileDetails:
type: object
properties:
username:
type: string
description: The username as part of the SSO user profile detail.
firstName:
type: string
description: The first name as part of the SSO user profile detail.
lastName:
type: string
description: The last name as part of the SSO user profile detail.
SubscribedListing:
type: object
properties:
id:
type: string
description: The identifier of the published asset for which the subscription grant is created.
revision:
type: string
description: The revision of the published asset for which the subscription grant is created.
name:
type: string
description: The name of the published asset for which the subscription grant is created.
description:
type: string
description: The description of the published asset for which the subscription grant is created.
item:
$ref: '#/components/schemas/SubscribedListingItem'
ownerProjectId:
type: string
description: The identifier of the project of the published asset for which the subscription grant is created.
ownerProjectName:
type: string
description: The name of the project that owns the published asset for which the subscription grant is created.
required:
- id
- name
- description
- item
- ownerProjectId
AccessDeniedException:
type: object
properties:
message:
type: string
required:
- message
GetSubscriptionRequestDetailsOutput:
type: object
properties:
id:
type: string
description: The identifier of the subscription request.
createdBy:
type: string
description: The Amazon DataZone user who created the subscription request.
updatedBy:
type: string
description: The Amazon DataZone user who updated the subscription request.
domainId:
type: string
description: The Amazon DataZone domain of the subscription request.
status:
type: string
enum:
- PENDING
- ACCEPTED
- REJECTED
description: The status of the subscription request.
createdAt:
type: string
format: date-time
description: The timestamp of when the specified subscription request was created.
updatedAt:
type: string
format: date-time
description: The timestamp of when the subscription request was updated.
requestReason:
type: string
description: The reason for the subscription request.
subscribedPrincipals:
type: array
items:
$ref: '#/components/schemas/SubscribedPrincipal'
description: The subscribed principals in the subscription request.
subscribedListings:
type: array
items:
$ref: '#/components/schemas/SubscribedListing'
description: The subscribed listings in the subscription request.
reviewerId:
type: string
description: The identifier of the Amazon DataZone user who reviewed the subscription request.
decisionComment:
type: string
description: The decision comment of the subscription request.
existingSubscriptionId:
type: string
description: The ID of the existing subscription.
metadataForms:
type: array
items:
$ref: '#/components/schemas/FormOutput'
description: The metadata forms included in the subscription request.
required:
- id
- createdBy
- domainId
- status
- createdAt
- updatedAt
- requestReason
- subscribedPrincipals
- subscribedListings
FormOutput:
type: object
properties:
formName:
type: string
description: The name of the metadata form.
typeName:
type: string
description: The name of the metadata form type.
typeRevision:
type: string
description: The revision of the metadata form type.
content:
type: string
description: The content of the metadata form.
required:
- formName
SubscribedListingItem:
type: object
properties:
assetListing:
$ref: '#/components/schemas/SubscribedAssetListing'
productListing:
$ref: '#/components/schemas/SubscribedProductListing'
description: Exactly one member is set.
SubscribedAssetListing:
type: object
properties:
entityId:
type: string
description: The identifier of the published asset for which the subscription grant is created.
entityRevision:
type: string
description: The revision of the published asset for which the subscription grant is created.
entityType:
type: string
description: The type of the published asset for which the subscription grant is created.
forms:
type: string
description: The forms attached to the published asset for which the subscription grant is created.
glossaryTerms:
type: array
items:
$ref: '#/components/schemas/DetailedGlossaryTerm'
description: The glossary terms attached to the published asset for which the subscription grant is created.
assetScope:
$ref: '#/components/schemas/AssetScope'
permissions:
$ref: '#/components/schemas/Permissions'
GetSubscriptionRequestDetailsInput:
type: object
properties:
domainIdentifier:
type: string
description: The identifier of the Amazon DataZone domain in which to get the subscription request details.
identifier:
type: string
description: The identifier of the subscription request the details of which to get.
required:
- domainIdentifier
- identifier
InternalServerException:
type: object
properties:
message:
type: string
required:
- message
AssetInDataProductListingItem:
type: object
properties:
entityId:
type: string
description: The entity ID of the listing of the asset in a data product.
entityRevision:
type: string
description: The entity revision of the listing of the asset in a data product.
entityType:
type: string
description: The entity type of the listing of the asset in a data product.
ResourceNotFoundException:
type: object
properties:
message:
type: string
required:
- message
SubscribedProject:
type: object
properties:
id:
type: string
description: The identifier of the project that has the subscription grant.
name:
type: string
description: The name of the project that has the subscription grant.
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)