- 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.
DeleteSubscriptionGrantCommand
Deletes and subscription grant in Amazon DataZone.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { DataZoneClient, DeleteSubscriptionGrantCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, DeleteSubscriptionGrantCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // DeleteSubscriptionGrantInput
domainIdentifier: "STRING_VALUE", // required
identifier: "STRING_VALUE", // required
};
const command = new DeleteSubscriptionGrantCommand(input);
const response = await client.send(command);
// { // DeleteSubscriptionGrantOutput
// id: "STRING_VALUE", // required
// createdBy: "STRING_VALUE", // required
// updatedBy: "STRING_VALUE",
// domainId: "STRING_VALUE", // required
// createdAt: new Date("TIMESTAMP"), // required
// updatedAt: new Date("TIMESTAMP"), // required
// subscriptionTargetId: "STRING_VALUE", // required
// grantedEntity: { // GrantedEntity Union: only one key present
// listing: { // ListingRevision
// id: "STRING_VALUE", // required
// revision: "STRING_VALUE", // required
// },
// },
// status: "PENDING" || "IN_PROGRESS" || "GRANT_FAILED" || "REVOKE_FAILED" || "GRANT_AND_REVOKE_FAILED" || "COMPLETED" || "INACCESSIBLE", // required
// assets: [ // SubscribedAssets
// { // SubscribedAsset
// assetId: "STRING_VALUE", // required
// assetRevision: "STRING_VALUE", // required
// status: "GRANT_PENDING" || "REVOKE_PENDING" || "GRANT_IN_PROGRESS" || "REVOKE_IN_PROGRESS" || "GRANTED" || "REVOKED" || "GRANT_FAILED" || "REVOKE_FAILED", // required
// targetName: "STRING_VALUE",
// failureCause: { // FailureCause
// message: "STRING_VALUE",
// },
// grantedTimestamp: new Date("TIMESTAMP"),
// failureTimestamp: new Date("TIMESTAMP"),
// assetScope: { // AssetScope
// assetId: "STRING_VALUE", // required
// filterIds: [ // FilterIds // required
// "STRING_VALUE",
// ],
// status: "STRING_VALUE", // required
// errorMessage: "STRING_VALUE",
// },
// },
// ],
// subscriptionId: "STRING_VALUE",
// };
DeleteSubscriptionGrantCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
domainIdentifier Required | string | undefined | The ID of the Amazon DataZone domain where the subscription grant is deleted. |
identifier Required | string | undefined | The ID of the subscription grant that is deleted. |
DeleteSubscriptionGrantCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
createdAt Required | Date | undefined | The timestamp of when the subscription grant that is deleted was created. |
createdBy Required | string | undefined | The Amazon DataZone user who created the subscription grant that is deleted. |
domainId Required | string | undefined | The ID of the Amazon DataZone domain in which the subscription grant is deleted. |
grantedEntity Required | GrantedEntity | undefined | The entity to which the subscription is deleted. |
id Required | string | undefined | The ID of the subscription grant that is deleted. |
status Required | SubscriptionGrantOverallStatus | undefined | The status of the subscription grant that is deleted. |
subscriptionTargetId Required | string | undefined | The ID of the subscription target associated with the subscription grant that is deleted. |
updatedAt Required | Date | undefined | The timestamp of when the subscription grant that is deleted was updated. |
assets | SubscribedAsset[] | undefined | The assets for which the subsctiption grant that is deleted gave access. |
subscriptionId | string | undefined | The identifier of the subsctiption whose subscription grant is to be deleted. |
updatedBy | string | undefined | The Amazon DataZone user who updated the subscription grant that is deleted. |
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. |