Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.APIGateway.TestInvokeAuthorizer

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Synopsis

data TestInvokeAuthorizer = TestInvokeAuthorizer' {
- additionalContext :: Maybe (HashMap Text Text)
- body :: Maybe Text
- headers :: Maybe (HashMap Text Text)
- multiValueHeaders :: Maybe (HashMap Text [Text])
- pathWithQueryString :: Maybe Text
- stageVariables :: Maybe (HashMap Text Text)
- restApiId :: Text
- authorizerId :: Text
}
newTestInvokeAuthorizer :: Text -> Text -> TestInvokeAuthorizer
testInvokeAuthorizer_additionalContext :: Lens' TestInvokeAuthorizer (Maybe (HashMap Text Text))
testInvokeAuthorizer_body :: Lens' TestInvokeAuthorizer (Maybe Text)
testInvokeAuthorizer_headers :: Lens' TestInvokeAuthorizer (Maybe (HashMap Text Text))
testInvokeAuthorizer_multiValueHeaders :: Lens' TestInvokeAuthorizer (Maybe (HashMap Text [Text]))
testInvokeAuthorizer_pathWithQueryString :: Lens' TestInvokeAuthorizer (Maybe Text)
testInvokeAuthorizer_stageVariables :: Lens' TestInvokeAuthorizer (Maybe (HashMap Text Text))
testInvokeAuthorizer_restApiId :: Lens' TestInvokeAuthorizer Text
testInvokeAuthorizer_authorizerId :: Lens' TestInvokeAuthorizer Text
data TestInvokeAuthorizerResponse = TestInvokeAuthorizerResponse' {
- authorization :: Maybe (HashMap Text [Text])
- claims :: Maybe (HashMap Text Text)
- clientStatus :: Maybe Int
- latency :: Maybe Integer
- log :: Maybe Text
- policy :: Maybe Text
- principalId :: Maybe Text
- httpStatus :: Int
}
newTestInvokeAuthorizerResponse :: Int -> TestInvokeAuthorizerResponse
testInvokeAuthorizerResponse_authorization :: Lens' TestInvokeAuthorizerResponse (Maybe (HashMap Text [Text]))
testInvokeAuthorizerResponse_claims :: Lens' TestInvokeAuthorizerResponse (Maybe (HashMap Text Text))
testInvokeAuthorizerResponse_clientStatus :: Lens' TestInvokeAuthorizerResponse (Maybe Int)
testInvokeAuthorizerResponse_latency :: Lens' TestInvokeAuthorizerResponse (Maybe Integer)
testInvokeAuthorizerResponse_log :: Lens' TestInvokeAuthorizerResponse (Maybe Text)
testInvokeAuthorizerResponse_policy :: Lens' TestInvokeAuthorizerResponse (Maybe Text)
testInvokeAuthorizerResponse_principalId :: Lens' TestInvokeAuthorizerResponse (Maybe Text)
testInvokeAuthorizerResponse_httpStatus :: Lens' TestInvokeAuthorizerResponse Int

Creating a Request

data TestInvokeAuthorizer Source #

Make a request to simulate the invocation of an Authorizer.

See: newTestInvokeAuthorizer smart constructor.

Constructors

TestInvokeAuthorizer'

Fields

additionalContext :: Maybe (HashMap Text Text)
A key-value map of additional context variables.
body :: Maybe Text
The simulated request body of an incoming invocation request.
headers :: Maybe (HashMap Text Text)
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.
multiValueHeaders :: Maybe (HashMap Text [Text])
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.
pathWithQueryString :: Maybe Text
The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.
stageVariables :: Maybe (HashMap Text Text)
A key-value map of stage variables to simulate an invocation on a deployed Stage.
restApiId :: Text
The string identifier of the associated RestApi.
authorizerId :: Text
Specifies a test invoke authorizer request's Authorizer ID.

Instances

Instances details

