Amazon DataZone Subscriptions API

openapi: 3.2.0
info:
  title: Amazon Datazone Subscriptions API
  version: '1.0'
  description: 'Operations tagged Subscriptions across 2 of this provider''s published API definitions: amazon-datazone-openapi.yml, amazon-datazone-subscriptions-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://datazone.amazonaws.com
  description: Amazon DataZone API
- url: https://datazone.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
tags:
- name: Subscriptions
  description: Operations for managing data subscriptions
paths:
  /v2/domains/{domainIdentifier}/subscriptions:
    get:
      operationId: listSubscriptions
      summary: List Subscriptions
      description: Lists subscriptions in a DataZone domain.
      tags:
      - Subscriptions
      parameters:
      - name: domainIdentifier
        in: path
        required: true
        schema:
          type: string
      - name: status
        in: query
        schema:
          type: string
          enum:
          - APPROVED
          - CANCELLED
          - REVOKED
      - name: maxResults
        in: query
        schema:
          type: integer
      - name: nextToken
        in: query
        schema:
          type: string
      responses:
        '200':
          description: List of subscriptions returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListSubscriptionsResponse'
              examples:
                default:
                  x-microcks-default: true
                  value:
                    items:
                    - id: sub_001abc
                      domainId: dzd_1234567890abcde
                      status: APPROVED
                      createdAt: '2024-03-01T10:00:00Z'
      security:
      - awsSignatureV4: []
    servers:
    - url: https://datazone.amazonaws.com
      description: Amazon DataZone API
  /v2/domains/{domainIdentifier}/subscription-requests:
    get:
      operationId: listSubscriptionRequests
      summary: List Subscription Requests
      description: Lists subscription requests in a DataZone domain.
      tags:
      - Subscriptions
      parameters:
      - name: domainIdentifier
        in: path
        required: true
        schema:
          type: string
      - name: status
        in: query
        schema:
          type: string
          enum:
          - PENDING
          - ACCEPTED
          - REJECTED
      - name: maxResults
        in: query
        schema:
          type: integer
      responses:
        '200':
          description: List of subscription requests returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListSubscriptionRequestsResponse'
              examples:
                default:
                  x-microcks-default: true
                  value:
                    items:
                    - id: subreq_001
                      domainId: dzd_1234567890abcde
                      status: PENDING
                      requestReason: Need access for Q2 analytics
                      createdAt: '2024-04-10T09:00:00Z'
      security:
      - awsSignatureV4: []
    post:
      operationId: createSubscriptionRequest
      summary: Create Subscription Request
      description: Creates a request to subscribe to a data asset listing.
      tags:
      - Subscriptions
      parameters:
      - name: domainIdentifier
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSubscriptionRequestRequest'
            examples:
              default:
                x-microcks-default: true
                value:
                  requestReason: Need access to sales data for Q2 analytics project
                  subscribedListings:
                  - identifier: listing_001abc
                  subscribedPrincipals:
                  - project:
                      identifier: prj_abc123
      responses:
        '201':
          description: Subscription request created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionRequest'
              examples:
                default:
                  x-microcks-default: true
                  value:
                    id: subreq_002
                    domainId: dzd_1234567890abcde
                    status: PENDING
                    requestReason: Need access for Q2 analytics
                    createdAt: '2024-04-15T13:00:00Z'
      security:
      - awsSignatureV4: []
    servers:
    - url: https://datazone.amazonaws.com
      description: Amazon DataZone API
  /v2/domains/{domainIdentifier}/subscriptions/{identifier}:
    get:
      operationId: GetSubscription
      summary: Get Subscription
      description: Gets a subscription in Amazon DataZone.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSubscriptionOutput'
        '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/GetSubscriptionInput'
      tags:
      - Subscriptions
      security:
      - sigv4: []
    servers:
    - url: https://datazone.{region}.amazonaws.com
      variables:
        region:
          default: us-east-1
components:
  schemas:
    ListSubscriptionRequestsResponse:
      description: Response containing a list of subscription requests.
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/SubscriptionRequest'
        nextToken:
          type: string
    SubscriptionRequest:
      description: A request to subscribe to a data asset listing in DataZone.
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the subscription request
        domainId:
          type: string
        status:
          type: string
          enum:
          - PENDING
          - ACCEPTED
          - REJECTED
        requestReason:
          type: string
          description: The reason for the subscription request
        createdAt:
          type: string
          format: date-time
    ListSubscriptionsResponse:
      description: Response containing a list of subscriptions.
      type: object
      properties:
        items:
          type: array
          items:
            type: object
        nextToken:
          type: string
    CreateSubscriptionRequestRequest:
      description: Request body for creating a subscription request.
      type: object
      required:
      - requestReason
      - subscribedListings
      - subscribedPrincipals
      properties:
        requestReason:
          type: string
        subscribedListings:
          type: array
          items:
            type: object
        subscribedPrincipals:
          type: array
          items:
            type: object
    ValidationException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    SubscribedIamPrincipal:
      type: object
      properties:
        principalArn:
          type: string
          description: The ARN of the subscribed IAM principal.
    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.
    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.
    GetSubscriptionInput:
      type: object
      properties:
        domainIdentifier:
          type: string
          description: The ID of the Amazon DataZone domain in which the subscription exists.
        identifier:
          type: string
          description: The ID of the subscription.
      required:
      - domainIdentifier
      - identifier
    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
    GetSubscriptionOutput:
      type: object
      properties:
        id:
          type: string
          description: The ID of the subscription.
        createdBy:
          type: string
          description: The Amazon DataZone user who created the subscription.
        updatedBy:
          type: string
          description: The Amazon DataZone user who updated the subscription.
        domainId:
          type: string
          description: The ID of the Amazon DataZone domain in which the subscription exists.
        status:
          type: string
          enum:
          - APPROVED
          - REVOKED
          - CANCELLED
          description: The status of the subscription.
        createdAt:
          type: string
          format: date-time
          description: The timestamp of when the subscription was created.
        updatedAt:
          type: string
          format: date-time
          description: The timestamp of when the subscription was updated.
        subscribedPrincipal:
          $ref: '#/components/schemas/SubscribedPrincipal'
        subscribedListing:
          $ref: '#/components/schemas/SubscribedListing'
        subscriptionRequestId:
          type: string
          description: The ID of the subscription request.
        retainPermissions:
          type: boolean
          description: The retain permissions of the subscription.
      required:
      - id
      - createdBy
      - domainId
      - status
      - createdAt
      - updatedAt
      - subscribedPrincipal
      - subscribedListing
    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'
    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.
  securitySchemes:
    awsSignatureV4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4 authentication
    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-refined-from:
- amazon-datazone-openapi.yml
- amazon-datazone-subscriptions-api-openapi.yml