Skip to content

Type definitions#

Index > VerifiedPermissions > Type definitions

Auto-generated documentation for VerifiedPermissions type annotations stubs module mypy-boto3-verifiedpermissions.

ActionIdentifierTypeDef#

# ActionIdentifierTypeDef definition

class ActionIdentifierTypeDef(TypedDict):
    actionType: str,
    actionId: str,

EntityIdentifierTypeDef#

# EntityIdentifierTypeDef definition

class EntityIdentifierTypeDef(TypedDict):
    entityType: str,
    entityId: str,

ContextDefinitionTypeDef#

# ContextDefinitionTypeDef definition

class ContextDefinitionTypeDef(TypedDict):
    contextMap: NotRequired[Mapping[str, AttributeValueTypeDef]],  # (1)
  1. See AttributeValueTypeDef

DeterminingPolicyItemTypeDef#

# DeterminingPolicyItemTypeDef definition

class DeterminingPolicyItemTypeDef(TypedDict):
    policyId: str,

EvaluationErrorItemTypeDef#

# EvaluationErrorItemTypeDef definition

class EvaluationErrorItemTypeDef(TypedDict):
    errorDescription: str,

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

CognitoUserPoolConfigurationTypeDef#

# CognitoUserPoolConfigurationTypeDef definition

class CognitoUserPoolConfigurationTypeDef(TypedDict):
    userPoolArn: str,
    clientIds: NotRequired[Sequence[str]],

ValidationSettingsTypeDef#

# ValidationSettingsTypeDef definition

class ValidationSettingsTypeDef(TypedDict):
    mode: ValidationModeType,  # (1)
  1. See ValidationModeType

CreatePolicyTemplateInputRequestTypeDef#

# CreatePolicyTemplateInputRequestTypeDef definition

class CreatePolicyTemplateInputRequestTypeDef(TypedDict):
    policyStoreId: str,
    statement: str,
    clientToken: NotRequired[str],
    description: NotRequired[str],

DeleteIdentitySourceInputRequestTypeDef#

# DeleteIdentitySourceInputRequestTypeDef definition

class DeleteIdentitySourceInputRequestTypeDef(TypedDict):
    policyStoreId: str,
    identitySourceId: str,

DeletePolicyInputRequestTypeDef#

# DeletePolicyInputRequestTypeDef definition

class DeletePolicyInputRequestTypeDef(TypedDict):
    policyStoreId: str,
    policyId: str,

DeletePolicyStoreInputRequestTypeDef#

# DeletePolicyStoreInputRequestTypeDef definition

class DeletePolicyStoreInputRequestTypeDef(TypedDict):
    policyStoreId: str,

DeletePolicyTemplateInputRequestTypeDef#

# DeletePolicyTemplateInputRequestTypeDef definition

class DeletePolicyTemplateInputRequestTypeDef(TypedDict):
    policyStoreId: str,
    policyTemplateId: str,

GetIdentitySourceInputRequestTypeDef#

# GetIdentitySourceInputRequestTypeDef definition

class GetIdentitySourceInputRequestTypeDef(TypedDict):
    policyStoreId: str,
    identitySourceId: str,

IdentitySourceDetailsTypeDef#

# IdentitySourceDetailsTypeDef definition

class IdentitySourceDetailsTypeDef(TypedDict):
    clientIds: NotRequired[List[str]],
    userPoolArn: NotRequired[str],
    discoveryUrl: NotRequired[str],
    openIdIssuer: NotRequired[OpenIdIssuerType],  # (1)
  1. See OpenIdIssuerType

GetPolicyInputRequestTypeDef#

# GetPolicyInputRequestTypeDef definition

class GetPolicyInputRequestTypeDef(TypedDict):
    policyStoreId: str,
    policyId: str,

GetPolicyStoreInputRequestTypeDef#

# GetPolicyStoreInputRequestTypeDef definition

class GetPolicyStoreInputRequestTypeDef(TypedDict):
    policyStoreId: str,

GetPolicyTemplateInputRequestTypeDef#

# GetPolicyTemplateInputRequestTypeDef definition

class GetPolicyTemplateInputRequestTypeDef(TypedDict):
    policyStoreId: str,
    policyTemplateId: str,

GetSchemaInputRequestTypeDef#

# GetSchemaInputRequestTypeDef definition

