Lists policy grants¶

Description¶

Lists policy grants.

Usage¶

datazone_list_policy_grants(domainIdentifier, entityType,
  entityIdentifier, policyType, maxResults, nextToken)

Arguments¶

domainIdentifier

[required] The ID of the domain where you want to list policy grants.
entityType

[required] The type of entity for which you want to list policy grants.
entityIdentifier

[required] The ID of the entity for which you want to list policy grants.
policyType

[required] The type of policy that you want to list.
maxResults

The maximum number of grants to return in a single call to list_policy_grants. 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 list_policy_grants to list the next set of grants.
nextToken

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 list_policy_grants to list the next set of grants.

Value¶

A list with the following syntax:

list(
  grantList = list(
    list(
      principal = list(
        user = list(
          userIdentifier = "string",
          allUsersGrantFilter = list()
        ),
        group = list(
          groupIdentifier = "string"
        ),
        project = list(
          projectDesignation = "OWNER"|"CONTRIBUTOR"|"PROJECT_CATALOG_STEWARD",
          projectIdentifier = "string",
          projectGrantFilter = list(
            domainUnitFilter = list(
              domainUnit = "string",
              includeChildDomainUnits = TRUE|FALSE
            )
          )
        ),
        domainUnit = list(
          domainUnitDesignation = "OWNER",
          domainUnitIdentifier = "string",
          domainUnitGrantFilter = list(
            allDomainUnitsGrantFilter = list()
          )
        )
      ),
      detail = list(
        createDomainUnit = list(
          includeChildDomainUnits = TRUE|FALSE
        ),
        overrideDomainUnitOwners = list(
          includeChildDomainUnits = TRUE|FALSE
        ),
        addToProjectMemberPool = list(
          includeChildDomainUnits = TRUE|FALSE
        ),
        overrideProjectOwners = list(
          includeChildDomainUnits = TRUE|FALSE
        ),
        createGlossary = list(
          includeChildDomainUnits = TRUE|FALSE
        ),
        createFormType = list(
          includeChildDomainUnits = TRUE|FALSE
        ),
        createAssetType = list(
          includeChildDomainUnits = TRUE|FALSE
        ),
        createProject = list(
          includeChildDomainUnits = TRUE|FALSE
        ),
        createEnvironmentProfile = list(
          domainUnitId = "string"
        ),
        delegateCreateEnvironmentProfile = list(),
        createEnvironment = list(),
        createEnvironmentFromBlueprint = list(),
        createProjectFromProjectProfile = list(
          includeChildDomainUnits = TRUE|FALSE,
          projectProfiles = list(
            "string"
          )
        ),
        useAssetType = list(
          domainUnitId = "string"
        )
      ),
      createdAt = as.POSIXct(
        "2015-01-01"
      ),
      createdBy = "string",
      grantId = "string"
    )
  ),
  nextToken = "string"
)

Request syntax¶

svc$list_policy_grants(
  domainIdentifier = "string",
  entityType = "DOMAIN_UNIT"|"ENVIRONMENT_BLUEPRINT_CONFIGURATION"|"ENVIRONMENT_PROFILE"|"ASSET_TYPE",
  entityIdentifier = "string",
  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"|"USE_ASSET_TYPE",
  maxResults = 123,
  nextToken = "string"
)