# ListPolicyTemplates


Returns a paginated list of all policy templates in the specified policy store.

## Request Syntax


```
{
   "maxResults": number,
   "nextToken": "string",
   "policyStoreId": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [policyStoreId](#API_ListPolicyTemplates_RequestSyntax) **   <a name="verifiedpermissions-ListPolicyTemplates-request-policyStoreId"></a>
Specifies the ID of the policy store that contains the policy templates you want to list.  
To specify a policy store, use its ID or alias name. When using an alias name, prefix it with `policy-store-alias/`. For example:  
+ ID: `PSEXAMPLEabcdefg111111` 
+ Alias name: `policy-store-alias/example-policy-store` 
To view aliases, use [ListPolicyStoreAliases](https://docs.amazonaws.cn/verifiedpermissions/latest/apireference/API_ListPolicyStoreAliases.html).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `[a-zA-Z0-9-/_]*`   
Required: Yes

 ** [maxResults](#API_ListPolicyTemplates_RequestSyntax) **   <a name="verifiedpermissions-ListPolicyTemplates-request-maxResults"></a>
Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the `NextToken` response element is returned with a value (not null). Include the specified value as the `NextToken` request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check `NextToken` after every operation to ensure that you receive all of the results.  
If you do not specify this parameter, the operation defaults to 10 policy templates per response. You can specify a maximum of 50 policy templates per response.  
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

 ** [nextToken](#API_ListPolicyTemplates_RequestSyntax) **   <a name="verifiedpermissions-ListPolicyTemplates-request-nextToken"></a>
Specifies that you want to receive the next page of results. Valid only if you received a `NextToken` response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's `NextToken` response to request the next page of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8000.  
Pattern: `[A-Za-z0-9-_=+/\.]*`   
Required: No

## Response Syntax


```
{
   "nextToken": "string",
   "policyTemplates": [ 
      { 
         "createdDate": "string",
         "description": "string",
         "lastUpdatedDate": "string",
         "name": "string",
         "policyStoreId": "string",
         "policyTemplateId": "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.

 ** [policyTemplates](#API_ListPolicyTemplates_ResponseSyntax) **   <a name="verifiedpermissions-ListPolicyTemplates-response-policyTemplates"></a>
The list of the policy templates in the specified policy store.  
Type: Array of [PolicyTemplateItem](API_PolicyTemplateItem.md) objects

 ** [nextToken](#API_ListPolicyTemplates_ResponseSyntax) **   <a name="verifiedpermissions-ListPolicyTemplates-response-nextToken"></a>
If present, this value indicates that more output is available than is included in the current response. Use this value in the `NextToken` request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the `NextToken` response element comes back as `null`. This indicates that this is the last page of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8000.  
Pattern: `[A-Za-z0-9-_=+/\.]*` 

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You don't have sufficient access to perform this action.  
HTTP Status Code: 400

 ** InternalServerException **   
The request failed because of an internal error. Try your request again later  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The request failed because it references a resource that doesn't exist.    
 ** resourceId **   
The unique ID of the resource referenced in the failed request.  
 ** resourceType **   
The resource type of the resource referenced in the failed request.
HTTP Status Code: 400

 ** ThrottlingException **   
The request failed because it exceeded a throttling quota.    
 ** quotaCode **   
The quota code recognized by the Amazon Service Quotas service.  
 ** serviceCode **   
The code for the Amazon Web Services service that owns the quota.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because one or more input parameters don't satisfy their constraint requirements. The output is provided as a list of fields and a reason for each field that isn't valid.  
The possible reasons include the following:  
+  **UnrecognizedEntityType** 

  The policy includes an entity type that isn't found in the schema.
+  **UnrecognizedActionId** 

  The policy includes an action id that isn't found in the schema.
+  **InvalidActionApplication** 

  The policy includes an action that, according to the schema, doesn't support the specified principal and resource.
+  **UnexpectedType** 

  The policy included an operand that isn't a valid type for the specified operation.
+  **IncompatibleTypes** 

  The types of elements included in a `set`, or the types of expressions used in an `if...then...else` clause aren't compatible in this context.
+  **MissingAttribute** 

  The policy attempts to access a record or entity attribute that isn't specified in the schema. Test for the existence of the attribute first before attempting to access its value. For more information, see the [has (presence of attribute test) operator](https://docs.cedarpolicy.com/policies/syntax-operators.html#has-presence-of-attribute-test) in the *Cedar Policy Language Guide*.
+  **UnsafeOptionalAttributeAccess** 

  The policy attempts to access a record or entity attribute that is optional and isn't guaranteed to be present. Test for the existence of the attribute first before attempting to access its value. For more information, see the [has (presence of attribute test) operator](https://docs.cedarpolicy.com/policies/syntax-operators.html#has-presence-of-attribute-test) in the *Cedar Policy Language Guide*.
+  **ImpossiblePolicy** 

  Cedar has determined that a policy condition always evaluates to false. If the policy is always false, it can never apply to any query, and so it can never affect an authorization decision.
+  **WrongNumberArguments** 

  The policy references an extension type with the wrong number of arguments.
+  **FunctionArgumentValidationError** 

  Cedar couldn't parse the argument passed to an extension type. For example, a string that is to be parsed as an IPv4 address can contain only digits and the period character.  
 ** fieldList **   
The list of fields that aren't valid.
HTTP Status Code: 400

## Examples


### Example


The following example retrieves a list of all of the policy templates in the specified policy store.

#### Sample Request


```
POST HTTP/1.1
Host: verifiedpermissions.us-east-1.amazonaws.com
X-Amz-Date: 20230613T200059Z
Accept-Encoding: identity
X-Amz-Target: VerifiedPermissions.ListPolicyTemplates
User-Agent: <UserAgentString>
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=<Headers>, Signature=<Signature>
Content-Length: <PayloadSizeBytes>

{
    "policyStoreId": "PSEXAMPLEabcdefg111111"
}
```

#### Sample Response


```
HTTP/1.1 200 OK
Date: Tue, 13 Jun 2023 20:00:59 GMT
Content-Type: application/x-amz-json-1.0
Content-Length: <PayloadSizeBytes>
vary: origin
vary: access-control-request-method
vary: access-control-request-headers
x-amzn-requestid: a1b2c3d4-e5f6-a1b2-c3d4-EXAMPLE11111
Connection: keep-alive

{
    "policyTemplates": [
        {
            "createdDate": "2023-05-17T18:55:20.888033+00:00",
            "description": "Generic template",
            "lastUpdatedDate": "2023-05-17T18:55:20.888033+00:00",
            "policyStoreId": "PSEXAMPLEabcdefg111111",
            "policyTemplateId": "PTEXAMPLEabcdefg111111"
        },
        {
            "createdDate": "2023-05-17T18:58:48.795411+00:00",
            "description": "Template for research dept",
            "lastUpdatedDate": "2023-05-17T18:58:48.795411+00:00",
            "policyStoreId": "PSEXAMPLEabcdefg111111",
            "policyTemplateId": "PTEXAMPLEabcdefg222222"
        }
    ]
}
```

## See Also


For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/verifiedpermissions-2021-12-01/ListPolicyTemplates) 
+  [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/verifiedpermissions-2021-12-01/ListPolicyTemplates) 
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/verifiedpermissions-2021-12-01/ListPolicyTemplates) 
+  [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/verifiedpermissions-2021-12-01/ListPolicyTemplates) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/verifiedpermissions-2021-12-01/ListPolicyTemplates) 
+  [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/verifiedpermissions-2021-12-01/ListPolicyTemplates) 
+  [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/verifiedpermissions-2021-12-01/ListPolicyTemplates) 
+  [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/verifiedpermissions-2021-12-01/ListPolicyTemplates) 
+  [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/verifiedpermissions-2021-12-01/ListPolicyTemplates) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/verifiedpermissions-2021-12-01/ListPolicyTemplates)