ListSubscriptionTargetsCommand

Lists subscription targets in Amazon DataZone.

Example Syntax

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

import { DataZoneClient, ListSubscriptionTargetsCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, ListSubscriptionTargetsCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // ListSubscriptionTargetsInput
  domainIdentifier: "STRING_VALUE", // required
  environmentIdentifier: "STRING_VALUE", // required
  sortBy: "CREATED_AT" || "UPDATED_AT",
  sortOrder: "ASCENDING" || "DESCENDING",
  maxResults: Number("int"),
  nextToken: "STRING_VALUE",
};
const command = new ListSubscriptionTargetsCommand(input);
const response = await client.send(command);
// { // ListSubscriptionTargetsOutput
//   items: [ // SubscriptionTargets // required
//     { // SubscriptionTargetSummary
//       id: "STRING_VALUE", // required
//       authorizedPrincipals: [ // AuthorizedPrincipalIdentifiers // required
//         "STRING_VALUE",
//       ],
//       domainId: "STRING_VALUE", // required
//       projectId: "STRING_VALUE", // required
//       environmentId: "STRING_VALUE", // required
//       name: "STRING_VALUE", // required
//       type: "STRING_VALUE", // required
//       createdBy: "STRING_VALUE", // required
//       updatedBy: "STRING_VALUE",
//       createdAt: new Date("TIMESTAMP"), // required
//       updatedAt: new Date("TIMESTAMP"),
//       manageAccessRole: "STRING_VALUE",
//       applicableAssetTypes: [ // ApplicableAssetTypes // required
//         "STRING_VALUE",
//       ],
//       subscriptionTargetConfig: [ // SubscriptionTargetForms // required
//         { // SubscriptionTargetForm
//           formName: "STRING_VALUE", // required
//           content: "STRING_VALUE", // required
//         },
//       ],
//       provider: "STRING_VALUE", // required
//     },
//   ],
//   nextToken: "STRING_VALUE",
// };

ListSubscriptionTargetsCommand Input

Parameter
Type
Description
domainIdentifier
Required
string | undefined

The identifier of the Amazon DataZone domain where you want to list subscription targets.

environmentIdentifier
Required
string | undefined

The identifier of the environment where you want to list subscription targets.

maxResults
number | undefined

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

nextToken
string | undefined

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

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.

ListSubscriptionTargetsCommand Output

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

The results of the ListSubscriptionTargets action.

nextToken
string | undefined

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

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.