class GetSchemaInputRequestTypeDef(TypedDict):
    policyStoreId: str,

IdentitySourceFilterTypeDef#

# IdentitySourceFilterTypeDef definition

class IdentitySourceFilterTypeDef(TypedDict):
    principalEntityType: NotRequired[str],

IdentitySourceItemDetailsTypeDef#

# IdentitySourceItemDetailsTypeDef definition

class IdentitySourceItemDetailsTypeDef(TypedDict):
    clientIds: NotRequired[List[str]],
    userPoolArn: NotRequired[str],
    discoveryUrl: NotRequired[str],
    openIdIssuer: NotRequired[OpenIdIssuerType],  # (1)
  1. See OpenIdIssuerType

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListPolicyStoresInputRequestTypeDef#

# ListPolicyStoresInputRequestTypeDef definition

class ListPolicyStoresInputRequestTypeDef(TypedDict):
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

PolicyStoreItemTypeDef#

# PolicyStoreItemTypeDef definition

class PolicyStoreItemTypeDef(TypedDict):
    policyStoreId: str,
    arn: str,
    createdDate: datetime,
    lastUpdatedDate: NotRequired[datetime],
    description: NotRequired[str],

ListPolicyTemplatesInputRequestTypeDef#

# ListPolicyTemplatesInputRequestTypeDef definition

class ListPolicyTemplatesInputRequestTypeDef(TypedDict):
    policyStoreId: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

PolicyTemplateItemTypeDef#

# PolicyTemplateItemTypeDef definition

class PolicyTemplateItemTypeDef(TypedDict):
    policyStoreId: str,
    policyTemplateId: str,
    createdDate: datetime,
    lastUpdatedDate: datetime,
    description: NotRequired[str],

StaticPolicyDefinitionDetailTypeDef#

# StaticPolicyDefinitionDetailTypeDef definition

class StaticPolicyDefinitionDetailTypeDef(TypedDict):
    statement: str,
    description: NotRequired[str],

StaticPolicyDefinitionItemTypeDef#

# StaticPolicyDefinitionItemTypeDef definition

class StaticPolicyDefinitionItemTypeDef(TypedDict):
    description: NotRequired[str],

StaticPolicyDefinitionTypeDef#

# StaticPolicyDefinitionTypeDef definition

class StaticPolicyDefinitionTypeDef(TypedDict):
    statement: str,
    description: NotRequired[str],

SchemaDefinitionTypeDef#

# SchemaDefinitionTypeDef definition

class SchemaDefinitionTypeDef(TypedDict):
    cedarJson: NotRequired[str],

UpdateCognitoUserPoolConfigurationTypeDef#

# UpdateCognitoUserPoolConfigurationTypeDef definition

class UpdateCognitoUserPoolConfigurationTypeDef(TypedDict):
    userPoolArn: str,
    clientIds: NotRequired[Sequence[str]],

UpdateStaticPolicyDefinitionTypeDef#

# UpdateStaticPolicyDefinitionTypeDef definition

class UpdateStaticPolicyDefinitionTypeDef(TypedDict):
    statement: str,
    description: NotRequired[str],

UpdatePolicyTemplateInputRequestTypeDef#

# UpdatePolicyTemplateInputRequestTypeDef definition

class UpdatePolicyTemplateInputRequestTypeDef(TypedDict):
    policyStoreId: str,
    policyTemplateId: str,
    statement: str,
    description: NotRequired[str],

AttributeValueTypeDef#

# AttributeValueTypeDef definition

class AttributeValueTypeDef(TypedDict):
    boolean: NotRequired[bool],
    entityIdentifier: NotRequired[EntityIdentifierTypeDef],  # (1)
    long: NotRequired[int],
    string: NotRequired[str],
    set: NotRequired[Sequence[Dict[str, Any]]],
    record: NotRequired[Mapping[str, Dict[str, Any]]],
  1. See EntityIdentifierTypeDef

EntityItemTypeDef#

# EntityItemTypeDef definition

class EntityItemTypeDef(TypedDict):
    identifier: EntityIdentifierTypeDef,  # (1)
    attributes: NotRequired[Mapping[str, AttributeValueTypeDef]],  # (2)
    parents: NotRequired[Sequence[EntityIdentifierTypeDef]],  # (3)
  1. See EntityIdentifierTypeDef
  2. See AttributeValueTypeDef
  3. See EntityIdentifierTypeDef

