Skip to content

PutSchemaInput

Source code in docs_src/capo_verifiedpermissions/types/put_schema_input.py
class PutSchemaInput(TypedDict, closed=True):
    policy_store_id: "capo_verifiedpermissions.types.policy_store_id.PolicyStoreId"
    """<p>Specifies the ID of the policy store in which to place the schema.</p> <p>To specify a policy store, use its ID or alias name. When using an alias name, prefix it with <code>policy-store-alias/</code>. For example:</p> <ul> <li> <p>ID: <code>PSEXAMPLEabcdefg111111</code> </p> </li> <li> <p>Alias name: <code>policy-store-alias/example-policy-store</code> </p> </li> </ul> <p>To view aliases, use <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicyStoreAliases.html">ListPolicyStoreAliases</a>.</p>"""
    definition: "capo_verifiedpermissions.types.schema_definition.SchemaDefinition"
    """<p>Specifies the definition of the schema to be stored. The schema definition must be written in Cedar schema JSON.</p>"""

definition instance-attribute

definition: SchemaDefinition

Specifies the definition of the schema to be stored. The schema definition must be written in Cedar schema JSON.

policy_store_id instance-attribute

policy_store_id: PolicyStoreId

Specifies the ID of the policy store in which to place the schema.

To specify a policy store, use its ID or alias name. When using an alias name, prefix it with policy-store-alias/. For example:

  • ID: PSEXAMPLEabcdefg111111

  • Alias name: policy-store-alias/example-policy-store

To view aliases, use ListPolicyStoreAliases.