Make a request to simulate the execution of an Authorizer.

See: newTestInvokeAuthorizer smart constructor.

Create a value of TestInvokeAuthorizer with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:pathWithQueryString:TestInvokeAuthorizer', testInvokeAuthorizer_pathWithQueryString - [Optional] The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.

$sel:body:TestInvokeAuthorizer', testInvokeAuthorizer_body - [Optional] The simulated request body of an incoming invocation request.

$sel:additionalContext:TestInvokeAuthorizer', testInvokeAuthorizer_additionalContext - [Optional] A key-value map of additional context variables.

$sel:stageVariables:TestInvokeAuthorizer', testInvokeAuthorizer_stageVariables - A key-value map of stage variables to simulate an invocation on a deployed Stage.

$sel:headers:TestInvokeAuthorizer', testInvokeAuthorizer_headers - [Required] 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.

$sel:multiValueHeaders:TestInvokeAuthorizer', testInvokeAuthorizer_multiValueHeaders - [Optional] 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.

$sel:restApiId:TestInvokeAuthorizer', testInvokeAuthorizer_restApiId - [Required] The string identifier of the associated RestApi.

$sel:authorizerId:TestInvokeAuthorizer', testInvokeAuthorizer_authorizerId - [Required] Specifies a test invoke authorizer request's Authorizer ID.

Optional

The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.

Optional

The simulated request body of an incoming invocation request.

Optional

A key-value map of additional context variables.

A key-value map of stage variables to simulate an invocation on a deployed Stage.

Required

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.

Optional

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.

Required

The string identifier of the associated RestApi.

Required

Specifies a test invoke authorizer request's Authorizer ID.

Represents the response of the test invoke request for a custom Authorizer

See: newTestInvokeAuthorizerResponse smart constructor.

Create a value of TestInvokeAuthorizerResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:log:TestInvokeAuthorizerResponse', testInvokeAuthorizerResponse_log - The API Gateway execution log for the test authorizer request.

$sel:principalId:TestInvokeAuthorizerResponse', testInvokeAuthorizerResponse_principalId - The principal identity returned by the Authorizer

$sel:latency:TestInvokeAuthorizerResponse', testInvokeAuthorizerResponse_latency - The execution latency of the test authorizer request.

$sel:authorization:TestInvokeAuthorizerResponse', testInvokeAuthorizerResponse_authorization - Undocumented member.

$sel:claims:TestInvokeAuthorizerResponse', testInvokeAuthorizerResponse_claims - The open identity claims, with any supported custom attributes, returned from the Cognito Your User Pool configured for the API.

$sel:clientStatus:TestInvokeAuthorizerResponse', testInvokeAuthorizerResponse_clientStatus - The HTTP status code that the client would have received. Value is 0 if the authorizer succeeded.

$sel:policy:TestInvokeAuthorizerResponse', testInvokeAuthorizerResponse_policy - The JSON policy document returned by the Authorizer

$sel:httpStatus:TestInvokeAuthorizerResponse', testInvokeAuthorizerResponse_httpStatus - The response's http status code.

The API Gateway execution log for the test authorizer request.

The principal identity returned by the Authorizer

The execution latency of the test authorizer request.

Undocumented member.

The open identity claims, with any supported custom attributes, returned from the Cognito Your User Pool configured for the API.

The HTTP status code that the client would have received. Value is 0 if the authorizer succeeded.

The JSON policy document returned by the Authorizer

The response's http status code.