VerifiedPermissionsClient#
Index > VerifiedPermissions > VerifiedPermissionsClient
Auto-generated documentation for VerifiedPermissions type annotations stubs module types-boto3-verifiedpermissions.
VerifiedPermissionsClient#
Type annotations and code completion for boto3.client("verifiedpermissions").
 boto3 documentation
# VerifiedPermissionsClient usage example
from boto3.session import Session
from types_boto3_verifiedpermissions.client import VerifiedPermissionsClient
def get_verifiedpermissions_client() -> VerifiedPermissionsClient:
    return Session().client("verifiedpermissions")Exceptions#
boto3 client exceptions are generated in runtime.
This class provides code completion for boto3.client("verifiedpermissions").exceptions structure.
# Exceptions.exceptions usage example
client = boto3.client("verifiedpermissions")
try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.InvalidStateException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.TooManyTagsException,
    client.exceptions.ValidationException,
) as e:
    print(e)# Exceptions.exceptions type checking example
from types_boto3_verifiedpermissions.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...Methods#
can_paginate#
Type annotations and code completion for boto3.client("verifiedpermissions").can_paginate method.
 boto3 documentation
# can_paginate method definition
def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...generate_presigned_url#
Type annotations and code completion for boto3.client("verifiedpermissions").generate_presigned_url method.
 boto3 documentation
# generate_presigned_url method definition
def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...batch_get_policy#
Retrieves information about a group (batch) of policies.
Type annotations and code completion for boto3.client("verifiedpermissions").batch_get_policy method.
 boto3 documentation
# batch_get_policy method definition
def batch_get_policy(
    self,
    *,
    requests: Sequence[BatchGetPolicyInputItemTypeDef],  # (1)
) -> BatchGetPolicyOutputTypeDef:  # (2)
    ...- See Sequence[BatchGetPolicyInputItemTypeDef]
- See BatchGetPolicyOutputTypeDef
# batch_get_policy method usage example with argument unpacking
kwargs: BatchGetPolicyInputTypeDef = {  # (1)
    "requests": ...,
}
parent.batch_get_policy(**kwargs)batch_is_authorized#
Makes a series of decisions about multiple authorization requests for one principal or resource.
Type annotations and code completion for boto3.client("verifiedpermissions").batch_is_authorized method.
 boto3 documentation
# batch_is_authorized method definition
def batch_is_authorized(
    self,
    *,
    policyStoreId: str,
    requests: Sequence[BatchIsAuthorizedInputItemUnionTypeDef],  # (1)
    entities: EntitiesDefinitionTypeDef = ...,  # (2)
) -> BatchIsAuthorizedOutputTypeDef:  # (3)
    ...- See Sequence[BatchIsAuthorizedInputItemUnionTypeDef]
- See EntitiesDefinitionTypeDef
- See BatchIsAuthorizedOutputTypeDef
# batch_is_authorized method usage example with argument unpacking
kwargs: BatchIsAuthorizedInputTypeDef = {  # (1)
    "policyStoreId": ...,
    "requests": ...,
}
parent.batch_is_authorized(**kwargs)batch_is_authorized_with_token#
Makes a series of decisions about multiple authorization requests for one token.
Type annotations and code completion for boto3.client("verifiedpermissions").batch_is_authorized_with_token method.
 boto3 documentation
# batch_is_authorized_with_token method definition
def batch_is_authorized_with_token(
    self,
    *,
    policyStoreId: str,
    requests: Sequence[BatchIsAuthorizedWithTokenInputItemUnionTypeDef],  # (1)
    identityToken: str = ...,
    accessToken: str = ...,
    entities: EntitiesDefinitionTypeDef = ...,  # (2)
) -> BatchIsAuthorizedWithTokenOutputTypeDef:  # (3)
    ...- See Sequence[BatchIsAuthorizedWithTokenInputItemUnionTypeDef]
- See EntitiesDefinitionTypeDef
- See BatchIsAuthorizedWithTokenOutputTypeDef
# batch_is_authorized_with_token method usage example with argument unpacking
kwargs: BatchIsAuthorizedWithTokenInputTypeDef = {  # (1)
    "policyStoreId": ...,
    "requests": ...,
}
parent.batch_is_authorized_with_token(**kwargs)create_identity_source#
Adds an identity source to a policy store-an Amazon Cognito user pool or OpenID Connect (OIDC) identity provider (IdP).
Type annotations and code completion for boto3.client("verifiedpermissions").create_identity_source method.
 boto3 documentation
