Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Simulate the execution of an Authorizer
in your RestApi
with headers, parameters, and an incoming request body.
- testInvokeAuthorizer :: Text -> Text -> TestInvokeAuthorizer
- data TestInvokeAuthorizer
- tiaPathWithQueryString :: Lens' TestInvokeAuthorizer (Maybe Text)
- tiaBody :: Lens' TestInvokeAuthorizer (Maybe Text)
- tiaAdditionalContext :: Lens' TestInvokeAuthorizer (HashMap Text Text)
- tiaStageVariables :: Lens' TestInvokeAuthorizer (HashMap Text Text)
- tiaHeaders :: Lens' TestInvokeAuthorizer (HashMap Text Text)
- tiaRestAPIId :: Lens' TestInvokeAuthorizer Text
- tiaAuthorizerId :: Lens' TestInvokeAuthorizer Text
- testInvokeAuthorizerResponse :: Int -> TestInvokeAuthorizerResponse
- data TestInvokeAuthorizerResponse
- tiarsLog :: Lens' TestInvokeAuthorizerResponse (Maybe Text)
- tiarsPrincipalId :: Lens' TestInvokeAuthorizerResponse (Maybe Text)
- tiarsLatency :: Lens' TestInvokeAuthorizerResponse (Maybe Integer)
- tiarsAuthorization :: Lens' TestInvokeAuthorizerResponse (HashMap Text [Text])
- tiarsClaims :: Lens' TestInvokeAuthorizerResponse (HashMap Text Text)
- tiarsClientStatus :: Lens' TestInvokeAuthorizerResponse (Maybe Int)
- tiarsPolicy :: Lens' TestInvokeAuthorizerResponse (Maybe Text)
- tiarsResponseStatus :: Lens' TestInvokeAuthorizerResponse Int
Creating a Request
Creates a value of TestInvokeAuthorizer
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tiaPathWithQueryString
- [Optional] The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.tiaBody
- [Optional] The simulated request body of an incoming invocation request.tiaAdditionalContext
- [Optional] A key-value map of additional context variables.tiaStageVariables
- A key-value map of stage variables to simulate an invocation on a deployedStage
.tiaHeaders
- [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.tiaRestAPIId
- [Required] The string identifier of the associatedRestApi
.tiaAuthorizerId
- [Required] Specifies a test invoke authorizer request'sAuthorizer
ID.
data TestInvokeAuthorizer Source #
Make a request to simulate the execution of an Authorizer
.
See: testInvokeAuthorizer
smart constructor.
Request Lenses
tiaPathWithQueryString :: Lens' TestInvokeAuthorizer (Maybe Text) Source #
- Optional
- The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.
tiaBody :: Lens' TestInvokeAuthorizer (Maybe Text) Source #
- Optional
- The simulated request body of an incoming invocation request.
tiaAdditionalContext :: Lens' TestInvokeAuthorizer (HashMap Text Text) Source #
- Optional
- A key-value map of additional context variables.
tiaStageVariables :: Lens' TestInvokeAuthorizer (HashMap Text Text) Source #
A key-value map of stage variables to simulate an invocation on a deployed Stage
.
tiaHeaders :: Lens' TestInvokeAuthorizer (HashMap Text Text) Source #
- 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.
tiaRestAPIId :: Lens' TestInvokeAuthorizer Text Source #
- Required
- The string identifier of the associated
RestApi
.
tiaAuthorizerId :: Lens' TestInvokeAuthorizer Text Source #
- Required
- Specifies a test invoke authorizer request's
Authorizer
ID.
Destructuring the Response
testInvokeAuthorizerResponse Source #
Creates a value of TestInvokeAuthorizerResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tiarsLog
- The API Gateway execution log for the test authorizer request.tiarsPrincipalId
- The principal identity returned by theAuthorizer
tiarsLatency
- The execution latency of the test authorizer request.tiarsAuthorization
- Undocumented member.tiarsClaims
- The open identity claims , with any supported custom attributes, returned from the Cognito Your User Pool configured for the API.tiarsClientStatus
- The HTTP status code that the client would have received. Value is 0 if the authorizer succeeded.tiarsPolicy
- The JSON policy document returned by theAuthorizer
tiarsResponseStatus
- -- | The response status code.
data TestInvokeAuthorizerResponse Source #
Represents the response of the test invoke request for a custom Authorizer
See: testInvokeAuthorizerResponse
smart constructor.
Response Lenses
tiarsLog :: Lens' TestInvokeAuthorizerResponse (Maybe Text) Source #
The API Gateway execution log for the test authorizer request.
tiarsPrincipalId :: Lens' TestInvokeAuthorizerResponse (Maybe Text) Source #
The principal identity returned by the Authorizer
tiarsLatency :: Lens' TestInvokeAuthorizerResponse (Maybe Integer) Source #
The execution latency of the test authorizer request.
tiarsAuthorization :: Lens' TestInvokeAuthorizerResponse (HashMap Text [Text]) Source #
Undocumented member.
tiarsClaims :: Lens' TestInvokeAuthorizerResponse (HashMap Text Text) Source #
The open identity claims , with any supported custom attributes, returned from the Cognito Your User Pool configured for the API.
tiarsClientStatus :: Lens' TestInvokeAuthorizerResponse (Maybe Int) Source #
The HTTP status code that the client would have received. Value is 0 if the authorizer succeeded.
tiarsPolicy :: Lens' TestInvokeAuthorizerResponse (Maybe Text) Source #
The JSON policy document returned by the Authorizer
tiarsResponseStatus :: Lens' TestInvokeAuthorizerResponse Int Source #
- - | The response status code.