# TestInvokeAuthorizer
<a name="API_TestInvokeAuthorizer"></a>

Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.

## Request Syntax
<a name="API_TestInvokeAuthorizer_RequestSyntax"></a>

```
POST /restapis/restapi_id/authorizers/authorizer_id HTTP/1.1
Content-type: application/json

{
   "additionalContext": { 
      "string" : "string" 
   },
   "body": "string",
   "headers": { 
      "string" : "string" 
   },
   "multiValueHeaders": { 
      "string" : [ "string" ]
   },
   "pathWithQueryString": "string",
   "stageVariables": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_TestInvokeAuthorizer_RequestParameters"></a>

The request uses the following URI parameters.

 ** [authorizer\$1id](#API_TestInvokeAuthorizer_RequestSyntax) **   <a name="apigw-TestInvokeAuthorizer-request-uri-authorizerId"></a>
Specifies a test invoke authorizer request's Authorizer ID.  
Required: Yes

 ** [restapi\$1id](#API_TestInvokeAuthorizer_RequestSyntax) **   <a name="apigw-TestInvokeAuthorizer-request-uri-restApiId"></a>
The string identifier of the associated RestApi.  
Required: Yes

## Request Body
<a name="API_TestInvokeAuthorizer_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [additionalContext](#API_TestInvokeAuthorizer_RequestSyntax) **   <a name="apigw-TestInvokeAuthorizer-request-additionalContext"></a>
A key-value map of additional context variables.  
Type: String to string map  
Required: No

 ** [body](#API_TestInvokeAuthorizer_RequestSyntax) **   <a name="apigw-TestInvokeAuthorizer-request-body"></a>
The simulated request body of an incoming invocation request.  
Type: String  
Required: No

 ** [headers](#API_TestInvokeAuthorizer_RequestSyntax) **   <a name="apigw-TestInvokeAuthorizer-request-headers"></a>
A key-value map of headers to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, should be specified.  
Type: String to string map  
Required: No

 ** [multiValueHeaders](#API_TestInvokeAuthorizer_RequestSyntax) **   <a name="apigw-TestInvokeAuthorizer-request-multiValueHeaders"></a>
The headers as a map from string to list of values to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, may be specified.  
Type: String to array of strings map  
Required: No

 ** [pathWithQueryString](#API_TestInvokeAuthorizer_RequestSyntax) **   <a name="apigw-TestInvokeAuthorizer-request-pathWithQueryString"></a>
The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.  
Type: String  
Required: No

 ** [stageVariables](#API_TestInvokeAuthorizer_RequestSyntax) **   <a name="apigw-TestInvokeAuthorizer-request-stageVariables"></a>
A key-value map of stage variables to simulate an invocation on a deployed Stage.  
Type: String to string map  
Required: No

## Response Syntax
<a name="API_TestInvokeAuthorizer_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "authorization": { 
      "string" : [ "string" ]
   },
   "claims": { 
      "string" : "string" 
   },
   "clientStatus": number,
   "latency": number,
   "log": "string",
   "policy": "string",
   "principalId": "string"
}
```

## Response Elements
<a name="API_TestInvokeAuthorizer_ResponseElements"></a>

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

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

 ** [authorization](#API_TestInvokeAuthorizer_ResponseSyntax) **   <a name="apigw-TestInvokeAuthorizer-response-authorization"></a>
The authorization response.  
Type: String to array of strings map

 ** [claims](#API_TestInvokeAuthorizer_ResponseSyntax) **   <a name="apigw-TestInvokeAuthorizer-response-claims"></a>
The open identity claims, with any supported custom attributes, returned from the Cognito Your User Pool configured for the API.  
Type: String to string map

 ** [clientStatus](#API_TestInvokeAuthorizer_ResponseSyntax) **   <a name="apigw-TestInvokeAuthorizer-response-clientStatus"></a>
The HTTP status code that the client would have received. Value is 0 if the authorizer succeeded.  
Type: Integer

 ** [latency](#API_TestInvokeAuthorizer_ResponseSyntax) **   <a name="apigw-TestInvokeAuthorizer-response-latency"></a>
The execution latency, in ms, of the test authorizer request.  
Type: Long

 ** [log](#API_TestInvokeAuthorizer_ResponseSyntax) **   <a name="apigw-TestInvokeAuthorizer-response-log"></a>
The API Gateway execution log for the test authorizer request.  
Type: String

 ** [policy](#API_TestInvokeAuthorizer_ResponseSyntax) **   <a name="apigw-TestInvokeAuthorizer-response-policy"></a>
The JSON policy document returned by the Authorizer  
Type: String

 ** [principalId](#API_TestInvokeAuthorizer_ResponseSyntax) **   <a name="apigw-TestInvokeAuthorizer-response-principalId"></a>
The principal identity returned by the Authorizer  
Type: String

## Errors
<a name="API_TestInvokeAuthorizer_Errors"></a>

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

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## See Also
<a name="API_TestInvokeAuthorizer_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/TestInvokeAuthorizer) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/TestInvokeAuthorizer) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/TestInvokeAuthorizer) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/TestInvokeAuthorizer) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/TestInvokeAuthorizer) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/TestInvokeAuthorizer) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/TestInvokeAuthorizer) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/TestInvokeAuthorizer) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/TestInvokeAuthorizer) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/TestInvokeAuthorizer)