Module Smaws_Client_VerifiedPermissions.Types

type nonrec throttling_exception = {
  1. quota_code : Smaws_Lib.Smithy_api.Types.string_ option;
    (*

    The quota code recognized by the Amazon Web Services Service Quotas service.

    *)
  2. service_code : Smaws_Lib.Smithy_api.Types.string_ option;
    (*

    The code for the Amazon Web Services service that owns the quota.

    *)
  3. message : Smaws_Lib.Smithy_api.Types.string_;
}

The request failed because it exceeded a throttling quota.

type nonrec resource_type =
  1. | POLICY_STORE_ALIAS
  2. | SCHEMA
  3. | POLICY_TEMPLATE
  4. | POLICY
  5. | POLICY_STORE
  6. | IDENTITY_SOURCE
type nonrec resource_not_found_exception = {
  1. resource_type : resource_type;
    (*

    The resource type of the resource referenced in the failed request.

    *)
  2. resource_id : Smaws_Lib.Smithy_api.Types.string_;
    (*

    The unique ID of the resource referenced in the failed request.

    *)
  3. message : Smaws_Lib.Smithy_api.Types.string_;
}

The request failed because it references a resource that doesn't exist.

type nonrec internal_server_exception = {
  1. message : Smaws_Lib.Smithy_api.Types.string_;
}

The request failed because of an internal error. Try your request again later

type nonrec access_denied_exception = {
  1. message : Smaws_Lib.Smithy_api.Types.string_;
}

You don't have sufficient access to perform this action.

type nonrec untag_resource_output = unit
type nonrec amazon_resource_name = string
type nonrec tag_key = string
type nonrec tag_key_list = tag_key list
type nonrec untag_resource_input = {
  1. tag_keys : tag_key_list;
    (*

    The list of tag keys to remove from the resource.

    *)
  2. resource_arn : amazon_resource_name;
    (*

    The ARN of the resource from which you are removing tags.

    *)
}
type nonrec too_many_tags_exception = {
  1. resource_name : amazon_resource_name option;
  2. message : Smaws_Lib.Smithy_api.Types.string_ option;
}

No more tags be added because the limit (50) has been reached. To add new tags, use UntagResource to remove existing tags.

type nonrec tag_resource_output = unit
type nonrec tag_value = string
type nonrec tag_map = (tag_key * tag_value) list
type nonrec tag_resource_input = {
  1. tags : tag_map;
    (*

    The list of key-value pairs to associate with the resource.

    *)
  2. resource_arn : amazon_resource_name;
    (*

    The ARN of the resource that you're adding tags to.

    *)
}
type nonrec list_tags_for_resource_output = {
  1. tags : tag_map option;
    (*

    The list of tags associated with the resource.

    *)
}
type nonrec list_tags_for_resource_input = {
  1. resource_arn : amazon_resource_name;
    (*

    The ARN of the resource for which you want to view tags.

    *)
}
type nonrec validation_mode =
  1. | STRICT
  2. | OFF
type nonrec validation_settings = {
  1. mode : validation_mode;
    (*

    The validation mode currently configured for this policy store. The valid values are:

    • OFF – Neither Verified Permissions nor Cedar perform any validation on policies. No validation errors are reported by either service.
    • STRICT – Requires a schema to be present in the policy store. Cedar performs validation on all submitted new or updated static policies and policy templates. Any that fail validation are rejected and Cedar doesn't store them in the policy store.

    If Mode=STRICT and the policy store doesn't contain a schema, Verified Permissions rejects all static policies and policy templates because there is no schema to validate against.

    To submit a static policy or policy template without a schema, you must turn off validation.

    *)
}

A structure that contains Cedar policy validation settings for the policy store. The validation mode determines which validation failures that Cedar considers serious enough to block acceptance of a new or edited static policy or policy template.

This data type is used as a request parameter in the CreatePolicyStore and UpdatePolicyStore operations.

type nonrec validation_exception_field = {
  1. message : Smaws_Lib.Smithy_api.Types.string_;
    (*

    Describes the policy validation error.

    *)
  2. path : Smaws_Lib.Smithy_api.Types.string_;
    (*

    The path to the specific element that Verified Permissions found to be not valid.

    *)
}

Details about a field that failed policy validation.

type nonrec validation_exception_field_list = validation_exception_field list
type nonrec validation_exception = {
  1. field_list : validation_exception_field_list option;
    (*

    The list of fields that aren't valid.

    *)
  2. message : Smaws_Lib.Smithy_api.Types.string_;
}

The request failed because one or more input parameters don't satisfy their constraint requirements. The output is provided as a list of fields and a reason for each field that isn't valid.

The possible reasons include the following:

  • UnrecognizedEntityType

    The policy includes an entity type that isn't found in the schema.

  • UnrecognizedActionId

    The policy includes an action id that isn't found in the schema.

  • InvalidActionApplication

    The policy includes an action that, according to the schema, doesn't support the specified principal and resource.

  • UnexpectedType

    The policy included an operand that isn't a valid type for the specified operation.

  • IncompatibleTypes

    The types of elements included in a set, or the types of expressions used in an if...then...else clause aren't compatible in this context.

  • MissingAttribute

    The policy attempts to access a record or entity attribute that isn't specified in the schema. Test for the existence of the attribute first before attempting to access its value. For more information, see the has (presence of attribute test) operator in the Cedar Policy Language Guide.

  • UnsafeOptionalAttributeAccess

    The policy attempts to access a record or entity attribute that is optional and isn't guaranteed to be present. Test for the existence of the attribute first before attempting to access its value. For more information, see the has (presence of attribute test) operator in the Cedar Policy Language Guide.

  • ImpossiblePolicy

    Cedar has determined that a policy condition always evaluates to false. If the policy is always false, it can never apply to any query, and so it can never affect an authorization decision.

  • WrongNumberArguments

    The policy references an extension type with the wrong number of arguments.

  • FunctionArgumentValidationError

    Cedar couldn't parse the argument passed to an extension type. For example, a string that is to be parsed as an IPv4 address can contain only digits and the period character.

type nonrec user_pool_arn = string
type nonrec static_policy_description = string
type nonrec policy_statement = string
type nonrec update_static_policy_definition = {
  1. statement : policy_statement;
    (*

    Specifies the Cedar policy language text to be added to or replaced on the static policy.

    You can change only the following elements from the original content:

    • The action referenced by the policy.
    • Any conditional clauses, such as when or unless clauses.

    You can't change the following elements:

    • Changing from StaticPolicy to TemplateLinkedPolicy.
    • The effect (permit or forbid) of the policy.
    • The principal referenced by the policy.
    • The resource referenced by the policy.
    *)
  2. description : static_policy_description option;
    (*

    Specifies the description to be added to or replaced on the static policy.

    *)
}

Contains information about an update to a static policy.

type nonrec policy_store_id = string
type nonrec policy_template_id = string
type nonrec timestamp_format = Smaws_Lib.CoreTypes.Timestamp.t
type nonrec update_policy_template_output = {
  1. last_updated_date : timestamp_format;
    (*

    The date and time that the policy template was most recently updated.

    *)
  2. created_date : timestamp_format;
    (*

    The date and time that the policy template was originally created.

    *)
  3. policy_template_id : policy_template_id;
    (*

    The ID of the updated policy template.

    *)
  4. policy_store_id : policy_store_id;
    (*

    The ID of the policy store that contains the updated policy template.

    *)
}
type nonrec policy_template_description = string
type nonrec policy_template_name = string
type nonrec update_policy_template_input = {
  1. name : policy_template_name option;
    (*

    Specifies a name for the policy template that is unique among all policy templates within the policy store. You can use the name in place of the policy template ID in API operations that reference the policy template. The name must be prefixed with name/.

    If you don't include the name in an update request, the existing name is unchanged. To remove a name, set it to an empty string ("").

    If you specify a name that is already associated with another policy template in the policy store, you receive a ConflictException error.

    *)
  2. statement : policy_statement;
    (*

    Specifies new statement content written in Cedar policy language to replace the current body of the policy template.

    You can change only the following elements of the policy body:

    • The action referenced by the policy template.
    • Any conditional clauses, such as when or unless clauses.

    You can't change the following elements:

    • The effect (permit or forbid) of the policy template.
    • The principal referenced by the policy template.
    • The resource referenced by the policy template.
    *)
  3. description : policy_template_description option;
    (*

    Specifies a new description to apply to the policy template.

    *)
  4. policy_template_id : policy_template_id;
    (*

    Specifies the ID of the policy template that you want to update.

    You can use the policy template name in place of the policy template ID. When using a name, prefix it with name/. For example:

    • ID: PTEXAMPLEabcdefg111111
    • Name: name/example-policy-template
    *)
  5. policy_store_id : policy_store_id;
    (*

    Specifies the ID of the policy store that contains the policy template that you want to update.

    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.

    *)
}
type nonrec resource_conflict = {
  1. resource_type : resource_type;
    (*

    The type of the resource involved in a conflict.

    *)
  2. resource_id : Smaws_Lib.Smithy_api.Types.string_;
    (*

    The unique identifier of the resource involved in a conflict.

    *)
}

Contains information about a resource conflict.

type nonrec resource_conflict_list = resource_conflict list
type nonrec conflict_exception = {
  1. resources : resource_conflict_list;
    (*

    The list of resources referenced with this failed request.

    *)
  2. message : Smaws_Lib.Smithy_api.Types.string_;
}

The request failed because another request to modify a resource occurred at the same time.

type nonrec resource_arn = string
type nonrec update_policy_store_output = {
  1. last_updated_date : timestamp_format;
    (*

    The date and time that the policy store was most recently updated.

    *)
  2. created_date : timestamp_format;
    (*

    The date and time that the policy store was originally created.

    *)
  3. arn : resource_arn;
    (*

    The Amazon Resource Name (ARN) of the updated policy store.

    *)
  4. policy_store_id : policy_store_id;
    (*

    The ID of the updated policy store.

    *)
}
type nonrec deletion_protection =
  1. | DISABLED
  2. | ENABLED
type nonrec policy_store_description = string
type nonrec update_policy_store_input = {
  1. description : policy_store_description option;
    (*

    Descriptive text that you can provide to help with identification of the current policy store.

    *)
  2. deletion_protection : deletion_protection option;
    (*

    Specifies whether the policy store can be deleted. If enabled, the policy store can't be deleted.

    When you call UpdatePolicyStore, this parameter is unchanged unless explicitly included in the call.

    *)
  3. validation_settings : validation_settings;
    (*

    A structure that defines the validation settings that want to enable for the policy store.

    *)
  4. policy_store_id : policy_store_id;
    (*

    Specifies the ID of the policy store that you want to update

    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.

    *)
}
type nonrec policy_id = string
type nonrec policy_type =
  1. | TEMPLATE_LINKED
  2. | STATIC
type nonrec entity_type = string
type nonrec entity_id = string
type nonrec entity_identifier = {
  1. entity_id : entity_id;
    (*

    The identifier of an entity.

    "entityId":"{i identifier}"
    *)
  2. entity_type : entity_type;
    (*

    The type of an entity.

    Example:

    "entityType":"{i typeName}"
    *)
}

Contains the identifier of an entity, including its ID and type.

This data type is used as a request parameter for IsAuthorized operation, and as a response parameter for the CreatePolicy, GetPolicy, and UpdatePolicy operations.

Example:

\{"entityId":"{i string}","entityType":"{i string}"\}
type nonrec action_type = string
type nonrec action_id = string
type nonrec action_identifier = {
  1. action_id : action_id;
    (*

    The ID of an action.

    *)
  2. action_type : action_type;
    (*

    The type of an action.

    *)
}

Contains information about an action for a request for which an authorization decision is made.

This data type is used as a request parameter to the IsAuthorized, BatchIsAuthorized, and IsAuthorizedWithToken operations.

Example: { "actionId": "<action name>", "actionType": "Action" }

type nonrec action_identifier_list = action_identifier list
type nonrec policy_effect =
  1. | FORBID
  2. | PERMIT
type nonrec update_policy_output = {
  1. effect_ : policy_effect option;
    (*

    The effect of the decision that a policy returns to an authorization request. For example, "effect": "Permit".

    *)
  2. last_updated_date : timestamp_format;
    (*

    The date and time that the policy was most recently updated.

    *)
  3. created_date : timestamp_format;
    (*

    The date and time that the policy was originally created.

    *)
  4. actions : action_identifier_list option;
    (*

    The action that a policy permits or forbids. For example, {"actions": [{"actionId": "ViewPhoto", "actionType": "PhotoFlash::Action"}, {"entityID": "SharePhoto", "entityType": "PhotoFlash::Action"}]}.

    *)
  5. resource : entity_identifier option;
    (*

    The resource specified in the policy's scope. This element isn't included in the response when Resource isn't present in the policy content.

    *)
  6. principal : entity_identifier option;
    (*

    The principal specified in the policy's scope. This element isn't included in the response when Principal isn't present in the policy content.

    *)
  7. policy_type : policy_type;
    (*

    The type of the policy that was updated.

    *)
  8. policy_id : policy_id;
    (*

    The ID of the policy that was updated.

    *)
  9. policy_store_id : policy_store_id;
    (*

    The ID of the policy store that contains the policy that was updated.

    *)
}
type nonrec update_policy_definition =
  1. | Static of update_static_policy_definition
    (*

    Contains details about the updates to be applied to a static policy.

    *)