ToJSON TestInvokeAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.TestInvokeAuthorizer Methods toJSON :: TestInvokeAuthorizer -> Value # toEncoding :: TestInvokeAuthorizer -> Encoding # toJSONList :: [TestInvokeAuthorizer] -> Value # toEncodingList :: [TestInvokeAuthorizer] -> Encoding #
ToHeaders TestInvokeAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.TestInvokeAuthorizer Methods toHeaders :: TestInvokeAuthorizer -> [Header] #
ToPath TestInvokeAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.TestInvokeAuthorizer Methods toPath :: TestInvokeAuthorizer -> ByteString #
ToQuery TestInvokeAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.TestInvokeAuthorizer Methods toQuery :: TestInvokeAuthorizer -> QueryString #
AWSRequest TestInvokeAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.TestInvokeAuthorizer Associated Types type AWSResponse TestInvokeAuthorizer # Methods request :: (Service -> Service) -> TestInvokeAuthorizer -> Request TestInvokeAuthorizer # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy TestInvokeAuthorizer -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse TestInvokeAuthorizer))) #
Generic TestInvokeAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.TestInvokeAuthorizer Associated Types type Rep TestInvokeAuthorizer :: Type -> Type # Methods from :: TestInvokeAuthorizer -> Rep TestInvokeAuthorizer x # to :: Rep TestInvokeAuthorizer x -> TestInvokeAuthorizer #
Read TestInvokeAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.TestInvokeAuthorizer Methods readsPrec :: Int -> ReadS TestInvokeAuthorizer # readList :: ReadS [TestInvokeAuthorizer] # readPrec :: ReadPrec TestInvokeAuthorizer # readListPrec :: ReadPrec [TestInvokeAuthorizer] #
Show TestInvokeAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.TestInvokeAuthorizer Methods showsPrec :: Int -> TestInvokeAuthorizer -> ShowS # show :: TestInvokeAuthorizer -> String # showList :: [TestInvokeAuthorizer] -> ShowS #
NFData TestInvokeAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.TestInvokeAuthorizer Methods rnf :: TestInvokeAuthorizer -> () #
Eq TestInvokeAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.TestInvokeAuthorizer Methods (==) :: TestInvokeAuthorizer -> TestInvokeAuthorizer -> Bool # (/=) :: TestInvokeAuthorizer -> TestInvokeAuthorizer -> Bool #
Hashable TestInvokeAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.TestInvokeAuthorizer Methods hashWithSalt :: Int -> TestInvokeAuthorizer -> Int # hash :: TestInvokeAuthorizer -> Int #
type AWSResponse TestInvokeAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.TestInvokeAuthorizer type AWSResponse TestInvokeAuthorizer = TestInvokeAuthorizerResponse
type Rep TestInvokeAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.TestInvokeAuthorizer type Rep TestInvokeAuthorizer = D1 ('MetaData "TestInvokeAuthorizer" "Amazonka.APIGateway.TestInvokeAuthorizer" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "TestInvokeAuthorizer'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "additionalContext") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "body") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "headers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "multiValueHeaders") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text [Text]))))) :: ((S1 ('MetaSel ('Just "pathWithQueryString") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "stageVariables") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :: (S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "authorizerId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newTestInvokeAuthorizer Source #

Arguments

:: Text	`TestInvokeAuthorizer`
-> Text	`TestInvokeAuthorizer`
-> TestInvokeAuthorizer

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:additionalContext:TestInvokeAuthorizer', testInvokeAuthorizer_additionalContext - A key-value map of additional context variables.

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

$sel:headers:TestInvokeAuthorizer', testInvokeAuthorizer_headers - 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 - 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:pathWithQueryString:TestInvokeAuthorizer', testInvokeAuthorizer_pathWithQueryString - The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.

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

TestInvokeAuthorizer, testInvokeAuthorizer_restApiId - The string identifier of the associated RestApi.

TestInvokeAuthorizer, testInvokeAuthorizer_authorizerId - Specifies a test invoke authorizer request's Authorizer ID.

Request Lenses

testInvokeAuthorizer_additionalContext :: Lens' TestInvokeAuthorizer (Maybe (HashMap Text Text)) Source #

A key-value map of additional context variables.

testInvokeAuthorizer_body :: Lens' TestInvokeAuthorizer (Maybe Text) Source #

The simulated request body of an incoming invocation request.

testInvokeAuthorizer_headers :: Lens' TestInvokeAuthorizer (Maybe (HashMap Text Text)) Source #

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.

testInvokeAuthorizer_multiValueHeaders :: Lens' TestInvokeAuthorizer (Maybe (HashMap Text [Text])) Source #

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.

testInvokeAuthorizer_pathWithQueryString :: Lens' TestInvokeAuthorizer (Maybe Text) Source #

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

testInvokeAuthorizer_stageVariables :: Lens' TestInvokeAuthorizer (Maybe (HashMap Text Text)) Source #

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

testInvokeAuthorizer_restApiId :: Lens' TestInvokeAuthorizer Text Source #

The string identifier of the associated RestApi.

testInvokeAuthorizer_authorizerId :: Lens' TestInvokeAuthorizer Text Source #

Specifies a test invoke authorizer request's Authorizer ID.

Destructuring the Response

data TestInvokeAuthorizerResponse Source #

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

See: newTestInvokeAuthorizerResponse smart constructor.

Constructors

TestInvokeAuthorizerResponse'

Fields

