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

Network.AWS.IoT.TestAuthorization

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Test custom authorization.

Creating a Request

testAuthorization #

Arguments

:: NonEmpty AuthInfo	`taAuthInfos`
-> TestAuthorization

Creates a value of TestAuthorization with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

taClientId - The MQTT client ID.
taPolicyNamesToAdd - When testing custom authorization, the policies specified here are treated as if they are attached to the principal being authorized.
taPrincipal - The principal.
taCognitoIdentityPoolId - The Cognito identity pool ID.
taPolicyNamesToSkip - When testing custom authorization, the policies specified here are treated as if they are not attached to the principal being authorized.
taAuthInfos - A list of authorization info objects. Simulating authorization will create a response for each authInfo object in the list.

data TestAuthorization #

See: testAuthorization smart constructor.

Instances

Eq TestAuthorization #
Instance details Defined in Network.AWS.IoT.TestAuthorization Methods (==) :: TestAuthorization -> TestAuthorization -> Bool # (/=) :: TestAuthorization -> TestAuthorization -> Bool #
Data TestAuthorization #
Instance details Defined in Network.AWS.IoT.TestAuthorization Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> TestAuthorization -> c TestAuthorization # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c TestAuthorization # toConstr :: TestAuthorization -> Constr # dataTypeOf :: TestAuthorization -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c TestAuthorization) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c TestAuthorization) # gmapT :: (forall b. Data b => b -> b) -> TestAuthorization -> TestAuthorization # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> TestAuthorization -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> TestAuthorization -> r # gmapQ :: (forall d. Data d => d -> u) -> TestAuthorization -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> TestAuthorization -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> TestAuthorization -> m TestAuthorization # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> TestAuthorization -> m TestAuthorization # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> TestAuthorization -> m TestAuthorization #
Read TestAuthorization #
Instance details Defined in Network.AWS.IoT.TestAuthorization Methods readsPrec :: Int -> ReadS TestAuthorization # readList :: ReadS [TestAuthorization] # readPrec :: ReadPrec TestAuthorization # readListPrec :: ReadPrec [TestAuthorization] #
Show TestAuthorization #
Instance details Defined in Network.AWS.IoT.TestAuthorization Methods showsPrec :: Int -> TestAuthorization -> ShowS # show :: TestAuthorization -> String # showList :: [TestAuthorization] -> ShowS #
Generic TestAuthorization #
Instance details Defined in Network.AWS.IoT.TestAuthorization Associated Types type Rep TestAuthorization :: * -> * # Methods from :: TestAuthorization -> Rep TestAuthorization x # to :: Rep TestAuthorization x -> TestAuthorization #
Hashable TestAuthorization #
Instance details Defined in Network.AWS.IoT.TestAuthorization Methods hashWithSalt :: Int -> TestAuthorization -> Int # hash :: TestAuthorization -> Int #
ToJSON TestAuthorization #
Instance details Defined in Network.AWS.IoT.TestAuthorization Methods toJSON :: TestAuthorization -> Value # toEncoding :: TestAuthorization -> Encoding # toJSONList :: [TestAuthorization] -> Value # toEncodingList :: [TestAuthorization] -> Encoding #
AWSRequest TestAuthorization #
Instance details Defined in Network.AWS.IoT.TestAuthorization Associated Types type Rs TestAuthorization :: * # Methods request :: TestAuthorization -> Request TestAuthorization # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy TestAuthorization -> ClientResponse -> m (Response TestAuthorization) #
ToHeaders TestAuthorization #
Instance details Defined in Network.AWS.IoT.TestAuthorization Methods toHeaders :: TestAuthorization -> [Header] #
ToPath TestAuthorization #
Instance details Defined in Network.AWS.IoT.TestAuthorization Methods toPath :: TestAuthorization -> ByteString #
ToQuery TestAuthorization #
Instance details Defined in Network.AWS.IoT.TestAuthorization Methods toQuery :: TestAuthorization -> QueryString #
NFData TestAuthorization #
Instance details Defined in Network.AWS.IoT.TestAuthorization Methods rnf :: TestAuthorization -> () #
type Rep TestAuthorization #
Instance details Defined in Network.AWS.IoT.TestAuthorization type Rep TestAuthorization = D1 (MetaData "TestAuthorization" "Network.AWS.IoT.TestAuthorization" "amazonka-iot-1.6.0-7Vy7dErS7zJKuWc6mk800q" False) (C1 (MetaCons "TestAuthorization'" PrefixI True) ((S1 (MetaSel (Just "_taClientId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "_taPolicyNamesToAdd") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :: S1 (MetaSel (Just "_taPrincipal") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 (MetaSel (Just "_taCognitoIdentityPoolId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "_taPolicyNamesToSkip") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 (MetaSel (Just "_taAuthInfos") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (List1 AuthInfo))))))
type Rs TestAuthorization #
Instance details Defined in Network.AWS.IoT.TestAuthorization type Rs TestAuthorization = TestAuthorizationResponse