Contains information about updates to be applied to a policy.

This data type is used as a request parameter in the UpdatePolicy operation.

type nonrec policy_name = string
type nonrec update_policy_input = {
  1. name : policy_name option;
    (*

    Specifies a name for the policy that is unique among all policies within the policy store. You can use the name in place of the policy ID in API operations that reference the policy. The name must be prefixed with name/.

    If you don't include the name in an update request, the existing name is unchanged. To remove a name, set it to an empty string ("").

    If you specify a name that is already associated with another policy in the policy store, you receive a ConflictException error.

    *)
  2. definition : update_policy_definition option;
    (*

    Specifies the updated policy content that you want to replace on the specified policy. The content must be valid Cedar policy language text.

    If you don't specify this parameter, the existing policy definition remains unchanged.

    You can change only the following elements from the policy definition:

    • The action referenced by the policy.
    • Any conditional clauses, such as when or unless clauses.

    You can't change the following elements:

    • Changing from static to templateLinked.
    • Changing the effect of the policy from permit or forbid.
    • The principal referenced by the policy.
    • The resource referenced by the policy.
    *)
  3. policy_id : policy_id;
    (*

    Specifies the ID of the policy that you want to update. To find this value, you can use ListPolicies.

    You can use the policy name in place of the policy ID. When using a name, prefix it with name/. For example:

    • ID: SPEXAMPLEabcdefg111111
    • Name: name/example-policy
    *)
  4. policy_store_id : policy_store_id;
    (*

    Specifies the ID of the policy store that contains the policy that you want to update.

    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.

    *)
}
type nonrec service_quota_exceeded_exception = {
  1. quota_code : Smaws_Lib.Smithy_api.Types.string_ option;
    (*

    The quota code recognized by the Amazon Web Services Service Quotas service.

    *)
  2. service_code : Smaws_Lib.Smithy_api.Types.string_ option;
    (*

    The code for the Amazon Web Services service that owns the quota.

    *)
  3. resource_type : resource_type;
    (*

    The resource type of the resource referenced in the failed request.

    *)
  4. resource_id : Smaws_Lib.Smithy_api.Types.string_ option;
    (*

    The unique ID of the resource referenced in the failed request.

    *)
  5. message : Smaws_Lib.Smithy_api.Types.string_;
}

The request failed because it would cause a service quota to be exceeded.

type nonrec claim = string
type nonrec audience = string
type nonrec audiences = audience list
type nonrec update_open_id_connect_access_token_configuration = {
  1. audiences : audiences option;
    (*

    The access token aud claim values that you want to accept in your policy store. For example, https://myapp.example.com, https://myapp2.example.com.

    *)
  2. principal_id_claim : claim option;
    (*

    The claim that determines the principal in OIDC access tokens. For example, sub.

    *)
}

The configuration of an OpenID Connect (OIDC) identity source for handling access token claims. Contains the claim that you want to identify as the principal in an authorization request, and the values of the aud claim, or audiences, that you want to accept.

This data type is part of a UpdateOpenIdConnectTokenSelection structure, which is a parameter to UpdateIdentitySource.

type nonrec client_id = string
type nonrec client_ids = client_id list
type nonrec update_open_id_connect_identity_token_configuration = {
  1. client_ids : client_ids option;
    (*

    The ID token audience, or client ID, claim values that you want to accept in your policy store from an OIDC identity provider. For example, 1example23456789, 2example10111213.

    *)
  2. principal_id_claim : claim option;
    (*

    The claim that determines the principal in OIDC access tokens. For example, sub.

    *)
}

The configuration of an OpenID Connect (OIDC) identity source for handling identity (ID) token claims. Contains the claim that you want to identify as the principal in an authorization request, and the values of the aud claim, or audiences, that you want to accept.

This data type is part of a UpdateOpenIdConnectTokenSelection structure, which is a parameter to UpdateIdentitySource.

type nonrec update_open_id_connect_token_selection =
  1. | IdentityTokenOnly of update_open_id_connect_identity_token_configuration
    (*

    The OIDC configuration for processing identity (ID) tokens. Contains allowed client ID claims, for example 1example23456789, and the claim that you want to map to the principal, for example sub.

    *)
  2. | AccessTokenOnly of update_open_id_connect_access_token_configuration
    (*

    The OIDC configuration for processing access tokens. Contains allowed audience claims, for example https://auth.example.com, and the claim that you want to map to the principal, for example sub.

    *)

The token type that you want to process from your OIDC identity provider. Your policy store can process either identity (ID) or access tokens from a given OIDC identity source.

This data type is part of a UpdateOpenIdConnectConfiguration structure, which is a parameter to UpdateIdentitySource.

type nonrec group_entity_type = string
type nonrec update_open_id_connect_group_configuration = {
  1. group_entity_type : group_entity_type;
    (*

    The policy store entity type that you want to map your users' group claim to. For example, MyCorp::UserGroup. A group entity type is an entity that can have a user entity type as a member.

    *)
  2. group_claim : claim;
    (*

    The token claim that you want Verified Permissions to interpret as group membership. For example, groups.

    *)
}

The claim in OIDC identity provider tokens that indicates a user's group membership, and the entity type that you want to map it to. For example, this object can map the contents of a groups claim to MyCorp::UserGroup.

This data type is part of a UpdateOpenIdConnectConfiguration structure, which is a parameter to UpdateIdentitySource.

type nonrec issuer = string
type nonrec entity_id_prefix = string
type nonrec update_open_id_connect_configuration = {
  1. token_selection : update_open_id_connect_token_selection;
    (*

    The token type that you want to process from your OIDC identity provider. Your policy store can process either identity (ID) or access tokens from a given OIDC identity source.

    *)
  2. group_configuration : update_open_id_connect_group_configuration option;
    (*

    The claim in OIDC identity provider tokens that indicates a user's group membership, and the entity type that you want to map it to. For example, this object can map the contents of a groups claim to MyCorp::UserGroup.

    *)
  3. entity_id_prefix : entity_id_prefix option;
    (*

    A descriptive string that you want to prefix to user entities from your OIDC identity provider. For example, if you set an entityIdPrefix of MyOIDCProvider, you can reference principals in your policies in the format MyCorp::User::MyOIDCProvider|Carlos.

    *)
  4. issuer : issuer;
    (*

    The issuer URL of an OIDC identity provider. This URL must have an OIDC discovery endpoint at the path .well-known/openid-configuration.

    *)
}

Contains configuration details of an OpenID Connect (OIDC) identity provider, or identity source, that Verified Permissions can use to generate entities from authenticated identities. It specifies the issuer URL, token type that you want to use, and policy store entity details.

This data type is part of a UpdateConfiguration structure, which is a parameter to UpdateIdentitySource.

type nonrec identity_source_id = string
type nonrec update_identity_source_output = {
  1. policy_store_id : policy_store_id;
    (*

    The ID of the policy store that contains the updated identity source.

    *)
  2. last_updated_date : timestamp_format;
    (*

    The date and time that the identity source was most recently updated.

    *)
  3. identity_source_id : identity_source_id;
    (*

    The ID of the updated identity source.

    *)
  4. created_date : timestamp_format;
    (*

    The date and time that the updated identity source was originally created.

    *)
}
type nonrec update_cognito_group_configuration = {
  1. group_entity_type : group_entity_type;
    (*

    The name of the schema entity type that's mapped to the user pool group. Defaults to AWS::CognitoGroup.

    *)
}

The user group entities from an Amazon Cognito user pool identity source.

type nonrec update_cognito_user_pool_configuration = {
  1. group_configuration : update_cognito_group_configuration option;
    (*

    The configuration of the user groups from an Amazon Cognito user pool identity source.

    *)
  2. client_ids : client_ids option;
    (*

    The client ID of an app client that is configured for the specified Amazon Cognito user pool.

    *)
  3. user_pool_arn : user_pool_arn;
    (*

    The Amazon Resource Name (ARN) of the Amazon Cognito user pool associated with this identity source.

    *)
}

Contains configuration details of a Amazon Cognito user pool for use with an identity source.

type nonrec update_configuration =
  1. | OpenIdConnectConfiguration of update_open_id_connect_configuration
    (*

    Contains configuration details of an OpenID Connect (OIDC) identity provider, or identity source, that Verified Permissions can use to generate entities from authenticated identities. It specifies the issuer URL, token type that you want to use, and policy store entity details.

    *)
  2. | CognitoUserPoolConfiguration of update_cognito_user_pool_configuration
    (*

    Contains configuration details of a Amazon Cognito user pool.

    *)

Contains an update to replace the configuration in an existing identity source.

type nonrec principal_entity_type = string
type nonrec update_identity_source_input = {
  1. principal_entity_type : principal_entity_type option;
    (*

    Specifies the data type of principals generated for identities authenticated by the identity source.

    *)
  2. update_configuration : update_configuration;
    (*

    Specifies the details required to communicate with the identity provider (IdP) associated with this identity source.

    *)
  3. identity_source_id : identity_source_id;
    (*

    Specifies the ID of the identity source that you want to update.

    *)
  4. policy_store_id : policy_store_id;
    (*

    Specifies the ID of the policy store that contains the identity source that you want to update.

    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.

    *)
}
type nonrec token = string
type nonrec template_linked_policy_definition_item = {
  1. resource : entity_identifier option;
    (*

    The resource associated with this template-linked policy. Verified Permissions substitutes this resource for the ?resource placeholder in the policy template when it evaluates an authorization request.

    *)
  2. principal : entity_identifier option;
    (*

    The principal associated with this template-linked policy. Verified Permissions substitutes this principal for the ?principal placeholder in the policy template when it evaluates an authorization request.

    *)
  3. policy_template_id : policy_template_id;
    (*

    The unique identifier of the policy template used to create this policy.

    *)
}

Contains information about a policy created by instantiating a policy template.

type nonrec template_linked_policy_definition_detail = {
  1. resource : entity_identifier option;
    (*

    The resource associated with this template-linked policy. Verified Permissions substitutes this resource for the ?resource placeholder in the policy template when it evaluates an authorization request.

    *)
  2. principal : entity_identifier option;
    (*

    The principal associated with this template-linked policy. Verified Permissions substitutes this principal for the ?principal placeholder in the policy template when it evaluates an authorization request.

    *)
  3. policy_template_id : policy_template_id;
    (*

    The unique identifier of the policy template used to create this policy.

    *)
}

Contains information about a policy that was created by instantiating a policy template.

type nonrec template_linked_policy_definition = {
  1. resource : entity_identifier option;
    (*

    The resource associated with this template-linked policy. Verified Permissions substitutes this resource for the ?resource placeholder in the policy template when it evaluates an authorization request.

    *)
  2. principal : entity_identifier option;
    (*

    The principal associated with this template-linked policy. Verified Permissions substitutes this principal for the ?principal placeholder in the policy template when it evaluates an authorization request.

    *)
  3. policy_template_id : policy_template_id;
    (*

    The unique identifier of the policy template used to create this policy.

    *)
}

Contains information about a policy created by instantiating a policy template.

type nonrec string_attribute = string
type nonrec static_policy_definition_item = {
  1. description : static_policy_description option;
    (*

    A description of the static policy.

    *)
}

A structure that contains details about a static policy. It includes the description and policy statement.

This data type is used within a PolicyDefinition structure as part of a request parameter for the CreatePolicy operation.

type nonrec static_policy_definition_detail = {
  1. statement : policy_statement;
    (*

    The content of the static policy written in the Cedar policy language.

    *)
  2. description : static_policy_description option;
    (*

    A description of the static policy.

    *)
}

A structure that contains details about a static policy. It includes the description and policy body.

This data type is used within a PolicyDefinition structure as part of a request parameter for the CreatePolicy operation.

type nonrec static_policy_definition = {
  1. statement : policy_statement;
    (*

    The policy content of the static policy, written in the Cedar policy language.

    *)
  2. description : static_policy_description option;
    (*

    The description of the static policy.

    *)
}

Contains information about a static policy.

This data type is used as a field that is part of the PolicyDefinitionDetail type.

type nonrec boolean_attribute = bool
type nonrec long_attribute = Smaws_Lib.CoreTypes.Int64.t
type nonrec ip_addr = string
type nonrec decimal = string
type nonrec datetime_attribute = string
type nonrec duration = string
type attribute_value =
  1. | Duration of duration
    (*

    An attribute value of duration type.

    Example: {"duration": "1h30m"}

    *)
  2. | Datetime of datetime_attribute
    (*

    An attribute value of datetime type.

    Example: {"datetime": "2024-10-15T11:35:00Z"}

    *)
  3. | Decimal of decimal
    (*

    An attribute value of decimal type.

    Example: {"decimal": "1.1"}

    *)
  4. | Ipaddr of ip_addr
    (*

    An attribute value of ipaddr type.

    Example: {"ip": "192.168.1.100"}

    *)
  5. | Record of record_attribute
    (*

    An attribute value of Record type.

    Example: {"record": { "keyName": {} } }

    *)
  6. | Set of set_attribute
    (*

    An attribute value of Set type.

    Example: {"set": [ {} ] }

    *)
  7. | String of string_attribute
    (*

    An attribute value of String type.

    Example: {"string": "abc"}

    *)
  8. | Long of long_attribute
    (*

    An attribute value of Long type.

    Example: {"long": 0}

    *)
  9. | EntityIdentifier of entity_identifier
    (*

    An attribute value of type EntityIdentifier.

    Example: {"entityIdentifier": { "entityId": "alice", "entityType": "User"} }

    *)
  10. | Boolean of boolean_attribute
    (*

    An attribute value of Boolean type.

    Example: {"boolean": true}

    *)