EntityReferenceTypeDef#

# EntityReferenceTypeDef definition

class EntityReferenceTypeDef(TypedDict):
    unspecified: NotRequired[bool],
    identifier: NotRequired[EntityIdentifierTypeDef],  # (1)
  1. See EntityIdentifierTypeDef

TemplateLinkedPolicyDefinitionDetailTypeDef#

# TemplateLinkedPolicyDefinitionDetailTypeDef definition

class TemplateLinkedPolicyDefinitionDetailTypeDef(TypedDict):
    policyTemplateId: str,
    principal: NotRequired[EntityIdentifierTypeDef],  # (1)
    resource: NotRequired[EntityIdentifierTypeDef],  # (1)
  1. See EntityIdentifierTypeDef
  2. See EntityIdentifierTypeDef

TemplateLinkedPolicyDefinitionItemTypeDef#

# TemplateLinkedPolicyDefinitionItemTypeDef definition

class TemplateLinkedPolicyDefinitionItemTypeDef(TypedDict):
    policyTemplateId: str,
    principal: NotRequired[EntityIdentifierTypeDef],  # (1)
    resource: NotRequired[EntityIdentifierTypeDef],  # (1)
  1. See EntityIdentifierTypeDef
  2. See EntityIdentifierTypeDef

TemplateLinkedPolicyDefinitionTypeDef#

# TemplateLinkedPolicyDefinitionTypeDef definition

class TemplateLinkedPolicyDefinitionTypeDef(TypedDict):
    policyTemplateId: str,
    principal: NotRequired[EntityIdentifierTypeDef],  # (1)
    resource: NotRequired[EntityIdentifierTypeDef],  # (1)
  1. See EntityIdentifierTypeDef
  2. See EntityIdentifierTypeDef

BatchIsAuthorizedInputItemTypeDef#

# BatchIsAuthorizedInputItemTypeDef definition

class BatchIsAuthorizedInputItemTypeDef(TypedDict):
    principal: NotRequired[EntityIdentifierTypeDef],  # (1)
    action: NotRequired[ActionIdentifierTypeDef],  # (2)
    resource: NotRequired[EntityIdentifierTypeDef],  # (1)
    context: NotRequired[ContextDefinitionTypeDef],  # (4)
  1. See EntityIdentifierTypeDef
  2. See ActionIdentifierTypeDef
  3. See EntityIdentifierTypeDef
  4. See ContextDefinitionTypeDef

CreateIdentitySourceOutputTypeDef#

# CreateIdentitySourceOutputTypeDef definition

class CreateIdentitySourceOutputTypeDef(TypedDict):
    createdDate: datetime,
    identitySourceId: str,
    lastUpdatedDate: datetime,
    policyStoreId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreatePolicyOutputTypeDef#

# CreatePolicyOutputTypeDef definition

class CreatePolicyOutputTypeDef(TypedDict):
    policyStoreId: str,
    policyId: str,
    policyType: PolicyTypeType,  # (1)
    principal: EntityIdentifierTypeDef,  # (2)
    resource: EntityIdentifierTypeDef,  # (2)
    createdDate: datetime,
    lastUpdatedDate: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See PolicyTypeType
  2. See EntityIdentifierTypeDef
  3. See EntityIdentifierTypeDef
  4. See ResponseMetadataTypeDef

CreatePolicyStoreOutputTypeDef#

# CreatePolicyStoreOutputTypeDef definition

class CreatePolicyStoreOutputTypeDef(TypedDict):
    policyStoreId: str,
    arn: str,
    createdDate: datetime,
    lastUpdatedDate: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreatePolicyTemplateOutputTypeDef#

# CreatePolicyTemplateOutputTypeDef definition

class CreatePolicyTemplateOutputTypeDef(TypedDict):
    policyStoreId: str,
    policyTemplateId: str,
    createdDate: datetime,
    lastUpdatedDate: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetPolicyTemplateOutputTypeDef#

# GetPolicyTemplateOutputTypeDef definition

class GetPolicyTemplateOutputTypeDef(TypedDict):
    policyStoreId: str,
    policyTemplateId: str,
    description: str,
    statement: str,
    createdDate: datetime,
    lastUpdatedDate: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetSchemaOutputTypeDef#

# GetSchemaOutputTypeDef definition

class GetSchemaOutputTypeDef(TypedDict):
    policyStoreId: str,
    schema: str,
    createdDate: datetime,
    lastUpdatedDate: datetime,
    namespaces: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

IsAuthorizedOutputTypeDef#

# IsAuthorizedOutputTypeDef definition

class IsAuthorizedOutputTypeDef(TypedDict):
    decision: DecisionType,  # (1)
    determiningPolicies: List[DeterminingPolicyItemTypeDef],  # (2)
    errors: List[EvaluationErrorItemTypeDef],  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See DecisionType
  2. See DeterminingPolicyItemTypeDef
  3. See EvaluationErrorItemTypeDef
  4. See ResponseMetadataTypeDef

IsAuthorizedWithTokenOutputTypeDef#

# IsAuthorizedWithTokenOutputTypeDef definition

class IsAuthorizedWithTokenOutputTypeDef(TypedDict):
    decision: DecisionType,  # (1)
    determiningPolicies: List[DeterminingPolicyItemTypeDef],  # (2)
    errors: List[EvaluationErrorItemTypeDef],  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See DecisionType
  2. See DeterminingPolicyItemTypeDef
  3. See EvaluationErrorItemTypeDef
  4. See ResponseMetadataTypeDef

PutSchemaOutputTypeDef#

# PutSchemaOutputTypeDef definition

class PutSchemaOutputTypeDef(TypedDict):
    policyStoreId: str,
    namespaces: List[str],
    createdDate: datetime,
    lastUpdatedDate: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateIdentitySourceOutputTypeDef#

# UpdateIdentitySourceOutputTypeDef definition

class UpdateIdentitySourceOutputTypeDef(TypedDict):
    createdDate: datetime,
    identitySourceId: str,
    lastUpdatedDate: datetime,
    policyStoreId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdatePolicyOutputTypeDef#

# UpdatePolicyOutputTypeDef definition

class UpdatePolicyOutputTypeDef(TypedDict):
    policyStoreId: str,
    policyId: str,
    policyType: PolicyTypeType,  # (1)
    principal: EntityIdentifierTypeDef,  # (2)
    resource: EntityIdentifierTypeDef,  # (2)
    createdDate: datetime,
    lastUpdatedDate: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See PolicyTypeType
  2. See EntityIdentifierTypeDef
  3. See EntityIdentifierTypeDef
  4. See ResponseMetadataTypeDef

UpdatePolicyStoreOutputTypeDef#

# UpdatePolicyStoreOutputTypeDef definition

class UpdatePolicyStoreOutputTypeDef(TypedDict):
    policyStoreId: str,
    arn: str,
    createdDate: datetime,
    lastUpdatedDate: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdatePolicyTemplateOutputTypeDef#

# UpdatePolicyTemplateOutputTypeDef definition

class UpdatePolicyTemplateOutputTypeDef(TypedDict):
    policyStoreId: str,
    policyTemplateId: str,
    createdDate: datetime,
    lastUpdatedDate: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ConfigurationTypeDef#

# ConfigurationTypeDef definition

class ConfigurationTypeDef(TypedDict):
    cognitoUserPoolConfiguration: NotRequired[CognitoUserPoolConfigurationTypeDef],  # (1)
  1. See CognitoUserPoolConfigurationTypeDef

CreatePolicyStoreInputRequestTypeDef#

# CreatePolicyStoreInputRequestTypeDef definition

class CreatePolicyStoreInputRequestTypeDef(TypedDict):
    validationSettings: ValidationSettingsTypeDef,  # (1)
    clientToken: NotRequired[str],
    description: NotRequired[str],
  1. See ValidationSettingsTypeDef

GetPolicyStoreOutputTypeDef#

# GetPolicyStoreOutputTypeDef definition

class GetPolicyStoreOutputTypeDef(TypedDict):
    policyStoreId: str,
    arn: str,
    validationSettings: ValidationSettingsTypeDef,  # (1)
    createdDate: datetime,
    lastUpdatedDate: datetime,
    description: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ValidationSettingsTypeDef
  2. See ResponseMetadataTypeDef

UpdatePolicyStoreInputRequestTypeDef#

# UpdatePolicyStoreInputRequestTypeDef definition