authorization :: Maybe (HashMap Text [Text])
The authorization response.
claims :: Maybe (HashMap Text Text)
The open identity claims, with any supported custom attributes, returned from the Cognito Your User Pool configured for the API.
clientStatus :: Maybe Int
The HTTP status code that the client would have received. Value is 0 if the authorizer succeeded.
latency :: Maybe Integer
The execution latency of the test authorizer request.
log :: Maybe Text
The API Gateway execution log for the test authorizer request.
policy :: Maybe Text
The JSON policy document returned by the Authorizer
principalId :: Maybe Text
The principal identity returned by the Authorizer
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic TestInvokeAuthorizerResponse Source #
Instance details Defined in Amazonka.APIGateway.TestInvokeAuthorizer Associated Types type Rep TestInvokeAuthorizerResponse :: Type -> Type # Methods from :: TestInvokeAuthorizerResponse -> Rep TestInvokeAuthorizerResponse x # to :: Rep TestInvokeAuthorizerResponse x -> TestInvokeAuthorizerResponse #
Read TestInvokeAuthorizerResponse Source #
Instance details Defined in Amazonka.APIGateway.TestInvokeAuthorizer Methods readsPrec :: Int -> ReadS TestInvokeAuthorizerResponse # readList :: ReadS [TestInvokeAuthorizerResponse] # readPrec :: ReadPrec TestInvokeAuthorizerResponse # readListPrec :: ReadPrec [TestInvokeAuthorizerResponse] #
Show TestInvokeAuthorizerResponse Source #
Instance details Defined in Amazonka.APIGateway.TestInvokeAuthorizer Methods showsPrec :: Int -> TestInvokeAuthorizerResponse -> ShowS # show :: TestInvokeAuthorizerResponse -> String # showList :: [TestInvokeAuthorizerResponse] -> ShowS #
NFData TestInvokeAuthorizerResponse Source #
Instance details Defined in Amazonka.APIGateway.TestInvokeAuthorizer Methods rnf :: TestInvokeAuthorizerResponse -> () #
Eq TestInvokeAuthorizerResponse Source #
Instance details Defined in Amazonka.APIGateway.TestInvokeAuthorizer Methods (==) :: TestInvokeAuthorizerResponse -> TestInvokeAuthorizerResponse -> Bool # (/=) :: TestInvokeAuthorizerResponse -> TestInvokeAuthorizerResponse -> Bool #
type Rep TestInvokeAuthorizerResponse Source #
Instance details Defined in Amazonka.APIGateway.TestInvokeAuthorizer type Rep TestInvokeAuthorizerResponse = D1 ('MetaData "TestInvokeAuthorizerResponse" "Amazonka.APIGateway.TestInvokeAuthorizer" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "TestInvokeAuthorizerResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "authorization") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text [Text]))) :: S1 ('MetaSel ('Just "claims") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :: (S1 ('MetaSel ('Just "clientStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "latency") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)))) :: ((S1 ('MetaSel ('Just "log") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "policy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "principalId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newTestInvokeAuthorizerResponse Source #

Arguments

:: Int	`$sel:httpStatus:TestInvokeAuthorizerResponse'`
-> TestInvokeAuthorizerResponse

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:authorization:TestInvokeAuthorizerResponse', testInvokeAuthorizerResponse_authorization - The authorization response.

$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:latency:TestInvokeAuthorizerResponse', testInvokeAuthorizerResponse_latency - The execution latency of the test authorizer request.

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

TestInvokeAuthorizerResponse, testInvokeAuthorizerResponse_policy - The JSON policy document returned by the Authorizer

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

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

Response Lenses

testInvokeAuthorizerResponse_authorization :: Lens' TestInvokeAuthorizerResponse (Maybe (HashMap Text [Text])) Source #

The authorization response.

testInvokeAuthorizerResponse_claims :: Lens' TestInvokeAuthorizerResponse (Maybe (HashMap Text Text)) Source #

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

testInvokeAuthorizerResponse_clientStatus :: Lens' TestInvokeAuthorizerResponse (Maybe Int) Source #

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

testInvokeAuthorizerResponse_latency :: Lens' TestInvokeAuthorizerResponse (Maybe Integer) Source #

The execution latency of the test authorizer request.

testInvokeAuthorizerResponse_log :: Lens' TestInvokeAuthorizerResponse (Maybe Text) Source #

The API Gateway execution log for the test authorizer request.

testInvokeAuthorizerResponse_policy :: Lens' TestInvokeAuthorizerResponse (Maybe Text) Source #

The JSON policy document returned by the Authorizer

testInvokeAuthorizerResponse_principalId :: Lens' TestInvokeAuthorizerResponse (Maybe Text) Source #

The principal identity returned by the Authorizer

testInvokeAuthorizerResponse_httpStatus :: Lens' TestInvokeAuthorizerResponse Int Source #

The response's http status code.