Amazon DataZone Datazone Subscription Grants API
The Datazone Subscription Grants API from Amazon DataZone — 2 operation(s) for datazone subscription grants.
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-grants-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 Grants API
version: '2018-05-10'
description: Generated from AWS's published Smithy model for Amazon DataZone. 4 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 Grants
paths:
/v2/domains/{domainIdentifier}/subscription-grants:
post:
operationId: CreateSubscriptionGrant
summary: Create Subscription Grant
description: Creates a subsscription grant in Amazon DataZone.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateSubscriptionGrantOutput'
'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/CreateSubscriptionGrantInput'
tags:
- Subscription Grants
get:
operationId: ListSubscriptionGrants
summary: List Subscription Grants
description: Lists subscription grants.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListSubscriptionGrantsOutput'
'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/ListSubscriptionGrantsInput'
tags:
- Subscription Grants
/v2/domains/{domainIdentifier}/subscription-grants/{identifier}:
delete:
operationId: DeleteSubscriptionGrant
summary: Delete Subscription Grant
description: Deletes and subscription grant in Amazon DataZone.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteSubscriptionGrantOutput'
'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/DeleteSubscriptionGrantInput'
tags:
- Subscription Grants
get:
operationId: GetSubscriptionGrant
summary: Get Subscription Grant
description: Gets the subscription grant in Amazon DataZone.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetSubscriptionGrantOutput'
'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/GetSubscriptionGrantInput'
tags:
- Subscription Grants
components:
schemas:
ValidationException:
type: object
properties:
message:
type: string
required:
- message
DeleteSubscriptionGrantInput:
type: object
properties:
domainIdentifier:
type: string
description: The ID of the Amazon DataZone domain where the subscription grant is deleted.
identifier:
type: string
description: The ID of the subscription grant that is deleted.
required:
- domainIdentifier
- identifier
SubscriptionGrantSummary:
type: object
properties:
id:
type: string
description: The identifier of the subscription grant.
createdBy:
type: string
description: The datazone user who created the subscription grant.
updatedBy:
type: string
description: The Amazon DataZone user who updated the subscription grant.
domainId:
type: string
description: The identifier of the Amazon DataZone domain in which a subscription grant exists.
createdAt:
type: string
format: date-time
description: The timestamp of when a subscription grant was created.
updatedAt:
type: string
format: date-time
description: The timestamp of when the subscription grant was updated.
environmentId:
type: string
description: The environment ID of the subscription grant.
subscriptionTargetId:
type: string
description: The identifier of the target of the subscription grant.
grantedEntity:
$ref: '#/components/schemas/GrantedEntity'
status:
type: string
enum:
- PENDING
- IN_PROGRESS
- GRANT_FAILED
- REVOKE_FAILED
- GRANT_AND_REVOKE_FAILED
- COMPLETED
- INACCESSIBLE
description: The status of the subscription grant.
assets:
type: array
items:
$ref: '#/components/schemas/SubscribedAsset'
description: The assets included in the subscription grant.
subscriptionId:
type: string
description: The ID of the subscription.
required:
- id
- createdBy
- domainId
- createdAt
- updatedAt
- subscriptionTargetId
- grantedEntity
- status
GetSubscriptionGrantOutput:
type: object
properties:
id:
type: string
description: The ID of the subscription grant.
createdBy:
type: string
description: The Amazon DataZone user who created the subscription grant.
updatedBy:
type: string
description: The Amazon DataZone user who updated the subscription grant.
domainId:
type: string
description: The ID of the Amazon DataZone domain in which the subscription grant exists.
createdAt:
type: string
format: date-time
description: The timestamp of when the subscription grant is created.
updatedAt:
type: string
format: date-time
description: The timestamp of when the subscription grant was upated.
environmentId:
type: string
description: The environment ID of the subscription grant.
subscriptionTargetId:
type: string
description: The subscription target ID associated with the subscription grant.
grantedEntity:
$ref: '#/components/schemas/GrantedEntity'
status:
type: string
enum:
- PENDING
- IN_PROGRESS
- GRANT_FAILED
- REVOKE_FAILED
- GRANT_AND_REVOKE_FAILED
- COMPLETED
- INACCESSIBLE
description: The status of the subscription grant.
assets:
type: array
items:
$ref: '#/components/schemas/SubscribedAsset'
description: The assets for which the subscription grant is created.
subscriptionId:
type: string
description: The identifier of the subscription.
required:
- id
- createdBy
- domainId
- createdAt
- updatedAt
- subscriptionTargetId
- grantedEntity
- status
GrantedEntityInput:
type: object
properties:
listing:
$ref: '#/components/schemas/ListingRevisionInput'
description: Exactly one member is set.
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
ListingRevisionInput:
type: object
properties:
identifier:
type: string
description: An identifier of revision to be made to an asset published in a Amazon DataZone catalog.
revision:
type: string
description: The details of a revision to be made to an asset published in a Amazon DataZone catalog.
required:
- identifier
- revision
ListSubscriptionGrantsOutput:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/SubscriptionGrantSummary'
description: The results of the ListSubscriptionGrants action.
nextToken:
type: string
description: When the number of subscription grants 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 grants, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListSubscriptionGrants to list the next set of subscription grants.
required:
- items
ThrottlingException:
type: object
properties:
message:
type: string
required:
- message
CreateSubscriptionGrantOutput:
type: object
properties:
id:
type: string
description: The ID of the subscription grant.
createdBy:
type: string
description: The Amazon DataZone user who created the subscription grant.
updatedBy:
type: string
description: The Amazon DataZone user who updated the subscription grant.
domainId:
type: string
description: The ID of the Amazon DataZone domain in which the subscription grant is created.
createdAt:
type: string
format: date-time
description: A timestamp of when the subscription grant is created.
updatedAt:
type: string
format: date-time
description: A timestamp of when the subscription grant was updated.
environmentId:
type: string
description: The environment ID for which subscription grant is created.
subscriptionTargetId:
type: string
description: The ID of the subscription target for which the subscription grant is created.
grantedEntity:
$ref: '#/components/schemas/GrantedEntity'
status:
type: string
enum:
- PENDING
- IN_PROGRESS
- GRANT_FAILED
- REVOKE_FAILED
- GRANT_AND_REVOKE_FAILED
- COMPLETED
- INACCESSIBLE
description: The status of the subscription grant.
assets:
type: array
items:
$ref: '#/components/schemas/SubscribedAsset'
description: The assets for which the subscription grant is created.
subscriptionId:
type: string
description: The identifier of the subscription grant.
required:
- id
- createdBy
- domainId
- createdAt
- updatedAt
- subscriptionTargetId
- grantedEntity
- status
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.
CreateSubscriptionGrantInput:
type: object
properties:
domainIdentifier:
type: string
description: The ID of the Amazon DataZone domain in which the subscription grant is created.
environmentIdentifier:
type: string
description: The ID of the environment in which the subscription grant is created.
subscriptionTargetIdentifier:
type: string
description: The ID of the subscription target for which the subscription grant is created.
grantedEntity:
$ref: '#/components/schemas/GrantedEntityInput'
assetTargetNames:
type: array
items:
$ref: '#/components/schemas/AssetTargetNameMap'
description: The names of the assets for which the subscription grant is created.
clientToken:
type: string
description: A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.
required:
- domainIdentifier
- environmentIdentifier
- grantedEntity
DeleteSubscriptionGrantOutput:
type: object
properties:
id:
type: string
description: The ID of the subscription grant that is deleted.
createdBy:
type: string
description: The Amazon DataZone user who created the subscription grant that is deleted.
updatedBy:
type: string
description: The Amazon DataZone user who updated the subscription grant that is deleted.
domainId:
type: string
description: The ID of the Amazon DataZone domain in which the subscription grant is deleted.
createdAt:
type: string
format: date-time
description: The timestamp of when the subscription grant that is deleted was created.
updatedAt:
type: string
format: date-time
description: The timestamp of when the subscription grant that is deleted was updated.
environmentId:
type: string
description: The ID of the environment in which the subscription grant is deleted.
subscriptionTargetId:
type: string
description: The ID of the subscription target associated with the subscription grant that is deleted.
grantedEntity:
$ref: '#/components/schemas/GrantedEntity'
status:
type: string
enum:
- PENDING
- IN_PROGRESS
- GRANT_FAILED
- REVOKE_FAILED
- GRANT_AND_REVOKE_FAILED
- COMPLETED
- INACCESSIBLE
description: The status of the subscription grant that is deleted.
assets:
type: array
items:
$ref: '#/components/schemas/SubscribedAsset'
description: The assets for which the subsctiption grant that is deleted gave access.
subscriptionId:
type: string
description: The identifier of the subsctiption whose subscription grant is to be deleted.
required:
- id
- createdBy
- domainId
- createdAt
- updatedAt
- subscriptionTargetId
- grantedEntity
- status
SubscribedAsset:
type: object
properties:
assetId:
type: string
description: The identifier of the asset for which the subscription grant is created.
assetRevision:
type: string
description: The revision of the asset for which the subscription grant is created.
status:
type: string
enum:
- GRANT_PENDING
- REVOKE_PENDING
- GRANT_IN_PROGRESS
- REVOKE_IN_PROGRESS
- GRANTED
- REVOKED
- GRANT_FAILED
- REVOKE_FAILED
description: The status of the asset for which the subscription grant is created.
targetName:
type: string
description: The target name of the asset for which the subscription grant is created.
failureCause:
$ref: '#/components/schemas/FailureCause'
grantedTimestamp:
type: string
description: The timestamp of when the subscription grant to the asset is created.
failureTimestamp:
type: string
description: The failure timestamp included in the details of the asset for which the subscription grant is created.
assetScope:
$ref: '#/components/schemas/AssetScope'
permissions:
$ref: '#/components/schemas/Permissions'
required:
- assetId
- assetRevision
- status
ListingRevision:
type: object
properties:
id:
type: string
description: An identifier of a revision of an asset published in a Amazon DataZone catalog.
revision:
type: string
description: The details of a revision of an asset published in a Amazon DataZone catalog.
required:
- id
- revision
FailureCause:
type: object
properties:
message:
type: string
description: The description of the error message.
AssetTargetNameMap:
type: object
properties:
assetId:
type: string
description: The identifier of the inventory asset.
targetName:
type: string
description: The target name in the asset target name map.
required:
- assetId
- targetName
AccessDeniedException:
type: object
properties:
message:
type: string
required:
- message
ListSubscriptionGrantsInput:
type: object
properties:
domainIdentifier:
type: string
description: The identifier of the Amazon DataZone domain.
environmentId:
type: string
description: The identifier of the Amazon DataZone environment.
subscriptionTargetId:
type: string
description: The identifier of the subscription target.
subscribedListingId:
type: string
description: The identifier of the subscribed listing.
subscriptionId:
type: string
description: The identifier of the subscription.
owningProjectId:
type: string
description: The ID of the owning project of the subscription grants.
owningIamPrincipalArn:
type: string
description: The ARN of the owning IAM principal.
owningUserId:
type: string
description: The ID of the owning user.
owningGroupId:
type: string
description: The ID of the owning group.
sortBy:
type: string
enum:
- CREATED_AT
- UPDATED_AT
description: Specifies the way of sorting the results of this action.
sortOrder:
type: string
enum:
- ASCENDING
- DESCENDING
description: Specifies the sort order of this action.
maxResults:
type: integer
description: The maximum number of subscription grants to return in a single call to ListSubscriptionGrants. When the number of subscription grants 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 ListSubscriptionGrants to list the next set of subscription grants.
nextToken:
type: string
description: When the number of subscription grants 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 grants, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListSubscriptionGrants to list the next set of subscription grants.
required:
- domainIdentifier
InternalServerException:
type: object
properties:
message:
type: string
required:
- message
ResourceNotFoundException:
type: object
properties:
message:
type: string
required:
- message
ConflictException:
type: object
properties:
message:
type: string
required:
- message
GrantedEntity:
type: object
properties:
listing:
$ref: '#/components/schemas/ListingRevision'
description: Exactly one member is set.
GetSubscriptionGrantInput:
type: object
properties:
domainIdentifier:
type: string
description: The ID of the Amazon DataZone domain in which the subscription grant exists.
identifier:
type: string
description: The ID of the subscription grant.
required:
- domainIdentifier
- identifier
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)