The value of an attribute.

Contains information about the runtime context for a request for which an authorization decision is made.

This data type is used as a member of the ContextDefinition structure which is used as a request parameter for the IsAuthorized, BatchIsAuthorized, and IsAuthorizedWithToken operations.

and record_attribute = (Smaws_Lib.Smithy_api.Types.string_ * attribute_value) list
and set_attribute = attribute_value list
type nonrec schema_json = string
type nonrec schema_definition =
  1. | CedarJson of schema_json
    (*

    A JSON string representation of the schema supported by applications that use this policy store. To delete the schema, run PutSchema with {} for this parameter. For more information, see Policy store schema in the Amazon Verified Permissions User Guide.

    *)

Contains a list of principal types, resource types, and actions that can be specified in policies stored in the same policy store. If the validation mode for the policy store is set to STRICT, then policies that can't be validated by this schema are rejected by Verified Permissions and can't be stored in the policy store.

type nonrec namespace = string
type nonrec namespace_list = namespace list
type nonrec put_schema_output = {
  1. last_updated_date : timestamp_format;
    (*

    The date and time that the schema was last updated.

    *)
  2. created_date : timestamp_format;
    (*

    The date and time that the schema was originally created.

    *)
  3. namespaces : namespace_list;
    (*

    Identifies the namespaces of the entities referenced by this schema.

    *)
  4. policy_store_id : policy_store_id;
    (*

    The unique ID of the policy store that contains the schema.

    *)
}
type nonrec put_schema_input = {
  1. definition : schema_definition;
    (*

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

    *)
  2. policy_store_id : policy_store_id;
    (*

    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.

    *)
}
type nonrec policy_template_item = {
  1. name : policy_template_name option;
    (*

    The name of the policy template, if one was assigned when the policy template was created or last updated.

    *)
  2. last_updated_date : timestamp_format;
    (*

    The date and time that the policy template was most recently updated.

    *)
  3. created_date : timestamp_format;
    (*

    The date and time that the policy template was created.

    *)
  4. description : policy_template_description option;
    (*

    The description attached to the policy template.

    *)
  5. policy_template_id : policy_template_id;
    (*

    The unique identifier of the policy template.

    *)
  6. policy_store_id : policy_store_id;
    (*

    The unique identifier of the policy store that contains the template.

    *)
}

Contains details about a policy template

This data type is used as a response parameter for the ListPolicyTemplates operation.

type nonrec policy_templates_list = policy_template_item list
type nonrec policy_template = Smaws_Lib.CoreTypes.Resource.t
type nonrec policy_store_item = {
  1. description : policy_store_description option;
    (*

    Descriptive text that you can provide to help with identification of the current policy store.

    *)
  2. last_updated_date : timestamp_format option;
    (*

    The date and time the policy store was most recently updated.

    *)
  3. created_date : timestamp_format;
    (*

    The date and time the policy was created.

    *)
  4. arn : resource_arn;
    (*

    The Amazon Resource Name (ARN) of the policy store.

    *)
  5. policy_store_id : policy_store_id;
    (*

    The unique identifier of the policy store.

    *)
}

Contains information about a policy store.

This data type is used as a response parameter for the ListPolicyStores operation.

type nonrec policy_store_list = policy_store_item list
type nonrec alias = string
type nonrec alias_state =
  1. | PENDING_DELETION
  2. | ACTIVE
type nonrec policy_store_alias_item = {
  1. state : alias_state;
    (*

    The state of the policy store alias. Policy Store Aliases in the Active state can be used normally. When a policy store alias is deleted, it enters the PendingDeletion state. Policy Store Aliases in the PendingDeletion state cannot be used, and creating a policy store alias with the same alias name will fail.

    *)
  2. created_at : timestamp_format;
    (*

    The date and time the policy store alias was created.

    *)
  3. alias_arn : resource_arn;
    (*

    The Amazon Resource Name (ARN) of the policy store alias.

    *)
  4. policy_store_id : policy_store_id;
    (*

    The ID of the policy store associated with the alias.

    *)
  5. alias_name : alias;
    (*

    The name of the policy store alias.

    *)
}

Contains information about a policy store alias.

This data type is used as a response parameter for the ListPolicyStoreAliases operation.

type nonrec policy_store_alias_list = policy_store_alias_item list
type nonrec policy_store_alias_filter = {
  1. policy_store_id : policy_store_id option;
    (*

    The ID of the policy store to filter by. Only policy store aliases associated with this policy store are returned.

    *)
}

Contains filters for the ListPolicyStoreAliases operation.

type nonrec policy_store_alias = Smaws_Lib.CoreTypes.Resource.t
type nonrec policy_store = Smaws_Lib.CoreTypes.Resource.t
type nonrec policy_definition_item =
  1. | TemplateLinked of template_linked_policy_definition_item
    (*

    Information about a template-linked policy that was created by instantiating a policy template.

    *)
  2. | Static of static_policy_definition_item
    (*

    Information about a static policy that wasn't created with a policy template.

    *)

A structure that describes a PolicyDefinintion. It will always have either an StaticPolicy or a TemplateLinkedPolicy element.

This data type is used as a response parameter for the CreatePolicy and ListPolicies operations.

type nonrec policy_item = {
  1. name : policy_name option;
    (*

    The name of the policy, if one was assigned when the policy was created or last updated.

    *)
  2. effect_ : policy_effect option;
    (*

    The effect of the decision that a policy returns to an authorization request. For example, "effect": "Permit".

    *)
  3. last_updated_date : timestamp_format;
    (*

    The date and time the policy was most recently updated.

    *)
  4. created_date : timestamp_format;
    (*

    The date and time the policy was created.

    *)
  5. definition : policy_definition_item;
    (*

    The policy definition of an item in the list of policies returned.

    *)
  6. actions : action_identifier_list option;
    (*

    The action that a policy permits or forbids. For example, {"actions": [{"actionId": "ViewPhoto", "actionType": "PhotoFlash::Action"}, {"entityID": "SharePhoto", "entityType": "PhotoFlash::Action"}]}.

    *)
  7. resource : entity_identifier option;
    (*

    The resource associated with the policy.

    *)
  8. principal : entity_identifier option;
    (*

    The principal associated with the policy.

    *)
  9. policy_type : policy_type;
    (*

    The type of the policy. This is one of the following values:

    • STATIC
    • TEMPLATE_LINKED
    *)
  10. policy_id : policy_id;
    (*

    The identifier of the policy you want information about.

    *)
  11. policy_store_id : policy_store_id;
    (*

    The identifier of the policy store where the policy you want information about is stored.

    *)
}

Contains information about a policy.

This data type is used as a response parameter for the ListPolicies operation.

type nonrec policy_list = policy_item list
type nonrec entity_reference =
  1. | Identifier of entity_identifier
    (*

    The identifier of the entity. It can consist of either an EntityType and EntityId, a principal, or a resource.

    *)
  2. | Unspecified of Smaws_Lib.Smithy_api.Types.boolean_
    (*

    Used to indicate that a principal or resource is not specified. This can be used to search for policies that are not associated with a specific principal or resource.

    *)

Contains information about a principal or resource that can be referenced in a Cedar policy.

This data type is used as part of the PolicyFilter structure that is used as a request parameter for the ListPolicies operation..

type nonrec policy_filter = {
  1. policy_template_id : policy_template_id option;
    (*

    Filters the output to only template-linked policies that were instantiated from the specified policy template.

    *)
  2. policy_type : policy_type option;
    (*

    Filters the output to only policies of the specified type.

    *)
  3. resource : entity_reference option;
    (*

    Filters the output to only policies that reference the specified resource.

    *)
  4. principal : entity_reference option;
    (*

    Filters the output to only policies that reference the specified principal.

    *)
}

Contains information about a filter to refine policies returned in a query.

This data type is used as a response parameter for the ListPolicies operation.

type nonrec policy_definition_detail =
  1. | TemplateLinked of template_linked_policy_definition_detail
    (*

    Information about a template-linked policy that was created by instantiating a policy template.

    *)
  2. | Static of static_policy_definition_detail
    (*

    Information about a static policy that wasn't created with a policy template.

    *)

A structure that describes a policy definition. It must always have either an static or a templateLinked element.

This data type is used as a response parameter for the GetPolicy operation.

type nonrec policy_definition =
  1. | TemplateLinked of template_linked_policy_definition
    (*

    A structure that describes a policy that was instantiated from a template. The template can specify placeholders for principal and resource. When you use CreatePolicy to create a policy from a template, you specify the exact principal and resource to use for the instantiated policy.

    *)
  2. | Static of static_policy_definition
    (*

    A structure that describes a static policy. An static policy doesn't use a template or allow placeholders for entities.

    *)

A structure that contains the details for a Cedar policy definition. It includes the policy type, a description, and a policy body. This is a top level data type used to create a policy.

This data type is used as a request parameter for the CreatePolicy operation. This structure must always have either an static or a templateLinked element.

type nonrec policy = Smaws_Lib.CoreTypes.Resource.t
type nonrec parent_list = entity_identifier list
type nonrec open_id_issuer =
  1. | COGNITO
type nonrec open_id_connect_access_token_configuration_item = {
  1. audiences : audiences option;
    (*

    The access token aud claim values that you want to accept in your policy store. For example, https://myapp.example.com, https://myapp2.example.com.

    *)
  2. principal_id_claim : claim option;
    (*

    The claim that determines the principal in OIDC access tokens. For example, sub.

    *)
}

The configuration of an OpenID Connect (OIDC) identity source for handling access token claims. Contains the claim that you want to identify as the principal in an authorization request, and the values of the aud claim, or audiences, that you want to accept.

This data type is part of a OpenIdConnectTokenSelectionItem structure, which is a parameter of ListIdentitySources.

type nonrec open_id_connect_identity_token_configuration_item = {
  1. client_ids : client_ids option;
    (*

    The ID token audience, or client ID, claim values that you want to accept in your policy store from an OIDC identity provider. For example, 1example23456789, 2example10111213.

    *)
  2. principal_id_claim : claim option;
    (*

    The claim that determines the principal in OIDC access tokens. For example, sub.

    *)
}

The configuration of an OpenID Connect (OIDC) identity source for handling identity (ID) token claims. Contains the claim that you want to identify as the principal in an authorization request, and the values of the aud claim, or audiences, that you want to accept.

This data type is part of a OpenIdConnectTokenSelectionItem structure, which is a parameter of ListIdentitySources.

type nonrec open_id_connect_token_selection_item =
  1. | IdentityTokenOnly of open_id_connect_identity_token_configuration_item
    (*

    The OIDC configuration for processing identity (ID) tokens. Contains allowed client ID claims, for example 1example23456789, and the claim that you want to map to the principal, for example sub.

    *)
  2. | AccessTokenOnly of open_id_connect_access_token_configuration_item
    (*

    The OIDC configuration for processing access tokens. Contains allowed audience claims, for example https://auth.example.com, and the claim that you want to map to the principal, for example sub.

    *)

The token type that you want to process from your OIDC identity provider. Your policy store can process either identity (ID) or access tokens from a given OIDC identity source.

This data type is part of a OpenIdConnectConfigurationItem structure, which is a parameter of ListIdentitySources.

type nonrec open_id_connect_access_token_configuration_detail = {
  1. audiences : audiences option;
    (*

    The access token aud claim values that you want to accept in your policy store. For example, https://myapp.example.com, https://myapp2.example.com.

    *)
  2. principal_id_claim : claim option;
    (*

    The claim that determines the principal in OIDC access tokens. For example, sub.

    *)
}

The configuration of an OpenID Connect (OIDC) identity source for handling access token claims. Contains the claim that you want to identify as the principal in an authorization request, and the values of the aud claim, or audiences, that you want to accept.

This data type is part of a OpenIdConnectTokenSelectionDetail structure, which is a parameter of GetIdentitySource.

type nonrec open_id_connect_identity_token_configuration_detail = {
  1. client_ids : client_ids option;
    (*

    The ID token audience, or client ID, claim values that you want to accept in your policy store from an OIDC identity provider. For example, 1example23456789, 2example10111213.

    *)
  2. principal_id_claim : claim option;
    (*

    The claim that determines the principal in OIDC access tokens. For example, sub.

    *)
}

The configuration of an OpenID Connect (OIDC) identity source for handling identity (ID) token claims. Contains the claim that you want to identify as the principal in an authorization request, and the values of the aud claim, or audiences, that you want to accept.