Request Lenses

taClientId :: Lens' TestAuthorization (Maybe Text) #

The MQTT client ID.

taPolicyNamesToAdd :: Lens' TestAuthorization [Text] #

When testing custom authorization, the policies specified here are treated as if they are attached to the principal being authorized.

taPrincipal :: Lens' TestAuthorization (Maybe Text) #

The principal.

taCognitoIdentityPoolId :: Lens' TestAuthorization (Maybe Text) #

The Cognito identity pool ID.

taPolicyNamesToSkip :: Lens' TestAuthorization [Text] #

When testing custom authorization, the policies specified here are treated as if they are not attached to the principal being authorized.

taAuthInfos :: Lens' TestAuthorization (NonEmpty AuthInfo) #

A list of authorization info objects. Simulating authorization will create a response for each authInfo object in the list.

Destructuring the Response

testAuthorizationResponse #

Arguments

:: Int	`tarsResponseStatus`
-> TestAuthorizationResponse

Creates a value of TestAuthorizationResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

tarsAuthResults - The authentication results.
tarsResponseStatus - -- | The response status code.

data TestAuthorizationResponse #

See: testAuthorizationResponse smart constructor.

Instances

Eq TestAuthorizationResponse #
Instance details Defined in Network.AWS.IoT.TestAuthorization Methods (==) :: TestAuthorizationResponse -> TestAuthorizationResponse -> Bool # (/=) :: TestAuthorizationResponse -> TestAuthorizationResponse -> Bool #
Data TestAuthorizationResponse #
Instance details Defined in Network.AWS.IoT.TestAuthorization Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> TestAuthorizationResponse -> c TestAuthorizationResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c TestAuthorizationResponse # toConstr :: TestAuthorizationResponse -> Constr # dataTypeOf :: TestAuthorizationResponse -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c TestAuthorizationResponse) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c TestAuthorizationResponse) # gmapT :: (forall b. Data b => b -> b) -> TestAuthorizationResponse -> TestAuthorizationResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> TestAuthorizationResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> TestAuthorizationResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> TestAuthorizationResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> TestAuthorizationResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> TestAuthorizationResponse -> m TestAuthorizationResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> TestAuthorizationResponse -> m TestAuthorizationResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> TestAuthorizationResponse -> m TestAuthorizationResponse #
Read TestAuthorizationResponse #
Instance details Defined in Network.AWS.IoT.TestAuthorization Methods readsPrec :: Int -> ReadS TestAuthorizationResponse # readList :: ReadS [TestAuthorizationResponse] # readPrec :: ReadPrec TestAuthorizationResponse # readListPrec :: ReadPrec [TestAuthorizationResponse] #
Show TestAuthorizationResponse #
Instance details Defined in Network.AWS.IoT.TestAuthorization Methods showsPrec :: Int -> TestAuthorizationResponse -> ShowS # show :: TestAuthorizationResponse -> String # showList :: [TestAuthorizationResponse] -> ShowS #
Generic TestAuthorizationResponse #
Instance details Defined in Network.AWS.IoT.TestAuthorization Associated Types type Rep TestAuthorizationResponse :: * -> * # Methods from :: TestAuthorizationResponse -> Rep TestAuthorizationResponse x # to :: Rep TestAuthorizationResponse x -> TestAuthorizationResponse #
NFData TestAuthorizationResponse #
Instance details Defined in Network.AWS.IoT.TestAuthorization Methods rnf :: TestAuthorizationResponse -> () #
type Rep TestAuthorizationResponse #
Instance details Defined in Network.AWS.IoT.TestAuthorization type Rep TestAuthorizationResponse = D1 (MetaData "TestAuthorizationResponse" "Network.AWS.IoT.TestAuthorization" "amazonka-iot-1.6.0-7Vy7dErS7zJKuWc6mk800q" False) (C1 (MetaCons "TestAuthorizationResponse'" PrefixI True) (S1 (MetaSel (Just "_tarsAuthResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [AuthResult])) :*: S1 (MetaSel (Just "_tarsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))

Response Lenses

tarsAuthResults :: Lens' TestAuthorizationResponse [AuthResult] #

The authentication results.

tarsResponseStatus :: Lens' TestAuthorizationResponse Int #

- | The response status code.