Copyright	(c) 2013-2021 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

Amazonka.IoT.GetEffectivePolicies

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets a list of the policies that have an effect on the authorization behavior of the specified device when it connects to the IoT device gateway.

Requires permission to access the GetEffectivePolicies action.

Creating a Request

data GetEffectivePolicies Source #

See: newGetEffectivePolicies smart constructor.

Constructors

GetEffectivePolicies'
Fields principal :: Maybe Text The principal. Valid principals are CertificateArn (arn:aws:iot:region:accountId:cert/certificateId), thingGroupArn (arn:aws:iot:region:accountId:thinggroup/groupName) and CognitoId (region:id). cognitoIdentityPoolId :: Maybe Text The Cognito identity pool ID. thingName :: Maybe Text The thing name.

Instances

Instances details

Eq GetEffectivePolicies Source #
Instance details Defined in Amazonka.IoT.GetEffectivePolicies Methods (==) :: GetEffectivePolicies -> GetEffectivePolicies -> Bool # (/=) :: GetEffectivePolicies -> GetEffectivePolicies -> Bool #
Read GetEffectivePolicies Source #
Instance details Defined in Amazonka.IoT.GetEffectivePolicies Methods readsPrec :: Int -> ReadS GetEffectivePolicies # readList :: ReadS [GetEffectivePolicies] # readPrec :: ReadPrec GetEffectivePolicies # readListPrec :: ReadPrec [GetEffectivePolicies] #
Show GetEffectivePolicies Source #
Instance details Defined in Amazonka.IoT.GetEffectivePolicies Methods showsPrec :: Int -> GetEffectivePolicies -> ShowS # show :: GetEffectivePolicies -> String # showList :: [GetEffectivePolicies] -> ShowS #
Generic GetEffectivePolicies Source #
Instance details Defined in Amazonka.IoT.GetEffectivePolicies Associated Types type Rep GetEffectivePolicies :: Type -> Type # Methods from :: GetEffectivePolicies -> Rep GetEffectivePolicies x # to :: Rep GetEffectivePolicies x -> GetEffectivePolicies #
NFData GetEffectivePolicies Source #
Instance details Defined in Amazonka.IoT.GetEffectivePolicies Methods rnf :: GetEffectivePolicies -> () #
Hashable GetEffectivePolicies Source #
Instance details Defined in Amazonka.IoT.GetEffectivePolicies Methods hashWithSalt :: Int -> GetEffectivePolicies -> Int # hash :: GetEffectivePolicies -> Int #
ToJSON GetEffectivePolicies Source #
Instance details Defined in Amazonka.IoT.GetEffectivePolicies Methods toJSON :: GetEffectivePolicies -> Value # toEncoding :: GetEffectivePolicies -> Encoding # toJSONList :: [GetEffectivePolicies] -> Value # toEncodingList :: [GetEffectivePolicies] -> Encoding #
AWSRequest GetEffectivePolicies Source #
Instance details Defined in Amazonka.IoT.GetEffectivePolicies Associated Types type AWSResponse GetEffectivePolicies # Methods request :: GetEffectivePolicies -> Request GetEffectivePolicies # response :: MonadResource m => Logger -> Service -> Proxy GetEffectivePolicies -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetEffectivePolicies))) #
ToHeaders GetEffectivePolicies Source #
Instance details Defined in Amazonka.IoT.GetEffectivePolicies Methods toHeaders :: GetEffectivePolicies -> [Header] #
ToPath GetEffectivePolicies Source #
Instance details Defined in Amazonka.IoT.GetEffectivePolicies Methods toPath :: GetEffectivePolicies -> ByteString #
ToQuery GetEffectivePolicies Source #
Instance details Defined in Amazonka.IoT.GetEffectivePolicies Methods toQuery :: GetEffectivePolicies -> QueryString #
type Rep GetEffectivePolicies Source #
Instance details Defined in Amazonka.IoT.GetEffectivePolicies type Rep GetEffectivePolicies = D1 ('MetaData "GetEffectivePolicies" "Amazonka.IoT.GetEffectivePolicies" "libZSservicesZSamazonka-iotZSamazonka-iot" 'False) (C1 ('MetaCons "GetEffectivePolicies'" 'PrefixI 'True) (S1 ('MetaSel ('Just "principal") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "cognitoIdentityPoolId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "thingName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))
type AWSResponse GetEffectivePolicies Source #
Instance details Defined in Amazonka.IoT.GetEffectivePolicies type AWSResponse GetEffectivePolicies = GetEffectivePoliciesResponse

newGetEffectivePolicies :: GetEffectivePolicies Source #

Create a value of GetEffectivePolicies 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:principal:GetEffectivePolicies', getEffectivePolicies_principal - The principal. Valid principals are CertificateArn (arn:aws:iot:region:accountId:cert/certificateId), thingGroupArn (arn:aws:iot:region:accountId:thinggroup/groupName) and CognitoId (region:id).

$sel:cognitoIdentityPoolId:GetEffectivePolicies', getEffectivePolicies_cognitoIdentityPoolId - The Cognito identity pool ID.

$sel:thingName:GetEffectivePolicies', getEffectivePolicies_thingName - The thing name.

Request Lenses

getEffectivePolicies_principal :: Lens' GetEffectivePolicies (Maybe Text) Source #

The principal. Valid principals are CertificateArn (arn:aws:iot:region:accountId:cert/certificateId), thingGroupArn (arn:aws:iot:region:accountId:thinggroup/groupName) and CognitoId (region:id).

getEffectivePolicies_cognitoIdentityPoolId :: Lens' GetEffectivePolicies (Maybe Text) Source #

The Cognito identity pool ID.

getEffectivePolicies_thingName :: Lens' GetEffectivePolicies (Maybe Text) Source #

The thing name.

Destructuring the Response

data GetEffectivePoliciesResponse Source #

See: newGetEffectivePoliciesResponse smart constructor.

Constructors

GetEffectivePoliciesResponse'
Fields effectivePolicies :: Maybe [EffectivePolicy] The effective policies. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq GetEffectivePoliciesResponse Source #
Instance details Defined in Amazonka.IoT.GetEffectivePolicies Methods (==) :: GetEffectivePoliciesResponse -> GetEffectivePoliciesResponse -> Bool # (/=) :: GetEffectivePoliciesResponse -> GetEffectivePoliciesResponse -> Bool #
Read GetEffectivePoliciesResponse Source #
Instance details Defined in Amazonka.IoT.GetEffectivePolicies Methods readsPrec :: Int -> ReadS GetEffectivePoliciesResponse # readList :: ReadS [GetEffectivePoliciesResponse] # readPrec :: ReadPrec GetEffectivePoliciesResponse # readListPrec :: ReadPrec [GetEffectivePoliciesResponse] #
Show GetEffectivePoliciesResponse Source #
Instance details Defined in Amazonka.IoT.GetEffectivePolicies Methods showsPrec :: Int -> GetEffectivePoliciesResponse -> ShowS # show :: GetEffectivePoliciesResponse -> String # showList :: [GetEffectivePoliciesResponse] -> ShowS #
Generic GetEffectivePoliciesResponse Source #
Instance details Defined in Amazonka.IoT.GetEffectivePolicies Associated Types type Rep GetEffectivePoliciesResponse :: Type -> Type # Methods from :: GetEffectivePoliciesResponse -> Rep GetEffectivePoliciesResponse x # to :: Rep GetEffectivePoliciesResponse x -> GetEffectivePoliciesResponse #
NFData GetEffectivePoliciesResponse Source #
Instance details Defined in Amazonka.IoT.GetEffectivePolicies Methods rnf :: GetEffectivePoliciesResponse -> () #
type Rep GetEffectivePoliciesResponse Source #
Instance details Defined in Amazonka.IoT.GetEffectivePolicies type Rep GetEffectivePoliciesResponse = D1 ('MetaData "GetEffectivePoliciesResponse" "Amazonka.IoT.GetEffectivePolicies" "libZSservicesZSamazonka-iotZSamazonka-iot" 'False) (C1 ('MetaCons "GetEffectivePoliciesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "effectivePolicies") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EffectivePolicy])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newGetEffectivePoliciesResponse Source #

Arguments

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

Create a value of GetEffectivePoliciesResponse 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:effectivePolicies:GetEffectivePoliciesResponse', getEffectivePoliciesResponse_effectivePolicies - The effective policies.

$sel:httpStatus:GetEffectivePoliciesResponse', getEffectivePoliciesResponse_httpStatus - The response's http status code.

Response Lenses

getEffectivePoliciesResponse_effectivePolicies :: Lens' GetEffectivePoliciesResponse (Maybe [EffectivePolicy]) Source #

The effective policies.

getEffectivePoliciesResponse_httpStatus :: Lens' GetEffectivePoliciesResponse Int Source #

The response's http status code.