ListSubscriptionsCommand

Suggest an Edit

Lists subscriptions in Amazon DataZone.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { DataZoneClient, ListSubscriptionsCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, ListSubscriptionsCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // ListSubscriptionsInput
  domainIdentifier: "STRING_VALUE", // required
  subscriptionRequestIdentifier: "STRING_VALUE",
  status: "APPROVED" || "REVOKED" || "CANCELLED",
  subscribedListingId: "STRING_VALUE",
  owningProjectId: "STRING_VALUE",
  approverProjectId: "STRING_VALUE",
  sortBy: "CREATED_AT" || "UPDATED_AT",
  sortOrder: "ASCENDING" || "DESCENDING",
  maxResults: Number("int"),
  nextToken: "STRING_VALUE",
};
const command = new ListSubscriptionsCommand(input);
const response = await client.send(command);
// { // ListSubscriptionsOutput
//   items: [ // Subscriptions // required
//     { // SubscriptionSummary
//       id: "STRING_VALUE", // required
//       createdBy: "STRING_VALUE", // required
//       updatedBy: "STRING_VALUE",
//       domainId: "STRING_VALUE", // required
//       status: "APPROVED" || "REVOKED" || "CANCELLED", // required
//       createdAt: new Date("TIMESTAMP"), // required
//       updatedAt: new Date("TIMESTAMP"), // required
//       subscribedPrincipal: { // SubscribedPrincipal Union: only one key present
//         project: { // SubscribedProject
//           id: "STRING_VALUE",
//           name: "STRING_VALUE",
//         },
//       },
//       subscribedListing: { // SubscribedListing
//         id: "STRING_VALUE", // required
//         revision: "STRING_VALUE",
//         name: "STRING_VALUE", // required
//         description: "STRING_VALUE", // required
//         item: { // SubscribedListingItem Union: only one key present
//           assetListing: { // SubscribedAssetListing
//             entityId: "STRING_VALUE",
//             entityRevision: "STRING_VALUE",
//             entityType: "STRING_VALUE",
//             forms: "STRING_VALUE",
//             glossaryTerms: [ // DetailedGlossaryTerms
//               { // DetailedGlossaryTerm
//                 name: "STRING_VALUE",
//                 shortDescription: "STRING_VALUE",
//               },
//             ],
//             assetScope: { // AssetScope
//               assetId: "STRING_VALUE", // required
//               filterIds: [ // FilterIds // required
//                 "STRING_VALUE",
//               ],
//               status: "STRING_VALUE", // required
//               errorMessage: "STRING_VALUE",
//             },
//           },
//           productListing: { // SubscribedProductListing
//             entityId: "STRING_VALUE",
//             entityRevision: "STRING_VALUE",
//             glossaryTerms: [
//               {
//                 name: "STRING_VALUE",
//                 shortDescription: "STRING_VALUE",
//               },
//             ],
//             name: "STRING_VALUE",
//             description: "STRING_VALUE",
//             assetListings: [ // AssetInDataProductListingItems
//               { // AssetInDataProductListingItem
//                 entityId: "STRING_VALUE",
//                 entityRevision: "STRING_VALUE",
//                 entityType: "STRING_VALUE",
//               },
//             ],
//           },
//         },
//         ownerProjectId: "STRING_VALUE", // required
//         ownerProjectName: "STRING_VALUE",
//       },
//       subscriptionRequestId: "STRING_VALUE",
//       retainPermissions: true || false,
//     },
//   ],
//   nextToken: "STRING_VALUE",
// };

ListSubscriptionsCommand Input

See ListSubscriptionsCommandInput for more details

Parameter
Type
Description
domainIdentifier
Required
string | undefined

The identifier of the Amazon DataZone domain.

approverProjectId
string | undefined

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

maxResults
number | undefined

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.

nextToken
string | undefined

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.

owningProjectId
string | undefined

The identifier of the owning project.

sortBy
SortKey | undefined

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

sortOrder
SortOrder | undefined

Specifies the sort order for the results of this action.

status
SubscriptionStatus | undefined

The status of the subscriptions that you want to list.

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

subscribedListingId
string | undefined

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

subscriptionRequestIdentifier
string | undefined

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

ListSubscriptionsCommand Output

See ListSubscriptionsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
items
Required
SubscriptionSummary[] | undefined

The results of the ListSubscriptions action.

nextToken
string | undefined

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.

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have sufficient access to perform this action.

InternalServerException
server

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

ResourceNotFoundException
client

The specified resource cannot be found.

ThrottlingException
client

The request was denied due to request throttling.

ValidationException
client

The input fails to satisfy the constraints specified by the Amazon Web Services service.

UnauthorizedException
client

You do not have permission to perform this action.

DataZoneServiceException
Base exception class for all service exceptions from DataZone service.