RevokeSubscriptionCommand

Suggest an Edit

Revokes a specified subscription in Amazon DataZone.

Example Syntax

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

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

RevokeSubscriptionCommand Input

See RevokeSubscriptionCommandInput for more details

Parameter
Type
Description
domainIdentifier
Required
string | undefined

The identifier of the Amazon DataZone domain where you want to revoke a subscription.

identifier
Required
string | undefined

The identifier of the revoked subscription.

retainPermissions
boolean | undefined

Specifies whether permissions are retained when the subscription is revoked.

RevokeSubscriptionCommand Output

See RevokeSubscriptionCommandOutput for details

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

The timestamp of when the subscription was revoked.

createdBy
Required
string | undefined

The identifier of the user who revoked the subscription.

domainId
Required
string | undefined

The identifier of the Amazon DataZone domain where you want to revoke a subscription.

id
Required
string | undefined

The identifier of the revoked subscription.

status
Required
SubscriptionStatus | undefined

The status of the revoked subscription.

subscribedListing
Required
SubscribedListing | undefined

The subscribed listing of the revoked subscription.

subscribedPrincipal
Required
SubscribedPrincipal | undefined

The subscribed principal of the revoked subscription.

updatedAt
Required
Date | undefined

The timestamp of when the subscription was revoked.

retainPermissions
boolean | undefined

Specifies whether permissions are retained when the subscription is revoked.

subscriptionRequestId
string | undefined

The identifier of the subscription request for the revoked subscription.

updatedBy
string | undefined

The Amazon DataZone user who revoked 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.