ListSubscriptionRequestsCommand

Suggest an Edit

Lists Amazon DataZone subscription requests.

Example Syntax

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

import { DataZoneClient, ListSubscriptionRequestsCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, ListSubscriptionRequestsCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // ListSubscriptionRequestsInput
  domainIdentifier: "STRING_VALUE", // required
  status: "PENDING" || "ACCEPTED" || "REJECTED",
  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 ListSubscriptionRequestsCommand(input);
const response = await client.send(command);
// { // ListSubscriptionRequestsOutput
//   items: [ // SubscriptionRequests // required
//     { // SubscriptionRequestSummary
//       id: "STRING_VALUE", // required
//       createdBy: "STRING_VALUE", // required
//       updatedBy: "STRING_VALUE",
//       domainId: "STRING_VALUE", // required
//       status: "PENDING" || "ACCEPTED" || "REJECTED", // required
//       createdAt: new Date("TIMESTAMP"), // required
//       updatedAt: new Date("TIMESTAMP"), // required
//       requestReason: "STRING_VALUE", // required
//       subscribedPrincipals: [ // SubscribedPrincipals // required
//         { // SubscribedPrincipal Union: only one key present
//           project: { // SubscribedProject
//             id: "STRING_VALUE",
//             name: "STRING_VALUE",
//           },
//         },
//       ],
//       subscribedListings: [ // SubscribedListings // required
//         { // 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",
//         },
//       ],
//       reviewerId: "STRING_VALUE",
//       decisionComment: "STRING_VALUE",
//       existingSubscriptionId: "STRING_VALUE",
//       metadataFormsSummary: [ // MetadataFormsSummary
//         { // MetadataFormSummary
//           formName: "STRING_VALUE",
//           typeName: "STRING_VALUE", // required
//           typeRevision: "STRING_VALUE", // required
//         },
//       ],
//     },
//   ],
//   nextToken: "STRING_VALUE",
// };

ListSubscriptionRequestsCommand Input

See ListSubscriptionRequestsCommandInput for more details

Parameter
Type
Description
domainIdentifier
Required
string | undefined

The identifier of the Amazon DataZone domain.

approverProjectId
string | undefined

The identifier of the subscription request approver's project.

maxResults
number | undefined

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

nextToken
string | undefined

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

owningProjectId
string | undefined

The identifier of the project for the subscription requests.

sortBy
SortKey | undefined

Specifies the way to sort the results of this action.

sortOrder
SortOrder | undefined

Specifies the sort order for the results of this action.

status
SubscriptionRequestStatus | undefined

Specifies the status of the subscription requests.

This is not a required parameter, but if not specified, by default, Amazon DataZone returns only PENDING subscription requests.

subscribedListingId
string | undefined

The identifier of the subscribed listing.

ListSubscriptionRequestsCommand Output

See ListSubscriptionRequestsCommandOutput for details

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

The results of the ListSubscriptionRequests action.

nextToken
string | undefined

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

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.