RemovePolicyGrantCommand

Suggest an Edit

Removes a policy grant.

Example Syntax

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

import { DataZoneClient, RemovePolicyGrantCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, RemovePolicyGrantCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // RemovePolicyGrantInput
  domainIdentifier: "STRING_VALUE", // required
  entityType: "DOMAIN_UNIT" || "ENVIRONMENT_BLUEPRINT_CONFIGURATION" || "ENVIRONMENT_PROFILE", // required
  entityIdentifier: "STRING_VALUE", // required
  policyType: "CREATE_DOMAIN_UNIT" || "OVERRIDE_DOMAIN_UNIT_OWNERS" || "ADD_TO_PROJECT_MEMBER_POOL" || "OVERRIDE_PROJECT_OWNERS" || "CREATE_GLOSSARY" || "CREATE_FORM_TYPE" || "CREATE_ASSET_TYPE" || "CREATE_PROJECT" || "CREATE_ENVIRONMENT_PROFILE" || "DELEGATE_CREATE_ENVIRONMENT_PROFILE" || "CREATE_ENVIRONMENT" || "CREATE_ENVIRONMENT_FROM_BLUEPRINT" || "CREATE_PROJECT_FROM_PROJECT_PROFILE", // required
  principal: { // PolicyGrantPrincipal Union: only one key present
    user: { // UserPolicyGrantPrincipal Union: only one key present
      userIdentifier: "STRING_VALUE",
      allUsersGrantFilter: {},
    },
    group: { // GroupPolicyGrantPrincipal Union: only one key present
      groupIdentifier: "STRING_VALUE",
    },
    project: { // ProjectPolicyGrantPrincipal
      projectDesignation: "OWNER" || "CONTRIBUTOR" || "PROJECT_CATALOG_STEWARD", // required
      projectIdentifier: "STRING_VALUE",
      projectGrantFilter: { // ProjectGrantFilter Union: only one key present
        domainUnitFilter: { // DomainUnitFilterForProject
          domainUnit: "STRING_VALUE", // required
          includeChildDomainUnits: true || false,
        },
      },
    },
    domainUnit: { // DomainUnitPolicyGrantPrincipal
      domainUnitDesignation: "OWNER", // required
      domainUnitIdentifier: "STRING_VALUE",
      domainUnitGrantFilter: { // DomainUnitGrantFilter Union: only one key present
        allDomainUnitsGrantFilter: {},
      },
    },
  },
  clientToken: "STRING_VALUE",
};
const command = new RemovePolicyGrantCommand(input);
const response = await client.send(command);
// {};

RemovePolicyGrantCommand Input

See RemovePolicyGrantCommandInput for more details

Parameter
Type
Description
domainIdentifier
Required
string | undefined

The ID of the domain where you want to remove a policy grant.

entityIdentifier
Required
string | undefined

The ID of the entity from which you want to remove a policy grant.

entityType
Required
TargetEntityType | undefined

The type of the entity from which you want to remove a policy grant.

policyType
Required
ManagedPolicyType | undefined

The type of the policy that you want to remove.

principal
Required
PolicyGrantPrincipal | undefined

The principal from which you want to remove a policy grant.

clientToken
string | undefined

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

RemovePolicyGrantCommand Output

See RemovePolicyGrantCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have sufficient access to perform this action.

InternalServerException
server

The request has failed because of an unknown error, exception or failure.

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.