VerifiedPermissionsClient#
Index > VerifiedPermissions > VerifiedPermissionsClient
Auto-generated documentation for VerifiedPermissions type annotations stubs module mypy-boto3-verifiedpermissions.
VerifiedPermissionsClient#
Type annotations and code completion for boto3.client("verifiedpermissions")
.
boto3 documentation
# VerifiedPermissionsClient usage example
from boto3.session import Session
from mypy_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.ResourceNotFoundException,
client.exceptions.ServiceQuotaExceededException,
client.exceptions.ThrottlingException,
client.exceptions.ValidationException,
) as e:
print(e)
# Exceptions.exceptions type checking example
from mypy_boto3_verifiedpermissions.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
...
Methods#
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[BatchIsAuthorizedInputItemTypeDef], # (1)
entities: EntitiesDefinitionTypeDef = ..., # (2)
) -> BatchIsAuthorizedOutputTypeDef: # (3)
...
- See BatchIsAuthorizedInputItemTypeDef
- See EntitiesDefinitionTypeDef
- See BatchIsAuthorizedOutputTypeDef
# batch_is_authorized method usage example with argument unpacking
kwargs: BatchIsAuthorizedInputRequestTypeDef = { # (1)
"policyStoreId": ...,
"requests": ...,
}
parent.batch_is_authorized(**kwargs)
can_paginate#
Check if an operation can be paginated.
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:
...
close#
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("verifiedpermissions").close
method.
boto3 documentation
# close method definition
def close(
self,
) -> None:
...
create_identity_source#
Creates a reference to an Amazon Cognito user pool as an external 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: CreateIdentitySourceInputRequestTypeDef = { # (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: CreatePolicyInputRequestTypeDef = { # (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 = ...,
) -> CreatePolicyStoreOutputTypeDef: # (2)
...
# create_policy_store method usage example with argument unpacking
kwargs: CreatePolicyStoreInputRequestTypeDef = { # (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: CreatePolicyTemplateInputRequestTypeDef = { # (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: DeleteIdentitySourceInputRequestTypeDef = { # (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: DeletePolicyInputRequestTypeDef = { # (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: DeletePolicyStoreInputRequestTypeDef = { # (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: DeletePolicyTemplateInputRequestTypeDef = { # (1)
"policyStoreId": ...,
"policyTemplateId": ...,
}
parent.delete_policy_template(**kwargs)
generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
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:
...
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: GetIdentitySourceInputRequestTypeDef = { # (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: GetPolicyInputRequestTypeDef = { # (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,
) -> GetPolicyStoreOutputTypeDef: # (1)
...
# get_policy_store method usage example with argument unpacking
kwargs: GetPolicyStoreInputRequestTypeDef = { # (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: GetPolicyTemplateInputRequestTypeDef = { # (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: GetSchemaInputRequestTypeDef = { # (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.