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.IoT.TestInvokeAuthorizer

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Tests a custom authorization behavior by invoking a specified custom authorizer. Use this to test and debug the custom authorization behavior of devices that connect to the IoT device gateway.

Requires permission to access the TestInvokeAuthorizer action.

Synopsis

data TestInvokeAuthorizer = TestInvokeAuthorizer' {
- httpContext :: Maybe HttpContext
- mqttContext :: Maybe MqttContext
- tlsContext :: Maybe TlsContext
- token :: Maybe Text
- tokenSignature :: Maybe Text
- authorizerName :: Text
}
newTestInvokeAuthorizer :: Text -> TestInvokeAuthorizer
testInvokeAuthorizer_httpContext :: Lens' TestInvokeAuthorizer (Maybe HttpContext)
testInvokeAuthorizer_mqttContext :: Lens' TestInvokeAuthorizer (Maybe MqttContext)
testInvokeAuthorizer_tlsContext :: Lens' TestInvokeAuthorizer (Maybe TlsContext)
testInvokeAuthorizer_token :: Lens' TestInvokeAuthorizer (Maybe Text)
testInvokeAuthorizer_tokenSignature :: Lens' TestInvokeAuthorizer (Maybe Text)
testInvokeAuthorizer_authorizerName :: Lens' TestInvokeAuthorizer Text
data TestInvokeAuthorizerResponse = TestInvokeAuthorizerResponse' {
- disconnectAfterInSeconds :: Maybe Int
- isAuthenticated :: Maybe Bool
- policyDocuments :: Maybe [Text]
- principalId :: Maybe Text
- refreshAfterInSeconds :: Maybe Int
- httpStatus :: Int
}
newTestInvokeAuthorizerResponse :: Int -> TestInvokeAuthorizerResponse
testInvokeAuthorizerResponse_disconnectAfterInSeconds :: Lens' TestInvokeAuthorizerResponse (Maybe Int)
testInvokeAuthorizerResponse_isAuthenticated :: Lens' TestInvokeAuthorizerResponse (Maybe Bool)
testInvokeAuthorizerResponse_policyDocuments :: Lens' TestInvokeAuthorizerResponse (Maybe [Text])
testInvokeAuthorizerResponse_principalId :: Lens' TestInvokeAuthorizerResponse (Maybe Text)
testInvokeAuthorizerResponse_refreshAfterInSeconds :: Lens' TestInvokeAuthorizerResponse (Maybe Int)
testInvokeAuthorizerResponse_httpStatus :: Lens' TestInvokeAuthorizerResponse Int

Creating a Request

data TestInvokeAuthorizer Source #

See: newTestInvokeAuthorizer smart constructor.

Constructors

TestInvokeAuthorizer'

Fields

httpContext :: Maybe HttpContext
Specifies a test HTTP authorization request.
mqttContext :: Maybe MqttContext
Specifies a test MQTT authorization request.
tlsContext :: Maybe TlsContext
Specifies a test TLS authorization request.
token :: Maybe Text
The token returned by your custom authentication service.
tokenSignature :: Maybe Text
The signature made with the token and your custom authentication service's private key. This value must be Base-64-encoded.
authorizerName :: Text
The custom authorizer name.

Instances

Instances details

ToJSON TestInvokeAuthorizer Source #
Instance details Defined in Amazonka.IoT.TestInvokeAuthorizer Methods toJSON :: TestInvokeAuthorizer -> Value # toEncoding :: TestInvokeAuthorizer -> Encoding # toJSONList :: [TestInvokeAuthorizer] -> Value # toEncodingList :: [TestInvokeAuthorizer] -> Encoding #
ToHeaders TestInvokeAuthorizer Source #
Instance details Defined in Amazonka.IoT.TestInvokeAuthorizer Methods toHeaders :: TestInvokeAuthorizer -> [Header] #
ToPath TestInvokeAuthorizer Source #
Instance details Defined in Amazonka.IoT.TestInvokeAuthorizer Methods toPath :: TestInvokeAuthorizer -> ByteString #
ToQuery TestInvokeAuthorizer Source #
Instance details Defined in Amazonka.IoT.TestInvokeAuthorizer Methods toQuery :: TestInvokeAuthorizer -> QueryString #
AWSRequest TestInvokeAuthorizer Source #
Instance details Defined in Amazonka.IoT.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.IoT.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.IoT.TestInvokeAuthorizer Methods readsPrec :: Int -> ReadS TestInvokeAuthorizer # readList :: ReadS [TestInvokeAuthorizer] # readPrec :: ReadPrec TestInvokeAuthorizer # readListPrec :: ReadPrec [TestInvokeAuthorizer] #
Show TestInvokeAuthorizer Source #
Instance details Defined in Amazonka.IoT.TestInvokeAuthorizer Methods showsPrec :: Int -> TestInvokeAuthorizer -> ShowS # show :: TestInvokeAuthorizer -> String # showList :: [TestInvokeAuthorizer] -> ShowS #
NFData TestInvokeAuthorizer Source #
Instance details Defined in Amazonka.IoT.TestInvokeAuthorizer Methods rnf :: TestInvokeAuthorizer -> () #
Eq TestInvokeAuthorizer Source #
Instance details Defined in Amazonka.IoT.TestInvokeAuthorizer Methods (==) :: TestInvokeAuthorizer -> TestInvokeAuthorizer -> Bool # (/=) :: TestInvokeAuthorizer -> TestInvokeAuthorizer -> Bool #
Hashable TestInvokeAuthorizer Source #
Instance details Defined in Amazonka.IoT.TestInvokeAuthorizer Methods hashWithSalt :: Int -> TestInvokeAuthorizer -> Int # hash :: TestInvokeAuthorizer -> Int #
type AWSResponse TestInvokeAuthorizer Source #
Instance details Defined in Amazonka.IoT.TestInvokeAuthorizer type AWSResponse TestInvokeAuthorizer = TestInvokeAuthorizerResponse
type Rep TestInvokeAuthorizer Source #
Instance details Defined in Amazonka.IoT.TestInvokeAuthorizer type Rep TestInvokeAuthorizer = D1 ('MetaData "TestInvokeAuthorizer" "Amazonka.IoT.TestInvokeAuthorizer" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "TestInvokeAuthorizer'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "httpContext") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HttpContext)) :: (S1 ('MetaSel ('Just "mqttContext") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MqttContext)) :: S1 ('MetaSel ('Just "tlsContext") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TlsContext)))) :: (S1 ('MetaSel ('Just "token") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "tokenSignature") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "authorizerName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newTestInvokeAuthorizer Source #