This data type is part of a OpenIdConnectTokenSelectionDetail structure, which is a parameter of GetIdentitySource.

type nonrec open_id_connect_token_selection_detail =
  1. | IdentityTokenOnly of open_id_connect_identity_token_configuration_detail
    (*

    The OIDC configuration for processing identity (ID) tokens. Contains allowed client ID claims, for example 1example23456789, and the claim that you want to map to the principal, for example sub.

    *)
  2. | AccessTokenOnly of open_id_connect_access_token_configuration_detail
    (*

    The OIDC configuration for processing access tokens. Contains allowed audience claims, for example https://auth.example.com, and the claim that you want to map to the principal, for example sub.

    *)

The token type that you want to process from your OIDC identity provider. Your policy store can process either identity (ID) or access tokens from a given OIDC identity source.

This data type is part of a OpenIdConnectConfigurationDetail structure, which is a parameter of GetIdentitySource.

type nonrec open_id_connect_access_token_configuration = {
  1. audiences : audiences option;
    (*

    The access token aud claim values that you want to accept in your policy store. For example, https://myapp.example.com, https://myapp2.example.com.

    *)
  2. principal_id_claim : claim option;
    (*

    The claim that determines the principal in OIDC access tokens. For example, sub.

    *)
}

The configuration of an OpenID Connect (OIDC) identity source for handling access token claims. Contains the claim that you want to identify as the principal in an authorization request, and the values of the aud claim, or audiences, that you want to accept.

This data type is part of a OpenIdConnectTokenSelection structure, which is a parameter of CreateIdentitySource.

type nonrec open_id_connect_identity_token_configuration = {
  1. client_ids : client_ids option;
    (*

    The ID token audience, or client ID, claim values that you want to accept in your policy store from an OIDC identity provider. For example, 1example23456789, 2example10111213.

    *)
  2. principal_id_claim : claim option;
    (*

    The claim that determines the principal in OIDC access tokens. For example, sub.

    *)
}

The configuration of an OpenID Connect (OIDC) identity source for handling identity (ID) token claims. Contains the claim that you want to identify as the principal in an authorization request, and the values of the aud claim, or audiences, that you want to accept.

This data type is part of a OpenIdConnectTokenSelection structure, which is a parameter of CreateIdentitySource.

type nonrec open_id_connect_token_selection =
  1. | IdentityTokenOnly of open_id_connect_identity_token_configuration
    (*

    The OIDC configuration for processing identity (ID) tokens. Contains allowed client ID claims, for example 1example23456789, and the claim that you want to map to the principal, for example sub.

    *)
  2. | AccessTokenOnly of open_id_connect_access_token_configuration
    (*

    The OIDC configuration for processing access tokens. Contains allowed audience claims, for example https://auth.example.com, and the claim that you want to map to the principal, for example sub.

    *)

The token type that you want to process from your OIDC identity provider. Your policy store can process either identity (ID) or access tokens from a given OIDC identity source.

This data type is part of a OpenIdConnectConfiguration structure, which is a parameter of CreateIdentitySource.

type nonrec open_id_connect_group_configuration_item = {
  1. group_entity_type : group_entity_type;
    (*

    The policy store entity type that you want to map your users' group claim to. For example, MyCorp::UserGroup. A group entity type is an entity that can have a user entity type as a member.

    *)
  2. group_claim : claim;
    (*

    The token claim that you want Verified Permissions to interpret as group membership. For example, groups.

    *)
}

The claim in OIDC identity provider tokens that indicates a user's group membership, and the entity type that you want to map it to. For example, this object can map the contents of a groups claim to MyCorp::UserGroup.

This data type is part of a OpenIdConnectConfigurationItem structure, which is a parameter of ListIdentitySourcea.

type nonrec open_id_connect_group_configuration_detail = {
  1. group_entity_type : group_entity_type;
    (*

    The policy store entity type that you want to map your users' group claim to. For example, MyCorp::UserGroup. A group entity type is an entity that can have a user entity type as a member.

    *)
  2. group_claim : claim;
    (*

    The token claim that you want Verified Permissions to interpret as group membership. For example, groups.

    *)
}

The claim in OIDC identity provider tokens that indicates a user's group membership, and the entity type that you want to map it to. For example, this object can map the contents of a groups claim to MyCorp::UserGroup.

This data type is part of a OpenIdConnectConfigurationDetail structure, which is a parameter of GetIdentitySource.

type nonrec open_id_connect_group_configuration = {
  1. group_entity_type : group_entity_type;
    (*

    The policy store entity type that you want to map your users' group claim to. For example, MyCorp::UserGroup. A group entity type is an entity that can have a user entity type as a member.

    *)
  2. group_claim : claim;
    (*

    The token claim that you want Verified Permissions to interpret as group membership. For example, groups.

    *)
}

The claim in OIDC identity provider tokens that indicates a user's group membership, and the entity type that you want to map it to. For example, this object can map the contents of a groups claim to MyCorp::UserGroup.

This data type is part of a OpenIdConnectConfiguration structure, which is a parameter of CreateIdentitySource.

type nonrec open_id_connect_configuration_item = {
  1. token_selection : open_id_connect_token_selection_item;
    (*

    The token type that you want to process from your OIDC identity provider. Your policy store can process either identity (ID) or access tokens from a given OIDC identity source.

    *)
  2. group_configuration : open_id_connect_group_configuration_item option;
    (*

    The claim in OIDC identity provider tokens that indicates a user's group membership, and the entity type that you want to map it to. For example, this object can map the contents of a groups claim to MyCorp::UserGroup.

    *)
  3. entity_id_prefix : entity_id_prefix option;
    (*

    A descriptive string that you want to prefix to user entities from your OIDC identity provider. For example, if you set an entityIdPrefix of MyOIDCProvider, you can reference principals in your policies in the format MyCorp::User::MyOIDCProvider|Carlos.

    *)
  4. issuer : issuer;
    (*

    The issuer URL of an OIDC identity provider. This URL must have an OIDC discovery endpoint at the path .well-known/openid-configuration.

    *)
}

Contains configuration details of an OpenID Connect (OIDC) identity provider, or identity source, that Verified Permissions can use to generate entities from authenticated identities. It specifies the issuer URL, token type that you want to use, and policy store entity details.

This data type is part of a ConfigurationItem structure, which is a parameter to ListIdentitySources.

type nonrec open_id_connect_configuration_detail = {
  1. token_selection : open_id_connect_token_selection_detail;
    (*

    The token type that you want to process from your OIDC identity provider. Your policy store can process either identity (ID) or access tokens from a given OIDC identity source.

    *)
  2. group_configuration : open_id_connect_group_configuration_detail option;
    (*

    The claim in OIDC identity provider tokens that indicates a user's group membership, and the entity type that you want to map it to. For example, this object can map the contents of a groups claim to MyCorp::UserGroup.

    *)
  3. entity_id_prefix : entity_id_prefix option;
    (*

    A descriptive string that you want to prefix to user entities from your OIDC identity provider. For example, if you set an entityIdPrefix of MyOIDCProvider, you can reference principals in your policies in the format MyCorp::User::MyOIDCProvider|Carlos.

    *)
  4. issuer : issuer;
    (*

    The issuer URL of an OIDC identity provider. This URL must have an OIDC discovery endpoint at the path .well-known/openid-configuration.

    *)
}

Contains configuration details of an OpenID Connect (OIDC) identity provider, or identity source, that Verified Permissions can use to generate entities from authenticated identities. It specifies the issuer URL, token type that you want to use, and policy store entity details.

This data type is part of a ConfigurationDetail structure, which is a parameter to GetIdentitySource.

type nonrec open_id_connect_configuration = {
  1. token_selection : open_id_connect_token_selection;
    (*

    The token type that you want to process from your OIDC identity provider. Your policy store can process either identity (ID) or access tokens from a given OIDC identity source.

    *)
  2. group_configuration : open_id_connect_group_configuration option;
    (*

    The claim in OIDC identity provider tokens that indicates a user's group membership, and the entity type that you want to map it to. For example, this object can map the contents of a groups claim to MyCorp::UserGroup.

    *)
  3. entity_id_prefix : entity_id_prefix option;
    (*

    A descriptive string that you want to prefix to user entities from your OIDC identity provider. For example, if you set an entityIdPrefix of MyOIDCProvider, you can reference principals in your policies in the format MyCorp::User::MyOIDCProvider|Carlos.

    *)
  4. issuer : issuer;
    (*

    The issuer URL of an OIDC identity provider. This URL must have an OIDC discovery endpoint at the path .well-known/openid-configuration.

    *)
}

Contains configuration details of an OpenID Connect (OIDC) identity provider, or identity source, that Verified Permissions can use to generate entities from authenticated identities. It specifies the issuer URL, token type that you want to use, and policy store entity details.

This data type is part of a Configuration structure, which is a parameter to CreateIdentitySource.

type nonrec next_token = string
type nonrec max_results = int
type nonrec list_policy_templates_output = {
  1. policy_templates : policy_templates_list;
    (*

    The list of the policy templates in the specified policy store.

    *)
  2. next_token : next_token option;
    (*

    If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. This indicates that this is the last page of results.

    *)
}
type nonrec list_policy_templates_input = {
  1. max_results : max_results option;
    (*

    Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

    If you do not specify this parameter, the operation defaults to 10 policy templates per response. You can specify a maximum of 50 policy templates per response.

    *)
  2. next_token : next_token option;
    (*

    Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.

    *)
  3. policy_store_id : policy_store_id;
    (*

    Specifies the ID of the policy store that contains the policy templates you want to list.

    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.

    *)
}
type nonrec list_policy_stores_output = {
  1. policy_stores : policy_store_list;
    (*

    The list of policy stores in the account.

    *)
  2. next_token : next_token option;
    (*

    If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. This indicates that this is the last page of results.

    *)
}
type nonrec list_policy_stores_input = {
  1. max_results : max_results option;
    (*

    Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

    If you do not specify this parameter, the operation defaults to 10 policy stores per response. You can specify a maximum of 50 policy stores per response.

    *)
  2. next_token : next_token option;
    (*

    Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.

    *)
}
type nonrec list_policy_store_aliases_output = {
  1. policy_store_aliases : policy_store_alias_list;
    (*

    The list of policy store aliases in the account.

    *)
  2. next_token : next_token option;
    (*

    If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. This indicates that this is the last page of results.

    *)
}
type nonrec list_policy_store_aliases_input = {
  1. filter : policy_store_alias_filter option;
    (*

    Specifies a filter to narrow the results. You can filter by policyStoreId to list only the policy store aliases associated with a specific policy store.

    *)
  2. max_results : max_results option;
    (*

    Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

    If you do not specify this parameter, the operation defaults to 5 policy store aliases per response. You can specify a maximum of 50 policy store aliases per response.

    *)
  3. next_token : next_token option;
    (*

    Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.

    *)
}
type nonrec list_policies_output = {
  1. policies : policy_list;
    (*

    Lists all policies that are available in the specified policy store.

    *)
  2. next_token : next_token option;
    (*

    If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. This indicates that this is the last page of results.

    *)
}
type nonrec list_policies_input = {
  1. filter : policy_filter option;
    (*

    Specifies a filter that limits the response to only policies that match the specified criteria. For example, you list only the policies that reference a specified principal.

    *)
  2. max_results : max_results option;
    (*

    Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

    If you do not specify this parameter, the operation defaults to 10 policies per response. You can specify a maximum of 50 policies per response.

    *)
  3. next_token : next_token option;
    (*

    Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.

    *)
  4. policy_store_id : policy_store_id;
    (*

    Specifies the ID of the policy store you want to list policies from.

    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.

    *)
}
type nonrec discovery_url = string
type nonrec identity_source_item_details = {
  1. open_id_issuer : open_id_issuer option;
    (*

    A string that identifies the type of OIDC service represented by this identity source.

    At this time, the only valid value is cognito.

    *)
  2. discovery_url : discovery_url option;
    (*

    The well-known URL that points to this user pool's OIDC discovery endpoint. This is a URL string in the following format. This URL replaces the placeholders for both the Amazon Web Services Region and the user pool identifier with those appropriate for this user pool.

    https://cognito-idp.{i <region>}.amazonaws.com/{i <user-pool-id>}/.well-known/openid-configuration
    *)
  3. user_pool_arn : user_pool_arn option;
    (*

    The Amazon Cognito user pool whose identities are accessible to this Verified Permissions policy store.

    *)
  4. client_ids : client_ids option;
    (*

    The application client IDs associated with the specified Amazon Cognito user pool that are enabled for this identity source.

    *)
}

A structure that contains configuration of the identity source.

This data type was a response parameter for the ListIdentitySources operation. Replaced by ConfigurationItem.

type nonrec cognito_group_configuration_item = {
  1. group_entity_type : group_entity_type option;
    (*

    The name of the schema entity type that's mapped to the user pool group. Defaults to AWS::CognitoGroup.

    *)
}

The type of entity that a policy store maps to groups from an Amazon Cognito user pool identity source.

This data type is part of an CognitoUserPoolConfigurationItem structure and is a response parameter to ListIdentitySources.

