---
title: "PUT /v2/domains/{domainIdentifier}/subscriptions/{identifier}/cancel"
method: PUT
path: "/v2/domains/{domainIdentifier}/subscriptions/{identifier}/cancel"
---

# PUT /v2/domains/{domainIdentifier}/subscriptions/{identifier}/cancel

`PUT /v2/domains/{domainIdentifier}/subscriptions/{identifier}/cancel`

Cancels the subscription to the specified asset.

## Path parameters

- `domainIdentifier` string, required
- `identifier` string, required

## Response `200`

Success

- CancelSubscriptionOutput
  - `id` string, required — The identifier of the subscription.
  - `createdBy` string, required — Specifies the Amazon DataZone user who is cancelling the subscription.
  - `updatedBy` string — The Amazon DataZone user that cancelled the subscription.
  - `domainId` string, required — The unique identifier of the Amazon DataZone domain where the subscription is being cancelled.
  - `status` 'APPROVED' | 'REVOKED' | 'CANCELLED', required — The status of the request to cancel the subscription.
  - `createdAt` string, date-time, required — The timestamp that specifies when the request to cancel the subscription was created.
  - `updatedAt` string, date-time, required — The timestamp that specifies when the subscription was cancelled.
  - `subscribedPrincipal` object, required — The Amazon DataZone user who is made a subscriber to the specified asset by the subscription that is being cancelled.
    - `project` object — The project that has the subscription grant.
      - `id` string — The identifier of the project that has the subscription grant.
      - `name` string, password — The name of the project that has the subscription grant.
    - `user` object — The subscribed user.
      - `id` string — The ID of the subscribed user.
      - `details` object — The subscribed user details.
        - `iam` object — The IAM details of the user profile.
          - `arn` string — The ARN of the IAM user.
          - `principalId` string — The principal ID as part of the IAM user profile details.
          - `sessionName` string — The session name for IAM role sessions.
          - `groupProfileId` string — 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.
        - `sso` object — The SSO details of the user profile.
          - `username` string, password — The username as part of the SSO user profile detail.
          - `firstName` string, password — The first name as part of the SSO user profile detail.
          - `lastName` string, password — The last name as part of the SSO user profile detail.
    - `group` object — The subscribed group.
      - `id` string — The ID of the subscribed group.
      - `name` string, password — The name of the subscribed group.
    - `iam` object — The subscribed IAM principal.
      - `principalArn` string — The ARN of the subscribed IAM principal.
  - `subscribedListing` object, required — The asset to which a subscription is being cancelled.
    - `id` string, required — The identifier of the published asset for which the subscription grant is created.
    - `revision` string — The revision of the published asset for which the subscription grant is created.
    - `name` string, required — The name of the published asset for which the subscription grant is created.
    - `description` string, password, required — The description of the published asset for which the subscription grant is created.
    - `item` object, required — The published asset for which the subscription grant is created.
      - `assetListing` object — The asset for which the subscription grant is created.
        - `entityId` string — The identifier of the published asset for which the subscription grant is created.
        - `entityRevision` string — The revision of the published asset for which the subscription grant is created.
        - `entityType` string — The type of the published asset for which the subscription grant is created.
        - `forms` string — The forms attached to the published asset for which the subscription grant is created.
        - `glossaryTerms` DetailedGlossaryTerm[] — The glossary terms attached to the published asset for which the subscription grant is created.
          - `name` string, password — The name of a glossary term attached to the inventory asset.
          - `shortDescription` string, password — The shoft description of a glossary term attached to the inventory asset.
        - `assetScope` object — The asset scope of the subscribed asset listing.
          - `assetId` string, required — The asset ID of the asset scope.
          - `filterIds` FilterId[], required — The filter IDs of the asset scope.
          - `status` string, required — The status of the asset scope.
          - `errorMessage` string — The error message of the asset scope.
        - `permissions` object — The asset permissions.
          - `s3` S3Permission[] — The S3 details of the asset permissions.
      - `productListing` object — The data product listing.
        - `entityId` string — The ID of the data product listing.
        - `entityRevision` string — The revision of the data product listing.
        - `glossaryTerms` DetailedGlossaryTerm[] — The glossary terms of the data product listing.
          - `name` string, password — The name of a glossary term attached to the inventory asset.
          - `shortDescription` string, password — The shoft description of a glossary term attached to the inventory asset.
        - `name` string — The name of the data product listing.
        - `description` string — The description of the data product listing.
        - `assetListings` AssetInDataProductListingItem[] — The data assets of the data product listing.
          - `entityId` string — The entity ID of the listing of the asset in a data product.
          - `entityRevision` string — The entity revision of the listing of the asset in a data product.
          - `entityType` string — The entity type of the listing of the asset in a data product.
    - `ownerProjectId` string, required — The identifier of the project of the published asset for which the subscription grant is created.
    - `ownerProjectName` string — The name of the project that owns the published asset for which the subscription grant is created.
  - `subscriptionRequestId` string — The unique ID of the subscripton request for the subscription that is being cancelled.
  - `retainPermissions` boolean — Specifies whether the permissions to the asset are retained after the subscription is cancelled.

## Other responses

- `480` — InternalServerException
- `481` — ResourceNotFoundException
- `482` — AccessDeniedException
- `483` — ThrottlingException
- `484` — ConflictException
- `485` — ValidationException
- `486` — UnauthorizedException

---

[API](https://skmtc.net/aws/apis/datazone.md) · [All operations](https://skmtc.net/aws/apis/datazone/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/datazone/versions/055599054b53/schema)