open-next-cdk
Version:
Deploy a NextJS app using OpenNext packaging to serverless AWS using CDK
661 lines • 84.6 kB
TypeScript
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class VerifiedPermissions extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: VerifiedPermissions.Types.ClientConfiguration)
config: Config & VerifiedPermissions.Types.ClientConfiguration;
/**
* 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 be propagate through the service and be visible in the results of other Verified Permissions operations.
*/
createIdentitySource(params: VerifiedPermissions.Types.CreateIdentitySourceInput, callback?: (err: AWSError, data: VerifiedPermissions.Types.CreateIdentitySourceOutput) => void): Request<VerifiedPermissions.Types.CreateIdentitySourceOutput, AWSError>;
/**
* 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 be propagate through the service and be visible in the results of other Verified Permissions operations.
*/
createIdentitySource(callback?: (err: AWSError, data: VerifiedPermissions.Types.CreateIdentitySourceOutput) => void): Request<VerifiedPermissions.Types.CreateIdentitySourceOutput, AWSError>;
/**
* 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 be propagate through the service and be visible in the results of other Verified Permissions operations.
*/
createPolicy(params: VerifiedPermissions.Types.CreatePolicyInput, callback?: (err: AWSError, data: VerifiedPermissions.Types.CreatePolicyOutput) => void): Request<VerifiedPermissions.Types.CreatePolicyOutput, AWSError>;
/**
* 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 be propagate through the service and be visible in the results of other Verified Permissions operations.
*/
createPolicy(callback?: (err: AWSError, data: VerifiedPermissions.Types.CreatePolicyOutput) => void): Request<VerifiedPermissions.Types.CreatePolicyOutput, AWSError>;
/**
* 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 be propagate through the service and be visible in the results of other Verified Permissions operations.
*/
createPolicyStore(params: VerifiedPermissions.Types.CreatePolicyStoreInput, callback?: (err: AWSError, data: VerifiedPermissions.Types.CreatePolicyStoreOutput) => void): Request<VerifiedPermissions.Types.CreatePolicyStoreOutput, AWSError>;
/**
* 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 be propagate through the service and be visible in the results of other Verified Permissions operations.
*/
createPolicyStore(callback?: (err: AWSError, data: VerifiedPermissions.Types.CreatePolicyStoreOutput) => void): Request<VerifiedPermissions.Types.CreatePolicyStoreOutput, AWSError>;
/**
* 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 be propagate through the service and be visible in the results of other Verified Permissions operations.
*/
createPolicyTemplate(params: VerifiedPermissions.Types.CreatePolicyTemplateInput, callback?: (err: AWSError, data: VerifiedPermissions.Types.CreatePolicyTemplateOutput) => void): Request<VerifiedPermissions.Types.CreatePolicyTemplateOutput, AWSError>;
/**
* 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 be propagate through the service and be visible in the results of other Verified Permissions operations.
*/
createPolicyTemplate(callback?: (err: AWSError, data: VerifiedPermissions.Types.CreatePolicyTemplateOutput) => void): Request<VerifiedPermissions.Types.CreatePolicyTemplateOutput, AWSError>;
/**
* 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(params: VerifiedPermissions.Types.DeleteIdentitySourceInput, callback?: (err: AWSError, data: VerifiedPermissions.Types.DeleteIdentitySourceOutput) => void): Request<VerifiedPermissions.Types.DeleteIdentitySourceOutput, AWSError>;
/**
* 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(callback?: (err: AWSError, data: VerifiedPermissions.Types.DeleteIdentitySourceOutput) => void): Request<VerifiedPermissions.Types.DeleteIdentitySourceOutput, AWSError>;
/**
* 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(params: VerifiedPermissions.Types.DeletePolicyInput, callback?: (err: AWSError, data: VerifiedPermissions.Types.DeletePolicyOutput) => void): Request<VerifiedPermissions.Types.DeletePolicyOutput, AWSError>;
/**
* 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(callback?: (err: AWSError, data: VerifiedPermissions.Types.DeletePolicyOutput) => void): Request<VerifiedPermissions.Types.DeletePolicyOutput, AWSError>;
/**
* 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(params: VerifiedPermissions.Types.DeletePolicyStoreInput, callback?: (err: AWSError, data: VerifiedPermissions.Types.DeletePolicyStoreOutput) => void): Request<VerifiedPermissions.Types.DeletePolicyStoreOutput, AWSError>;
/**
* 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(callback?: (err: AWSError, data: VerifiedPermissions.Types.DeletePolicyStoreOutput) => void): Request<VerifiedPermissions.Types.DeletePolicyStoreOutput, AWSError>;
/**
* 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(params: VerifiedPermissions.Types.DeletePolicyTemplateInput, callback?: (err: AWSError, data: VerifiedPermissions.Types.DeletePolicyTemplateOutput) => void): Request<VerifiedPermissions.Types.DeletePolicyTemplateOutput, AWSError>;
/**
* 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(callback?: (err: AWSError, data: VerifiedPermissions.Types.DeletePolicyTemplateOutput) => void): Request<VerifiedPermissions.Types.DeletePolicyTemplateOutput, AWSError>;
/**
* Retrieves the details about the specified identity source.
*/
getIdentitySource(params: VerifiedPermissions.Types.GetIdentitySourceInput, callback?: (err: AWSError, data: VerifiedPermissions.Types.GetIdentitySourceOutput) => void): Request<VerifiedPermissions.Types.GetIdentitySourceOutput, AWSError>;
/**
* Retrieves the details about the specified identity source.
*/
getIdentitySource(callback?: (err: AWSError, data: VerifiedPermissions.Types.GetIdentitySourceOutput) => void): Request<VerifiedPermissions.Types.GetIdentitySourceOutput, AWSError>;
/**
* Retrieves information about the specified policy.
*/
getPolicy(params: VerifiedPermissions.Types.GetPolicyInput, callback?: (err: AWSError, data: VerifiedPermissions.Types.GetPolicyOutput) => void): Request<VerifiedPermissions.Types.GetPolicyOutput, AWSError>;
/**
* Retrieves information about the specified policy.
*/
getPolicy(callback?: (err: AWSError, data: VerifiedPermissions.Types.GetPolicyOutput) => void): Request<VerifiedPermissions.Types.GetPolicyOutput, AWSError>;
/**
* Retrieves details about a policy store.
*/
getPolicyStore(params: VerifiedPermissions.Types.GetPolicyStoreInput, callback?: (err: AWSError, data: VerifiedPermissions.Types.GetPolicyStoreOutput) => void): Request<VerifiedPermissions.Types.GetPolicyStoreOutput, AWSError>;
/**
* Retrieves details about a policy store.
*/
getPolicyStore(callback?: (err: AWSError, data: VerifiedPermissions.Types.GetPolicyStoreOutput) => void): Request<VerifiedPermissions.Types.GetPolicyStoreOutput, AWSError>;
/**
* Retrieve the details for the specified policy template in the specified policy store.
*/
getPolicyTemplate(params: VerifiedPermissions.Types.GetPolicyTemplateInput, callback?: (err: AWSError, data: VerifiedPermissions.Types.GetPolicyTemplateOutput) => void): Request<VerifiedPermissions.Types.GetPolicyTemplateOutput, AWSError>;
/**
* Retrieve the details for the specified policy template in the specified policy store.
*/
getPolicyTemplate(callback?: (err: AWSError, data: VerifiedPermissions.Types.GetPolicyTemplateOutput) => void): Request<VerifiedPermissions.Types.GetPolicyTemplateOutput, AWSError>;
/**
* Retrieve the details for the specified schema in the specified policy store.
*/
getSchema(params: VerifiedPermissions.Types.GetSchemaInput, callback?: (err: AWSError, data: VerifiedPermissions.Types.GetSchemaOutput) => void): Request<VerifiedPermissions.Types.GetSchemaOutput, AWSError>;
/**
* Retrieve the details for the specified schema in the specified policy store.
*/
getSchema(callback?: (err: AWSError, data: VerifiedPermissions.Types.GetSchemaOutput) => void): Request<VerifiedPermissions.Types.GetSchemaOutput, AWSError>;
/**
* 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(params: VerifiedPermissions.Types.IsAuthorizedInput, callback?: (err: AWSError, data: VerifiedPermissions.Types.IsAuthorizedOutput) => void): Request<VerifiedPermissions.Types.IsAuthorizedOutput, AWSError>;
/**
* 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(callback?: (err: AWSError, data: VerifiedPermissions.Types.IsAuthorizedOutput) => void): Request<VerifiedPermissions.Types.IsAuthorizedOutput, AWSError>;
/**
* 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. If you specify the identityToken parameter, then this operation derives the principal from that token. You must not also include that principal in the entities parameter or the operation fails and reports a conflict between the two entity sources. If you provide only an accessToken, then you can include the entity as part of the entities parameter to provide additional attributes. 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(params: VerifiedPermissions.Types.IsAuthorizedWithTokenInput, callback?: (err: AWSError, data: VerifiedPermissions.Types.IsAuthorizedWithTokenOutput) => void): Request<VerifiedPermissions.Types.IsAuthorizedWithTokenOutput, AWSError>;
/**
* 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. If you specify the identityToken parameter, then this operation derives the principal from that token. You must not also include that principal in the entities parameter or the operation fails and reports a conflict between the two entity sources. If you provide only an accessToken, then you can include the entity as part of the entities parameter to provide additional attributes. 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(callback?: (err: AWSError, data: VerifiedPermissions.Types.IsAuthorizedWithTokenOutput) => void): Request<VerifiedPermissions.Types.IsAuthorizedWithTokenOutput, AWSError>;
/**
* Returns a paginated list of all of the identity sources defined in the specified policy store.
*/
listIdentitySources(params: VerifiedPermissions.Types.ListIdentitySourcesInput, callback?: (err: AWSError, data: VerifiedPermissions.Types.ListIdentitySourcesOutput) => void): Request<VerifiedPermissions.Types.ListIdentitySourcesOutput, AWSError>;
/**
* Returns a paginated list of all of the identity sources defined in the specified policy store.
*/
listIdentitySources(callback?: (err: AWSError, data: VerifiedPermissions.Types.ListIdentitySourcesOutput) => void): Request<VerifiedPermissions.Types.ListIdentitySourcesOutput, AWSError>;
/**
* Returns a paginated list of all policies stored in the specified policy store.
*/
listPolicies(params: VerifiedPermissions.Types.ListPoliciesInput, callback?: (err: AWSError, data: VerifiedPermissions.Types.ListPoliciesOutput) => void): Request<VerifiedPermissions.Types.ListPoliciesOutput, AWSError>;
/**
* Returns a paginated list of all policies stored in the specified policy store.
*/
listPolicies(callback?: (err: AWSError, data: VerifiedPermissions.Types.ListPoliciesOutput) => void): Request<VerifiedPermissions.Types.ListPoliciesOutput, AWSError>;
/**
* Returns a paginated list of all policy stores in the calling Amazon Web Services account.
*/
listPolicyStores(params: VerifiedPermissions.Types.ListPolicyStoresInput, callback?: (err: AWSError, data: VerifiedPermissions.Types.ListPolicyStoresOutput) => void): Request<VerifiedPermissions.Types.ListPolicyStoresOutput, AWSError>;
/**
* Returns a paginated list of all policy stores in the calling Amazon Web Services account.
*/
listPolicyStores(callback?: (err: AWSError, data: VerifiedPermissions.Types.ListPolicyStoresOutput) => void): Request<VerifiedPermissions.Types.ListPolicyStoresOutput, AWSError>;
/**
* Returns a paginated list of all policy templates in the specified policy store.
*/
listPolicyTemplates(params: VerifiedPermissions.Types.ListPolicyTemplatesInput, callback?: (err: AWSError, data: VerifiedPermissions.Types.ListPolicyTemplatesOutput) => void): Request<VerifiedPermissions.Types.ListPolicyTemplatesOutput, AWSError>;
/**
* Returns a paginated list of all policy templates in the specified policy store.
*/
listPolicyTemplates(callback?: (err: AWSError, data: VerifiedPermissions.Types.ListPolicyTemplatesOutput) => void): Request<VerifiedPermissions.Types.ListPolicyTemplatesOutput, AWSError>;
/**
* 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 be propagate through the service and be visible in the results of other Verified Permissions operations.
*/
putSchema(params: VerifiedPermissions.Types.PutSchemaInput, callback?: (err: AWSError, data: VerifiedPermissions.Types.PutSchemaOutput) => void): Request<VerifiedPermissions.Types.PutSchemaOutput, AWSError>;
/**
* 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 be propagate through the service and be visible in the results of other Verified Permissions operations.
*/
putSchema(callback?: (err: AWSError, data: VerifiedPermissions.Types.PutSchemaOutput) => void): Request<VerifiedPermissions.Types.PutSchemaOutput, AWSError>;
/**
* 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 be propagate through the service and be visible in the results of other Verified Permissions operations.
*/
updateIdentitySource(params: VerifiedPermissions.Types.UpdateIdentitySourceInput, callback?: (err: AWSError, data: VerifiedPermissions.Types.UpdateIdentitySourceOutput) => void): Request<VerifiedPermissions.Types.UpdateIdentitySourceOutput, AWSError>;
/**
* 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 be propagate through the service and be visible in the results of other Verified Permissions operations.
*/
updateIdentitySource(callback?: (err: AWSError, data: VerifiedPermissions.Types.UpdateIdentitySourceOutput) => void): Request<VerifiedPermissions.Types.UpdateIdentitySourceOutput, AWSError>;
/**
* 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 be propagate through the service and be visible in the results of other Verified Permissions operations.
*/
updatePolicy(params: VerifiedPermissions.Types.UpdatePolicyInput, callback?: (err: AWSError, data: VerifiedPermissions.Types.UpdatePolicyOutput) => void): Request<VerifiedPermissions.Types.UpdatePolicyOutput, AWSError>;
/**
* 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 be propagate through the service and be visible in the results of other Verified Permissions operations.
*/
updatePolicy(callback?: (err: AWSError, data: VerifiedPermissions.Types.UpdatePolicyOutput) => void): Request<VerifiedPermissions.Types.UpdatePolicyOutput, AWSError>;
/**
* 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 be propagate through the service and be visible in the results of other Verified Permissions operations.
*/
updatePolicyStore(params: VerifiedPermissions.Types.UpdatePolicyStoreInput, callback?: (err: AWSError, data: VerifiedPermissions.Types.UpdatePolicyStoreOutput) => void): Request<VerifiedPermissions.Types.UpdatePolicyStoreOutput, AWSError>;
/**
* 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 be propagate through the service and be visible in the results of other Verified Permissions operations.
*/
updatePolicyStore(callback?: (err: AWSError, data: VerifiedPermissions.Types.UpdatePolicyStoreOutput) => void): Request<VerifiedPermissions.Types.UpdatePolicyStoreOutput, AWSError>;
/**
* 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 be propagate through the service and be visible in the results of other Verified Permissions operations.
*/
updatePolicyTemplate(params: VerifiedPermissions.Types.UpdatePolicyTemplateInput, callback?: (err: AWSError, data: VerifiedPermissions.Types.UpdatePolicyTemplateOutput) => void): Request<VerifiedPermissions.Types.UpdatePolicyTemplateOutput, AWSError>;
/**
* 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 be propagate through the service and be visible in the results of other Verified Permissions operations.
*/
updatePolicyTemplate(callback?: (err: AWSError, data: VerifiedPermissions.Types.UpdatePolicyTemplateOutput) => void): Request<VerifiedPermissions.Types.UpdatePolicyTemplateOutput, AWSError>;
}
declare namespace VerifiedPermissions {
export type ActionId = string;
export interface ActionIdentifier {
/**
* The type of an action.
*/
actionType: ActionType;
/**
* The ID of an action.
*/
actionId: ActionId;
}
export type ActionType = string;
export interface AttributeValue {
/**
* An attribute value of Boolean type. Example: {"boolean": true}
*/
boolean?: BooleanAttribute;
/**
* An attribute value of type EntityIdentifier. Example: "entityIdentifier": { "entityId": "<id>", "entityType": "<entity type>"}
*/
entityIdentifier?: EntityIdentifier;
/**
* An attribute value of Long type. Example: {"long": 0}
*/
long?: LongAttribute;
/**
* An attribute value of String type. Example: {"string": "abc"}
*/
string?: StringAttribute;
/**
* An attribute value of Set type. Example: {"set": [ {} ] }
*/
set?: SetAttribute;
/**
* An attribute value of Record type. Example: {"record": { "keyName": {} } }
*/
record?: RecordAttribute;
}
export type Boolean = boolean;
export type BooleanAttribute = boolean;
export type ClientId = string;
export type ClientIds = ClientId[];
export interface CognitoUserPoolConfiguration {
/**
* The Amazon Resource Name (ARN) of the Amazon Cognito user pool that contains the identities to be authorized. Example: "UserPoolArn": "arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5"
*/
userPoolArn: UserPoolArn;
/**
* The unique application client IDs that are associated with the specified Amazon Cognito user pool. Example: "ClientIds": ["&ExampleCogClientId;"]
*/
clientIds?: ClientIds;
}
export interface Configuration {
/**
* Contains configuration details of a Amazon Cognito user pool that Verified Permissions can use as a source of authenticated identities as entities. It specifies the Amazon Resource Name (ARN) of a Amazon Cognito user pool and one or more application client IDs. Example: "configuration":{"cognitoUserPoolConfiguration":{"userPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","clientIds": ["a1b2c3d4e5f6g7h8i9j0kalbmc"]}}
*/
cognitoUserPoolConfiguration?: CognitoUserPoolConfiguration;
}
export interface ContextDefinition {
/**
* An list of attributes that are needed to successfully evaluate an authorization request. Each attribute in this array must include a map of a data type and its value. Example: "Context":{"<KeyName1>":{"boolean":true},"<KeyName2>":{"long":1234}}
*/
contextMap?: ContextMap;
}
export type ContextMap = {[key: string]: AttributeValue};
export interface CreateIdentitySourceInput {
/**
* Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.. If you don't provide this value, then Amazon Web Services generates a random one for you. If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.
*/
clientToken?: IdempotencyToken;
/**
* Specifies the ID of the policy store in which you want to store this identity source. Only policies and requests made using this policy store can reference identities from the identity provider configured in the new identity source.
*/
policyStoreId: PolicyStoreId;
/**
* Specifies the details required to communicate with the identity provider (IdP) associated with this identity source. At this time, the only valid member of this structure is a Amazon Cognito user pool configuration. You must specify a UserPoolArn, and optionally, a ClientId.
*/
configuration: Configuration;
/**
* Specifies the namespace and data type of the principals generated for identities authenticated by the new identity source.
*/
principalEntityType?: PrincipalEntityType;
}
export interface CreateIdentitySourceOutput {
/**
* The date and time the identity source was originally created.
*/
createdDate: TimestampFormat;
/**
* The unique ID of the new identity source.
*/
identitySourceId: IdentitySourceId;
/**
* The date and time the identity source was most recently updated.
*/
lastUpdatedDate: TimestampFormat;
/**
* The ID of the policy store that contains the identity source.
*/
policyStoreId: PolicyStoreId;
}
export interface CreatePolicyInput {
/**
* Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.. If you don't provide this value, then Amazon Web Services generates a random one for you. If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.
*/
clientToken?: IdempotencyToken;
/**
* Specifies the PolicyStoreId of the policy store you want to store the policy in.
*/
policyStoreId: PolicyStoreId;
/**
* A structure that specifies the policy type and content to use for the new policy. You must include either a static or a templateLinked element. The policy content must be written in the Cedar policy language.
*/
definition: PolicyDefinition;
}
export interface CreatePolicyOutput {
/**
* The ID of the policy store that contains the new policy.
*/
policyStoreId: PolicyStoreId;
/**
* The unique ID of the new policy.
*/
policyId: PolicyId;
/**
* The policy type of the new policy.
*/
policyType: PolicyType;
/**
* The principal specified in the new policy's scope. This response element isn't present when principal isn't specified in the policy content.
*/
principal?: EntityIdentifier;
/**
* The resource specified in the new policy's scope. This response element isn't present when the resource isn't specified in the policy content.
*/
resource?: EntityIdentifier;
/**
* The date and time the policy was originally created.
*/
createdDate: TimestampFormat;
/**
* The date and time the policy was last updated.
*/
lastUpdatedDate: TimestampFormat;
}
export interface CreatePolicyStoreInput {
/**
* Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.. If you don't provide this value, then Amazon Web Services generates a random one for you. If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.
*/
clientToken?: IdempotencyToken;
/**
* Specifies the validation setting for this policy store. Currently, the only valid and required value is Mode. We recommend that you turn on STRICT mode only after you define a schema. If a schema doesn't exist, then STRICT mode causes any policy to fail validation, and Verified Permissions rejects the policy. You can turn off validation by using the UpdatePolicyStore. Then, when you have a schema defined, use UpdatePolicyStore again to turn validation back on.
*/
validationSettings: ValidationSettings;
}
export interface CreatePolicyStoreOutput {
/**
* The unique ID of the new policy store.
*/
policyStoreId: PolicyStoreId;
/**
* The Amazon Resource Name (ARN) of the new policy store.
*/
arn: ResourceArn;
/**
* The date and time the policy store was originally created.
*/
createdDate: TimestampFormat;
/**
* The date and time the policy store was last updated.
*/
lastUpdatedDate: TimestampFormat;
}
export interface CreatePolicyTemplateInput {
/**
* Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.. If you don't provide this value, then Amazon Web Services generates a random one for you. If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.
*/
clientToken?: IdempotencyToken;
/**
* The ID of the policy store in which to create the policy template.
*/
policyStoreId: PolicyStoreId;
/**
* Specifies a description for the policy template.
*/
description?: PolicyTemplateDescription;
/**
* Specifies the content that you want to use for the new policy template, written in the Cedar policy language.
*/
statement: PolicyStatement;
}
export interface CreatePolicyTemplateOutput {
/**
* The ID of the policy store that contains the policy template.
*/
policyStoreId: PolicyStoreId;
/**
* The unique ID of the new policy template.
*/
policyTemplateId: PolicyTemplateId;
/**
* The date and time the policy template was originally created.
*/
createdDate: TimestampFormat;
/**
* The date and time the policy template was most recently updated.
*/
lastUpdatedDate: TimestampFormat;
}
export type Decision = "ALLOW"|"DENY"|string;
export interface DeleteIdentitySourceInput {
/**
* Specifies the ID of the policy store that contains the identity source that you want to delete.
*/
policyStoreId: PolicyStoreId;
/**
* Specifies the ID of the identity source that you want to delete.
*/
identitySourceId: IdentitySourceId;
}
export interface DeleteIdentitySourceOutput {
}
export interface DeletePolicyInput {
/**
* Specifies the ID of the policy store that contains the policy that you want to delete.
*/
policyStoreId: PolicyStoreId;
/**
* Specifies the ID of the policy that you want to delete.
*/
policyId: PolicyId;
}
export interface DeletePolicyOutput {
}
export interface DeletePolicyStoreInput {
/**
* Specifies the ID of the policy store that you want to delete.
*/
policyStoreId: PolicyStoreId;
}
export interface DeletePolicyStoreOutput {
}
export interface DeletePolicyTemplateInput {
/**
* Specifies the ID of the policy store that contains the policy template that you want to delete.
*/
policyStoreId: PolicyStoreId;
/**
* Specifies the ID of the policy template that you want to delete.
*/
policyTemplateId: PolicyTemplateId;
}
export interface DeletePolicyTemplateOutput {
}
export interface DeterminingPolicyItem {
/**
* The Id of a policy that determined to an authorization decision. Example: "policyId":"SPEXAMPLEabcdefg111111"
*/
policyId: PolicyId;
}
export type DeterminingPolicyList = DeterminingPolicyItem[];
export type DiscoveryUrl = string;
export interface EntitiesDefinition {
/**
* An array of entities that are needed to successfully evaluate an authorization request. Each entity in this array must include an identifier for the entity, the attributes of the entity, and a list of any parent entities.
*/
entityList?: EntityList;
}
export type EntityAttributes = {[key: string]: AttributeValue};
export type EntityId = string;
export interface EntityIdentifier {
/**
* The type of an entity. Example: "entityType":"typeName"
*/
entityType: EntityType;
/**
* The identifier of an entity. "entityId":"identifier"
*/
entityId: EntityId;
}
export interface EntityItem {
/**
* The identifier of the entity.
*/
identifier: EntityIdentifier;
/**
* A list of attributes for the entity.
*/
attributes?: EntityAttributes;
/**
* The parents in the hierarchy that contains the entity.
*/
parents?: ParentList;
}
export type EntityList = EntityItem[];
export interface EntityReference {
/**
* Used to indicate that a principal or resource is not specified. This can be used to search for policies that are not associated with a specific principal or resource.
*/
unspecified?: Boolean;
/**
* The identifier of the entity. It can consist of either an EntityType and EntityId, a principal, or a resource.
*/
identifier?: EntityIdentifier;
}
export type EntityType = string;
export interface EvaluationErrorItem {
/**
* The error description.
*/
errorDescription: String;
}
export type EvaluationErrorList = EvaluationErrorItem[];
export interface GetIdentitySourceInput {
/**
* Specifies the ID of the policy store that contains the identity source you want information about.
*/
policyStoreId: PolicyStoreId;
/**
* Specifies the ID of the identity source you want information about.
*/
identitySourceId: IdentitySourceId;
}
export interface GetIdentitySourceOutput {
/**
* The date and time that the identity source was originally created.
*/
createdDate: TimestampFormat;
/**
* A structure that describes the configuration of the identity source.
*/
details: IdentitySourceDetails;
/**
* The ID of the identity source.
*/
identitySourceId: IdentitySourceId;
/**
* The date and time that the identity source was most recently updated.
*/
lastUpdatedDate: TimestampFormat;
/**
* The ID of the policy store that contains the identity source.
*/
policyStoreId: PolicyStoreId;
/**
* The data type of principals generated for identities authenticated by this identity source.
*/
principalEntityType: PrincipalEntityType;
}
export interface GetPolicyInput {
/**
* Specifies the ID of the policy store that contains the policy that you want information about.
*/
policyStoreId: PolicyStoreId;
/**
* Specifies the ID of the policy you want information about.
*/
policyId: PolicyId;
}
export interface GetPolicyOutput {
/**
* The ID of the policy store that contains the policy that you want information about.
*/
policyStoreId: PolicyStoreId;
/**
* The unique ID of the policy that you want information about.
*/
policyId: PolicyId;
/**
* The type of the policy.
*/
policyType: PolicyType;
/**
* The principal specified in the policy's scope. This element isn't included in the response when Principal isn't present in the policy content.
*/
principal?: EntityIdentifier;
/**
* The resource specified in the policy's scope. This element isn't included in the response when Resource isn't present in the policy content.
*/
resource?: EntityIdentifier;
/**
* The definition of the requested policy.
*/
definition: PolicyDefinitionDetail;
/**
* The date and time that the policy was originally created.
*/
createdDate: TimestampFormat;
/**
* The date and time that the policy was last updated.
*/
lastUpdatedDate: TimestampFormat;
}
export interface GetPolicyStoreInput {
/**
* Specifies the ID of the policy store that you want information about.
*/
policyStoreId: PolicyStoreId;
}
export interface GetPolicyStoreOutput {
/**
* The ID of the policy store;
*/
policyStoreId: PolicyStoreId;
/**
* The Amazon Resource Name (ARN) of the policy store.
*/
arn: ResourceArn;
/**
* The current validation settings for the policy store.
*/
validationSettings: ValidationSettings;
/**
* The date and time that the policy store was originally created.
*/
createdDate: TimestampFormat;
/**
* The date and time that the policy store was last updated.
*/
lastUpdatedDate: TimestampFormat;
}
export interface GetPolicyTemplateInput {
/**
* Specifies the ID of the policy store that contains the policy template that you want information about.
*/
policyStoreId: PolicyStoreId;
/**
* Specifies the ID of the policy template that you want information about.
*/
policyTemplateId: PolicyTemplateId;
}
export interface GetPolicyTemplateOutput {
/**
* The ID of the policy store that contains the policy template.
*/
policyStoreId: PolicyStoreId;
/**
* The ID of the policy template.
*/
policyTemplateId: PolicyTemplateId;
/**
* The description of the policy template.
*/
description?: PolicyTemplateDescription;
/**
* The content of the body of the policy template written in the Cedar policy language.
*/
statement: PolicyStatement;
/**
* The date and time that the policy template was originally created.
*/
createdDate: TimestampFormat;
/**
* The date and tim