# create_identity_source method definition
def create_identity_source(
    self,
    *,
    policyStoreId: str,
    configuration: ConfigurationTypeDef,  # (1)
    clientToken: str = ...,
    principalEntityType: str = ...,
) -> CreateIdentitySourceOutputTypeDef:  # (2)
    ...# create_identity_source method usage example with argument unpacking
kwargs: CreateIdentitySourceInputTypeDef = {  # (1)
    "policyStoreId": ...,
    "configuration": ...,
}
parent.create_identity_source(**kwargs)create_policy#
Creates a Cedar policy and saves it in the specified policy store.
Type annotations and code completion for boto3.client("verifiedpermissions").create_policy method.
 boto3 documentation
# create_policy method definition
def create_policy(
    self,
    *,
    policyStoreId: str,
    definition: PolicyDefinitionTypeDef,  # (1)
    clientToken: str = ...,
) -> CreatePolicyOutputTypeDef:  # (2)
    ...# create_policy method usage example with argument unpacking
kwargs: CreatePolicyInputTypeDef = {  # (1)
    "policyStoreId": ...,
    "definition": ...,
}
parent.create_policy(**kwargs)create_policy_store#
Creates a policy store.
Type annotations and code completion for boto3.client("verifiedpermissions").create_policy_store method.
 boto3 documentation
# create_policy_store method definition
def create_policy_store(
    self,
    *,
    validationSettings: ValidationSettingsTypeDef,  # (1)
    clientToken: str = ...,
    description: str = ...,
    deletionProtection: DeletionProtectionType = ...,  # (2)
    tags: Mapping[str, str] = ...,
) -> CreatePolicyStoreOutputTypeDef:  # (3)
    ...# create_policy_store method usage example with argument unpacking
kwargs: CreatePolicyStoreInputTypeDef = {  # (1)
    "validationSettings": ...,
}
parent.create_policy_store(**kwargs)create_policy_template#
Creates a policy template.
Type annotations and code completion for boto3.client("verifiedpermissions").create_policy_template method.
 boto3 documentation
# create_policy_template method definition
def create_policy_template(
    self,
    *,
    policyStoreId: str,
    statement: str,
    clientToken: str = ...,
    description: str = ...,
) -> CreatePolicyTemplateOutputTypeDef:  # (1)
    ...# create_policy_template method usage example with argument unpacking
kwargs: CreatePolicyTemplateInputTypeDef = {  # (1)
    "policyStoreId": ...,
    "statement": ...,
}
parent.create_policy_template(**kwargs)delete_identity_source#
Deletes an identity source that references an identity provider (IdP) such as Amazon Cognito.
Type annotations and code completion for boto3.client("verifiedpermissions").delete_identity_source method.
 boto3 documentation
# delete_identity_source method definition
def delete_identity_source(
    self,
    *,
    policyStoreId: str,
    identitySourceId: str,
) -> Dict[str, Any]:
    ...# delete_identity_source method usage example with argument unpacking
kwargs: DeleteIdentitySourceInputTypeDef = {  # (1)
    "policyStoreId": ...,
    "identitySourceId": ...,
}
parent.delete_identity_source(**kwargs)delete_policy#
Deletes the specified policy from the policy store.
Type annotations and code completion for boto3.client("verifiedpermissions").delete_policy method.
 boto3 documentation
# delete_policy method definition
def delete_policy(
    self,
    *,
    policyStoreId: str,
    policyId: str,
) -> Dict[str, Any]:
    ...# delete_policy method usage example with argument unpacking
kwargs: DeletePolicyInputTypeDef = {  # (1)
    "policyStoreId": ...,
    "policyId": ...,
}
parent.delete_policy(**kwargs)delete_policy_store#
Deletes the specified policy store.
Type annotations and code completion for boto3.client("verifiedpermissions").delete_policy_store method.
 boto3 documentation
# delete_policy_store method definition
def delete_policy_store(
    self,
    *,
    policyStoreId: str,
) -> Dict[str, Any]:
    ...# delete_policy_store method usage example with argument unpacking
kwargs: DeletePolicyStoreInputTypeDef = {  # (1)
    "policyStoreId": ...,
}
parent.delete_policy_store(**kwargs)delete_policy_template#
Deletes the specified policy template from the policy store.
Type annotations and code completion for boto3.client("verifiedpermissions").delete_policy_template method.
 boto3 documentation
