CancelSubscriptionCommand

Suggest an Edit

Cancels the subscription to the specified asset.

Example Syntax

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

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

CancelSubscriptionCommand Input

See CancelSubscriptionCommandInput for more details

Parameter
Type
Description
domainIdentifier
Required
string | undefined

The unique identifier of the Amazon DataZone domain where the subscription request is being cancelled.

identifier
Required
string | undefined

The unique identifier of the subscription that is being cancelled.

CancelSubscriptionCommand Output

See CancelSubscriptionCommandOutput for details

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

The timestamp that specifies when the request to cancel the subscription was created.

createdBy
Required
string | undefined

Specifies the Amazon DataZone user who is cancelling the subscription.

domainId
Required
string | undefined

The unique identifier of the Amazon DataZone domain where the subscription is being cancelled.

id
Required
string | undefined

The identifier of the subscription.

status
Required
SubscriptionStatus | undefined

The status of the request to cancel the subscription.

subscribedListing
Required
SubscribedListing | undefined

The asset to which a subscription is being cancelled.

subscribedPrincipal
Required
SubscribedPrincipal | undefined

The Amazon DataZone user who is made a subscriber to the specified asset by the subscription that is being cancelled.

updatedAt
Required
Date | undefined

The timestamp that specifies when the subscription was cancelled.

retainPermissions
boolean | undefined

Specifies whether the permissions to the asset are retained after the subscription is cancelled.

subscriptionRequestId
string | undefined

The unique ID of the subscripton request for the subscription that is being cancelled.

updatedBy
string | undefined

The Amazon DataZone user that cancelled the subscription.

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.