type nonrec cognito_user_pool_configuration_item = {
  1. group_configuration : cognito_group_configuration_item option;
    (*

    The type of entity that a policy store maps to groups from an Amazon Cognito user pool identity source.

    *)
  2. issuer : issuer;
    (*

    The OpenID Connect (OIDC) issuer ID of the Amazon Cognito user pool that contains the identities to be authorized.

    Example: "issuer": "https://cognito-idp.us-east-1.amazonaws.com/us-east-1_1a2b3c4d5"

    *)
  3. client_ids : client_ids;
    (*

    The unique application client IDs that are associated with the specified Amazon Cognito user pool.

    Example: "clientIds": ["&ExampleCogClientId;"]

    *)
  4. user_pool_arn : user_pool_arn;
    (*

    The Amazon Resource Name (ARN) of the Amazon Cognito user pool that contains the identities to be authorized.

    Example: "userPoolArn": "arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5"

    *)
}

The configuration for an identity source that represents a connection to an Amazon Cognito user pool used as an identity provider for Verified Permissions.

This data type is used as a field that is part of the ConfigurationItem structure that is part of the response to ListIdentitySources.

Example:"CognitoUserPoolConfiguration":{"UserPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","ClientIds": ["a1b2c3d4e5f6g7h8i9j0kalbmc"],"groupConfiguration": {"groupEntityType": "MyCorp::Group"}}

type nonrec configuration_item =
  1. | OpenIdConnectConfiguration of open_id_connect_configuration_item
    (*

    Contains configuration details of an OpenID Connect (OIDC) identity provider, or identity source, that Verified Permissions can use to generate entities from authenticated identities. It specifies the issuer URL, token type that you want to use, and policy store entity details.

    Example:"configuration":{"openIdConnectConfiguration":{"issuer":"https://auth.example.com","tokenSelection":{"accessTokenOnly":{"audiences":["https://myapp.example.com","https://myapp2.example.com"],"principalIdClaim":"sub"}},"entityIdPrefix":"MyOIDCProvider","groupConfiguration":{"groupClaim":"groups","groupEntityType":"MyCorp::UserGroup"}}}

    *)
  2. | CognitoUserPoolConfiguration of cognito_user_pool_configuration_item
    (*

    Contains configuration details of a Amazon Cognito user pool that Verified Permissions can use as a source of authenticated identities as entities. It specifies the Amazon Resource Name (ARN) of a Amazon Cognito user pool, the policy store entity that you want to assign to user groups, and one or more application client IDs.

    Example: "configuration":{"cognitoUserPoolConfiguration":{"userPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","clientIds": ["a1b2c3d4e5f6g7h8i9j0kalbmc"],"groupConfiguration": {"groupEntityType": "MyCorp::Group"}}}

    *)

Contains configuration information about an identity source.

This data type is a response parameter to the ListIdentitySources operation.

type nonrec identity_source_item = {
  1. configuration : configuration_item option;
    (*

    Contains configuration information about an identity source.

    *)
  2. principal_entity_type : principal_entity_type;
    (*

    The Cedar entity type of the principals returned from the IdP associated with this identity source.

    *)
  3. policy_store_id : policy_store_id;
    (*

    The identifier of the policy store that contains the identity source.

    *)
  4. last_updated_date : timestamp_format;
    (*

    The date and time the identity source was most recently updated.

    *)
  5. identity_source_id : identity_source_id;
    (*

    The unique identifier of the identity source.

    *)
  6. details : identity_source_item_details option;
    (*

    A structure that contains the details of the associated identity provider (IdP).

    *)
  7. created_date : timestamp_format;
    (*

    The date and time the identity source was originally created.

    *)
}

A structure that defines an identity source.

This data type is a response parameter to the ListIdentitySources operation.

type nonrec identity_sources = identity_source_item list
type nonrec list_identity_sources_output = {
  1. identity_sources : identity_sources;
    (*

    The list of identity sources stored in the specified policy store.

    *)
  2. next_token : next_token option;
    (*

    If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. This indicates that this is the last page of results.

    *)
}
type nonrec list_identity_sources_max_results = int
type nonrec identity_source_filter = {
  1. principal_entity_type : principal_entity_type option;
    (*

    The Cedar entity type of the principals returned by the identity provider (IdP) associated with this identity source.

    *)
}

A structure that defines characteristics of an identity source that you can use to filter.

This data type is a request parameter for the ListIdentityStores operation.

type nonrec identity_source_filters = identity_source_filter list
type nonrec list_identity_sources_input = {
  1. filters : identity_source_filters option;
    (*

    Specifies characteristics of an identity source that you can use to limit the output to matching identity sources.

    *)
  2. max_results : list_identity_sources_max_results option;
    (*

    Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

    If you do not specify this parameter, the operation defaults to 10 identity sources per response. You can specify a maximum of 50 identity sources per response.

    *)
  3. next_token : next_token option;
    (*

    Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.

    *)
  4. policy_store_id : policy_store_id;
    (*

    Specifies the ID of the policy store that contains the identity sources that you want to list.

    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.

    *)
}
type nonrec kms_key = string
type nonrec encryption_context_value = string
type nonrec encryption_context_key = string
type nonrec encryption_context = (encryption_context_key * encryption_context_value) list
type nonrec kms_encryption_state = {
  1. encryption_context : encryption_context;
    (*

    User-defined, additional context added to encryption processes.

    *)
  2. key : kms_key;
    (*

    The customer-managed KMS key Amazon Resource Name (ARN) being used for encryption processes.

    *)
}

A structure that contains the KMS encryption configuration for the policy store. The encryption state shows what customer-managed KMS key is being used to encrypt all resources within the policy store, and any user-defined context key-value pairs added during encryption processes.

This data type is used as a field that is part of the EncryptionState type.

type nonrec kms_encryption_settings = {
  1. encryption_context : encryption_context option;
    (*

    User-defined, additional context to be added to encryption processes.

    *)
  2. key : kms_key;
    (*

    The customer-managed KMS key Amazon Resource Name (ARN), alias or ID to be used for encryption processes.

    Users can provide the full KMS key ARN, a KMS key alias, or a KMS key ID, but it will be mapped to the full KMS key ARN after policy store creation, and referenced when encrypting child resources.

    *)
}

A structure that contains the KMS encryption configuration for the policy store. The encryption settings determine what customer-managed KMS key will be used to encrypt all resources within the policy store, and any user-defined context key-value pairs to append during encryption processes.

This data type is used as a field that is part of the EncryptionSettings type.

type nonrec decision =
  1. | DENY
  2. | ALLOW
type nonrec determining_policy_item = {
  1. policy_id : policy_id;
    (*

    The Id of a policy that determined to an authorization decision.

    Example: "policyId":"SPEXAMPLEabcdefg111111"

    *)
}

Contains information about one of the policies that determined an authorization decision.

This data type is used as an element in a response parameter for the IsAuthorized, BatchIsAuthorized, and IsAuthorizedWithToken operations.

Example: "determiningPolicies":[{"policyId":"SPEXAMPLEabcdefg111111"}]

type nonrec determining_policy_list = determining_policy_item list
type nonrec evaluation_error_item = {
  1. error_description : Smaws_Lib.Smithy_api.Types.string_;
    (*

    The error description.

    *)
}

Contains a description of an evaluation error.

This data type is a response parameter of the IsAuthorized, BatchIsAuthorized, and IsAuthorizedWithToken operations.

type nonrec evaluation_error_list = evaluation_error_item list
type nonrec is_authorized_with_token_output = {
  1. principal : entity_identifier option;
    (*

    The identifier of the principal in the ID or access token.

    *)
  2. errors : evaluation_error_list;
    (*

    Errors that occurred while making an authorization decision. For example, a policy references an entity or entity attribute that does not exist in the slice.

    *)
  3. determining_policies : determining_policy_list;
    (*

    The list of determining policies used to make the authorization decision. For example, if there are multiple matching policies, where at least one is a forbid policy, then because forbid always overrides permit the forbid policies are the determining policies. If all matching policies are permit policies, then those policies are the determining policies. When no policies match and the response is the default DENY, there are no determining policies.

    *)
  4. decision : decision;
    (*

    An authorization decision that indicates if the authorization request should be allowed or denied.

    *)
}
type nonrec context_map = (Smaws_Lib.Smithy_api.Types.string_ * attribute_value) list
type nonrec cedar_json = string
type nonrec context_definition =
  1. | CedarJson of cedar_json
    (*

    A Cedar JSON string representation of the context needed to successfully evaluate an authorization request.

    Example: {"cedarJson":"{\"<KeyName1>\": true, \"<KeyName2>\": 1234}" }

    *)
  2. | ContextMap of context_map
    (*

    An list of attributes that are needed to successfully evaluate an authorization request. Each attribute in this array must include a map of a data type and its value.

    Example: "contextMap":{"<KeyName1>":{"boolean":true},"<KeyName2>":{"long":1234}}

    *)

Contains additional details about the context of the request. Verified Permissions evaluates this information in an authorization request as part of the when and unless clauses in a policy.

This data type is used as a request parameter for the IsAuthorized, BatchIsAuthorized, and IsAuthorizedWithToken operations.

If you're passing context as part of the request, exactly one instance of context must be passed. If you don't want to pass context, omit the context parameter from your request rather than sending context {}.

Example: "context":{"contextMap":{"<KeyName1>":{"boolean":true},"<KeyName2>":{"long":1234}}}

type nonrec entity_attributes = (Smaws_Lib.Smithy_api.Types.string_ * attribute_value) list
type cedar_tag_record_attribute = (Smaws_Lib.Smithy_api.Types.string_ * cedar_tag_value) list
and cedar_tag_set_attribute = cedar_tag_value list
and cedar_tag_value =
  1. | Duration of duration
    (*

    A Cedar tag value of duration type.

    Example: {"duration": "-1d12h"}

    *)
  2. | Datetime of datetime_attribute
    (*

    A Cedar tag value of datetime type.

    Example: {"datetime": "2025-11-04T11:35:00.000+0100"}

    *)
  3. | Decimal of decimal
    (*

    A Cedar tag value of decimal type.

    Example: {"decimal": "-2.0"}

    *)
  4. | Ipaddr of ip_addr
    (*

    A Cedar tag value of ipaddr type.

    Example: {"ip": "10.50.0.0/24"}

    *)
  5. | Record of cedar_tag_record_attribute
    (*

    A Cedar tag value of Record type.

    Example: {"record": { "keyName": {} } }

    *)
  6. | Set of cedar_tag_set_attribute
    (*

    A Cedar tag value of Set type.

    Example: {"set": [ { "string": "abc" } ] }

    *)
  7. | String of string_attribute
    (*

    A Cedar tag value of String type.

    Example: {"string": "abc"}

    *)
  8. | Long of long_attribute
    (*

    A Cedar tag value of Long type.

    Example: {"long": 0}

    *)
  9. | EntityIdentifier of entity_identifier
    (*

    A Cedar tag value of type EntityIdentifier.

    Example: {"entityIdentifier": { "entityId": "alice", "entityType": "User"} }

    *)
  10. | Boolean of boolean_attribute
    (*

    A Cedar tag value of Boolean type.

    Example: {"boolean": false}

    *)

The value of an entity's Cedar tag.

This data type is used as a member of the EntityItem structure that forms the body of the Entities request parameter for the IsAuthorized, BatchIsAuthorized, IsAuthorizedWithToken, and BatchIsAuthorizedWithToken operations.

type nonrec entity_cedar_tags = (Smaws_Lib.Smithy_api.Types.string_ * cedar_tag_value) list
type nonrec entity_item = {
  1. tags : entity_cedar_tags option;
    (*

    A list of cedar tags for the entity.

    *)
  2. parents : parent_list option;
    (*

    The parent entities in the hierarchy that contains the entity. A principal or resource entity can be defined with at most 99 transitive parents per authorization request.

    A transitive parent is an entity in the hierarchy of entities including all direct parents, and parents of parents. For example, a user can be a member of 91 groups if one of those groups is a member of eight groups, for a total of 100: one entity, 91 entity parents, and eight parents of parents.

    *)
  3. attributes : entity_attributes option;
    (*

    A list of attributes for the entity.

    *)
  4. identifier : entity_identifier;
    (*

    The identifier of the entity.

    *)
}

Contains information about an entity that can be referenced in a Cedar policy.

This data type is used as one of the fields in the EntitiesDefinition structure.

{ "identifier": { "entityType": "Photo", "entityId": "VacationPhoto94.jpg" }, "attributes": {}, "parents": [ { "entityType": "Album", "entityId": "alice_folder" } ] }

type nonrec entity_list = entity_item list
type nonrec entities_definition =
  1. | CedarJson of cedar_json
    (*

    A Cedar JSON string representation of the entities needed to successfully evaluate an authorization request.

    Example: {"cedarJson": "[{\"uid\":{\"type\":\"Photo\",\"id\":\"VacationPhoto94.jpg\"},\"attrs\":{\"accessLevel\":\"public\"},\"parents\":[]}]"}

    *)
  2. | EntityList of entity_list
    (*

    An array of entities that are needed to successfully evaluate an authorization request. Each entity in this array must include an identifier for the entity, the attributes of the entity, and a list of any parent entities.

    If you include multiple entities with the same identifier, only the last one is processed in the request.

    *)