# delete_policy_template method definition
def delete_policy_template(
    self,
    *,
    policyStoreId: str,
    policyTemplateId: str,
) -> Dict[str, Any]:
    ...# delete_policy_template method usage example with argument unpacking
kwargs: DeletePolicyTemplateInputTypeDef = {  # (1)
    "policyStoreId": ...,
    "policyTemplateId": ...,
}
parent.delete_policy_template(**kwargs)get_identity_source#
Retrieves the details about the specified identity source.
Type annotations and code completion for boto3.client("verifiedpermissions").get_identity_source method.
 boto3 documentation
# get_identity_source method definition
def get_identity_source(
    self,
    *,
    policyStoreId: str,
    identitySourceId: str,
) -> GetIdentitySourceOutputTypeDef:  # (1)
    ...# get_identity_source method usage example with argument unpacking
kwargs: GetIdentitySourceInputTypeDef = {  # (1)
    "policyStoreId": ...,
    "identitySourceId": ...,
}
parent.get_identity_source(**kwargs)get_policy#
Retrieves information about the specified policy.
Type annotations and code completion for boto3.client("verifiedpermissions").get_policy method.
 boto3 documentation
# get_policy method definition
def get_policy(
    self,
    *,
    policyStoreId: str,
    policyId: str,
) -> GetPolicyOutputTypeDef:  # (1)
    ...# get_policy method usage example with argument unpacking
kwargs: GetPolicyInputTypeDef = {  # (1)
    "policyStoreId": ...,
    "policyId": ...,
}
parent.get_policy(**kwargs)get_policy_store#
Retrieves details about a policy store.
Type annotations and code completion for boto3.client("verifiedpermissions").get_policy_store method.
 boto3 documentation
# get_policy_store method definition
def get_policy_store(
    self,
    *,
    policyStoreId: str,
    tags: bool = ...,
) -> GetPolicyStoreOutputTypeDef:  # (1)
    ...# get_policy_store method usage example with argument unpacking
kwargs: GetPolicyStoreInputTypeDef = {  # (1)
    "policyStoreId": ...,
}
parent.get_policy_store(**kwargs)get_policy_template#
Retrieve the details for the specified policy template in the specified policy store.
Type annotations and code completion for boto3.client("verifiedpermissions").get_policy_template method.
 boto3 documentation
# get_policy_template method definition
def get_policy_template(
    self,
    *,
    policyStoreId: str,
    policyTemplateId: str,
) -> GetPolicyTemplateOutputTypeDef:  # (1)
    ...# get_policy_template method usage example with argument unpacking
kwargs: GetPolicyTemplateInputTypeDef = {  # (1)
    "policyStoreId": ...,
    "policyTemplateId": ...,
}
parent.get_policy_template(**kwargs)get_schema#
Retrieve the details for the specified schema in the specified policy store.
Type annotations and code completion for boto3.client("verifiedpermissions").get_schema method.
 boto3 documentation
# get_schema method definition
def get_schema(
    self,
    *,
    policyStoreId: str,
) -> GetSchemaOutputTypeDef:  # (1)
    ...# get_schema method usage example with argument unpacking
kwargs: GetSchemaInputTypeDef = {  # (1)
    "policyStoreId": ...,
}
parent.get_schema(**kwargs)is_authorized#
Makes an authorization decision about a service request described in the parameters.
Type annotations and code completion for boto3.client("verifiedpermissions").is_authorized method.
 boto3 documentation
# is_authorized method definition
def is_authorized(
    self,
    *,
    policyStoreId: str,
    principal: EntityIdentifierTypeDef = ...,  # (1)
    action: ActionIdentifierTypeDef = ...,  # (2)
    resource: EntityIdentifierTypeDef = ...,  # (1)
    context: ContextDefinitionUnionTypeDef = ...,  # (4)
    entities: EntitiesDefinitionTypeDef = ...,  # (5)
) -> IsAuthorizedOutputTypeDef:  # (6)
    ...- See EntityIdentifierTypeDef
- See ActionIdentifierTypeDef
- See EntityIdentifierTypeDef
- See ContextDefinitionUnionTypeDef
- See EntitiesDefinitionTypeDef
- See IsAuthorizedOutputTypeDef
# is_authorized method usage example with argument unpacking
kwargs: IsAuthorizedInputTypeDef = {  # (1)
    "policyStoreId": ...,
}
parent.is_authorized(**kwargs)is_authorized_with_token#
Makes an authorization decision about a service request described in the parameters.
Type annotations and code completion for boto3.client("verifiedpermissions").is_authorized_with_token method.
 boto3 documentation
