ListPolicyGrantsCommand

Suggest an Edit

Lists policy grants.

Example Syntax

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

import { DataZoneClient, ListPolicyGrantsCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, ListPolicyGrantsCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // ListPolicyGrantsInput
  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
  maxResults: Number("int"),
  nextToken: "STRING_VALUE",
};
const command = new ListPolicyGrantsCommand(input);
const response = await client.send(command);
// { // ListPolicyGrantsOutput
//   grantList: [ // PolicyGrantList // required
//     { // PolicyGrantMember
//       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: {},
//           },
//         },
//       },
//       detail: { // PolicyGrantDetail Union: only one key present
//         createDomainUnit: { // CreateDomainUnitPolicyGrantDetail
//           includeChildDomainUnits: true || false,
//         },
//         overrideDomainUnitOwners: { // OverrideDomainUnitOwnersPolicyGrantDetail
//           includeChildDomainUnits: true || false,
//         },
//         addToProjectMemberPool: { // AddToProjectMemberPoolPolicyGrantDetail
//           includeChildDomainUnits: true || false,
//         },
//         overrideProjectOwners: { // OverrideProjectOwnersPolicyGrantDetail
//           includeChildDomainUnits: true || false,
//         },
//         createGlossary: { // CreateGlossaryPolicyGrantDetail
//           includeChildDomainUnits: true || false,
//         },
//         createFormType: { // CreateFormTypePolicyGrantDetail
//           includeChildDomainUnits: true || false,
//         },
//         createAssetType: { // CreateAssetTypePolicyGrantDetail
//           includeChildDomainUnits: true || false,
//         },
//         createProject: { // CreateProjectPolicyGrantDetail
//           includeChildDomainUnits: true || false,
//         },
//         createEnvironmentProfile: { // CreateEnvironmentProfilePolicyGrantDetail
//           domainUnitId: "STRING_VALUE",
//         },
//         delegateCreateEnvironmentProfile: {},
//         createEnvironment: {},
//         createEnvironmentFromBlueprint: {},
//         createProjectFromProjectProfile: { // CreateProjectFromProjectProfilePolicyGrantDetail
//           includeChildDomainUnits: true || false,
//           projectProfiles: [ // ProjectProfileList
//             "STRING_VALUE",
//           ],
//         },
//       },
//       createdAt: new Date("TIMESTAMP"),
//       createdBy: "STRING_VALUE",
//     },
//   ],
//   nextToken: "STRING_VALUE",
// };

ListPolicyGrantsCommand Input

See ListPolicyGrantsCommandInput for more details

Parameter
Type
Description
domainIdentifier
Required
string | undefined

The ID of the domain where you want to list policy grants.

entityIdentifier
Required
string | undefined

The ID of the entity for which you want to list policy grants.

entityType
Required
TargetEntityType | undefined

The type of entity for which you want to list policy grants.

policyType
Required
ManagedPolicyType | undefined

The type of policy that you want to list.

maxResults
number | undefined

The maximum number of grants to return in a single call to ListPolicyGrants. When the number of grants to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListPolicyGrants to list the next set of grants.

nextToken
string | undefined

When the number of grants is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of grants, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListPolicyGrants to list the next set of grants.

ListPolicyGrantsCommand Output

See ListPolicyGrantsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
grantList
Required
PolicyGrantMember[] | undefined

The results of this action - the listed grants.

nextToken
string | undefined

When the number of grants is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of grants, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListPolicyGrants to list the next set of grants.

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.