Arguments

:: 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:httpContext:TestInvokeAuthorizer', testInvokeAuthorizer_httpContext - Specifies a test HTTP authorization request.

$sel:mqttContext:TestInvokeAuthorizer', testInvokeAuthorizer_mqttContext - Specifies a test MQTT authorization request.

$sel:tlsContext:TestInvokeAuthorizer', testInvokeAuthorizer_tlsContext - Specifies a test TLS authorization request.

TestInvokeAuthorizer, testInvokeAuthorizer_token - The token returned by your custom authentication service.

$sel:tokenSignature:TestInvokeAuthorizer', testInvokeAuthorizer_tokenSignature - The signature made with the token and your custom authentication service's private key. This value must be Base-64-encoded.

TestInvokeAuthorizer, testInvokeAuthorizer_authorizerName - The custom authorizer name.

Request Lenses

testInvokeAuthorizer_httpContext :: Lens' TestInvokeAuthorizer (Maybe HttpContext) Source #

Specifies a test HTTP authorization request.

testInvokeAuthorizer_mqttContext :: Lens' TestInvokeAuthorizer (Maybe MqttContext) Source #

Specifies a test MQTT authorization request.

testInvokeAuthorizer_tlsContext :: Lens' TestInvokeAuthorizer (Maybe TlsContext) Source #

Specifies a test TLS authorization request.

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

The token returned by your custom authentication service.

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

The signature made with the token and your custom authentication service's private key. This value must be Base-64-encoded.

testInvokeAuthorizer_authorizerName :: Lens' TestInvokeAuthorizer Text Source #

The custom authorizer name.

Destructuring the Response

data TestInvokeAuthorizerResponse Source #

See: newTestInvokeAuthorizerResponse smart constructor.

Constructors

TestInvokeAuthorizerResponse'

Fields

disconnectAfterInSeconds :: Maybe Int
The number of seconds after which the connection is terminated.
isAuthenticated :: Maybe Bool
True if the token is authenticated, otherwise false.
policyDocuments :: Maybe [Text]
IAM policy documents.
principalId :: Maybe Text
The principal ID.
refreshAfterInSeconds :: Maybe Int
The number of seconds after which the temporary credentials are refreshed.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic TestInvokeAuthorizerResponse Source #
Instance details Defined in Amazonka.IoT.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.IoT.TestInvokeAuthorizer Methods readsPrec :: Int -> ReadS TestInvokeAuthorizerResponse # readList :: ReadS [TestInvokeAuthorizerResponse] # readPrec :: ReadPrec TestInvokeAuthorizerResponse # readListPrec :: ReadPrec [TestInvokeAuthorizerResponse] #
Show TestInvokeAuthorizerResponse Source #
Instance details Defined in Amazonka.IoT.TestInvokeAuthorizer Methods showsPrec :: Int -> TestInvokeAuthorizerResponse -> ShowS # show :: TestInvokeAuthorizerResponse -> String # showList :: [TestInvokeAuthorizerResponse] -> ShowS #
NFData TestInvokeAuthorizerResponse Source #
Instance details Defined in Amazonka.IoT.TestInvokeAuthorizer Methods rnf :: TestInvokeAuthorizerResponse -> () #
Eq TestInvokeAuthorizerResponse Source #
Instance details Defined in Amazonka.IoT.TestInvokeAuthorizer Methods (==) :: TestInvokeAuthorizerResponse -> TestInvokeAuthorizerResponse -> Bool # (/=) :: TestInvokeAuthorizerResponse -> TestInvokeAuthorizerResponse -> Bool #
type Rep TestInvokeAuthorizerResponse Source #
Instance details Defined in Amazonka.IoT.TestInvokeAuthorizer type Rep TestInvokeAuthorizerResponse = D1 ('MetaData "TestInvokeAuthorizerResponse" "Amazonka.IoT.TestInvokeAuthorizer" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "TestInvokeAuthorizerResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "disconnectAfterInSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "isAuthenticated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "policyDocuments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :: (S1 ('MetaSel ('Just "principalId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "refreshAfterInSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))