Skip to content

TestAuthorizationRequest

Source code in docs_src/capo_iot/types/test_authorization_request.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
class TestAuthorizationRequest(TypedDict, closed=True):
    principal: NotRequired["capo_iot.types.principal.Principal"]
    """<p>The principal. Valid principals are CertificateArn (arn:aws:iot:<i>region</i>:<i>accountId</i>:cert/<i>certificateId</i>) and CognitoId (<i>region</i>:<i>id</i>).</p>"""
    cognito_identity_pool_id: NotRequired[
        "capo_iot.types.cognito_identity_pool_id.CognitoIdentityPoolId"
    ]
    """<p>The Cognito identity pool ID.</p>"""
    auth_infos: "capo_iot.types.auth_infos.AuthInfos"
    """<p>A list of authorization info objects. Simulating authorization will create a response for each <code>authInfo</code> object in the list.</p>"""
    client_id: NotRequired["capo_iot.types.client_id.ClientId"]
    """<p>The MQTT client ID.</p>"""
    policy_names_to_add: NotRequired["capo_iot.types.policy_names.PolicyNames"]
    """<p>When testing custom authorization, the policies specified here are treated as if they are attached to the principal being authorized.</p>"""
    policy_names_to_skip: NotRequired["capo_iot.types.policy_names.PolicyNames"]
    """<p>When testing custom authorization, the policies specified here are treated as if they are not attached to the principal being authorized.</p>"""

auth_infos instance-attribute 

auth_infos: AuthInfos

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

client_id instance-attribute 

client_id: NotRequired[ClientId]

The MQTT client ID.

cognito_identity_pool_id instance-attribute 

cognito_identity_pool_id: NotRequired[CognitoIdentityPoolId]

The Cognito identity pool ID.

policy_names_to_add instance-attribute 

policy_names_to_add: NotRequired[PolicyNames]

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

policy_names_to_skip instance-attribute 

policy_names_to_skip: NotRequired[PolicyNames]

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

principal instance-attribute 

principal: NotRequired[Principal]

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