Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-141891,2951.1 MB

Lists subscriptions in Amazon DataZone.

get/v2/domains/{domainIdentifier}/subscriptions

Path parameters

domainIdentifierstring required

The identifier of the Amazon DataZone domain.

Query parameters

subscriptionRequestIdentifierstring

The identifier of the subscription request for the subscriptions that you want to list.

status'APPROVED' | 'REVOKED' | 'CANCELLED'
<p>The status of the subscriptions that you want to list.</p> <note> <p>This is not a required parameter, but if not provided, by default, Amazon DataZone returns only <code>APPROVED</code> subscriptions. </p> </note>
subscribedListingIdstring

The identifier of the subscribed listing for the subscriptions that you want to list.

owningProjectIdstring

The identifier of the owning project.

owningIamPrincipalArnstring

The ARN of the owning IAM principal.

owningUserIdstring

The ID of the owning user.

owningGroupIdstring

The ID of the owning group.

approverProjectIdstring

The identifier of the project for the subscription's approver.

sortBy'CREATED_AT' | 'UPDATED_AT'

Specifies the way in which the results of this action are to be sorted.

sortOrder'ASCENDING' | 'DESCENDING'

Specifies the sort order for the results of this action.

maxResultsinteger

The maximum number of subscriptions to return in a single call to <code>ListSubscriptions</code>. When the number of subscriptions to be listed is greater than the value of <code>MaxResults</code>, the response contains a <code>NextToken</code> value that you can use in a subsequent call to <code>ListSubscriptions</code> to list the next set of Subscriptions.

nextTokenstring

When the number of subscriptions 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 subscriptions, the response includes a pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code> value in a subsequent call to <code>ListSubscriptions</code> to list the next set of subscriptions.

Response

Success

nextTokenstring

When the number of subscriptions 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 subscriptions, the response includes a pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code> value in a subsequent call to <code>ListSubscriptions</code> to list the next set of subscriptions.