Contains the list of entities to be considered during an authorization request. This includes all principals, resources, and actions required to successfully evaluate the request.

This data type is used as a field in the response parameter for the IsAuthorized and IsAuthorizedWithToken operations.

type nonrec is_authorized_with_token_input = {
  1. entities : entities_definition option;
    (*

    (Optional) Specifies the list of resources and their associated attributes that Verified Permissions can examine when evaluating the policies. These additional entities and their attributes can be referenced and checked by conditional elements in the policies in the specified policy store.

    You can't include principals in this parameter, only resource and action entities. This parameter can't include any entities of a type that matches the user or group entity types that you defined in your identity source.

    • The IsAuthorizedWithToken operation takes principal attributes from only the identityToken or accessToken passed to the operation.
    • For action entities, you can include only their Identifier and EntityType.
    *)
  2. context : context_definition option;
    (*

    Specifies additional context that can be used to make more granular authorization decisions.

    *)
  3. resource : entity_identifier option;
    (*

    Specifies the resource for which the authorization decision is made. For example, is the principal allowed to perform the action on the resource?

    *)
  4. action : action_identifier option;
    (*

    Specifies the requested action to be authorized. Is the specified principal authorized to perform this action on the specified resource.

    *)
  5. access_token : token option;
    (*

    Specifies an access token for the principal to be authorized. This token is provided to you by the identity provider (IdP) associated with the specified identity source. You must specify either an accessToken, an identityToken, or both.

    Must be an access token. Verified Permissions returns an error if the token_use claim in the submitted token isn't access.

    *)
  6. identity_token : token option;
    (*

    Specifies an identity token for the principal to be authorized. This token is provided to you by the identity provider (IdP) associated with the specified identity source. You must specify either an accessToken, an identityToken, or both.

    Must be an ID token. Verified Permissions returns an error if the token_use claim in the submitted token isn't id.

    *)
  7. policy_store_id : policy_store_id;
    (*

    Specifies the ID of the policy store. Policies in this policy store will be used to make an authorization decision for the input.

    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.

    *)
}
type nonrec is_authorized_output = {
  1. errors : evaluation_error_list;
    (*

    Errors that occurred while making an authorization decision, for example, a policy references an Entity or entity Attribute that does not exist in the slice.

    *)
  2. determining_policies : determining_policy_list;
    (*

    The list of determining policies used to make the authorization decision. For example, if there are two matching policies, where one is a forbid and the other is a permit, then the forbid policy will be the determining policy. In the case of multiple matching permit policies then there would be multiple determining policies. In the case that no policies match, and hence the response is DENY, there would be no determining policies.

    *)
  3. decision : decision;
    (*

    An authorization decision that indicates if the authorization request should be allowed or denied.

    *)
}
type nonrec is_authorized_input = {
  1. entities : entities_definition option;
    (*

    (Optional) Specifies the list of resources and principals and their associated attributes that Verified Permissions can examine when evaluating the policies. These additional entities and their attributes can be referenced and checked by conditional elements in the policies in the specified policy store.

    You can include only principal and resource entities in this parameter; you can't include actions. You must specify actions in the schema.

    *)
  2. context : context_definition option;
    (*

    Specifies additional context that can be used to make more granular authorization decisions.

    *)
  3. resource : entity_identifier option;
    (*

    Specifies the resource for which the authorization decision is to be made.

    *)
  4. action : action_identifier option;
    (*

    Specifies the requested action to be authorized. For example, is the principal authorized to perform this action on the resource?

    *)
  5. principal : entity_identifier option;
    (*

    Specifies the principal for which the authorization decision is to be made.

    *)
  6. policy_store_id : policy_store_id;
    (*

    Specifies the ID of the policy store. Policies in this policy store will be used to make an authorization decision for the input.

    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.

    *)
}
type nonrec invalid_state_exception = {
  1. message : Smaws_Lib.Smithy_api.Types.string_;
}

The policy store can't be deleted because deletion protection is enabled. To delete this policy store, disable deletion protection.

type nonrec identity_source_details = {
  1. open_id_issuer : open_id_issuer option;
    (*

    A string that identifies the type of OIDC service represented by this identity source.

    At this time, the only valid value is cognito.

    *)
  2. discovery_url : discovery_url option;
    (*

    The well-known URL that points to this user pool's OIDC discovery endpoint. This is a URL string in the following format. This URL replaces the placeholders for both the Amazon Web Services Region and the user pool identifier with those appropriate for this user pool.

    https://cognito-idp.{i <region>}.amazonaws.com/{i <user-pool-id>}/.well-known/openid-configuration
    *)
  3. user_pool_arn : user_pool_arn option;
    (*

    The Amazon Resource Name (ARN) of the Amazon Cognito user pool whose identities are accessible to this Verified Permissions policy store.

    *)
  4. client_ids : client_ids option;
    (*

    The application client IDs associated with the specified Amazon Cognito user pool that are enabled for this identity source.

    *)
}

A structure that contains configuration of the identity source.

This data type was a response parameter for the GetIdentitySource operation. Replaced by ConfigurationDetail.

type nonrec identity_source = Smaws_Lib.CoreTypes.Resource.t
type nonrec idempotency_token = string
type nonrec get_schema_output = {
  1. namespaces : namespace_list option;
    (*

    The namespaces of the entities referenced by this schema.

    *)
  2. last_updated_date : timestamp_format;
    (*

    The date and time that the schema was most recently updated.

    *)
  3. created_date : timestamp_format;
    (*

    The date and time that the schema was originally created.

    *)
  4. schema : schema_json;
    (*

    The body of the schema, written in Cedar schema JSON.

    *)
  5. policy_store_id : policy_store_id;
    (*

    The ID of the policy store that contains the schema.

    *)
}
type nonrec get_schema_input = {
  1. policy_store_id : policy_store_id;
    (*

    Specifies the ID of the policy store that contains 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.

    *)
}
type nonrec get_policy_template_output = {
  1. name : policy_template_name option;
    (*

    The name of the policy template, if one was assigned when the policy template was created or last updated.

    *)
  2. last_updated_date : timestamp_format;
    (*

    The date and time that the policy template was most recently updated.

    *)
  3. created_date : timestamp_format;
    (*

    The date and time that the policy template was originally created.

    *)
  4. statement : policy_statement;
    (*

    The content of the body of the policy template written in the Cedar policy language.

    *)
  5. description : policy_template_description option;
    (*

    The description of the policy template.

    *)
  6. policy_template_id : policy_template_id;
    (*

    The ID of the policy template.

    *)
  7. policy_store_id : policy_store_id;
    (*

    The ID of the policy store that contains the policy template.

    *)
}
type nonrec get_policy_template_input = {
  1. policy_template_id : policy_template_id;
    (*

    Specifies the ID of the policy template that you want information about.

    You can use the policy template name in place of the policy template ID. When using a name, prefix it with name/. For example:

    • ID: PTEXAMPLEabcdefg111111
    • Name: name/example-policy-template
    *)
  2. policy_store_id : policy_store_id;
    (*

    Specifies the ID of the policy store that contains the policy template that you want information about.

    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.

    *)
}
type nonrec encryption_state =
  1. | Default of Smaws_Lib.Smithy_api.Types.unit_
    (*

    This is the default encryption state. The policy store is encrypted using an Amazon Web Services owned key.

    *)
  2. | KmsEncryptionState of kms_encryption_state
    (*

    The KMS encryption settings currently configured for this policy store to encrypt data with. It contains the customer-managed KMS key, and a user-defined encryption context.

    *)

A structure that contains the encryption configuration for the policy store and child resources.

This data type is used as a response parameter field for the GetPolicyStore operation.

type nonrec cedar_version =
  1. | CEDAR_4
  2. | CEDAR_2
type nonrec get_policy_store_output = {
  1. tags : tag_map option;
    (*

    The list of tags associated with the policy store.

    *)
  2. cedar_version : cedar_version option;
    (*

    The version of the Cedar language used with policies, policy templates, and schemas in this policy store. For more information, see Amazon Verified Permissions upgrade to Cedar v4 FAQ.

    *)
  3. encryption_state : encryption_state option;
    (*

    A structure that contains the encryption configuration for the policy store.

    *)
  4. deletion_protection : deletion_protection option;
    (*

    Specifies whether the policy store can be deleted. If enabled, the policy store can't be deleted.

    The default state is DISABLED.

    *)
  5. description : policy_store_description option;
    (*

    Descriptive text that you can provide to help with identification of the current policy store.

    *)
  6. last_updated_date : timestamp_format;
    (*

    The date and time that the policy store was last updated.

    *)
  7. created_date : timestamp_format;
    (*

    The date and time that the policy store was originally created.

    *)
  8. validation_settings : validation_settings;
    (*

    The current validation settings for the policy store.

    *)
  9. arn : resource_arn;
    (*

    The Amazon Resource Name (ARN) of the policy store.

    *)
  10. policy_store_id : policy_store_id;
    (*

    The ID of the policy store;

    *)
}
type nonrec get_policy_store_input = {
  1. tags : Smaws_Lib.Smithy_api.Types.boolean_ option;
    (*

    Specifies whether to return the tags that are attached to the policy store. If this parameter is included in the API call, the tags are returned, otherwise they are not returned.

    If this parameter is included in the API call but there are no tags attached to the policy store, the tags response parameter is omitted from the response.

    *)
  2. policy_store_id : policy_store_id;
    (*

    Specifies the policy store that you want information about.

    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.

    *)
}
type nonrec get_policy_store_alias_output = {
  1. state : alias_state;
    (*

    The state of the policy store alias. Policy Store Aliases in the Active state can be used normally. When a policy store alias is deleted, it enters the PendingDeletion state. Policy Store Aliases in the PendingDeletion cannot be used, and creating a policy store alias with the same alias name will fail.

    *)
  2. created_at : timestamp_format;
    (*

    The date and time the policy store alias was created.

    *)
  3. alias_arn : resource_arn;
    (*

    The Amazon Resource Name (ARN) of the policy store alias.

    *)
  4. policy_store_id : policy_store_id;
    (*

    The ID of the policy store associated with the alias.

    *)
  5. alias_name : alias;
    (*

    The name of the policy store alias.

    *)
}
type nonrec get_policy_store_alias_input = {
  1. alias_name : alias;
    (*

    Specifies the name of the policy store alias that you want information about.

    The alias name must always be prefixed with policy-store-alias/.

    *)
}
type nonrec get_policy_output = {
  1. name : policy_name option;
    (*

    The name of the policy, if one was assigned when the policy was created or last updated.

    *)
  2. effect_ : policy_effect option;
    (*

    The effect of the decision that a policy returns to an authorization request. For example, "effect": "Permit".

    *)
  3. last_updated_date : timestamp_format;
    (*

    The date and time that the policy was last updated.

    *)
  4. created_date : timestamp_format;
    (*

    The date and time that the policy was originally created.

    *)
  5. definition : policy_definition_detail;
    (*

    The definition of the requested policy.

    *)
  6. actions : action_identifier_list option;
    (*

    The action that a policy permits or forbids. For example, {"actions": [{"actionId": "ViewPhoto", "actionType": "PhotoFlash::Action"}, {"entityID": "SharePhoto", "entityType": "PhotoFlash::Action"}]}.

    *)
  7. resource : entity_identifier option;
    (*

    The resource specified in the policy's scope. This element isn't included in the response when Resource isn't present in the policy content.

    *)
  8. principal : entity_identifier option;
    (*

    The principal specified in the policy's scope. This element isn't included in the response when Principal isn't present in the policy content.

    *)
  9. policy_type : policy_type;
    (*

    The type of the policy.

    *)
  10. policy_id : policy_id;
    (*

    The unique ID of the policy that you want information about.

    *)
  11. policy_store_id : policy_store_id;
    (*

    The ID of the policy store that contains the policy that you want information about.

    *)
}
type nonrec get_policy_input = {
  1. policy_id : policy_id;
    (*

    Specifies the ID of the policy you want information about.

    You can use the policy name in place of the policy ID. When using a name, prefix it with name/. For example:

    • ID: SPEXAMPLEabcdefg111111
    • Name: name/example-policy
    *)
  2. policy_store_id : policy_store_id;
    (*

    Specifies the ID of the policy store that contains the policy that you want information about.

    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.

    *)
}
type nonrec cognito_group_configuration_detail = {
  1. group_entity_type : group_entity_type option;
    (*

    The name of the schema entity type that's mapped to the user pool group. Defaults to AWS::CognitoGroup.

    *)
}

The type of entity that a policy store maps to groups from an Amazon Cognito user pool identity source.

This data type is part of an CognitoUserPoolConfigurationDetail structure and is a response parameter to GetIdentitySource.

