Interface VerifiedPermissionsClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
Amazon Verified Permissions is a permissions management service from Amazon Web Services. You can use Verified Permissions to manage permissions for your application, and authorize user access based on those permissions. Using Verified Permissions, application developers can grant access based on information about the users, resources, and requested actions. You can also evaluate additional information like group membership, attributes of the resources, and session context, such as time of request and IP addresses. Verified Permissions manages these permissions by letting you create and store authorization policies for your applications, such as consumer-facing web sites and enterprise business systems.
Verified Permissions uses Cedar as the policy language to express your permission requirements. Cedar supports both role-based access control (RBAC) and attribute-based access control (ABAC) authorization models.
For more information about configuring, administering, and using Amazon Verified Permissions in your applications, see the Amazon Verified Permissions User Guide.
For more information about the Cedar policy language, see the Cedar Policy Language Guide.
When you write Cedar policies that reference principals, resources and actions, you can define the unique identifiers used for each of those elements. We strongly recommend that you follow these best practices:
-
Use values like universally unique identifiers (UUIDs) for all principal and resource identifiers.
For example, if user
jane
leaves the company, and you later let someone else use the namejane
, then that new user automatically gets access to everything granted by policies that still referenceUser::"jane"
. Cedar can’t distinguish between the new user and the old. This applies to both principal and resource identifiers. Always use identifiers that are guaranteed unique and never reused to ensure that you don’t unintentionally grant access because of the presence of an old identifier in a policy.Where you use a UUID for an entity, we recommend that you follow it with the // comment specifier and the ‘friendly’ name of your entity. This helps to make your policies easier to understand. For example: principal == User::"a1b2c3d4-e5f6-a1b2-c3d4-EXAMPLE11111", // alice
-
Do not include personally identifying, confidential, or sensitive information as part of the unique identifier for your principals or resources. These identifiers are included in log entries shared in CloudTrail trails.
Several operations return structures that appear similar, but have different purposes. As new functionality is added to the product, the structure used in a parameter of one operation might need to change in a way that wouldn't make sense for the same parameter in a different operation. To help you understand the purpose of each, the following naming convention is used for the structures:
-
Parameter type structures that end in
Detail
are used inGet
operations. -
Parameter type structures that end in
Item
are used inList
operations. -
Parameter type structures that use neither suffix are used in the mutating (create and update) operations.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptiondefault BatchIsAuthorizedResponse
batchIsAuthorized
(Consumer<BatchIsAuthorizedRequest.Builder> batchIsAuthorizedRequest) Makes a series of decisions about multiple authorization requests for one principal or resource.default BatchIsAuthorizedResponse
batchIsAuthorized
(BatchIsAuthorizedRequest batchIsAuthorizedRequest) Makes a series of decisions about multiple authorization requests for one principal or resource.batchIsAuthorizedWithToken
(Consumer<BatchIsAuthorizedWithTokenRequest.Builder> batchIsAuthorizedWithTokenRequest) Makes a series of decisions about multiple authorization requests for one token.batchIsAuthorizedWithToken
(BatchIsAuthorizedWithTokenRequest batchIsAuthorizedWithTokenRequest) Makes a series of decisions about multiple authorization requests for one token.builder()
Create a builder that can be used to configure and create aVerifiedPermissionsClient
.static VerifiedPermissionsClient
create()
Create aVerifiedPermissionsClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CreateIdentitySourceResponse
createIdentitySource
(Consumer<CreateIdentitySourceRequest.Builder> createIdentitySourceRequest) Creates a reference to an Amazon Cognito user pool as an external identity provider (IdP).default CreateIdentitySourceResponse
createIdentitySource
(CreateIdentitySourceRequest createIdentitySourceRequest) Creates a reference to an Amazon Cognito user pool as an external identity provider (IdP).default CreatePolicyResponse
createPolicy
(Consumer<CreatePolicyRequest.Builder> createPolicyRequest) Creates a Cedar policy and saves it in the specified policy store.default CreatePolicyResponse
createPolicy
(CreatePolicyRequest createPolicyRequest) Creates a Cedar policy and saves it in the specified policy store.default CreatePolicyStoreResponse
createPolicyStore
(Consumer<CreatePolicyStoreRequest.Builder> createPolicyStoreRequest) Creates a policy store.default CreatePolicyStoreResponse
createPolicyStore
(CreatePolicyStoreRequest createPolicyStoreRequest) Creates a policy store.default CreatePolicyTemplateResponse
createPolicyTemplate
(Consumer<CreatePolicyTemplateRequest.Builder> createPolicyTemplateRequest) Creates a policy template.default CreatePolicyTemplateResponse
createPolicyTemplate
(CreatePolicyTemplateRequest createPolicyTemplateRequest) Creates a policy template.default DeleteIdentitySourceResponse
deleteIdentitySource
(Consumer<DeleteIdentitySourceRequest.Builder> deleteIdentitySourceRequest) Deletes an identity source that references an identity provider (IdP) such as Amazon Cognito.default DeleteIdentitySourceResponse
deleteIdentitySource
(DeleteIdentitySourceRequest deleteIdentitySourceRequest) Deletes an identity source that references an identity provider (IdP) such as Amazon Cognito.default DeletePolicyResponse
deletePolicy
(Consumer<DeletePolicyRequest.Builder> deletePolicyRequest) Deletes the specified policy from the policy store.default DeletePolicyResponse
deletePolicy
(DeletePolicyRequest deletePolicyRequest) Deletes the specified policy from the policy store.default DeletePolicyStoreResponse
deletePolicyStore
(Consumer<DeletePolicyStoreRequest.Builder> deletePolicyStoreRequest) Deletes the specified policy store.default DeletePolicyStoreResponse
deletePolicyStore
(DeletePolicyStoreRequest deletePolicyStoreRequest) Deletes the specified policy store.default DeletePolicyTemplateResponse
deletePolicyTemplate
(Consumer<DeletePolicyTemplateRequest.Builder> deletePolicyTemplateRequest) Deletes the specified policy template from the policy store.default DeletePolicyTemplateResponse
deletePolicyTemplate
(DeletePolicyTemplateRequest deletePolicyTemplateRequest) Deletes the specified policy template from the policy store.default GetIdentitySourceResponse
getIdentitySource
(Consumer<GetIdentitySourceRequest.Builder> getIdentitySourceRequest) Retrieves the details about the specified identity source.default GetIdentitySourceResponse
getIdentitySource
(GetIdentitySourceRequest getIdentitySourceRequest) Retrieves the details about the specified identity source.default GetPolicyResponse
getPolicy
(Consumer<GetPolicyRequest.Builder> getPolicyRequest) Retrieves information about the specified policy.default GetPolicyResponse
getPolicy
(GetPolicyRequest getPolicyRequest) Retrieves information about the specified policy.default GetPolicyStoreResponse
getPolicyStore
(Consumer<GetPolicyStoreRequest.Builder> getPolicyStoreRequest) Retrieves details about a policy store.default GetPolicyStoreResponse
getPolicyStore
(GetPolicyStoreRequest getPolicyStoreRequest) Retrieves details about a policy store.default GetPolicyTemplateResponse
getPolicyTemplate
(Consumer<GetPolicyTemplateRequest.Builder> getPolicyTemplateRequest) Retrieve the details for the specified policy template in the specified policy store.default GetPolicyTemplateResponse
getPolicyTemplate
(GetPolicyTemplateRequest getPolicyTemplateRequest) Retrieve the details for the specified policy template in the specified policy store.default GetSchemaResponse
getSchema
(Consumer<GetSchemaRequest.Builder> getSchemaRequest) Retrieve the details for the specified schema in the specified policy store.default GetSchemaResponse
getSchema
(GetSchemaRequest getSchemaRequest) Retrieve the details for the specified schema in the specified policy store.default IsAuthorizedResponse
isAuthorized
(Consumer<IsAuthorizedRequest.Builder> isAuthorizedRequest) Makes an authorization decision about a service request described in the parameters.default IsAuthorizedResponse
isAuthorized
(IsAuthorizedRequest isAuthorizedRequest) Makes an authorization decision about a service request described in the parameters.default IsAuthorizedWithTokenResponse
isAuthorizedWithToken
(Consumer<IsAuthorizedWithTokenRequest.Builder> isAuthorizedWithTokenRequest) Makes an authorization decision about a service request described in the parameters.default IsAuthorizedWithTokenResponse
isAuthorizedWithToken
(IsAuthorizedWithTokenRequest isAuthorizedWithTokenRequest) Makes an authorization decision about a service request described in the parameters.default ListIdentitySourcesResponse
listIdentitySources
(Consumer<ListIdentitySourcesRequest.Builder> listIdentitySourcesRequest) Returns a paginated list of all of the identity sources defined in the specified policy store.default ListIdentitySourcesResponse
listIdentitySources
(ListIdentitySourcesRequest listIdentitySourcesRequest) Returns a paginated list of all of the identity sources defined in the specified policy store.default ListIdentitySourcesIterable
listIdentitySourcesPaginator
(Consumer<ListIdentitySourcesRequest.Builder> listIdentitySourcesRequest) This is a variant oflistIdentitySources(software.amazon.awssdk.services.verifiedpermissions.model.ListIdentitySourcesRequest)
operation.default ListIdentitySourcesIterable
listIdentitySourcesPaginator
(ListIdentitySourcesRequest listIdentitySourcesRequest) This is a variant oflistIdentitySources(software.amazon.awssdk.services.verifiedpermissions.model.ListIdentitySourcesRequest)
operation.default ListPoliciesResponse
listPolicies
(Consumer<ListPoliciesRequest.Builder> listPoliciesRequest) Returns a paginated list of all policies stored in the specified policy store.default ListPoliciesResponse
listPolicies
(ListPoliciesRequest listPoliciesRequest) Returns a paginated list of all policies stored in the specified policy store.default ListPoliciesIterable
listPoliciesPaginator
(Consumer<ListPoliciesRequest.Builder> listPoliciesRequest) This is a variant oflistPolicies(software.amazon.awssdk.services.verifiedpermissions.model.ListPoliciesRequest)
operation.default ListPoliciesIterable
listPoliciesPaginator
(ListPoliciesRequest listPoliciesRequest) This is a variant oflistPolicies(software.amazon.awssdk.services.verifiedpermissions.model.ListPoliciesRequest)
operation.default ListPolicyStoresResponse
listPolicyStores
(Consumer<ListPolicyStoresRequest.Builder> listPolicyStoresRequest) Returns a paginated list of all policy stores in the calling Amazon Web Services account.default ListPolicyStoresResponse
listPolicyStores
(ListPolicyStoresRequest listPolicyStoresRequest) Returns a paginated list of all policy stores in the calling Amazon Web Services account.default ListPolicyStoresIterable
listPolicyStoresPaginator
(Consumer<ListPolicyStoresRequest.Builder> listPolicyStoresRequest) This is a variant oflistPolicyStores(software.amazon.awssdk.services.verifiedpermissions.model.ListPolicyStoresRequest)
operation.default ListPolicyStoresIterable
listPolicyStoresPaginator
(ListPolicyStoresRequest listPolicyStoresRequest) This is a variant oflistPolicyStores(software.amazon.awssdk.services.verifiedpermissions.model.ListPolicyStoresRequest)
operation.default ListPolicyTemplatesResponse
listPolicyTemplates
(Consumer<ListPolicyTemplatesRequest.Builder> listPolicyTemplatesRequest) Returns a paginated list of all policy templates in the specified policy store.default ListPolicyTemplatesResponse
listPolicyTemplates
(ListPolicyTemplatesRequest listPolicyTemplatesRequest) Returns a paginated list of all policy templates in the specified policy store.default ListPolicyTemplatesIterable
listPolicyTemplatesPaginator
(Consumer<ListPolicyTemplatesRequest.Builder> listPolicyTemplatesRequest) This is a variant oflistPolicyTemplates(software.amazon.awssdk.services.verifiedpermissions.model.ListPolicyTemplatesRequest)
operation.default ListPolicyTemplatesIterable
listPolicyTemplatesPaginator
(ListPolicyTemplatesRequest listPolicyTemplatesRequest) This is a variant oflistPolicyTemplates(software.amazon.awssdk.services.verifiedpermissions.model.ListPolicyTemplatesRequest)
operation.default PutSchemaResponse
putSchema
(Consumer<PutSchemaRequest.Builder> putSchemaRequest) Creates or updates the policy schema in the specified policy store.default PutSchemaResponse
putSchema
(PutSchemaRequest putSchemaRequest) Creates or updates the policy schema in the specified policy store.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
default UpdateIdentitySourceResponse
updateIdentitySource
(Consumer<UpdateIdentitySourceRequest.Builder> updateIdentitySourceRequest) 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.default UpdateIdentitySourceResponse
updateIdentitySource
(UpdateIdentitySourceRequest updateIdentitySourceRequest) 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.default UpdatePolicyResponse
updatePolicy
(Consumer<UpdatePolicyRequest.Builder> updatePolicyRequest) Modifies a Cedar static policy in the specified policy store.default UpdatePolicyResponse
updatePolicy
(UpdatePolicyRequest updatePolicyRequest) Modifies a Cedar static policy in the specified policy store.default UpdatePolicyStoreResponse
updatePolicyStore
(Consumer<UpdatePolicyStoreRequest.Builder> updatePolicyStoreRequest) Modifies the validation setting for a policy store.default UpdatePolicyStoreResponse
updatePolicyStore
(UpdatePolicyStoreRequest updatePolicyStoreRequest) Modifies the validation setting for a policy store.default UpdatePolicyTemplateResponse
updatePolicyTemplate
(Consumer<UpdatePolicyTemplateRequest.Builder> updatePolicyTemplateRequest) Updates the specified policy template.default UpdatePolicyTemplateResponse
updatePolicyTemplate
(UpdatePolicyTemplateRequest updatePolicyTemplateRequest) Updates the specified policy template.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
batchIsAuthorized
default BatchIsAuthorizedResponse batchIsAuthorized(BatchIsAuthorizedRequest batchIsAuthorizedRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, VerifiedPermissionsException 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 theprincipal
or theresource
parameter must be identical across all requests. For example, Verified Permissions won't evaluate a pair of requests wherebob
viewsphoto1
andalice
viewsphoto2
. Authorization ofbob
to viewphoto1
andphoto2
, orbob
andalice
to viewphoto1
, 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
orDeny
responses, along with the IDs of the policies that produced each decision.The
entities
of aBatchIsAuthorized
API request can contain up to 100 principals and up to 100 resources. Therequests
of aBatchIsAuthorized
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 permissionverifiedpermissions:IsAuthorized
in their IAM policies.- Parameters:
batchIsAuthorizedRequest
-- Returns:
- Result of the BatchIsAuthorized operation returned by the service.
- See Also:
-
batchIsAuthorized
default BatchIsAuthorizedResponse batchIsAuthorized(Consumer<BatchIsAuthorizedRequest.Builder> batchIsAuthorizedRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, VerifiedPermissionsException 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 theprincipal
or theresource
parameter must be identical across all requests. For example, Verified Permissions won't evaluate a pair of requests wherebob
viewsphoto1
andalice
viewsphoto2
. Authorization ofbob
to viewphoto1
andphoto2
, orbob
andalice
to viewphoto1
, 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
orDeny
responses, along with the IDs of the policies that produced each decision.The
entities
of aBatchIsAuthorized
API request can contain up to 100 principals and up to 100 resources. Therequests
of aBatchIsAuthorized
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 permissionverifiedpermissions:IsAuthorized
in their IAM policies.
This is a convenience which creates an instance of the
BatchIsAuthorizedRequest.Builder
avoiding the need to create one manually viaBatchIsAuthorizedRequest.builder()
- Parameters:
batchIsAuthorizedRequest
- AConsumer
that will call methods onBatchIsAuthorizedRequest.Builder
to create a request.- Returns:
- Result of the BatchIsAuthorized operation returned by the service.
- See Also:
-
batchIsAuthorizedWithToken
default BatchIsAuthorizedWithTokenResponse batchIsAuthorizedWithToken(BatchIsAuthorizedWithTokenRequest batchIsAuthorizedWithTokenRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, VerifiedPermissionsException 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
orDeny
responses, along with the IDs of the policies that produced each decision.The
entities
of aBatchIsAuthorizedWithToken
API request can contain up to 100 resources and up to 99 user groups. Therequests
of aBatchIsAuthorizedWithToken
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 permissionverifiedpermissions:IsAuthorizedWithToken
in their IAM policies.- Parameters:
batchIsAuthorizedWithTokenRequest
-- Returns:
- Result of the BatchIsAuthorizedWithToken operation returned by the service.
- See Also:
-
batchIsAuthorizedWithToken
default BatchIsAuthorizedWithTokenResponse batchIsAuthorizedWithToken(Consumer<BatchIsAuthorizedWithTokenRequest.Builder> batchIsAuthorizedWithTokenRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, VerifiedPermissionsException 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
orDeny
responses, along with the IDs of the policies that produced each decision.The
entities
of aBatchIsAuthorizedWithToken
API request can contain up to 100 resources and up to 99 user groups. Therequests
of aBatchIsAuthorizedWithToken
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 permissionverifiedpermissions:IsAuthorizedWithToken
in their IAM policies.
This is a convenience which creates an instance of the
BatchIsAuthorizedWithTokenRequest.Builder
avoiding the need to create one manually viaBatchIsAuthorizedWithTokenRequest.builder()
- Parameters:
batchIsAuthorizedWithTokenRequest
- AConsumer
that will call methods onBatchIsAuthorizedWithTokenRequest.Builder
to create a request.- Returns:
- Result of the BatchIsAuthorizedWithToken operation returned by the service.
- See Also:
-
createIdentitySource
default CreateIdentitySourceResponse createIdentitySource(CreateIdentitySourceRequest createIdentitySourceRequest) throws ValidationException, ServiceQuotaExceededException, ConflictException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, VerifiedPermissionsException 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 thePrincipalEntityType
parameter for this operation. TheCognitoUserPoolId
andCognitoClientId
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.
- Parameters:
createIdentitySourceRequest
-- Returns:
- Result of the CreateIdentitySource operation returned by the service.
- See Also:
-
createIdentitySource
default CreateIdentitySourceResponse createIdentitySource(Consumer<CreateIdentitySourceRequest.Builder> createIdentitySourceRequest) throws ValidationException, ServiceQuotaExceededException, ConflictException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, VerifiedPermissionsException 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 thePrincipalEntityType
parameter for this operation. TheCognitoUserPoolId
andCognitoClientId
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.
This is a convenience which creates an instance of the
CreateIdentitySourceRequest.Builder
avoiding the need to create one manually viaCreateIdentitySourceRequest.builder()
- Parameters:
createIdentitySourceRequest
- AConsumer
that will call methods onCreateIdentitySourceRequest.Builder
to create a request.- Returns:
- Result of the CreateIdentitySource operation returned by the service.
- See Also:
-
createPolicy
default CreatePolicyResponse createPolicy(CreatePolicyRequest createPolicyRequest) throws ValidationException, ServiceQuotaExceededException, ConflictException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, VerifiedPermissionsException 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 thePolicyDefinition
. -
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 thePolicyDefinition
. 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.
- Parameters:
createPolicyRequest
-- Returns:
- Result of the CreatePolicy operation returned by the service.
- See Also:
-
-
createPolicy
default CreatePolicyResponse createPolicy(Consumer<CreatePolicyRequest.Builder> createPolicyRequest) throws ValidationException, ServiceQuotaExceededException, ConflictException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, VerifiedPermissionsException 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 thePolicyDefinition
. -
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 thePolicyDefinition
. 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.
This is a convenience which creates an instance of the
CreatePolicyRequest.Builder
avoiding the need to create one manually viaCreatePolicyRequest.builder()
- Parameters:
createPolicyRequest
- AConsumer
that will call methods onCreatePolicyRequest.Builder
to create a request.- Returns:
- Result of the CreatePolicy operation returned by the service.
- See Also:
-
-
createPolicyStore
default CreatePolicyStoreResponse createPolicyStore(CreatePolicyStoreRequest createPolicyStoreRequest) throws ValidationException, ServiceQuotaExceededException, ConflictException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, VerifiedPermissionsException 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.
- Parameters:
createPolicyStoreRequest
-- Returns:
- Result of the CreatePolicyStore operation returned by the service.
- See Also:
-
createPolicyStore
default CreatePolicyStoreResponse createPolicyStore(Consumer<CreatePolicyStoreRequest.Builder> createPolicyStoreRequest) throws ValidationException, ServiceQuotaExceededException, ConflictException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, VerifiedPermissionsException 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.
This is a convenience which creates an instance of the
CreatePolicyStoreRequest.Builder
avoiding the need to create one manually viaCreatePolicyStoreRequest.builder()
- Parameters:
createPolicyStoreRequest
- AConsumer
that will call methods onCreatePolicyStoreRequest.Builder
to create a request.- Returns:
- Result of the CreatePolicyStore operation returned by the service.
- See Also:
-
createPolicyTemplate
default CreatePolicyTemplateResponse createPolicyTemplate(CreatePolicyTemplateRequest createPolicyTemplateRequest) throws ValidationException, ServiceQuotaExceededException, ConflictException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, VerifiedPermissionsException 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.
- Parameters:
createPolicyTemplateRequest
-- Returns:
- Result of the CreatePolicyTemplate operation returned by the service.
- See Also:
-
createPolicyTemplate
default CreatePolicyTemplateResponse createPolicyTemplate(Consumer<CreatePolicyTemplateRequest.Builder> createPolicyTemplateRequest) throws ValidationException, ServiceQuotaExceededException, ConflictException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, VerifiedPermissionsException 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.
This is a convenience which creates an instance of the
CreatePolicyTemplateRequest.Builder
avoiding the need to create one manually viaCreatePolicyTemplateRequest.builder()
- Parameters:
createPolicyTemplateRequest
- AConsumer
that will call methods onCreatePolicyTemplateRequest.Builder
to create a request.- Returns:
- Result of the CreatePolicyTemplate operation returned by the service.
- See Also:
-
deleteIdentitySource
default DeleteIdentitySourceResponse deleteIdentitySource(DeleteIdentitySourceRequest deleteIdentitySourceRequest) throws ValidationException, ConflictException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, VerifiedPermissionsException 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.
- Parameters:
deleteIdentitySourceRequest
-- Returns:
- Result of the DeleteIdentitySource operation returned by the service.
- See Also:
-
deleteIdentitySource
default DeleteIdentitySourceResponse deleteIdentitySource(Consumer<DeleteIdentitySourceRequest.Builder> deleteIdentitySourceRequest) throws ValidationException, ConflictException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, VerifiedPermissionsException 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.
This is a convenience which creates an instance of the
DeleteIdentitySourceRequest.Builder
avoiding the need to create one manually viaDeleteIdentitySourceRequest.builder()
- Parameters:
deleteIdentitySourceRequest
- AConsumer
that will call methods onDeleteIdentitySourceRequest.Builder
to create a request.- Returns:
- Result of the DeleteIdentitySource operation returned by the service.
- See Also:
-
deletePolicy
default DeletePolicyResponse deletePolicy(DeletePolicyRequest deletePolicyRequest) throws ValidationException, ConflictException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, VerifiedPermissionsException 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.- Parameters:
deletePolicyRequest
-- Returns:
- Result of the DeletePolicy operation returned by the service.
- See Also:
-
deletePolicy
default DeletePolicyResponse deletePolicy(Consumer<DeletePolicyRequest.Builder> deletePolicyRequest) throws ValidationException, ConflictException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, VerifiedPermissionsException 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.
This is a convenience which creates an instance of the
DeletePolicyRequest.Builder
avoiding the need to create one manually viaDeletePolicyRequest.builder()
- Parameters:
deletePolicyRequest
- AConsumer
that will call methods onDeletePolicyRequest.Builder
to create a request.- Returns:
- Result of the DeletePolicy operation returned by the service.
- See Also:
-
deletePolicyStore
default DeletePolicyStoreResponse deletePolicyStore(DeletePolicyStoreRequest deletePolicyStoreRequest) throws ValidationException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, VerifiedPermissionsException 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.
- Parameters:
deletePolicyStoreRequest
-- Returns:
- Result of the DeletePolicyStore operation returned by the service.
- See Also:
-
deletePolicyStore
default DeletePolicyStoreResponse deletePolicyStore(Consumer<DeletePolicyStoreRequest.Builder> deletePolicyStoreRequest) throws ValidationException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, VerifiedPermissionsException 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.
This is a convenience which creates an instance of the
DeletePolicyStoreRequest.Builder
avoiding the need to create one manually viaDeletePolicyStoreRequest.builder()
- Parameters:
deletePolicyStoreRequest
- AConsumer
that will call methods onDeletePolicyStoreRequest.Builder
to create a request.- Returns:
- Result of the DeletePolicyStore operation returned by the service.
- See Also:
-
deletePolicyTemplate
default DeletePolicyTemplateResponse deletePolicyTemplate(DeletePolicyTemplateRequest deletePolicyTemplateRequest) throws ValidationException, ConflictException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, VerifiedPermissionsException 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.
- Parameters:
deletePolicyTemplateRequest
-- Returns:
- Result of the DeletePolicyTemplate operation returned by the service.
- See Also:
-
deletePolicyTemplate
default DeletePolicyTemplateResponse deletePolicyTemplate(Consumer<DeletePolicyTemplateRequest.Builder> deletePolicyTemplateRequest) throws ValidationException, ConflictException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, VerifiedPermissionsException 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.
This is a convenience which creates an instance of the
DeletePolicyTemplateRequest.Builder
avoiding the need to create one manually viaDeletePolicyTemplateRequest.builder()
- Parameters:
deletePolicyTemplateRequest
- AConsumer
that will call methods onDeletePolicyTemplateRequest.Builder
to create a request.- Returns:
- Result of the DeletePolicyTemplate operation returned by the service.
- See Also:
-
getIdentitySource
default GetIdentitySourceResponse getIdentitySource(GetIdentitySourceRequest getIdentitySourceRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, VerifiedPermissionsException Retrieves the details about the specified identity source.
- Parameters:
getIdentitySourceRequest
-- Returns:
- Result of the GetIdentitySource operation returned by the service.
- See Also:
-
getIdentitySource
default GetIdentitySourceResponse getIdentitySource(Consumer<GetIdentitySourceRequest.Builder> getIdentitySourceRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, VerifiedPermissionsException Retrieves the details about the specified identity source.
This is a convenience which creates an instance of the
GetIdentitySourceRequest.Builder
avoiding the need to create one manually viaGetIdentitySourceRequest.builder()
- Parameters:
getIdentitySourceRequest
- AConsumer
that will call methods onGetIdentitySourceRequest.Builder
to create a request.- Returns:
- Result of the GetIdentitySource operation returned by the service.
- See Also:
-
getPolicy
default GetPolicyResponse getPolicy(GetPolicyRequest getPolicyRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, VerifiedPermissionsException Retrieves information about the specified policy.
- Parameters:
getPolicyRequest
-- Returns:
- Result of the GetPolicy operation returned by the service.
- See Also:
-
getPolicy
default GetPolicyResponse getPolicy(Consumer<GetPolicyRequest.Builder> getPolicyRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, VerifiedPermissionsException Retrieves information about the specified policy.
This is a convenience which creates an instance of the
GetPolicyRequest.Builder
avoiding the need to create one manually viaGetPolicyRequest.builder()
- Parameters:
getPolicyRequest
- AConsumer
that will call methods onGetPolicyRequest.Builder
to create a request.- Returns:
- Result of the GetPolicy operation returned by the service.
- See Also:
-
getPolicyStore
default GetPolicyStoreResponse getPolicyStore(GetPolicyStoreRequest getPolicyStoreRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, VerifiedPermissionsException Retrieves details about a policy store.
- Parameters:
getPolicyStoreRequest
-- Returns:
- Result of the GetPolicyStore operation returned by the service.
- See Also:
-
getPolicyStore
default GetPolicyStoreResponse getPolicyStore(Consumer<GetPolicyStoreRequest.Builder> getPolicyStoreRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, VerifiedPermissionsException Retrieves details about a policy store.
This is a convenience which creates an instance of the
GetPolicyStoreRequest.Builder
avoiding the need to create one manually viaGetPolicyStoreRequest.builder()
- Parameters:
getPolicyStoreRequest
- AConsumer
that will call methods onGetPolicyStoreRequest.Builder
to create a request.- Returns:
- Result of the GetPolicyStore operation returned by the service.
- See Also:
-
getPolicyTemplate
default GetPolicyTemplateResponse getPolicyTemplate(GetPolicyTemplateRequest getPolicyTemplateRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, VerifiedPermissionsException Retrieve the details for the specified policy template in the specified policy store.
- Parameters:
getPolicyTemplateRequest
-- Returns:
- Result of the GetPolicyTemplate operation returned by the service.
- See Also:
-
getPolicyTemplate
default GetPolicyTemplateResponse getPolicyTemplate(Consumer<GetPolicyTemplateRequest.Builder> getPolicyTemplateRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, VerifiedPermissionsException Retrieve the details for the specified policy template in the specified policy store.
This is a convenience which creates an instance of the
GetPolicyTemplateRequest.Builder
avoiding the need to create one manually viaGetPolicyTemplateRequest.builder()
- Parameters:
getPolicyTemplateRequest
- AConsumer
that will call methods onGetPolicyTemplateRequest.Builder
to create a request.- Returns:
- Result of the GetPolicyTemplate operation returned by the service.
- See Also:
-
getSchema
default GetSchemaResponse getSchema(GetSchemaRequest getSchemaRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, VerifiedPermissionsException Retrieve the details for the specified schema in the specified policy store.
- Parameters:
getSchemaRequest
-- Returns:
- Result of the GetSchema operation returned by the service.
- See Also:
-
getSchema
default GetSchemaResponse getSchema(Consumer<GetSchemaRequest.Builder> getSchemaRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, VerifiedPermissionsException Retrieve the details for the specified schema in the specified policy store.
This is a convenience which creates an instance of the
GetSchemaRequest.Builder
avoiding the need to create one manually viaGetSchemaRequest.builder()
- Parameters:
getSchemaRequest
- AConsumer
that will call methods onGetSchemaRequest.Builder
to create a request.- Returns:
- Result of the GetSchema operation returned by the service.
- See Also:
-
isAuthorized
default IsAuthorizedResponse isAuthorized(IsAuthorizedRequest isAuthorizedRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, VerifiedPermissionsException 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
orDeny
, along with a list of the policies that resulted in the decision.- Parameters:
isAuthorizedRequest
-- Returns:
- Result of the IsAuthorized operation returned by the service.
- See Also:
-
isAuthorized
default IsAuthorizedResponse isAuthorized(Consumer<IsAuthorizedRequest.Builder> isAuthorizedRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, VerifiedPermissionsException 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
orDeny
, along with a list of the policies that resulted in the decision.
This is a convenience which creates an instance of the
IsAuthorizedRequest.Builder
avoiding the need to create one manually viaIsAuthorizedRequest.builder()
- Parameters:
isAuthorizedRequest
- AConsumer
that will call methods onIsAuthorizedRequest.Builder
to create a request.- Returns:
- Result of the IsAuthorized operation returned by the service.
- See Also:
-
isAuthorizedWithToken
default IsAuthorizedWithTokenResponse isAuthorizedWithToken(IsAuthorizedWithTokenRequest isAuthorizedWithTokenRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, VerifiedPermissionsException 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
orDeny
, 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.
- Parameters:
isAuthorizedWithTokenRequest
-- Returns:
- Result of the IsAuthorizedWithToken operation returned by the service.
- See Also:
-
isAuthorizedWithToken
default IsAuthorizedWithTokenResponse isAuthorizedWithToken(Consumer<IsAuthorizedWithTokenRequest.Builder> isAuthorizedWithTokenRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, VerifiedPermissionsException 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
orDeny
, 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.
This is a convenience which creates an instance of the
IsAuthorizedWithTokenRequest.Builder
avoiding the need to create one manually viaIsAuthorizedWithTokenRequest.builder()
- Parameters:
isAuthorizedWithTokenRequest
- AConsumer
that will call methods onIsAuthorizedWithTokenRequest.Builder
to create a request.- Returns:
- Result of the IsAuthorizedWithToken operation returned by the service.
- See Also:
-
listIdentitySources
default ListIdentitySourcesResponse listIdentitySources(ListIdentitySourcesRequest listIdentitySourcesRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, VerifiedPermissionsException Returns a paginated list of all of the identity sources defined in the specified policy store.
- Parameters:
listIdentitySourcesRequest
-- Returns:
- Result of the ListIdentitySources operation returned by the service.
- See Also:
-
listIdentitySources
default ListIdentitySourcesResponse listIdentitySources(Consumer<ListIdentitySourcesRequest.Builder> listIdentitySourcesRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, VerifiedPermissionsException Returns a paginated list of all of the identity sources defined in the specified policy store.
This is a convenience which creates an instance of the
ListIdentitySourcesRequest.Builder
avoiding the need to create one manually viaListIdentitySourcesRequest.builder()
- Parameters:
listIdentitySourcesRequest
- AConsumer
that will call methods onListIdentitySourcesRequest.Builder
to create a request.- Returns:
- Result of the ListIdentitySources operation returned by the service.
- See Also:
-
listIdentitySourcesPaginator
default ListIdentitySourcesIterable listIdentitySourcesPaginator(ListIdentitySourcesRequest listIdentitySourcesRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, VerifiedPermissionsException This is a variant of
listIdentitySources(software.amazon.awssdk.services.verifiedpermissions.model.ListIdentitySourcesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.verifiedpermissions.paginators.ListIdentitySourcesIterable responses = client.listIdentitySourcesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.verifiedpermissions.paginators.ListIdentitySourcesIterable responses = client .listIdentitySourcesPaginator(request); for (software.amazon.awssdk.services.verifiedpermissions.model.ListIdentitySourcesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.verifiedpermissions.paginators.ListIdentitySourcesIterable responses = client.listIdentitySourcesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listIdentitySources(software.amazon.awssdk.services.verifiedpermissions.model.ListIdentitySourcesRequest)
operation.- Parameters:
listIdentitySourcesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listIdentitySourcesPaginator
default ListIdentitySourcesIterable listIdentitySourcesPaginator(Consumer<ListIdentitySourcesRequest.Builder> listIdentitySourcesRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, VerifiedPermissionsException This is a variant of
listIdentitySources(software.amazon.awssdk.services.verifiedpermissions.model.ListIdentitySourcesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.verifiedpermissions.paginators.ListIdentitySourcesIterable responses = client.listIdentitySourcesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.verifiedpermissions.paginators.ListIdentitySourcesIterable responses = client .listIdentitySourcesPaginator(request); for (software.amazon.awssdk.services.verifiedpermissions.model.ListIdentitySourcesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.verifiedpermissions.paginators.ListIdentitySourcesIterable responses = client.listIdentitySourcesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listIdentitySources(software.amazon.awssdk.services.verifiedpermissions.model.ListIdentitySourcesRequest)
operation.
This is a convenience which creates an instance of the
ListIdentitySourcesRequest.Builder
avoiding the need to create one manually viaListIdentitySourcesRequest.builder()
- Parameters:
listIdentitySourcesRequest
- AConsumer
that will call methods onListIdentitySourcesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listPolicies
default ListPoliciesResponse listPolicies(ListPoliciesRequest listPoliciesRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, VerifiedPermissionsException Returns a paginated list of all policies stored in the specified policy store.
- Parameters:
listPoliciesRequest
-- Returns:
- Result of the ListPolicies operation returned by the service.
- See Also:
-
listPolicies
default ListPoliciesResponse listPolicies(Consumer<ListPoliciesRequest.Builder> listPoliciesRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, VerifiedPermissionsException Returns a paginated list of all policies stored in the specified policy store.
This is a convenience which creates an instance of the
ListPoliciesRequest.Builder
avoiding the need to create one manually viaListPoliciesRequest.builder()
- Parameters:
listPoliciesRequest
- AConsumer
that will call methods onListPoliciesRequest.Builder
to create a request.- Returns:
- Result of the ListPolicies operation returned by the service.
- See Also:
-
listPoliciesPaginator
default ListPoliciesIterable listPoliciesPaginator(ListPoliciesRequest listPoliciesRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, VerifiedPermissionsException This is a variant of
listPolicies(software.amazon.awssdk.services.verifiedpermissions.model.ListPoliciesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.verifiedpermissions.paginators.ListPoliciesIterable responses = client.listPoliciesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.verifiedpermissions.paginators.ListPoliciesIterable responses = client .listPoliciesPaginator(request); for (software.amazon.awssdk.services.verifiedpermissions.model.ListPoliciesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.verifiedpermissions.paginators.ListPoliciesIterable responses = client.listPoliciesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPolicies(software.amazon.awssdk.services.verifiedpermissions.model.ListPoliciesRequest)
operation.- Parameters:
listPoliciesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listPoliciesPaginator
default ListPoliciesIterable listPoliciesPaginator(Consumer<ListPoliciesRequest.Builder> listPoliciesRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, VerifiedPermissionsException This is a variant of
listPolicies(software.amazon.awssdk.services.verifiedpermissions.model.ListPoliciesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.verifiedpermissions.paginators.ListPoliciesIterable responses = client.listPoliciesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.verifiedpermissions.paginators.ListPoliciesIterable responses = client .listPoliciesPaginator(request); for (software.amazon.awssdk.services.verifiedpermissions.model.ListPoliciesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.verifiedpermissions.paginators.ListPoliciesIterable responses = client.listPoliciesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPolicies(software.amazon.awssdk.services.verifiedpermissions.model.ListPoliciesRequest)
operation.
This is a convenience which creates an instance of the
ListPoliciesRequest.Builder
avoiding the need to create one manually viaListPoliciesRequest.builder()
- Parameters:
listPoliciesRequest
- AConsumer
that will call methods onListPoliciesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listPolicyStores
default ListPolicyStoresResponse listPolicyStores(ListPolicyStoresRequest listPolicyStoresRequest) throws ValidationException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, VerifiedPermissionsException Returns a paginated list of all policy stores in the calling Amazon Web Services account.
- Parameters:
listPolicyStoresRequest
-- Returns:
- Result of the ListPolicyStores operation returned by the service.
- See Also:
-
listPolicyStores
default ListPolicyStoresResponse listPolicyStores(Consumer<ListPolicyStoresRequest.Builder> listPolicyStoresRequest) throws ValidationException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, VerifiedPermissionsException Returns a paginated list of all policy stores in the calling Amazon Web Services account.
This is a convenience which creates an instance of the
ListPolicyStoresRequest.Builder
avoiding the need to create one manually viaListPolicyStoresRequest.builder()
- Parameters:
listPolicyStoresRequest
- AConsumer
that will call methods onListPolicyStoresRequest.Builder
to create a request.- Returns:
- Result of the ListPolicyStores operation returned by the service.
- See Also:
-
listPolicyStoresPaginator
default ListPolicyStoresIterable listPolicyStoresPaginator(ListPolicyStoresRequest listPolicyStoresRequest) throws ValidationException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, VerifiedPermissionsException This is a variant of
listPolicyStores(software.amazon.awssdk.services.verifiedpermissions.model.ListPolicyStoresRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.verifiedpermissions.paginators.ListPolicyStoresIterable responses = client.listPolicyStoresPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.verifiedpermissions.paginators.ListPolicyStoresIterable responses = client .listPolicyStoresPaginator(request); for (software.amazon.awssdk.services.verifiedpermissions.model.ListPolicyStoresResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.verifiedpermissions.paginators.ListPolicyStoresIterable responses = client.listPolicyStoresPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPolicyStores(software.amazon.awssdk.services.verifiedpermissions.model.ListPolicyStoresRequest)
operation.- Parameters:
listPolicyStoresRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listPolicyStoresPaginator
default ListPolicyStoresIterable listPolicyStoresPaginator(Consumer<ListPolicyStoresRequest.Builder> listPolicyStoresRequest) throws ValidationException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, VerifiedPermissionsException This is a variant of
listPolicyStores(software.amazon.awssdk.services.verifiedpermissions.model.ListPolicyStoresRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.verifiedpermissions.paginators.ListPolicyStoresIterable responses = client.listPolicyStoresPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.verifiedpermissions.paginators.ListPolicyStoresIterable responses = client .listPolicyStoresPaginator(request); for (software.amazon.awssdk.services.verifiedpermissions.model.ListPolicyStoresResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.verifiedpermissions.paginators.ListPolicyStoresIterable responses = client.listPolicyStoresPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPolicyStores(software.amazon.awssdk.services.verifiedpermissions.model.ListPolicyStoresRequest)
operation.
This is a convenience which creates an instance of the
ListPolicyStoresRequest.Builder
avoiding the need to create one manually viaListPolicyStoresRequest.builder()
- Parameters:
listPolicyStoresRequest
- AConsumer
that will call methods onListPolicyStoresRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listPolicyTemplates
default ListPolicyTemplatesResponse listPolicyTemplates(ListPolicyTemplatesRequest listPolicyTemplatesRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, VerifiedPermissionsException Returns a paginated list of all policy templates in the specified policy store.
- Parameters:
listPolicyTemplatesRequest
-- Returns:
- Result of the ListPolicyTemplates operation returned by the service.
- See Also:
-
listPolicyTemplates
default ListPolicyTemplatesResponse listPolicyTemplates(Consumer<ListPolicyTemplatesRequest.Builder> listPolicyTemplatesRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, VerifiedPermissionsException Returns a paginated list of all policy templates in the specified policy store.
This is a convenience which creates an instance of the
ListPolicyTemplatesRequest.Builder
avoiding the need to create one manually viaListPolicyTemplatesRequest.builder()
- Parameters:
listPolicyTemplatesRequest
- AConsumer
that will call methods onListPolicyTemplatesRequest.Builder
to create a request.- Returns:
- Result of the ListPolicyTemplates operation returned by the service.
- See Also:
-
listPolicyTemplatesPaginator
default ListPolicyTemplatesIterable listPolicyTemplatesPaginator(ListPolicyTemplatesRequest listPolicyTemplatesRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, VerifiedPermissionsException This is a variant of
listPolicyTemplates(software.amazon.awssdk.services.verifiedpermissions.model.ListPolicyTemplatesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.verifiedpermissions.paginators.ListPolicyTemplatesIterable responses = client.listPolicyTemplatesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.verifiedpermissions.paginators.ListPolicyTemplatesIterable responses = client .listPolicyTemplatesPaginator(request); for (software.amazon.awssdk.services.verifiedpermissions.model.ListPolicyTemplatesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.verifiedpermissions.paginators.ListPolicyTemplatesIterable responses = client.listPolicyTemplatesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPolicyTemplates(software.amazon.awssdk.services.verifiedpermissions.model.ListPolicyTemplatesRequest)
operation.- Parameters:
listPolicyTemplatesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listPolicyTemplatesPaginator
default ListPolicyTemplatesIterable listPolicyTemplatesPaginator(Consumer<ListPolicyTemplatesRequest.Builder> listPolicyTemplatesRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, VerifiedPermissionsException This is a variant of
listPolicyTemplates(software.amazon.awssdk.services.verifiedpermissions.model.ListPolicyTemplatesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.verifiedpermissions.paginators.ListPolicyTemplatesIterable responses = client.listPolicyTemplatesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.verifiedpermissions.paginators.ListPolicyTemplatesIterable responses = client .listPolicyTemplatesPaginator(request); for (software.amazon.awssdk.services.verifiedpermissions.model.ListPolicyTemplatesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.verifiedpermissions.paginators.ListPolicyTemplatesIterable responses = client.listPolicyTemplatesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPolicyTemplates(software.amazon.awssdk.services.verifiedpermissions.model.ListPolicyTemplatesRequest)
operation.
This is a convenience which creates an instance of the
ListPolicyTemplatesRequest.Builder
avoiding the need to create one manually viaListPolicyTemplatesRequest.builder()
- Parameters:
listPolicyTemplatesRequest
- AConsumer
that will call methods onListPolicyTemplatesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
putSchema
default PutSchemaResponse putSchema(PutSchemaRequest putSchemaRequest) throws ValidationException, ServiceQuotaExceededException, ConflictException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, VerifiedPermissionsException 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.
- Parameters:
putSchemaRequest
-- Returns:
- Result of the PutSchema operation returned by the service.
- See Also:
-
putSchema
default PutSchemaResponse putSchema(Consumer<PutSchemaRequest.Builder> putSchemaRequest) throws ValidationException, ServiceQuotaExceededException, ConflictException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, VerifiedPermissionsException 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.
This is a convenience which creates an instance of the
PutSchemaRequest.Builder
avoiding the need to create one manually viaPutSchemaRequest.builder()
- Parameters:
putSchemaRequest
- AConsumer
that will call methods onPutSchemaRequest.Builder
to create a request.- Returns:
- Result of the PutSchema operation returned by the service.
- See Also:
-
updateIdentitySource
default UpdateIdentitySourceResponse updateIdentitySource(UpdateIdentitySourceRequest updateIdentitySourceRequest) throws ValidationException, ConflictException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, VerifiedPermissionsException 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.
- Parameters:
updateIdentitySourceRequest
-- Returns:
- Result of the UpdateIdentitySource operation returned by the service.
- See Also:
-
updateIdentitySource
default UpdateIdentitySourceResponse updateIdentitySource(Consumer<UpdateIdentitySourceRequest.Builder> updateIdentitySourceRequest) throws ValidationException, ConflictException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, VerifiedPermissionsException 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.
This is a convenience which creates an instance of the
UpdateIdentitySourceRequest.Builder
avoiding the need to create one manually viaUpdateIdentitySourceRequest.builder()
- Parameters:
updateIdentitySourceRequest
- AConsumer
that will call methods onUpdateIdentitySourceRequest.Builder
to create a request.- Returns:
- Result of the UpdateIdentitySource operation returned by the service.
- See Also:
-
updatePolicy
default UpdatePolicyResponse updatePolicy(UpdatePolicyRequest updatePolicyRequest) throws ValidationException, ServiceQuotaExceededException, ConflictException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, VerifiedPermissionsException 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.
- Parameters:
updatePolicyRequest
-- Returns:
- Result of the UpdatePolicy operation returned by the service.
- See Also:
-
-
updatePolicy
default UpdatePolicyResponse updatePolicy(Consumer<UpdatePolicyRequest.Builder> updatePolicyRequest) throws ValidationException, ServiceQuotaExceededException, ConflictException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, VerifiedPermissionsException 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.
This is a convenience which creates an instance of the
UpdatePolicyRequest.Builder
avoiding the need to create one manually viaUpdatePolicyRequest.builder()
- Parameters:
updatePolicyRequest
- AConsumer
that will call methods onUpdatePolicyRequest.Builder
to create a request.- Returns:
- Result of the UpdatePolicy operation returned by the service.
- See Also:
-
-
updatePolicyStore
default UpdatePolicyStoreResponse updatePolicyStore(UpdatePolicyStoreRequest updatePolicyStoreRequest) throws ValidationException, ConflictException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, VerifiedPermissionsException 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.
- Parameters:
updatePolicyStoreRequest
-- Returns:
- Result of the UpdatePolicyStore operation returned by the service.
- See Also:
-
updatePolicyStore
default UpdatePolicyStoreResponse updatePolicyStore(Consumer<UpdatePolicyStoreRequest.Builder> updatePolicyStoreRequest) throws ValidationException, ConflictException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, VerifiedPermissionsException 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.
This is a convenience which creates an instance of the
UpdatePolicyStoreRequest.Builder
avoiding the need to create one manually viaUpdatePolicyStoreRequest.builder()
- Parameters:
updatePolicyStoreRequest
- AConsumer
that will call methods onUpdatePolicyStoreRequest.Builder
to create a request.- Returns:
- Result of the UpdatePolicyStore operation returned by the service.
- See Also:
-
updatePolicyTemplate
default UpdatePolicyTemplateResponse updatePolicyTemplate(UpdatePolicyTemplateRequest updatePolicyTemplateRequest) throws ValidationException, ConflictException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, VerifiedPermissionsException 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.
- Parameters:
updatePolicyTemplateRequest
-- Returns:
- Result of the UpdatePolicyTemplate operation returned by the service.
- See Also:
-
updatePolicyTemplate
default UpdatePolicyTemplateResponse updatePolicyTemplate(Consumer<UpdatePolicyTemplateRequest.Builder> updatePolicyTemplateRequest) throws ValidationException, ConflictException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, VerifiedPermissionsException 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.
This is a convenience which creates an instance of the
UpdatePolicyTemplateRequest.Builder
avoiding the need to create one manually viaUpdatePolicyTemplateRequest.builder()
- Parameters:
updatePolicyTemplateRequest
- AConsumer
that will call methods onUpdatePolicyTemplateRequest.Builder
to create a request.- Returns:
- Result of the UpdatePolicyTemplate operation returned by the service.
- See Also:
-
create
Create aVerifiedPermissionsClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aVerifiedPermissionsClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-