# is_authorized_with_token method definition
def is_authorized_with_token(
    self,
    *,
    policyStoreId: str,
    identityToken: str = ...,
    accessToken: str = ...,
    action: ActionIdentifierTypeDef = ...,  # (1)
    resource: EntityIdentifierTypeDef = ...,  # (2)
    context: ContextDefinitionUnionTypeDef = ...,  # (3)
    entities: EntitiesDefinitionTypeDef = ...,  # (4)
) -> IsAuthorizedWithTokenOutputTypeDef:  # (5)
    ...- See ActionIdentifierTypeDef
- See EntityIdentifierTypeDef
- See ContextDefinitionUnionTypeDef
- See EntitiesDefinitionTypeDef
- See IsAuthorizedWithTokenOutputTypeDef
# is_authorized_with_token method usage example with argument unpacking
kwargs: IsAuthorizedWithTokenInputTypeDef = {  # (1)
    "policyStoreId": ...,
}
parent.is_authorized_with_token(**kwargs)list_identity_sources#
Returns a paginated list of all of the identity sources defined in the specified policy store.
Type annotations and code completion for boto3.client("verifiedpermissions").list_identity_sources method.
 boto3 documentation
# list_identity_sources method definition
def list_identity_sources(
    self,
    *,
    policyStoreId: str,
    nextToken: str = ...,
    maxResults: int = ...,
    filters: Sequence[IdentitySourceFilterTypeDef] = ...,  # (1)
) -> ListIdentitySourcesOutputTypeDef:  # (2)
    ...- See Sequence[IdentitySourceFilterTypeDef]
- See ListIdentitySourcesOutputTypeDef
# list_identity_sources method usage example with argument unpacking
kwargs: ListIdentitySourcesInputTypeDef = {  # (1)
    "policyStoreId": ...,
}
parent.list_identity_sources(**kwargs)list_policies#
Returns a paginated list of all policies stored in the specified policy store.
Type annotations and code completion for boto3.client("verifiedpermissions").list_policies method.
 boto3 documentation
# list_policies method definition
def list_policies(
    self,
    *,
    policyStoreId: str,
    nextToken: str = ...,
    maxResults: int = ...,
    filter: PolicyFilterTypeDef = ...,  # (1)
) -> ListPoliciesOutputTypeDef:  # (2)
    ...# list_policies method usage example with argument unpacking
kwargs: ListPoliciesInputTypeDef = {  # (1)
    "policyStoreId": ...,
}
parent.list_policies(**kwargs)list_policy_stores#
Returns a paginated list of all policy stores in the calling Amazon Web Services account.
Type annotations and code completion for boto3.client("verifiedpermissions").list_policy_stores method.
 boto3 documentation