class UpdatePolicyStoreInputRequestTypeDef(TypedDict):
    policyStoreId: str,
    validationSettings: ValidationSettingsTypeDef,  # (1)
    description: NotRequired[str],
  1. See ValidationSettingsTypeDef

GetIdentitySourceOutputTypeDef#

# GetIdentitySourceOutputTypeDef definition

class GetIdentitySourceOutputTypeDef(TypedDict):
    createdDate: datetime,
    details: IdentitySourceDetailsTypeDef,  # (1)
    identitySourceId: str,
    lastUpdatedDate: datetime,
    policyStoreId: str,
    principalEntityType: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See IdentitySourceDetailsTypeDef
  2. See ResponseMetadataTypeDef

ListIdentitySourcesInputRequestTypeDef#

# ListIdentitySourcesInputRequestTypeDef definition

class ListIdentitySourcesInputRequestTypeDef(TypedDict):
    policyStoreId: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
    filters: NotRequired[Sequence[IdentitySourceFilterTypeDef]],  # (1)
  1. See IdentitySourceFilterTypeDef

IdentitySourceItemTypeDef#

# IdentitySourceItemTypeDef definition

class IdentitySourceItemTypeDef(TypedDict):
    createdDate: datetime,
    details: IdentitySourceItemDetailsTypeDef,  # (1)
    identitySourceId: str,
    lastUpdatedDate: datetime,
    policyStoreId: str,
    principalEntityType: str,
  1. See IdentitySourceItemDetailsTypeDef

ListIdentitySourcesInputListIdentitySourcesPaginateTypeDef#

# ListIdentitySourcesInputListIdentitySourcesPaginateTypeDef definition

class ListIdentitySourcesInputListIdentitySourcesPaginateTypeDef(TypedDict):
    policyStoreId: str,
    filters: NotRequired[Sequence[IdentitySourceFilterTypeDef]],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See IdentitySourceFilterTypeDef
  2. See PaginatorConfigTypeDef

ListPolicyStoresInputListPolicyStoresPaginateTypeDef#

# ListPolicyStoresInputListPolicyStoresPaginateTypeDef definition

class ListPolicyStoresInputListPolicyStoresPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListPolicyTemplatesInputListPolicyTemplatesPaginateTypeDef#

# ListPolicyTemplatesInputListPolicyTemplatesPaginateTypeDef definition

class ListPolicyTemplatesInputListPolicyTemplatesPaginateTypeDef(TypedDict):
    policyStoreId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListPolicyStoresOutputTypeDef#

# ListPolicyStoresOutputTypeDef definition

class ListPolicyStoresOutputTypeDef(TypedDict):
    nextToken: str,
    policyStores: List[PolicyStoreItemTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PolicyStoreItemTypeDef
  2. See ResponseMetadataTypeDef

ListPolicyTemplatesOutputTypeDef#

# ListPolicyTemplatesOutputTypeDef definition

class ListPolicyTemplatesOutputTypeDef(TypedDict):
    nextToken: str,
    policyTemplates: List[PolicyTemplateItemTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PolicyTemplateItemTypeDef
  2. See ResponseMetadataTypeDef

PutSchemaInputRequestTypeDef#

# PutSchemaInputRequestTypeDef definition

class PutSchemaInputRequestTypeDef(TypedDict):
    policyStoreId: str,
    definition: SchemaDefinitionTypeDef,  # (1)
  1. See SchemaDefinitionTypeDef

UpdateConfigurationTypeDef#

# UpdateConfigurationTypeDef definition

class UpdateConfigurationTypeDef(TypedDict):
    cognitoUserPoolConfiguration: NotRequired[UpdateCognitoUserPoolConfigurationTypeDef],  # (1)
  1. See UpdateCognitoUserPoolConfigurationTypeDef

UpdatePolicyDefinitionTypeDef#

# UpdatePolicyDefinitionTypeDef definition

class UpdatePolicyDefinitionTypeDef(TypedDict):
    static: NotRequired[UpdateStaticPolicyDefinitionTypeDef],  # (1)
  1. See UpdateStaticPolicyDefinitionTypeDef

EntitiesDefinitionTypeDef#

# EntitiesDefinitionTypeDef definition

class EntitiesDefinitionTypeDef(TypedDict):
    entityList: NotRequired[Sequence[EntityItemType