@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonVerifiedPermissions extends Object implements AmazonVerifiedPermissions
AmazonVerifiedPermissions
. Convenient method forms pass through to the
corresponding overload that takes a request object, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
BatchIsAuthorizedResult |
batchIsAuthorized(BatchIsAuthorizedRequest request)
Makes a series of decisions about multiple authorization requests for one principal or resource.
|
BatchIsAuthorizedWithTokenResult |
batchIsAuthorizedWithToken(BatchIsAuthorizedWithTokenRequest request)
Makes a series of decisions about multiple authorization requests for one token.
|
CreateIdentitySourceResult |
createIdentitySource(CreateIdentitySourceRequest request)
Creates a reference to an Amazon Cognito user pool as an external identity provider (IdP).
|
CreatePolicyResult |
createPolicy(CreatePolicyRequest request)
Creates a Cedar policy and saves it in the specified policy store.
|
CreatePolicyStoreResult |
createPolicyStore(CreatePolicyStoreRequest request)
Creates a policy store.
|
CreatePolicyTemplateResult |
createPolicyTemplate(CreatePolicyTemplateRequest request)
Creates a policy template.
|
DeleteIdentitySourceResult |
deleteIdentitySource(DeleteIdentitySourceRequest request)
Deletes an identity source that references an identity provider (IdP) such as Amazon Cognito.
|
DeletePolicyResult |
deletePolicy(DeletePolicyRequest request)
Deletes the specified policy from the policy store.
|
DeletePolicyStoreResult |
deletePolicyStore(DeletePolicyStoreRequest request)
Deletes the specified policy store.
|
DeletePolicyTemplateResult |
deletePolicyTemplate(DeletePolicyTemplateRequest request)
Deletes the specified policy template from the policy store.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetIdentitySourceResult |
getIdentitySource(GetIdentitySourceRequest request)
Retrieves the details about the specified identity source.
|
GetPolicyResult |
getPolicy(GetPolicyRequest request)
Retrieves information about the specified policy.
|
GetPolicyStoreResult |
getPolicyStore(GetPolicyStoreRequest request)
Retrieves details about a policy store.
|
GetPolicyTemplateResult |
getPolicyTemplate(GetPolicyTemplateRequest request)
Retrieve the details for the specified policy template in the specified policy store.
|
GetSchemaResult |
getSchema(GetSchemaRequest request)
Retrieve the details for the specified schema in the specified policy store.
|
IsAuthorizedResult |
isAuthorized(IsAuthorizedRequest request)
Makes an authorization decision about a service request described in the parameters.
|
IsAuthorizedWithTokenResult |
isAuthorizedWithToken(IsAuthorizedWithTokenRequest request)
Makes an authorization decision about a service request described in the parameters.
|
ListIdentitySourcesResult |
listIdentitySources(ListIdentitySourcesRequest request)
Returns a paginated list of all of the identity sources defined in the specified policy store.
|
ListPoliciesResult |
listPolicies(ListPoliciesRequest request)
Returns a paginated list of all policies stored in the specified policy store.
|
ListPolicyStoresResult |
listPolicyStores(ListPolicyStoresRequest request)
Returns a paginated list of all policy stores in the calling Amazon Web Services account.
|
ListPolicyTemplatesResult |
listPolicyTemplates(ListPolicyTemplatesRequest request)
Returns a paginated list of all policy templates in the specified policy store.
|
PutSchemaResult |
putSchema(PutSchemaRequest request)
Creates or updates the policy schema in the specified policy store.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
UpdateIdentitySourceResult |
updateIdentitySource(UpdateIdentitySourceRequest request)
Updates the specified identity source to use a new identity provider (IdP) source, or to change the mapping of
identities from the IdP to a different principal entity type.
|
UpdatePolicyResult |
updatePolicy(UpdatePolicyRequest request)
Modifies a Cedar static policy in the specified policy store.
|
UpdatePolicyStoreResult |
updatePolicyStore(UpdatePolicyStoreRequest request)
Modifies the validation setting for a policy store.
|
UpdatePolicyTemplateResult |
updatePolicyTemplate(UpdatePolicyTemplateRequest request)
Updates the specified policy template.
|
public BatchIsAuthorizedResult batchIsAuthorized(BatchIsAuthorizedRequest request)
AmazonVerifiedPermissions
Makes a series of decisions about multiple authorization requests for one principal or resource. Each request
contains the equivalent content of an IsAuthorized
request: principal, action, resource, and
context. Either the principal
or the resource
parameter must be identical across all
requests. For example, Verified Permissions won't evaluate a pair of requests where bob
views
photo1
and alice
views photo2
. Authorization of bob
to view
photo1
and photo2
, or bob
and alice
to view
photo1
, are valid batches.
The request is evaluated against all policies in the specified policy store that match the entities that you
declare. The result of the decisions is a series of Allow
or Deny
responses, along with
the IDs of the policies that produced each decision.
The entities
of a BatchIsAuthorized
API request can contain up to 100 principals and up
to 100 resources. The requests
of a BatchIsAuthorized
API request can contain up to 30
requests.
The BatchIsAuthorized
operation doesn't have its own IAM permission. To authorize this operation for
Amazon Web Services principals, include the permission verifiedpermissions:IsAuthorized
in their IAM
policies.
batchIsAuthorized
in interface AmazonVerifiedPermissions
public BatchIsAuthorizedWithTokenResult batchIsAuthorizedWithToken(BatchIsAuthorizedWithTokenRequest request)
AmazonVerifiedPermissions
Makes a series of decisions about multiple authorization requests for one token. The principal in this request comes from an external identity source in the form of an identity or access token, formatted as a JSON web token (JWT). The information in the parameters can also define additional context that Verified Permissions can include in the evaluations.
The request is evaluated against all policies in the specified policy store that match the entities that you
provide in the entities declaration and in the token. The result of the decisions is a series of
Allow
or Deny
responses, along with the IDs of the policies that produced each
decision.
The entities
of a BatchIsAuthorizedWithToken
API request can contain up to 100
resources and up to 99 user groups. The requests
of a BatchIsAuthorizedWithToken
API
request can contain up to 30 requests.
The BatchIsAuthorizedWithToken
operation doesn't have its own IAM permission. To authorize this
operation for Amazon Web Services principals, include the permission
verifiedpermissions:IsAuthorizedWithToken
in their IAM policies.
batchIsAuthorizedWithToken
in interface AmazonVerifiedPermissions
public CreateIdentitySourceResult createIdentitySource(CreateIdentitySourceRequest request)
AmazonVerifiedPermissions
Creates a reference to an Amazon Cognito user pool as an external identity provider (IdP).
After you create an identity source, you can use the identities provided by the IdP as proxies for the principal in authorization queries that use the IsAuthorizedWithToken operation. These identities take the form of tokens that contain claims about the user, such as IDs, attributes and group memberships. Amazon Cognito provides both identity tokens and access tokens, and Verified Permissions can use either or both. Any combination of identity and access tokens results in the same Cedar principal. Verified Permissions automatically translates the information about the identities into the standard Cedar attributes that can be evaluated by your policies. Because the Amazon Cognito identity and access tokens can contain different information, the tokens you choose to use determine which principal attributes are available to access when evaluating Cedar policies.
If you delete a Amazon Cognito user pool or user, tokens from that deleted pool or that deleted user continue to be usable until they expire.
To reference a user from this identity source in your Cedar policies, use the following syntax.
IdentityType::"<CognitoUserPoolIdentifier>|<CognitoClientId>
Where IdentityType
is the string that you provide to the PrincipalEntityType
parameter
for this operation. The CognitoUserPoolId
and CognitoClientId
are defined by the Amazon
Cognito user pool.
Verified Permissions is eventually consistent . It can take a few seconds for a new or changed element to propagate through the service and be visible in the results of other Verified Permissions operations.
createIdentitySource
in interface AmazonVerifiedPermissions
public CreatePolicyResult createPolicy(CreatePolicyRequest request)
AmazonVerifiedPermissions
Creates a Cedar policy and saves it in the specified policy store. You can create either a static policy or a policy linked to a policy template.
To create a static policy, provide the Cedar policy text in the StaticPolicy
section of the
PolicyDefinition
.
To create a policy that is dynamically linked to a policy template, specify the policy template ID and the
principal and resource to associate with this policy in the templateLinked
section of the
PolicyDefinition
. If the policy template is ever updated, any policies linked to the policy template
automatically use the updated template.
Creating a policy causes it to be validated against the schema in the policy store. If the policy doesn't pass validation, the operation fails and the policy isn't stored.
Verified Permissions is eventually consistent . It can take a few seconds for a new or changed element to propagate through the service and be visible in the results of other Verified Permissions operations.
createPolicy
in interface AmazonVerifiedPermissions
public CreatePolicyStoreResult createPolicyStore(CreatePolicyStoreRequest request)
AmazonVerifiedPermissions
Creates a policy store. A policy store is a container for policy resources.
Although Cedar supports multiple namespaces, Verified Permissions currently supports only one namespace per policy store.
Verified Permissions is eventually consistent . It can take a few seconds for a new or changed element to propagate through the service and be visible in the results of other Verified Permissions operations.
createPolicyStore
in interface AmazonVerifiedPermissions
public CreatePolicyTemplateResult createPolicyTemplate(CreatePolicyTemplateRequest request)
AmazonVerifiedPermissions
Creates a policy template. A template can use placeholders for the principal and resource. A template must be instantiated into a policy by associating it with specific principals and resources to use for the placeholders. That instantiated policy can then be considered in authorization decisions. The instantiated policy works identically to any other policy, except that it is dynamically linked to the template. If the template changes, then any policies that are linked to that template are immediately updated as well.
Verified Permissions is eventually consistent . It can take a few seconds for a new or changed element to propagate through the service and be visible in the results of other Verified Permissions operations.
createPolicyTemplate
in interface AmazonVerifiedPermissions
public DeleteIdentitySourceResult deleteIdentitySource(DeleteIdentitySourceRequest request)
AmazonVerifiedPermissions
Deletes an identity source that references an identity provider (IdP) such as Amazon Cognito. After you delete the identity source, you can no longer use tokens for identities from that identity source to represent principals in authorization queries made using IsAuthorizedWithToken. operations.
deleteIdentitySource
in interface AmazonVerifiedPermissions
public DeletePolicyResult deletePolicy(DeletePolicyRequest request)
AmazonVerifiedPermissions
Deletes the specified policy from the policy store.
This operation is idempotent; if you specify a policy that doesn't exist, the request response returns a
successful HTTP 200
status code.
deletePolicy
in interface AmazonVerifiedPermissions
public DeletePolicyStoreResult deletePolicyStore(DeletePolicyStoreRequest request)
AmazonVerifiedPermissions
Deletes the specified policy store.
This operation is idempotent. If you specify a policy store that does not exist, the request response will still return a successful HTTP 200 status code.
deletePolicyStore
in interface AmazonVerifiedPermissions
public DeletePolicyTemplateResult deletePolicyTemplate(DeletePolicyTemplateRequest request)
AmazonVerifiedPermissions
Deletes the specified policy template from the policy store.
This operation also deletes any policies that were created from the specified policy template. Those policies are immediately removed from all future API responses, and are asynchronously deleted from the policy store.
deletePolicyTemplate
in interface AmazonVerifiedPermissions
public GetIdentitySourceResult getIdentitySource(GetIdentitySourceRequest request)
AmazonVerifiedPermissions
Retrieves the details about the specified identity source.
getIdentitySource
in interface AmazonVerifiedPermissions
public GetPolicyResult getPolicy(GetPolicyRequest request)
AmazonVerifiedPermissions
Retrieves information about the specified policy.
getPolicy
in interface AmazonVerifiedPermissions
public GetPolicyStoreResult getPolicyStore(GetPolicyStoreRequest request)
AmazonVerifiedPermissions
Retrieves details about a policy store.
getPolicyStore
in interface AmazonVerifiedPermissions
public GetPolicyTemplateResult getPolicyTemplate(GetPolicyTemplateRequest request)
AmazonVerifiedPermissions
Retrieve the details for the specified policy template in the specified policy store.
getPolicyTemplate
in interface AmazonVerifiedPermissions
public GetSchemaResult getSchema(GetSchemaRequest request)
AmazonVerifiedPermissions
Retrieve the details for the specified schema in the specified policy store.
getSchema
in interface AmazonVerifiedPermissions
public IsAuthorizedResult isAuthorized(IsAuthorizedRequest request)
AmazonVerifiedPermissions
Makes an authorization decision about a service request described in the parameters. The information in the
parameters can also define additional context that Verified Permissions can include in the evaluation. The
request is evaluated against all matching policies in the specified policy store. The result of the decision is
either Allow
or Deny
, along with a list of the policies that resulted in the decision.
isAuthorized
in interface AmazonVerifiedPermissions
public IsAuthorizedWithTokenResult isAuthorizedWithToken(IsAuthorizedWithTokenRequest request)
AmazonVerifiedPermissions
Makes an authorization decision about a service request described in the parameters. The principal in this
request comes from an external identity source in the form of an identity token formatted as a JSON web token (JWT). The information in the parameters can
also define additional context that Verified Permissions can include in the evaluation. The request is evaluated
against all matching policies in the specified policy store. The result of the decision is either
Allow
or Deny
, along with a list of the policies that resulted in the decision.
At this time, Verified Permissions accepts tokens from only Amazon Cognito.
Verified Permissions validates each token that is specified in a request by checking its expiration date and its signature.
If you delete a Amazon Cognito user pool or user, tokens from that deleted pool or that deleted user continue to be usable until they expire.
isAuthorizedWithToken
in interface AmazonVerifiedPermissions
public ListIdentitySourcesResult listIdentitySources(ListIdentitySourcesRequest request)
AmazonVerifiedPermissions
Returns a paginated list of all of the identity sources defined in the specified policy store.
listIdentitySources
in interface AmazonVerifiedPermissions
public ListPoliciesResult listPolicies(ListPoliciesRequest request)
AmazonVerifiedPermissions
Returns a paginated list of all policies stored in the specified policy store.
listPolicies
in interface AmazonVerifiedPermissions
public ListPolicyStoresResult listPolicyStores(ListPolicyStoresRequest request)
AmazonVerifiedPermissions
Returns a paginated list of all policy stores in the calling Amazon Web Services account.
listPolicyStores
in interface AmazonVerifiedPermissions
public ListPolicyTemplatesResult listPolicyTemplates(ListPolicyTemplatesRequest request)
AmazonVerifiedPermissions
Returns a paginated list of all policy templates in the specified policy store.
listPolicyTemplates
in interface AmazonVerifiedPermissions
public PutSchemaResult putSchema(PutSchemaRequest request)
AmazonVerifiedPermissions
Creates or updates the policy schema in the specified policy store. The schema is used to validate any Cedar policies and policy templates submitted to the policy store. Any changes to the schema validate only policies and templates submitted after the schema change. Existing policies and templates are not re-evaluated against the changed schema. If you later update a policy, then it is evaluated against the new schema at that time.
Verified Permissions is eventually consistent . It can take a few seconds for a new or changed element to propagate through the service and be visible in the results of other Verified Permissions operations.
putSchema
in interface AmazonVerifiedPermissions
public UpdateIdentitySourceResult updateIdentitySource(UpdateIdentitySourceRequest request)
AmazonVerifiedPermissions
Updates the specified identity source to use a new identity provider (IdP) source, or to change the mapping of identities from the IdP to a different principal entity type.
Verified Permissions is eventually consistent . It can take a few seconds for a new or changed element to propagate through the service and be visible in the results of other Verified Permissions operations.
updateIdentitySource
in interface AmazonVerifiedPermissions
public UpdatePolicyResult updatePolicy(UpdatePolicyRequest request)
AmazonVerifiedPermissions
Modifies a Cedar static policy in the specified policy store. You can change only certain elements of the UpdatePolicyDefinition parameter. You can directly update only static policies. To change a template-linked policy, you must update the template instead, using UpdatePolicyTemplate.
If policy validation is enabled in the policy store, then updating a static policy causes Verified Permissions to validate the policy against the schema in the policy store. If the updated static policy doesn't pass validation, the operation fails and the update isn't stored.
When you edit a static policy, you can change only certain elements of a static policy:
The action referenced by the policy.
A condition clause, such as when and unless.
You can't change these elements of a static policy:
Changing a policy from a static policy to a template-linked policy.
Changing the effect of a static policy from permit or forbid.
The principal referenced by a static policy.
The resource referenced by a static policy.
To update a template-linked policy, you must update the template instead.
Verified Permissions is eventually consistent . It can take a few seconds for a new or changed element to propagate through the service and be visible in the results of other Verified Permissions operations.
updatePolicy
in interface AmazonVerifiedPermissions
public UpdatePolicyStoreResult updatePolicyStore(UpdatePolicyStoreRequest request)
AmazonVerifiedPermissions
Modifies the validation setting for a policy store.
Verified Permissions is eventually consistent . It can take a few seconds for a new or changed element to propagate through the service and be visible in the results of other Verified Permissions operations.
updatePolicyStore
in interface AmazonVerifiedPermissions
public UpdatePolicyTemplateResult updatePolicyTemplate(UpdatePolicyTemplateRequest request)
AmazonVerifiedPermissions
Updates the specified policy template. You can update only the description and the some elements of the policyBody.
Changes you make to the policy template content are immediately (within the constraints of eventual consistency) reflected in authorization decisions that involve all template-linked policies instantiated from this template.
Verified Permissions is eventually consistent . It can take a few seconds for a new or changed element to propagate through the service and be visible in the results of other Verified Permissions operations.
updatePolicyTemplate
in interface AmazonVerifiedPermissions
public void shutdown()
AmazonVerifiedPermissions
shutdown
in interface AmazonVerifiedPermissions
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonVerifiedPermissions
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata
in interface AmazonVerifiedPermissions
request
- The originally executed request.