# list_policy_stores method definition
def list_policy_stores(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListPolicyStoresOutputTypeDef:  # (1)
    ...# list_policy_stores method usage example with argument unpacking
kwargs: ListPolicyStoresInputTypeDef = {  # (1)
    "nextToken": ...,
}
parent.list_policy_stores(**kwargs)list_policy_templates#
Returns a paginated list of all policy templates in the specified policy store.
Type annotations and code completion for boto3.client("verifiedpermissions").list_policy_templates method.
 boto3 documentation
# list_policy_templates method definition
def list_policy_templates(
    self,
    *,
    policyStoreId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListPolicyTemplatesOutputTypeDef:  # (1)
    ...# list_policy_templates method usage example with argument unpacking
kwargs: ListPolicyTemplatesInputTypeDef = {  # (1)
    "policyStoreId": ...,
}
parent.list_policy_templates(**kwargs)list_tags_for_resource#
Returns the tags associated with the specified Amazon Verified Permissions resource.
Type annotations and code completion for boto3.client("verifiedpermissions").list_tags_for_resource method.
 boto3 documentation
# list_tags_for_resource method definition
def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceOutputTypeDef:  # (1)
    ...# list_tags_for_resource method usage example with argument unpacking
kwargs: ListTagsForResourceInputTypeDef = {  # (1)
    "resourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)put_schema#
Creates or updates the policy schema in the specified policy store.
Type annotations and code completion for boto3.client("verifiedpermissions").put_schema method.
 boto3 documentation
# put_schema method definition
def put_schema(
    self,
    *,
    policyStoreId: str,
    definition: SchemaDefinitionTypeDef,  # (1)
) -> PutSchemaOutputTypeDef:  # (2)
    ...# put_schema method usage example with argument unpacking
kwargs: PutSchemaInputTypeDef = {  # (1)
    "policyStoreId": ...,
    "definition": ...,
}
parent.put_schema(**kwargs)tag_resource#
Assigns one or more tags (key-value pairs) to the specified Amazon Verified Permissions resource.
Type annotations and code completion for boto3.client("verifiedpermissions").tag_resource method.
 boto3 documentation
# tag_resource method definition
def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...# tag_resource method usage example with argument unpacking
kwargs: TagResourceInputTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}
parent.tag_resource(**kwargs)untag_resource#
Removes one or more tags from the specified Amazon Verified Permissions resource.
Type annotations and code completion for boto3.client("verifiedpermissions").untag_resource method.
 boto3 documentation
# untag_resource method definition
def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...# untag_resource method usage example with argument unpacking
kwargs: UntagResourceInputTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}
parent.untag_resource(**kwargs)update_identity_source#
Updates the specified identity source to use a new identity provider (IdP), or to change the mapping of identities from the IdP to a different principal entity type.
Type annotations and code completion for boto3.client("verifiedpermissions").update_identity_source method.
 boto3 documentation
# update_identity_source method definition
def update_identity_source(
    self,
    *,
    policyStoreId: str,
    identitySourceId: str,
    updateConfiguration: UpdateConfigurationTypeDef,  # (1)
    principalEntityType: str = ...,
) -> UpdateIdentitySourceOutputTypeDef:  # (2)
    ...# update_identity_source method usage example with argument unpacking
kwargs: UpdateIdentitySourceInputTypeDef = {  # (1)
    "policyStoreId": ...,
    "identitySourceId": ...,
    "updateConfiguration": ...,
}
parent.update_identity_source(**kwargs)update_policy#
Modifies a Cedar static policy in the specified policy store.
Type annotations and code completion for boto3.client("verifiedpermissions").update_policy method.
 boto3 documentation
# update_policy method definition
def update_policy(
    self,
    *,
    policyStoreId: str,
    policyId: str,
    definition: UpdatePolicyDefinitionTypeDef,  # (1)
) -> UpdatePolicyOutputTypeDef:  # (2)
    ...# update_policy method usage example with argument unpacking
kwargs: UpdatePolicyInputTypeDef = {  # (1)
    "policyStoreId": ...,
    "policyId": ...,
    "definition": ...,
}
parent.update_policy(**kwargs)update_policy_store#
Modifies the validation setting for a policy store.
Type annotations and code completion for boto3.client("verifiedpermissions").update_policy_store method.
 boto3 documentation
# update_policy_store method definition
def update_policy_store(
    self,
    *,
    policyStoreId: str,
    validationSettings: ValidationSettingsTypeDef,  # (1)
    deletionProtection: DeletionProtectionType = ...,  # (2)
    description: str = ...,
) -> UpdatePolicyStoreOutputTypeDef:  # (3)
    ...# update_policy_store method usage example with argument unpacking
kwargs: UpdatePolicyStoreInputTypeDef = {  # (1)
    "policyStoreId": ...,
    "validationSettings": ...,
}
parent.update_policy_store(**kwargs)update_policy_template#
Updates the specified policy template.
Type annotations and code completion for boto3.client("verifiedpermissions").update_policy_template method.
 boto3 documentation
# update_policy_template method definition
def update_policy_template(
    self,
    *,
    policyStoreId: str,
    policyTemplateId: str,
    statement: str,
    description: str = ...,
) -> UpdatePolicyTemplateOutputTypeDef:  # (1)
    ...# update_policy_template method usage example with argument unpacking
kwargs: UpdatePolicyTemplateInputTypeDef = {  # (1)
    "policyStoreId": ...,
    "policyTemplateId": ...,
    "statement": ...,
}
parent.update_policy_template(**kwargs)get_paginator#
Type annotations and code completion for boto3.client("verifiedpermissions").get_paginator method with overloads.
- client.get_paginator("list_identity_sources")-> ListIdentitySourcesPaginator
- client.get_paginator("list_policies")-> ListPoliciesPaginator
- client.get_paginator("list_policy_stores")-> ListPolicyStoresPaginator
- client.get_paginator("list_policy_templates")-> ListPolicyTemplatesPaginator