Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListSubscriptions

Lists subscriptions in Amazon DataZone.

Request Syntax


GET /v2/domains/domainIdentifier/subscriptions?approverProjectId=approverProjectId&maxResults=maxResults&nextToken=nextToken&owningProjectId=owningProjectId&sortBy=sortBy&sortOrder=sortOrder&status=status&subscribedListingId=subscribedListingId&subscriptionRequestIdentifier=subscriptionRequestIdentifier HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

approverProjectId

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

Pattern: ^[a-zA-Z0-9_-]{1,36}$

domainIdentifier

The identifier of the Amazon DataZone domain.

Pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$

Required: Yes

maxResults

The maximum number of subscriptions to return in a single call to ListSubscriptions. When the number of subscriptions 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 ListSubscriptions to list the next set of Subscriptions.

Valid Range: Minimum value of 1. Maximum value of 50.

nextToken

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

Length Constraints: Minimum length of 1. Maximum length of 8192.

owningProjectId

The identifier of the owning project.

Pattern: ^[a-zA-Z0-9_-]{1,36}$

sortBy

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

Valid Values: CREATED_AT | UPDATED_AT

sortOrder

Specifies the sort order for the results of this action.

Valid Values: ASCENDING | DESCENDING

status

The status of the subscriptions that you want to list.

Note

This is not a required parameter, but if not provided, by default, Amazon DataZone returns only APPROVED subscriptions.

Valid Values: APPROVED | REVOKED | CANCELLED

subscribedListingId

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

Pattern: ^[a-zA-Z0-9_-]{1,36}$

subscriptionRequestIdentifier

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

Pattern: ^[a-zA-Z0-9_-]{1,36}$

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "items": [ 
      { 
         "createdAt": number,
         "createdBy": "string",
         "domainId": "string",
         "id": "string",
         "retainPermissions": boolean,
         "status": "string",
         "subscribedListing": { 
            "description": "string",
            "id": "string",
            "item": { ... },
            "name": "string",
            "ownerProjectId": "string",
            "ownerProjectName": "string",
            "revision": "string"
         },
         "subscribedPrincipal": { ... },
         "subscriptionRequestId": "string",
         "updatedAt": number,
         "updatedBy": "string"
      }
   ],
   "nextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

items

The results of the ListSubscriptions action.

Type: Array of SubscriptionSummary objects

nextToken

Type: String

Length Constraints: Minimum length of 1. Maximum length of 8192.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

The request has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource cannot be found.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

UnauthorizedException

You do not have permission to perform this action.

HTTP Status Code: 401

ValidationException

The input fails to satisfy the constraints specified by the AWS service.

HTTP Status Code: 400