type nonrec cognito_user_pool_configuration_detail = {
  1. group_configuration : cognito_group_configuration_detail option;
    (*

    The type of entity that a policy store maps to groups from an Amazon Cognito user pool identity source.

    *)
  2. issuer : issuer;
    (*

    The OpenID Connect (OIDC) issuer ID of the Amazon Cognito user pool that contains the identities to be authorized.

    Example: "issuer": "https://cognito-idp.us-east-1.amazonaws.com/us-east-1_1a2b3c4d5"

    *)
  3. client_ids : client_ids;
    (*

    The unique application client IDs that are associated with the specified Amazon Cognito user pool.

    Example: "clientIds": ["&ExampleCogClientId;"]

    *)
  4. user_pool_arn : user_pool_arn;
    (*

    The Amazon Resource Name (ARN) of the Amazon Cognito user pool that contains the identities to be authorized.

    Example: "userPoolArn": "arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5"

    *)
}

The configuration for an identity source that represents a connection to an Amazon Cognito user pool used as an identity provider for Verified Permissions.

This data type is used as a field that is part of an ConfigurationDetail structure that is part of the response to GetIdentitySource.

Example:"CognitoUserPoolConfiguration":{"UserPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","ClientIds": ["a1b2c3d4e5f6g7h8i9j0kalbmc"],"groupConfiguration": {"groupEntityType": "MyCorp::Group"}}

type nonrec configuration_detail =
  1. | OpenIdConnectConfiguration of open_id_connect_configuration_detail
    (*

    Contains configuration details of an OpenID Connect (OIDC) identity provider, or identity source, that Verified Permissions can use to generate entities from authenticated identities. It specifies the issuer URL, token type that you want to use, and policy store entity details.

    Example:"configuration":{"openIdConnectConfiguration":{"issuer":"https://auth.example.com","tokenSelection":{"accessTokenOnly":{"audiences":["https://myapp.example.com","https://myapp2.example.com"],"principalIdClaim":"sub"}},"entityIdPrefix":"MyOIDCProvider","groupConfiguration":{"groupClaim":"groups","groupEntityType":"MyCorp::UserGroup"}}}

    *)
  2. | CognitoUserPoolConfiguration of cognito_user_pool_configuration_detail
    (*

    Contains configuration details of a Amazon Cognito user pool that Verified Permissions can use as a source of authenticated identities as entities. It specifies the Amazon Resource Name (ARN) of a Amazon Cognito user pool, the policy store entity that you want to assign to user groups, and one or more application client IDs.

    Example: "configuration":{"cognitoUserPoolConfiguration":{"userPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","clientIds": ["a1b2c3d4e5f6g7h8i9j0kalbmc"],"groupConfiguration": {"groupEntityType": "MyCorp::Group"}}}

    *)

Contains configuration information about an identity source.

This data type is a response parameter to the GetIdentitySource operation.

type nonrec get_identity_source_output = {
  1. configuration : configuration_detail option;
    (*

    Contains configuration information about an identity source.

    *)
  2. principal_entity_type : principal_entity_type;
    (*

    The data type of principals generated for identities authenticated by this identity source.

    *)
  3. policy_store_id : policy_store_id;
    (*

    The ID of the policy store that contains the identity source.

    *)
  4. last_updated_date : timestamp_format;
    (*

    The date and time that the identity source was most recently updated.

    *)
  5. identity_source_id : identity_source_id;
    (*

    The ID of the identity source.

    *)
  6. details : identity_source_details option;
    (*

    A structure that describes the configuration of the identity source.

    *)
  7. created_date : timestamp_format;
    (*

    The date and time that the identity source was originally created.

    *)
}
type nonrec get_identity_source_input = {
  1. identity_source_id : identity_source_id;
    (*

    Specifies the ID of the identity source you want information about.

    *)
  2. policy_store_id : policy_store_id;
    (*

    Specifies the ID of the policy store that contains the identity source you want information about.

    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.

    *)
}
type nonrec encryption_settings =
  1. | Default of Smaws_Lib.Smithy_api.Types.unit_
    (*

    This is the default encryption setting. The policy store uses an Amazon Web Services owned key for encrypting data.

    *)
  2. | KmsEncryptionSettings of kms_encryption_settings
    (*

    The KMS encryption settings for this policy store to encrypt data with. It will contain the customer-managed KMS key, and a user-defined encryption context.

    *)

A structure that contains the encryption configuration for the policy store and child resources.

This data type is used as a request parameter in the CreatePolicyStore operation.

type nonrec deletion_mode =
  1. | HARD_DELETE
  2. | SOFT_DELETE

The deletion mode for a resource. The valid values are:

  • SoftDelete – The resource enters the PendingDeletion state. This is the default behavior.
  • HardDelete – The resource is immediately deleted, bypassing the PendingDeletion state.
type nonrec delete_policy_template_output = unit
type nonrec delete_policy_template_input = {
  1. policy_template_id : policy_template_id;
    (*

    Specifies the ID of the policy template that you want to delete.

    You can use the policy template name in place of the policy template ID. When using a name, prefix it with name/. For example:

    • ID: PTEXAMPLEabcdefg111111
    • Name: name/example-policy-template
    *)
  2. policy_store_id : policy_store_id;
    (*

    Specifies the ID of the policy store that contains the policy template that you want to delete.

    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.

    *)
}
type nonrec delete_policy_store_output = unit
type nonrec delete_policy_store_input = {
  1. policy_store_id : policy_store_id;
    (*

    Specifies the ID of the policy store that you want to delete.

    To specify a policy store, the alias name cannot be used. Only the ID can be used.

    *)
}
type nonrec delete_policy_store_alias_output = unit
type nonrec delete_policy_store_alias_input = {
  1. deletion_mode : deletion_mode option;
    (*

    Specifies the deletion mode for the policy store alias. The valid values are:

    • SoftDelete – The policy store alias enters the PendingDeletion state. This is the default behavior when no deletionMode is specified.
    • HardDelete – The policy store alias is immediately deleted, bypassing the PendingDeletion state.
    *)
  2. alias_name : alias;
    (*

    Specifies the name of the policy store alias that you want to delete.

    The alias name must always be prefixed with policy-store-alias/.

    *)
}
type nonrec delete_policy_output = unit
type nonrec delete_policy_input = {
  1. policy_id : policy_id;
    (*

    Specifies the ID of the policy that you want to delete.

    You can use the policy name in place of the policy ID. When using a name, prefix it with name/. For example:

    • ID: SPEXAMPLEabcdefg111111
    • Name: name/example-policy
    *)
  2. policy_store_id : policy_store_id;
    (*

    Specifies the ID of the policy store that contains the policy that you want to delete.

    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.

    *)
}
type nonrec delete_identity_source_output = unit
type nonrec delete_identity_source_input = {
  1. identity_source_id : identity_source_id;
    (*

    Specifies the ID of the identity source that you want to delete.

    *)
  2. policy_store_id : policy_store_id;
    (*

    Specifies the ID of the policy store that contains the identity source that you want to delete.

    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.

    *)
}
type nonrec create_policy_template_output = {
  1. last_updated_date : timestamp_format;
    (*

    The date and time the policy template was most recently updated.

    *)
  2. created_date : timestamp_format;
    (*

    The date and time the policy template was originally created.

    *)
  3. policy_template_id : policy_template_id;
    (*

    The unique ID of the new policy template.

    *)
  4. policy_store_id : policy_store_id;
    (*

    The ID of the policy store that contains the policy template.

    *)
}
type nonrec create_policy_template_input = {
  1. name : policy_template_name option;
    (*

    Specifies a name for the policy template that is unique among all policy templates within the policy store. You can use the name in place of the policy template ID in API operations that reference the policy template. The name must be prefixed with name/.

    If you specify a name that is already associated with another policy template in the policy store, you receive a ConflictException error.

    *)
  2. statement : policy_statement;
    (*

    Specifies the content that you want to use for the new policy template, written in the Cedar policy language.

    *)
  3. description : policy_template_description option;
    (*

    Specifies a description for the policy template.

    *)
  4. policy_store_id : policy_store_id;
    (*

    The ID of the policy store in which to create the policy template.

    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.

    *)
  5. client_token : idempotency_token option;
    (*

    Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

    If you don't provide this value, then Amazon Web Services generates a random one for you.

    If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an ConflictException error.

    Verified Permissions recognizes a ClientToken for eight hours. After eight hours, the next request with the same parameters performs the operation again regardless of the value of ClientToken.

    *)
}
type nonrec create_policy_store_output = {
  1. last_updated_date : timestamp_format;
    (*

    The date and time the policy store was last updated.

    *)
  2. created_date : timestamp_format;
    (*

    The date and time the policy store was originally created.

    *)
  3. arn : resource_arn;
    (*

    The Amazon Resource Name (ARN) of the new policy store.

    *)
  4. policy_store_id : policy_store_id;
    (*

    The unique ID of the new policy store.

    *)
}
type nonrec create_policy_store_input = {
  1. tags : tag_map option;
    (*

    The list of key-value pairs to associate with the policy store.

    *)
  2. encryption_settings : encryption_settings option;
    (*

    Specifies the encryption settings used to encrypt the policy store and their child resources. Allows for the ability to use a customer owned KMS key for encryption of data.

    This is an optional field to be used when providing a customer-managed KMS key for encryption.

    *)
  3. deletion_protection : deletion_protection option;
    (*

    Specifies whether the policy store can be deleted. If enabled, the policy store can't be deleted.

    The default state is DISABLED.

    *)
  4. description : policy_store_description option;
    (*

    Descriptive text that you can provide to help with identification of the current policy store.

    *)
  5. validation_settings : validation_settings;
    (*

    Specifies the validation setting for this policy store.

    Currently, the only valid and required value is Mode.

    We recommend that you turn on STRICT mode only after you define a schema. If a schema doesn't exist, then STRICT mode causes any policy to fail validation, and Verified Permissions rejects the policy. You can turn off validation by using the UpdatePolicyStore. Then, when you have a schema defined, use UpdatePolicyStore again to turn validation back on.

    *)
  6. client_token : idempotency_token option;
    (*

    Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

    If you don't provide this value, then Amazon Web Services generates a random one for you.

    If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an ConflictException error.

    Verified Permissions recognizes a ClientToken for eight hours. After eight hours, the next request with the same parameters performs the operation again regardless of the value of ClientToken.

    *)
}
type nonrec create_policy_store_alias_output = {
  1. created_at : timestamp_format;
    (*

    The date and time the policy store alias was created.

    *)
  2. alias_arn : resource_arn;
    (*

    The Amazon Resource Name (ARN) of the policy store alias.

    *)
  3. policy_store_id : policy_store_id;
    (*

    The ID of the policy store associated with the alias.

    *)
  4. alias_name : alias;
    (*

    The name of the policy store alias.

    *)
}
type nonrec create_policy_store_alias_input = {
  1. policy_store_id : policy_store_id;
    (*

    Specifies the ID of the policy store to associate with the alias.

    The associated policy store must be specified using its ID. The alias name cannot be used.

    *)
  2. alias_name : alias;
    (*

    Specifies the name of the policy store alias to create. The name must be unique within your Amazon Web Services account and Amazon Web Services Region.

    The alias name must always be prefixed with policy-store-alias/.

    *)
}
type nonrec create_policy_output = {
  1. effect_ : policy_effect option;
    (*

    The effect of the decision that a policy returns to an authorization request. For example, "effect": "Permit".

    *)
  2. last_updated_date : timestamp_format;
    (*

    The date and time the policy was last updated.

    *)
  3. created_date : timestamp_format;
    (*

    The date and time the policy was originally created.

    *)
  4. actions : action_identifier_list option;
    (*

    The action that a policy permits or forbids. For example, {"actions": [{"actionId": "ViewPhoto", "actionType": "PhotoFlash::Action"}, {"entityID": "SharePhoto", "entityType": "PhotoFlash::Action"}]}.

    *)
  5. resource : entity_identifier option;
    (*

    The resource specified in the new policy's scope. This response element isn't present when the resource isn't specified in the policy content.

    *)
  6. principal : entity_identifier option;
    (*

    The principal specified in the new policy's scope. This response element isn't present when principal isn't specified in the policy content.

    *)
  7. policy_type : policy_type;
    (*

    The policy type of the new policy.

    *)
  8. policy_id : policy_id;
    (*

    The unique ID of the new policy.

    *)
  9. policy_store_id : policy_store_id;
    (*

    The ID of the policy store that contains the new policy.

    *)
}
type nonrec create_policy_input = {
  1. name : policy_name option;
    (*

    Specifies a name for the policy that is unique among all policies within the policy store. You can use the name in place of the policy ID in API operations that reference the policy. The name must be prefixed with name/.

    If you specify a name that is already associated with another policy in the policy store, you receive a ConflictException error.

    *)
  2. definition : policy_definition;
    (*

    A structure that specifies the policy type and content to use for the new policy. You must include either a static or a templateLinked element. The policy content must be written in the Cedar policy language.

    *)
  3. policy_store_id : policy_store_id;
    (*

    Specifies the PolicyStoreId of the policy store you want to store the policy in.

    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.

    *)
  4. client_token : idempotency_token option;
    (*

    Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

    If you don't provide this value, then Amazon Web Services generates a random one for you.

    If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an ConflictException error.

    Verified Permissions recognizes a ClientToken for eight hours. After eight hours, the next request with the same parameters performs the operation again regardless of the value of ClientToken.

    *)
}
type nonrec create_identity_source_output = {
  1. policy_store_id : policy_store_id;
    (*

    The ID of the policy store that contains the identity source.

    *)
  2. last_updated_date : timestamp_format;
    (*

    The date and time the identity source was most recently updated.

    *)
  3. identity_source_id : identity_source_id;
    (*

    The unique ID of the new identity source.

    *)
  4. created_date : timestamp_format;
    (*

    The date and time the identity source was originally created.

    *)
}
type nonrec cognito_group_configuration = {
  1. group_entity_type : group_entity_type;
    (*

    The name of the schema entity type that's mapped to the user pool group. Defaults to AWS::CognitoGroup.

    *)
}

