IoT / Client / get_effective_policies

get_effective_policies#

IoT.Client.get_effective_policies(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.get_effective_policies(
    principal='string',
    cognitoIdentityPoolId='string',
    thingName='string'
)
Parameters:

  • principal (string) – 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 (string) – The Cognito identity pool ID.

  • thingName (string) – The thing name.

Return type:

dict

Returns:

Response Syntax

{
    'effectivePolicies': [
        {
            'policyName': 'string',
            'policyArn': 'string',
            'policyDocument': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • effectivePolicies (list) –

      The effective policies.

      • (dict) –

        The policy that has the effect on the authorization results.

        • policyName (string) –

          The policy name.

        • policyArn (string) –

          The policy ARN.

        • policyDocument (string) –

          The IAM policy document.

Exceptions