- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
AcceptSubscriptionRequestCommand
Accepts a subscription request to a specific asset.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { DataZoneClient, AcceptSubscriptionRequestCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, AcceptSubscriptionRequestCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // AcceptSubscriptionRequestInput
domainIdentifier: "STRING_VALUE", // required
identifier: "STRING_VALUE", // required
decisionComment: "STRING_VALUE",
assetScopes: [ // AcceptedAssetScopes
{ // AcceptedAssetScope
assetId: "STRING_VALUE", // required
filterIds: [ // FilterIds // required
"STRING_VALUE",
],
},
],
};
const command = new AcceptSubscriptionRequestCommand(input);
const response = await client.send(command);
// { // AcceptSubscriptionRequestOutput
// 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",
// metadataForms: [ // MetadataForms
// { // FormOutput
// formName: "STRING_VALUE", // required
// typeName: "STRING_VALUE",
// typeRevision: "STRING_VALUE",
// content: "STRING_VALUE",
// },
// ],
// };
AcceptSubscriptionRequestCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
domainIdentifier Required | string | undefined | The Amazon DataZone domain where the specified subscription request is being accepted. |
identifier Required | string | undefined | The unique identifier of the subscription request that is to be accepted. |
assetScopes | AcceptedAssetScope[] | undefined | The asset scopes of the accept subscription request. |
decisionComment | string | undefined | A description that specifies the reason for accepting the specified subscription request. |
AcceptSubscriptionRequestCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
createdAt Required | Date | undefined | The timestamp that specifies when the subscription request was accepted. |
createdBy Required | string | undefined | Specifies the Amazon DataZone user that accepted the specified subscription request. |
domainId Required | string | undefined | The unique identifier of the Amazon DataZone domain where the specified subscription request was accepted. |
id Required | string | undefined | The identifier of the subscription request. |
requestReason Required | string | undefined | Specifies the reason for requesting a subscription to the asset. |
status Required | SubscriptionRequestStatus | undefined | Specifies the status of the subscription request. |
subscribedListings Required | SubscribedListing[] | undefined | Specifies the asset for which the subscription request was created. |
subscribedPrincipals Required | SubscribedPrincipal[] | undefined | Specifies the Amazon DataZone users who are subscribed to the asset specified in the subscription request. |
updatedAt Required | Date | undefined | Specifies the timestamp when subscription request was updated. |
decisionComment | string | undefined | Specifies the reason for accepting the subscription request. |
existingSubscriptionId | string | undefined | The ID of the existing subscription. |
metadataForms | FormOutput[] | undefined | The metadata form in the subscription request. |
reviewerId | string | undefined | Specifes the ID of the Amazon DataZone user who reviewed the subscription request. |
updatedBy | string | undefined | Specifies the Amazon DataZone user who updated the subscription request. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
AccessDeniedException | client | You do not have sufficient access to perform this action. |
ConflictException | client | There is a conflict while performing 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. |