The type of entity that a policy store maps to groups from an Amazon Cognito user pool identity source.

This data type is part of a CognitoUserPoolConfiguration structure and is a request parameter in CreateIdentitySource.

type nonrec cognito_user_pool_configuration = {
  1. group_configuration : cognito_group_configuration option;
    (*

    The type of entity that a policy store maps to groups from an Amazon Cognito user pool identity source.

    *)
  2. client_ids : client_ids option;
    (*

    The unique application client IDs that are associated with the specified Amazon Cognito user pool.

    Example: "ClientIds": ["&ExampleCogClientId;"]

    *)
  3. user_pool_arn : user_pool_arn;
    (*

    The Amazon Resource Name (ARN) of the Amazon Cognito user pool that contains the identities to be authorized.

    Example: "UserPoolArn": "arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5"

    *)
}

The configuration for an identity source that represents a connection to an Amazon Cognito user pool used as an identity provider for Verified Permissions.

This data type part of a Configuration structure that is used as a parameter to CreateIdentitySource.

Example:"CognitoUserPoolConfiguration":{"UserPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","ClientIds": ["a1b2c3d4e5f6g7h8i9j0kalbmc"],"groupConfiguration": {"groupEntityType": "MyCorp::Group"}}

type nonrec configuration =
  1. | OpenIdConnectConfiguration of open_id_connect_configuration
    (*

    Contains configuration details of an OpenID Connect (OIDC) identity provider, or identity source, that Verified Permissions can use to generate entities from authenticated identities. It specifies the issuer URL, token type that you want to use, and policy store entity details.

    Example:"configuration":{"openIdConnectConfiguration":{"issuer":"https://auth.example.com","tokenSelection":{"accessTokenOnly":{"audiences":["https://myapp.example.com","https://myapp2.example.com"],"principalIdClaim":"sub"}},"entityIdPrefix":"MyOIDCProvider","groupConfiguration":{"groupClaim":"groups","groupEntityType":"MyCorp::UserGroup"}}}

    *)
  2. | CognitoUserPoolConfiguration of cognito_user_pool_configuration
    (*

    Contains configuration details of a Amazon Cognito user pool that Verified Permissions can use as a source of authenticated identities as entities. It specifies the Amazon Resource Name (ARN) of a Amazon Cognito user pool and one or more application client IDs.

    Example: "configuration":{"cognitoUserPoolConfiguration":{"userPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","clientIds": ["a1b2c3d4e5f6g7h8i9j0kalbmc"],"groupConfiguration": {"groupEntityType": "MyCorp::Group"}}}

    *)

Contains configuration information used when creating a new identity source.

This data type is used as a request parameter for the CreateIdentitySource operation.

type nonrec create_identity_source_input = {
  1. principal_entity_type : principal_entity_type option;
    (*

    Specifies the namespace and data type of the principals generated for identities authenticated by the new identity source.

    *)
  2. configuration : configuration;
    (*

    Specifies the details required to communicate with the identity provider (IdP) associated with this identity source.

    *)
  3. policy_store_id : policy_store_id;
    (*

    Specifies the ID of the policy store in which you want to store this identity source. Only policies and requests made using this policy store can reference identities from the identity provider configured in the new identity source.

    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.

    *)
  4. client_token : idempotency_token option;
    (*

    Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

    If you don't provide this value, then Amazon Web Services generates a random one for you.

    If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an ConflictException error.

    Verified Permissions recognizes a ClientToken for eight hours. After eight hours, the next request with the same parameters performs the operation again regardless of the value of ClientToken.

    *)
}
type nonrec batch_is_authorized_with_token_input_item = {
  1. context : context_definition option;
    (*

    Specifies additional context that can be used to make more granular authorization decisions.

    *)
  2. resource : entity_identifier option;
    (*

    Specifies the resource that you want an authorization decision for. For example, PhotoFlash::Photo.

    *)
  3. action : action_identifier option;
    (*

    Specifies the requested action to be authorized. For example, PhotoFlash::ReadPhoto.

    *)
}

An authorization request that you include in a BatchIsAuthorizedWithToken API request.

type nonrec batch_is_authorized_with_token_output_item = {
  1. errors : evaluation_error_list;
    (*

    Errors that occurred while making an authorization decision. For example, a policy might reference an entity or attribute that doesn't exist in the request.

    *)
  2. determining_policies : determining_policy_list;
    (*

    The list of determining policies used to make the authorization decision. For example, if there are two matching policies, where one is a forbid and the other is a permit, then the forbid policy will be the determining policy. In the case of multiple matching permit policies then there would be multiple determining policies. In the case that no policies match, and hence the response is DENY, there would be no determining policies.

    *)
  3. decision : decision;
    (*

    An authorization decision that indicates if the authorization request should be allowed or denied.

    *)
  4. request : batch_is_authorized_with_token_input_item;
    (*

    The authorization request that initiated the decision.

    *)
}

The decision, based on policy evaluation, from an individual authorization request in a BatchIsAuthorizedWithToken API request.

type nonrec batch_is_authorized_with_token_output_list = batch_is_authorized_with_token_output_item list
type nonrec batch_is_authorized_with_token_output = {
  1. results : batch_is_authorized_with_token_output_list;
    (*

    A series of Allow or Deny decisions for each request, and the policies that produced them. These results are returned in the order they were requested.

    *)
  2. principal : entity_identifier option;
    (*

    The identifier of the principal in the ID or access token.

    *)
}
type nonrec batch_is_authorized_with_token_input_list = batch_is_authorized_with_token_input_item list
type nonrec batch_is_authorized_with_token_input = {
  1. requests : batch_is_authorized_with_token_input_list;
    (*

    An array of up to 30 requests that you want Verified Permissions to evaluate.

    *)
  2. entities : entities_definition option;
    (*

    (Optional) Specifies the list of resources and their associated attributes that Verified Permissions can examine when evaluating the policies. These additional entities and their attributes can be referenced and checked by conditional elements in the policies in the specified policy store.

    You can't include principals in this parameter, only resource and action entities. This parameter can't include any entities of a type that matches the user or group entity types that you defined in your identity source.

    • The BatchIsAuthorizedWithToken operation takes principal attributes from only the identityToken or accessToken passed to the operation.
    • For action entities, you can include only their Identifier and EntityType.
    *)
  3. access_token : token option;
    (*

    Specifies an access token for the principal that you want to authorize in each request. This token is provided to you by the identity provider (IdP) associated with the specified identity source. You must specify either an accessToken, an identityToken, or both.

    Must be an access token. Verified Permissions returns an error if the token_use claim in the submitted token isn't access.

    *)
  4. identity_token : token option;
    (*

    Specifies an identity (ID) token for the principal that you want to authorize in each request. This token is provided to you by the identity provider (IdP) associated with the specified identity source. You must specify either an accessToken, an identityToken, or both.

    Must be an ID token. Verified Permissions returns an error if the token_use claim in the submitted token isn't id.

    *)
  5. policy_store_id : policy_store_id;
    (*

    Specifies the ID of the policy store. Policies in this policy store will be used to make an authorization decision for the input.

    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.

    *)
}
type nonrec batch_is_authorized_input_item = {
  1. context : context_definition option;
    (*

    Specifies additional context that can be used to make more granular authorization decisions.

    *)
  2. resource : entity_identifier option;
    (*

    Specifies the resource that you want an authorization decision for. For example, PhotoFlash::Photo.

    *)
  3. action : action_identifier option;
    (*

    Specifies the requested action to be authorized. For example, PhotoFlash::ReadPhoto.

    *)
  4. principal : entity_identifier option;
    (*

    Specifies the principal for which the authorization decision is to be made.

    *)
}

An authorization request that you include in a BatchIsAuthorized API request.

type nonrec batch_is_authorized_output_item = {
  1. errors : evaluation_error_list;
    (*

    Errors that occurred while making an authorization decision. For example, a policy might reference an entity or attribute that doesn't exist in the request.

    *)
  2. determining_policies : determining_policy_list;
    (*

    The list of determining policies used to make the authorization decision. For example, if there are two matching policies, where one is a forbid and the other is a permit, then the forbid policy will be the determining policy. In the case of multiple matching permit policies then there would be multiple determining policies. In the case that no policies match, and hence the response is DENY, there would be no determining policies.

    *)
  3. decision : decision;
    (*

    An authorization decision that indicates if the authorization request should be allowed or denied.

    *)
  4. request : batch_is_authorized_input_item;
    (*

    The authorization request that initiated the decision.

    *)
}

The decision, based on policy evaluation, from an individual authorization request in a BatchIsAuthorized API request.

type nonrec batch_is_authorized_output_list = batch_is_authorized_output_item list
type nonrec batch_is_authorized_output = {
  1. results : batch_is_authorized_output_list;
    (*

    A series of Allow or Deny decisions for each request, and the policies that produced them. These results are returned in the order they were requested.

    *)
}
type nonrec batch_is_authorized_input_list = batch_is_authorized_input_item list
type nonrec batch_is_authorized_input = {
  1. requests : batch_is_authorized_input_list;
    (*

    An array of up to 30 requests that you want Verified Permissions to evaluate.

    *)
  2. entities : entities_definition option;
    (*

    (Optional) Specifies the list of resources and principals and their associated attributes that Verified Permissions can examine when evaluating the policies. These additional entities and their attributes can be referenced and checked by conditional elements in the policies in the specified policy store.

    You can include only principal and resource entities in this parameter; you can't include actions. You must specify actions in the schema.

    *)
  3. policy_store_id : policy_store_id;
    (*

    Specifies the ID of the policy store. Policies in this policy store will be used to make the authorization decisions for the input.

    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.

    *)
}
type nonrec batch_get_policy_output_item = {
  1. name : policy_name option;
    (*

    The name of the policy, if one was assigned when the policy was created or last updated.

    *)
  2. last_updated_date : timestamp_format;
    (*

    The date and time the policy was most recently updated.

    *)
  3. created_date : timestamp_format;
    (*

    The date and time the policy was created.

    *)
  4. definition : policy_definition_detail;
    (*

    The policy definition of an item in the list of policies returned.

    *)
  5. policy_type : policy_type;
    (*

    The type of the policy. This is one of the following values:

    • STATIC
    • TEMPLATE_LINKED
    *)
  6. policy_id : policy_id;
    (*

    The identifier of the policy you want information about.

    *)
  7. policy_store_id : policy_store_id;
    (*

    The identifier of the policy store where the policy you want information about is stored.

    *)
}

Contains information about a policy returned from a BatchGetPolicy API request.

type nonrec batch_get_policy_output_list = batch_get_policy_output_item list
type nonrec batch_get_policy_error_code =
  1. | POLICY_STORE_ALIAS_NOT_FOUND
  2. | POLICY_NOT_FOUND
  3. | POLICY_STORE_NOT_FOUND
type nonrec batch_get_policy_error_item = {
  1. message : Smaws_Lib.Smithy_api.Types.string_;
    (*

    A detailed error message.

    *)
  2. policy_id : Smaws_Lib.Smithy_api.Types.string_;
    (*

    The identifier of the policy associated with the failed request.

    *)
  3. policy_store_id : Smaws_Lib.Smithy_api.Types.string_;
    (*

    The identifier of the policy store associated with the failed request.

    *)
  4. code : batch_get_policy_error_code;
    (*

    The error code that was returned.

    *)
}

Contains the information about an error resulting from a BatchGetPolicy API call.

type nonrec batch_get_policy_error_list = batch_get_policy_error_item list
type nonrec batch_get_policy_output = {
  1. errors : batch_get_policy_error_list;
    (*

    Information about the policies from the request that resulted in an error. These results are returned in the order they were requested.

    *)
  2. results : batch_get_policy_output_list;
    (*

    Information about the policies listed in the request that were successfully returned. These results are returned in the order they were requested.

    *)
}
type nonrec batch_get_policy_input_item = {
  1. policy_id : policy_id;
    (*

    The identifier of the policy you want information about.

    You can use the policy name in place of the policy ID. When using a name, prefix it with name/. For example:

    • ID: SPEXAMPLEabcdefg111111
    • Name: name/example-policy
    *)
  2. policy_store_id : policy_store_id;
    (*

    The identifier of the policy store where the policy you want information about is stored.

    *)
}

Information about a policy that you include in a BatchGetPolicy API request.

type nonrec batch_get_policy_input_list = batch_get_policy_input_item list
type nonrec batch_get_policy_input = {
  1. requests : batch_get_policy_input_list;
    (*

    An array of up to 100 policies you want information about.

    *)
}