Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListPolicyGrants

Lists policy grants.

Request Syntax


GET /v2/domains/domainIdentifier/policies/managed/entityType/entityIdentifier/grants?maxResults=maxResults&nextToken=nextToken&policyType=policyType HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

domainIdentifier

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

Pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$

Required: Yes

entityIdentifier

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

Required: Yes

entityType

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

Valid Values: DOMAIN_UNIT | ENVIRONMENT_BLUEPRINT_CONFIGURATION | ENVIRONMENT_PROFILE

Required: Yes

maxResults

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.

Valid Range: Minimum value of 1. Maximum value of 25.

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

Length Constraints: Minimum length of 1. Maximum length of 8192.

policyType

The type of policy that you want to list.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "grantList": [ 
      { 
         "createdAt": number,
         "createdBy": "string",
         "detail": { ... },
         "principal": { ... }
      }
   ],
   "nextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

grantList

The results of this action - the listed grants.

Type: Array of PolicyGrantMember objects

nextToken

Type: String

Length Constraints: Minimum length of 1. Maximum length of 8192.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

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

HTTP Status Code: 500

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

UnauthorizedException

You do not have permission to perform this action.

HTTP Status Code: 401

ValidationException

The input fails to satisfy the constraints specified by the AWS service.

HTTP Status Code: 400