---
title: "GET /v2/domains/{domainIdentifier}/subscription-grants"
method: GET
path: "/v2/domains/{domainIdentifier}/subscription-grants"
---

# GET /v2/domains/{domainIdentifier}/subscription-grants

`GET /v2/domains/{domainIdentifier}/subscription-grants`

Lists subscription grants.

## Path parameters

- `domainIdentifier` string, required

## Query parameters

- `environmentId` string
- `subscriptionTargetId` string
- `subscribedListingId` string
- `subscriptionId` string
- `owningProjectId` string
- `owningIamPrincipalArn` string
- `owningUserId` string
- `owningGroupId` string
- `sortBy` 'CREATED_AT' | 'UPDATED_AT'
- `sortOrder` 'ASCENDING' | 'DESCENDING'
- `maxResults` integer
- `nextToken` string

## Response `200`

Success

- ListSubscriptionGrantsOutput
  - `items` SubscriptionGrantSummary[], required — The results of the <code>ListSubscriptionGrants</code> action.
    - `id` string, required — The identifier of the subscription grant.
    - `createdBy` string, required — The datazone user who created the subscription grant.
    - `updatedBy` string — The Amazon DataZone user who updated the subscription grant.
    - `domainId` string, required — The identifier of the Amazon DataZone domain in which a subscription grant exists.
    - `createdAt` string, date-time, required — The timestamp of when a subscription grant was created.
    - `updatedAt` string, date-time, required — The timestamp of when the subscription grant was updated.
    - `environmentId` string — The environment ID of the subscription grant.
    - `subscriptionTargetId` string, required — The identifier of the target of the subscription grant.
    - `grantedEntity` object, required — The entity to which the subscription is granted.
      - `listing` object — The listing for which a subscription is granted.
        - `id` string, required — An identifier of a revision of an asset published in a Amazon DataZone catalog.
        - `revision` string, required — The details of a revision of an asset published in a Amazon DataZone catalog.
    - `status` 'PENDING' | 'IN_PROGRESS' | 'GRANT_FAILED' | 'REVOKE_FAILED' | 'GRANT_AND_REVOKE_FAILED' | 'COMPLETED' | 'INACCESSIBLE', required — The status of the subscription grant.
    - `assets` SubscribedAsset[] — The assets included in the subscription grant.
      - `assetId` string, required — The identifier of the asset for which the subscription grant is created.
      - `assetRevision` string, required — The revision of the asset for which the subscription grant is created.
      - `status` 'GRANT_PENDING' | 'REVOKE_PENDING' | 'GRANT_IN_PROGRESS' | 'REVOKE_IN_PROGRESS' | 'GRANTED' | 'REVOKED' | 'GRANT_FAILED' | 'REVOKE_FAILED', required — The status of the asset for which the subscription grant is created.
      - `targetName` string — The target name of the asset for which the subscription grant is created.
      - `failureCause` object — The failure cause included in the details of the asset for which the subscription grant is created.
        - `message` string — The description of the error message.
      - `grantedTimestamp` string, date-time — The timestamp of when the subscription grant to the asset is created.
      - `failureTimestamp` string, date-time — The failure timestamp included in the details of the asset for which the subscription grant is created.
      - `assetScope` object — The asset scope of the subscribed asset.
        - `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.
    - `subscriptionId` string — The ID of the subscription.Multiple subscriptions can exist for a single grant
  - `nextToken` string — When the number of subscription grants is greater than the default value for the <code>MaxResults</code> parameter, or if you explicitly specify a value for <code>MaxResults</code> that is less than the number of subscription grants, the response includes a pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code> value in a subsequent call to <code>ListSubscriptionGrants</code> to list the next set of subscription grants.

## Other responses

- `480` — InternalServerException
- `481` — ResourceNotFoundException
- `482` — AccessDeniedException
- `483` — ThrottlingException
- `484` — ValidationException
- `485` — 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)