RejectSubscriptionRequestCommand

Suggest an Edit

Rejects the specified subscription request.

Example Syntax

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

import { DataZoneClient, RejectSubscriptionRequestCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, RejectSubscriptionRequestCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // RejectSubscriptionRequestInput
  domainIdentifier: "STRING_VALUE", // required
  identifier: "STRING_VALUE", // required
  decisionComment: "STRING_VALUE",
};
const command = new RejectSubscriptionRequestCommand(input);
const response = await client.send(command);
// { // RejectSubscriptionRequestOutput
//   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",
//     },
//   ],
// };

RejectSubscriptionRequestCommand Input

See RejectSubscriptionRequestCommandInput for more details

Parameter
Type
Description
domainIdentifier
Required
string | undefined

The identifier of the Amazon DataZone domain in which the subscription request was rejected.

identifier
Required
string | undefined

The identifier of the subscription request that was rejected.

decisionComment
string | undefined

The decision comment of the rejected subscription request.

RejectSubscriptionRequestCommand Output

See RejectSubscriptionRequestCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
createdAt
Required
Date | undefined

The timestamp of when the subscription request was rejected.

createdBy
Required
string | undefined

The timestamp of when the subscription request was rejected.

domainId
Required
string | undefined

The identifier of the Amazon DataZone domain in which the subscription request was rejected.

id
Required
string | undefined

The identifier of the subscription request that was rejected.

requestReason
Required
string | undefined

The reason for the subscription request.

status
Required
SubscriptionRequestStatus | undefined

The status of the subscription request.

subscribedListings
Required
SubscribedListing[] | undefined

The subscribed listings of the subscription request.

subscribedPrincipals
Required
SubscribedPrincipal[] | undefined

The subscribed principals of the subscription request.

updatedAt
Required
Date | undefined

The timestamp of when the subscription request was updated.

decisionComment
string | undefined

The decision comment of the rejected subscription request.

existingSubscriptionId
string | undefined

The ID of the existing subscription.

metadataForms
FormOutput[] | undefined

Metadata forms included in the subscription request.

reviewerId
string | undefined

The identifier of the subscription request reviewer.

updatedBy
string | undefined

The Amazon DataZone user who updated the subscription request.

Throws

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.