@aws-sdk/client-verifiedpermissions 3.352.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +201 -0
- package/README.md +461 -0
- package/dist-cjs/VerifiedPermissions.js +59 -0
- package/dist-cjs/VerifiedPermissionsClient.js +41 -0
- package/dist-cjs/commands/CreateIdentitySourceCommand.js +46 -0
- package/dist-cjs/commands/CreatePolicyCommand.js +46 -0
- package/dist-cjs/commands/CreatePolicyStoreCommand.js +46 -0
- package/dist-cjs/commands/CreatePolicyTemplateCommand.js +46 -0
- package/dist-cjs/commands/DeleteIdentitySourceCommand.js +46 -0
- package/dist-cjs/commands/DeletePolicyCommand.js +46 -0
- package/dist-cjs/commands/DeletePolicyStoreCommand.js +46 -0
- package/dist-cjs/commands/DeletePolicyTemplateCommand.js +46 -0
- package/dist-cjs/commands/GetIdentitySourceCommand.js +46 -0
- package/dist-cjs/commands/GetPolicyCommand.js +46 -0
- package/dist-cjs/commands/GetPolicyStoreCommand.js +46 -0
- package/dist-cjs/commands/GetPolicyTemplateCommand.js +46 -0
- package/dist-cjs/commands/GetSchemaCommand.js +46 -0
- package/dist-cjs/commands/IsAuthorizedCommand.js +46 -0
- package/dist-cjs/commands/IsAuthorizedWithTokenCommand.js +46 -0
- package/dist-cjs/commands/ListIdentitySourcesCommand.js +46 -0
- package/dist-cjs/commands/ListPoliciesCommand.js +46 -0
- package/dist-cjs/commands/ListPolicyStoresCommand.js +46 -0
- package/dist-cjs/commands/ListPolicyTemplatesCommand.js +46 -0
- package/dist-cjs/commands/PutSchemaCommand.js +46 -0
- package/dist-cjs/commands/UpdateIdentitySourceCommand.js +46 -0
- package/dist-cjs/commands/UpdatePolicyCommand.js +46 -0
- package/dist-cjs/commands/UpdatePolicyStoreCommand.js +46 -0
- package/dist-cjs/commands/UpdatePolicyTemplateCommand.js +46 -0
- package/dist-cjs/commands/index.js +27 -0
- package/dist-cjs/endpoint/EndpointParameters.js +12 -0
- package/dist-cjs/endpoint/endpointResolver.js +12 -0
- package/dist-cjs/endpoint/ruleset.js +7 -0
- package/dist-cjs/index.js +11 -0
- package/dist-cjs/models/VerifiedPermissionsServiceException.js +12 -0
- package/dist-cjs/models/index.js +4 -0
- package/dist-cjs/models/models_0.js +237 -0
- package/dist-cjs/pagination/Interfaces.js +2 -0
- package/dist-cjs/pagination/ListIdentitySourcesPaginator.js +29 -0
- package/dist-cjs/pagination/ListPoliciesPaginator.js +29 -0
- package/dist-cjs/pagination/ListPolicyStoresPaginator.js +29 -0
- package/dist-cjs/pagination/ListPolicyTemplatesPaginator.js +29 -0
- package/dist-cjs/pagination/index.js +8 -0
- package/dist-cjs/protocols/Aws_json1_0.js +1772 -0
- package/dist-cjs/runtimeConfig.browser.js +39 -0
- package/dist-cjs/runtimeConfig.js +48 -0
- package/dist-cjs/runtimeConfig.native.js +15 -0
- package/dist-cjs/runtimeConfig.shared.js +21 -0
- package/dist-es/VerifiedPermissions.js +55 -0
- package/dist-es/VerifiedPermissionsClient.js +37 -0
- package/dist-es/commands/CreateIdentitySourceCommand.js +42 -0
- package/dist-es/commands/CreatePolicyCommand.js +42 -0
- package/dist-es/commands/CreatePolicyStoreCommand.js +42 -0
- package/dist-es/commands/CreatePolicyTemplateCommand.js +42 -0
- package/dist-es/commands/DeleteIdentitySourceCommand.js +42 -0
- package/dist-es/commands/DeletePolicyCommand.js +42 -0
- package/dist-es/commands/DeletePolicyStoreCommand.js +42 -0
- package/dist-es/commands/DeletePolicyTemplateCommand.js +42 -0
- package/dist-es/commands/GetIdentitySourceCommand.js +42 -0
- package/dist-es/commands/GetPolicyCommand.js +42 -0
- package/dist-es/commands/GetPolicyStoreCommand.js +42 -0
- package/dist-es/commands/GetPolicyTemplateCommand.js +42 -0
- package/dist-es/commands/GetSchemaCommand.js +42 -0
- package/dist-es/commands/IsAuthorizedCommand.js +42 -0
- package/dist-es/commands/IsAuthorizedWithTokenCommand.js +42 -0
- package/dist-es/commands/ListIdentitySourcesCommand.js +42 -0
- package/dist-es/commands/ListPoliciesCommand.js +42 -0
- package/dist-es/commands/ListPolicyStoresCommand.js +42 -0
- package/dist-es/commands/ListPolicyTemplatesCommand.js +42 -0
- package/dist-es/commands/PutSchemaCommand.js +42 -0
- package/dist-es/commands/UpdateIdentitySourceCommand.js +42 -0
- package/dist-es/commands/UpdatePolicyCommand.js +42 -0
- package/dist-es/commands/UpdatePolicyStoreCommand.js +42 -0
- package/dist-es/commands/UpdatePolicyTemplateCommand.js +42 -0
- package/dist-es/commands/index.js +24 -0
- package/dist-es/endpoint/EndpointParameters.js +8 -0
- package/dist-es/endpoint/endpointResolver.js +8 -0
- package/dist-es/endpoint/ruleset.js +4 -0
- package/dist-es/index.js +6 -0
- package/dist-es/models/VerifiedPermissionsServiceException.js +8 -0
- package/dist-es/models/index.js +1 -0
- package/dist-es/models/models_0.js +227 -0
- package/dist-es/pagination/Interfaces.js +1 -0
- package/dist-es/pagination/ListIdentitySourcesPaginator.js +25 -0
- package/dist-es/pagination/ListPoliciesPaginator.js +25 -0
- package/dist-es/pagination/ListPolicyStoresPaginator.js +25 -0
- package/dist-es/pagination/ListPolicyTemplatesPaginator.js +25 -0
- package/dist-es/pagination/index.js +5 -0
- package/dist-es/protocols/Aws_json1_0.js +1721 -0
- package/dist-es/runtimeConfig.browser.js +34 -0
- package/dist-es/runtimeConfig.js +43 -0
- package/dist-es/runtimeConfig.native.js +11 -0
- package/dist-es/runtimeConfig.shared.js +17 -0
- package/dist-types/VerifiedPermissions.d.ts +242 -0
- package/dist-types/VerifiedPermissionsClient.d.ts +250 -0
- package/dist-types/commands/CreateIdentitySourceCommand.d.ts +210 -0
- package/dist-types/commands/CreatePolicyCommand.d.ts +222 -0
- package/dist-types/commands/CreatePolicyStoreCommand.d.ts +175 -0
- package/dist-types/commands/CreatePolicyTemplateCommand.d.ts +184 -0
- package/dist-types/commands/DeleteIdentitySourceCommand.d.ts +175 -0
- package/dist-types/commands/DeletePolicyCommand.d.ts +174 -0
- package/dist-types/commands/DeletePolicyStoreCommand.d.ts +166 -0
- package/dist-types/commands/DeletePolicyTemplateCommand.d.ts +177 -0
- package/dist-types/commands/GetIdentitySourceCommand.d.ts +182 -0
- package/dist-types/commands/GetPolicyCommand.d.ts +199 -0
- package/dist-types/commands/GetPolicyStoreCommand.d.ts +175 -0
- package/dist-types/commands/GetPolicyTemplateCommand.d.ts +175 -0
- package/dist-types/commands/GetSchemaCommand.d.ts +172 -0
- package/dist-types/commands/IsAuthorizedCommand.d.ts +239 -0
- package/dist-types/commands/IsAuthorizedWithTokenCommand.d.ts +240 -0
- package/dist-types/commands/ListIdentitySourcesCommand.d.ts +193 -0
- package/dist-types/commands/ListPoliciesCommand.d.ts +222 -0
- package/dist-types/commands/ListPolicyStoresCommand.d.ts +174 -0
- package/dist-types/commands/ListPolicyTemplatesCommand.d.ts +180 -0
- package/dist-types/commands/PutSchemaCommand.d.ts +188 -0
- package/dist-types/commands/UpdateIdentitySourceCommand.d.ts +187 -0
- package/dist-types/commands/UpdatePolicyCommand.d.ts +202 -0
- package/dist-types/commands/UpdatePolicyStoreCommand.d.ts +179 -0
- package/dist-types/commands/UpdatePolicyTemplateCommand.d.ts +184 -0
- package/dist-types/commands/index.d.ts +24 -0
- package/dist-types/endpoint/EndpointParameters.d.ts +20 -0
- package/dist-types/endpoint/endpointResolver.d.ts +5 -0
- package/dist-types/endpoint/ruleset.d.ts +2 -0
- package/dist-types/index.d.ts +75 -0
- package/dist-types/models/VerifiedPermissionsServiceException.d.ts +13 -0
- package/dist-types/models/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +2456 -0
- package/dist-types/pagination/Interfaces.d.ts +8 -0
- package/dist-types/pagination/ListIdentitySourcesPaginator.d.ts +7 -0
- package/dist-types/pagination/ListPoliciesPaginator.d.ts +7 -0
- package/dist-types/pagination/ListPolicyStoresPaginator.d.ts +7 -0
- package/dist-types/pagination/ListPolicyTemplatesPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +5 -0
- package/dist-types/protocols/Aws_json1_0.d.ts +218 -0
- package/dist-types/runtimeConfig.browser.d.ts +42 -0
- package/dist-types/runtimeConfig.d.ts +42 -0
- package/dist-types/runtimeConfig.native.d.ts +41 -0
- package/dist-types/runtimeConfig.shared.d.ts +18 -0
- package/dist-types/ts3.4/VerifiedPermissions.d.ts +415 -0
- package/dist-types/ts3.4/VerifiedPermissionsClient.d.ts +259 -0
- package/dist-types/ts3.4/commands/CreateIdentitySourceCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/CreatePolicyCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/CreatePolicyStoreCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/CreatePolicyTemplateCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/DeleteIdentitySourceCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/DeletePolicyCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/DeletePolicyStoreCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/DeletePolicyTemplateCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/GetIdentitySourceCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/GetPolicyCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/GetPolicyStoreCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/GetPolicyTemplateCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/GetSchemaCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/IsAuthorizedCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/IsAuthorizedWithTokenCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/ListIdentitySourcesCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/ListPoliciesCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/ListPolicyStoresCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/ListPolicyTemplatesCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/PutSchemaCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/UpdateIdentitySourceCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/UpdatePolicyCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/UpdatePolicyStoreCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/UpdatePolicyTemplateCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/index.d.ts +24 -0
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +32 -0
- package/dist-types/ts3.4/endpoint/endpointResolver.d.ts +8 -0
- package/dist-types/ts3.4/endpoint/ruleset.d.ts +2 -0
- package/dist-types/ts3.4/index.d.ts +6 -0
- package/dist-types/ts3.4/models/VerifiedPermissionsServiceException.d.ts +8 -0
- package/dist-types/ts3.4/models/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +757 -0
- package/dist-types/ts3.4/pagination/Interfaces.d.ts +6 -0
- package/dist-types/ts3.4/pagination/ListIdentitySourcesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListPoliciesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListPolicyStoresPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListPolicyTemplatesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +5 -0
- package/dist-types/ts3.4/protocols/Aws_json1_0.d.ts +293 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +96 -0
- package/dist-types/ts3.4/runtimeConfig.d.ts +93 -0
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +87 -0
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +20 -0
- package/package.json +101 -0
|
@@ -0,0 +1,2456 @@
|
|
|
1
|
+
import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
|
|
2
|
+
import { VerifiedPermissionsServiceException as __BaseException } from "./VerifiedPermissionsServiceException";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
* <p>You don't have sufficient access to perform this action.</p>
|
|
6
|
+
*/
|
|
7
|
+
export declare class AccessDeniedException extends __BaseException {
|
|
8
|
+
readonly name: "AccessDeniedException";
|
|
9
|
+
readonly $fault: "client";
|
|
10
|
+
/**
|
|
11
|
+
* @internal
|
|
12
|
+
*/
|
|
13
|
+
constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
|
|
14
|
+
}
|
|
15
|
+
/**
|
|
16
|
+
* @public
|
|
17
|
+
* <p>Contains information about an action for a request for which an authorization decision
|
|
18
|
+
* is made.</p>
|
|
19
|
+
* <p>This data type is used as an request parameter to the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorized.html">IsAuthorized</a> and <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorizedWithToken.html">IsAuthorizedWithToken</a> operations.</p>
|
|
20
|
+
* <p>Example: <code>\{ "actionId": "<action name>", "actionType": "Action"
|
|
21
|
+
* \}</code>
|
|
22
|
+
* </p>
|
|
23
|
+
*/
|
|
24
|
+
export interface ActionIdentifier {
|
|
25
|
+
/**
|
|
26
|
+
* <p>The type of an action.</p>
|
|
27
|
+
*/
|
|
28
|
+
actionType: string | undefined;
|
|
29
|
+
/**
|
|
30
|
+
* <p>The ID of an action.</p>
|
|
31
|
+
*/
|
|
32
|
+
actionId: string | undefined;
|
|
33
|
+
}
|
|
34
|
+
/**
|
|
35
|
+
* @public
|
|
36
|
+
* <p>Contains the identifier of an entity, including its ID and type.</p>
|
|
37
|
+
* <p>This data type is used as a request parameter for <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorized.html">IsAuthorized</a> operation, and as a
|
|
38
|
+
* response parameter for the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreatePolicy.html">CreatePolicy</a>, <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_GetPolicy.html">GetPolicy</a>, and
|
|
39
|
+
* <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdatePolicy.html">UpdatePolicy</a> operations.</p>
|
|
40
|
+
* <p>Example:
|
|
41
|
+
* <code>\{"entityId":"<i>string</i>","entityType":"<i>string</i>"\}</code>
|
|
42
|
+
* </p>
|
|
43
|
+
*/
|
|
44
|
+
export interface EntityIdentifier {
|
|
45
|
+
/**
|
|
46
|
+
* <p>The type of an entity.</p>
|
|
47
|
+
* <p>Example: <code>"entityType":"<i>typeName</i>"</code>
|
|
48
|
+
* </p>
|
|
49
|
+
*/
|
|
50
|
+
entityType: string | undefined;
|
|
51
|
+
/**
|
|
52
|
+
* <p>The identifier of an entity.</p>
|
|
53
|
+
* <p>
|
|
54
|
+
* <code>"entityId":"<i>identifier</i>"</code>
|
|
55
|
+
* </p>
|
|
56
|
+
*/
|
|
57
|
+
entityId: string | undefined;
|
|
58
|
+
}
|
|
59
|
+
/**
|
|
60
|
+
* @public
|
|
61
|
+
* <p>The configuration for an identity source that represents a connection to an Amazon Cognito user pool used
|
|
62
|
+
* as an identity provider for Verified Permissions.</p>
|
|
63
|
+
* <p>This data type is used as a field that is part of an <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_Configuration.html">Configuration</a> structure that is
|
|
64
|
+
* used as a parameter to the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_Configuration.html">Configuration</a>.</p>
|
|
65
|
+
* <p>Example:<code>"CognitoUserPoolConfiguration":\{"UserPoolArn":"cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","ClientIds":
|
|
66
|
+
* ["a1b2c3d4e5f6g7h8i9j0kalbmc"]\}</code>
|
|
67
|
+
* </p>
|
|
68
|
+
*/
|
|
69
|
+
export interface CognitoUserPoolConfiguration {
|
|
70
|
+
/**
|
|
71
|
+
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of the Amazon Cognito user pool that contains the identities to be
|
|
72
|
+
* authorized.</p>
|
|
73
|
+
* <p>Example: <code>"UserPoolArn":
|
|
74
|
+
* "cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5"</code>
|
|
75
|
+
* </p>
|
|
76
|
+
*/
|
|
77
|
+
userPoolArn: string | undefined;
|
|
78
|
+
/**
|
|
79
|
+
* <p>The unique application client IDs that are associated with the specified Amazon Cognito user
|
|
80
|
+
* pool.</p>
|
|
81
|
+
* <p>Example: <code>"ClientIds": ["&ExampleCogClientId;"]</code>
|
|
82
|
+
* </p>
|
|
83
|
+
*/
|
|
84
|
+
clientIds?: string[];
|
|
85
|
+
}
|
|
86
|
+
/**
|
|
87
|
+
* @public
|
|
88
|
+
* <p>Contains configuration information used when creating a new identity source.</p>
|
|
89
|
+
* <note>
|
|
90
|
+
* <p>At this time, the only valid member of this structure is a Amazon Cognito user pool
|
|
91
|
+
* configuration.</p>
|
|
92
|
+
* <p>You must specify a <code>userPoolArn</code>, and optionally, a
|
|
93
|
+
* <code>ClientId</code>.</p>
|
|
94
|
+
* </note>
|
|
95
|
+
* <p>This data type is used as a request parameter for the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreateIdentitySource.html">CreateIdentitySource</a>
|
|
96
|
+
* operation.</p>
|
|
97
|
+
*/
|
|
98
|
+
export type Configuration = Configuration.CognitoUserPoolConfigurationMember | Configuration.$UnknownMember;
|
|
99
|
+
/**
|
|
100
|
+
* @public
|
|
101
|
+
*/
|
|
102
|
+
export declare namespace Configuration {
|
|
103
|
+
/**
|
|
104
|
+
* <p>Contains configuration details of a Amazon Cognito user pool that Verified Permissions can use as a source of
|
|
105
|
+
* authenticated identities as entities. It specifies the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of a Amazon Cognito user pool
|
|
106
|
+
* and one or more application client IDs.</p>
|
|
107
|
+
* <p>Example:
|
|
108
|
+
* <code>"configuration":\{"cognitoUserPoolConfiguration":\{"userPoolArn":"cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","clientIds":
|
|
109
|
+
* ["a1b2c3d4e5f6g7h8i9j0kalbmc"]\}\}</code>
|
|
110
|
+
* </p>
|
|
111
|
+
*/
|
|
112
|
+
interface CognitoUserPoolConfigurationMember {
|
|
113
|
+
cognitoUserPoolConfiguration: CognitoUserPoolConfiguration;
|
|
114
|
+
$unknown?: never;
|
|
115
|
+
}
|
|
116
|
+
interface $UnknownMember {
|
|
117
|
+
cognitoUserPoolConfiguration?: never;
|
|
118
|
+
$unknown: [string, any];
|
|
119
|
+
}
|
|
120
|
+
interface Visitor<T> {
|
|
121
|
+
cognitoUserPoolConfiguration: (value: CognitoUserPoolConfiguration) => T;
|
|
122
|
+
_: (name: string, value: any) => T;
|
|
123
|
+
}
|
|
124
|
+
const visit: <T>(value: Configuration, visitor: Visitor<T>) => T;
|
|
125
|
+
}
|
|
126
|
+
/**
|
|
127
|
+
* @public
|
|
128
|
+
* @enum
|
|
129
|
+
*/
|
|
130
|
+
export declare const ResourceType: {
|
|
131
|
+
readonly IDENTITY_SOURCE: "IDENTITY_SOURCE";
|
|
132
|
+
readonly POLICY: "POLICY";
|
|
133
|
+
readonly POLICY_STORE: "POLICY_STORE";
|
|
134
|
+
readonly POLICY_TEMPLATE: "POLICY_TEMPLATE";
|
|
135
|
+
readonly SCHEMA: "SCHEMA";
|
|
136
|
+
};
|
|
137
|
+
/**
|
|
138
|
+
* @public
|
|
139
|
+
*/
|
|
140
|
+
export type ResourceType = (typeof ResourceType)[keyof typeof ResourceType];
|
|
141
|
+
/**
|
|
142
|
+
* @public
|
|
143
|
+
* <p>Contains information about a resource conflict.</p>
|
|
144
|
+
*/
|
|
145
|
+
export interface ResourceConflict {
|
|
146
|
+
/**
|
|
147
|
+
* <p>The unique identifier of the resource involved in a conflict.</p>
|
|
148
|
+
*/
|
|
149
|
+
resourceId: string | undefined;
|
|
150
|
+
/**
|
|
151
|
+
* <p>The type of the resource involved in a conflict.</p>
|
|
152
|
+
*/
|
|
153
|
+
resourceType: ResourceType | string | undefined;
|
|
154
|
+
}
|
|
155
|
+
/**
|
|
156
|
+
* @public
|
|
157
|
+
* <p>The request failed because another request to modify a resource occurred at the
|
|
158
|
+
* same.</p>
|
|
159
|
+
*/
|
|
160
|
+
export declare class ConflictException extends __BaseException {
|
|
161
|
+
readonly name: "ConflictException";
|
|
162
|
+
readonly $fault: "client";
|
|
163
|
+
/**
|
|
164
|
+
* <p>The list of resources referenced with this failed request.</p>
|
|
165
|
+
*/
|
|
166
|
+
resources: ResourceConflict[] | undefined;
|
|
167
|
+
/**
|
|
168
|
+
* @internal
|
|
169
|
+
*/
|
|
170
|
+
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
|
|
171
|
+
}
|
|
172
|
+
/**
|
|
173
|
+
* @public
|
|
174
|
+
*/
|
|
175
|
+
export interface CreateIdentitySourceInput {
|
|
176
|
+
/**
|
|
177
|
+
* <p>Specifies a unique, case-sensitive ID that you provide to
|
|
178
|
+
* ensure the idempotency of the request. This lets you safely retry the request without
|
|
179
|
+
* accidentally performing the same operation a second time. Passing the same value to a
|
|
180
|
+
* later call to an operation requires that you also pass the same value for all other
|
|
181
|
+
* parameters. We recommend that you use a <a href="https://wikipedia.org/wiki/Universally_unique_Id">UUID type of
|
|
182
|
+
* value.</a>.</p>
|
|
183
|
+
* <p>If you don't provide this value, then Amazon Web Services generates a random one for
|
|
184
|
+
* you.</p>
|
|
185
|
+
* <p>If you retry the operation with the same <code>ClientToken</code>, but with
|
|
186
|
+
* different parameters, the retry fails with an <code>IdempotentParameterMismatch</code>
|
|
187
|
+
* error.</p>
|
|
188
|
+
*/
|
|
189
|
+
clientToken?: string;
|
|
190
|
+
/**
|
|
191
|
+
* <p>Specifies the ID of the policy store in which you want to store this identity source. Only policies and
|
|
192
|
+
* requests made using this policy store can reference identities from the identity provider
|
|
193
|
+
* configured in the new identity source.</p>
|
|
194
|
+
*/
|
|
195
|
+
policyStoreId: string | undefined;
|
|
196
|
+
/**
|
|
197
|
+
* <p>Specifies the details required to communicate with the identity provider (IdP)
|
|
198
|
+
* associated with this identity source.</p>
|
|
199
|
+
* <note>
|
|
200
|
+
* <p>At this time, the only valid member of this structure is a Amazon Cognito user pool
|
|
201
|
+
* configuration.</p>
|
|
202
|
+
* <p>You must specify a <code>UserPoolArn</code>, and optionally, a
|
|
203
|
+
* <code>ClientId</code>.</p>
|
|
204
|
+
* </note>
|
|
205
|
+
*/
|
|
206
|
+
configuration: Configuration | undefined;
|
|
207
|
+
/**
|
|
208
|
+
* <p>Specifies the namespace and data type of the principals generated for identities
|
|
209
|
+
* authenticated by the new identity source.</p>
|
|
210
|
+
*/
|
|
211
|
+
principalEntityType?: string;
|
|
212
|
+
}
|
|
213
|
+
/**
|
|
214
|
+
* @public
|
|
215
|
+
*/
|
|
216
|
+
export interface CreateIdentitySourceOutput {
|
|
217
|
+
/**
|
|
218
|
+
* <p>The date and time the identity source was originally created.</p>
|
|
219
|
+
*/
|
|
220
|
+
createdDate: Date | undefined;
|
|
221
|
+
/**
|
|
222
|
+
* <p>The unique ID of the new identity source.</p>
|
|
223
|
+
*/
|
|
224
|
+
identitySourceId: string | undefined;
|
|
225
|
+
/**
|
|
226
|
+
* <p>The date and time the identity source was most recently updated.</p>
|
|
227
|
+
*/
|
|
228
|
+
lastUpdatedDate: Date | undefined;
|
|
229
|
+
/**
|
|
230
|
+
* <p>The ID of the policy store that contains the identity source.</p>
|
|
231
|
+
*/
|
|
232
|
+
policyStoreId: string | undefined;
|
|
233
|
+
}
|
|
234
|
+
/**
|
|
235
|
+
* @public
|
|
236
|
+
* <p>The request failed because of an internal error. Try your request again later</p>
|
|
237
|
+
*/
|
|
238
|
+
export declare class InternalServerException extends __BaseException {
|
|
239
|
+
readonly name: "InternalServerException";
|
|
240
|
+
readonly $fault: "server";
|
|
241
|
+
$retryable: {};
|
|
242
|
+
/**
|
|
243
|
+
* @internal
|
|
244
|
+
*/
|
|
245
|
+
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
|
|
246
|
+
}
|
|
247
|
+
/**
|
|
248
|
+
* @public
|
|
249
|
+
* <p>The request failed because it references a resource that doesn't exist.</p>
|
|
250
|
+
*/
|
|
251
|
+
export declare class ResourceNotFoundException extends __BaseException {
|
|
252
|
+
readonly name: "ResourceNotFoundException";
|
|
253
|
+
readonly $fault: "client";
|
|
254
|
+
/**
|
|
255
|
+
* <p>The unique ID of the resource referenced in the failed request.</p>
|
|
256
|
+
*/
|
|
257
|
+
resourceId: string | undefined;
|
|
258
|
+
/**
|
|
259
|
+
* <p>The resource type of the resource referenced in the failed request.</p>
|
|
260
|
+
*/
|
|
261
|
+
resourceType: ResourceType | string | undefined;
|
|
262
|
+
/**
|
|
263
|
+
* @internal
|
|
264
|
+
*/
|
|
265
|
+
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
266
|
+
}
|
|
267
|
+
/**
|
|
268
|
+
* @public
|
|
269
|
+
* <p>The request failed because it would cause a service quota to be exceeded.</p>
|
|
270
|
+
*/
|
|
271
|
+
export declare class ServiceQuotaExceededException extends __BaseException {
|
|
272
|
+
readonly name: "ServiceQuotaExceededException";
|
|
273
|
+
readonly $fault: "client";
|
|
274
|
+
/**
|
|
275
|
+
* <p>The unique ID of the resource referenced in the failed request.</p>
|
|
276
|
+
*/
|
|
277
|
+
resourceId?: string;
|
|
278
|
+
/**
|
|
279
|
+
* <p>The resource type of the resource referenced in the failed request.</p>
|
|
280
|
+
*/
|
|
281
|
+
resourceType: ResourceType | string | undefined;
|
|
282
|
+
/**
|
|
283
|
+
* <p>The code for the Amazon Web Service that owns the quota.</p>
|
|
284
|
+
*/
|
|
285
|
+
serviceCode?: string;
|
|
286
|
+
/**
|
|
287
|
+
* <p>The quota code recognized by the Amazon Web Services Service Quotas service.</p>
|
|
288
|
+
*/
|
|
289
|
+
quotaCode?: string;
|
|
290
|
+
/**
|
|
291
|
+
* @internal
|
|
292
|
+
*/
|
|
293
|
+
constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
|
|
294
|
+
}
|
|
295
|
+
/**
|
|
296
|
+
* @public
|
|
297
|
+
* <p>The request failed because it exceeded a throttling quota.</p>
|
|
298
|
+
*/
|
|
299
|
+
export declare class ThrottlingException extends __BaseException {
|
|
300
|
+
readonly name: "ThrottlingException";
|
|
301
|
+
readonly $fault: "client";
|
|
302
|
+
$retryable: {
|
|
303
|
+
throttling: boolean;
|
|
304
|
+
};
|
|
305
|
+
/**
|
|
306
|
+
* <p>The code for the Amazon Web Service that owns the quota.</p>
|
|
307
|
+
*/
|
|
308
|
+
serviceCode?: string;
|
|
309
|
+
/**
|
|
310
|
+
* <p>The quota code recognized by the Amazon Web Services Service Quotas service.</p>
|
|
311
|
+
*/
|
|
312
|
+
quotaCode?: string;
|
|
313
|
+
/**
|
|
314
|
+
* @internal
|
|
315
|
+
*/
|
|
316
|
+
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
|
|
317
|
+
}
|
|
318
|
+
/**
|
|
319
|
+
* @public
|
|
320
|
+
* <p>Details about a field that failed policy validation.</p>
|
|
321
|
+
*/
|
|
322
|
+
export interface ValidationExceptionField {
|
|
323
|
+
/**
|
|
324
|
+
* <p>The path to the specific element that Verified Permissions found to be not valid.</p>
|
|
325
|
+
*/
|
|
326
|
+
path: string | undefined;
|
|
327
|
+
/**
|
|
328
|
+
* <p>Describes the policy validation error.</p>
|
|
329
|
+
*/
|
|
330
|
+
message: string | undefined;
|
|
331
|
+
}
|
|
332
|
+
/**
|
|
333
|
+
* @public
|
|
334
|
+
* <p>The request failed because one or more input parameters don't satisfy their constraint
|
|
335
|
+
* requirements. The output is provided as a list of fields and a reason for each field that
|
|
336
|
+
* isn't valid.</p>
|
|
337
|
+
* <p>The possible reasons include the following:</p>
|
|
338
|
+
* <ul>
|
|
339
|
+
* <li>
|
|
340
|
+
* <p>
|
|
341
|
+
* <b>UnrecognizedEntityType</b>
|
|
342
|
+
* </p>
|
|
343
|
+
* <p>The policy includes an entity type that isn't found in the schema.</p>
|
|
344
|
+
* </li>
|
|
345
|
+
* <li>
|
|
346
|
+
* <p>
|
|
347
|
+
* <b>UnrecognizedActionId</b>
|
|
348
|
+
* </p>
|
|
349
|
+
* <p>The policy includes an action id that isn't found in the schema.</p>
|
|
350
|
+
* </li>
|
|
351
|
+
* <li>
|
|
352
|
+
* <p>
|
|
353
|
+
* <b>InvalidActionApplication</b>
|
|
354
|
+
* </p>
|
|
355
|
+
* <p>The policy includes an action that, according to the schema, doesn't support
|
|
356
|
+
* the specified principal and resource.</p>
|
|
357
|
+
* </li>
|
|
358
|
+
* <li>
|
|
359
|
+
* <p>
|
|
360
|
+
* <b>UnexpectedType</b>
|
|
361
|
+
* </p>
|
|
362
|
+
* <p>The policy included an operand that isn't a valid type for the specified
|
|
363
|
+
* operation.</p>
|
|
364
|
+
* </li>
|
|
365
|
+
* <li>
|
|
366
|
+
* <p>
|
|
367
|
+
* <b>IncompatibleTypes</b>
|
|
368
|
+
* </p>
|
|
369
|
+
* <p>The types of elements included in a <code>set</code>, or the types of
|
|
370
|
+
* expressions used in an <code>if...then...else</code> clause aren't compatible in
|
|
371
|
+
* this context.</p>
|
|
372
|
+
* </li>
|
|
373
|
+
* <li>
|
|
374
|
+
* <p>
|
|
375
|
+
* <b>MissingAttribute</b>
|
|
376
|
+
* </p>
|
|
377
|
+
* <p>The policy attempts to access a record or entity attribute that isn't
|
|
378
|
+
* specified in the schema. Test for the existence of the attribute first before
|
|
379
|
+
* attempting to access its value. For more information, see the <a href="docs.cedarpolicy.comsyntax-operators.html#has-presence-of-attribute-test">has (presence of attribute test) operator</a> in the
|
|
380
|
+
* <i>Cedar Policy Language Guide</i>.</p>
|
|
381
|
+
* </li>
|
|
382
|
+
* <li>
|
|
383
|
+
* <p>
|
|
384
|
+
* <b>UnsafeOptionalAttributeAccess</b>
|
|
385
|
+
* </p>
|
|
386
|
+
* <p>The policy attempts to access a record or entity attribute that is optional
|
|
387
|
+
* and isn't guaranteed to be present. Test for the existence of the attribute
|
|
388
|
+
* first before attempting to access its value. For more information, see the
|
|
389
|
+
* <a href="docs.cedarpolicy.comsyntax-operators.html#has-presence-of-attribute-test">has (presence of attribute test) operator</a> in the
|
|
390
|
+
* <i>Cedar Policy Language Guide</i>.</p>
|
|
391
|
+
* </li>
|
|
392
|
+
* <li>
|
|
393
|
+
* <p>
|
|
394
|
+
* <b>ImpossiblePolicy</b>
|
|
395
|
+
* </p>
|
|
396
|
+
* <p>Cedar has determined that a policy condition always evaluates to false. If
|
|
397
|
+
* the policy is always false, it can never apply to any query, and so it can never
|
|
398
|
+
* affect an authorization decision.</p>
|
|
399
|
+
* </li>
|
|
400
|
+
* <li>
|
|
401
|
+
* <p>
|
|
402
|
+
* <b>WrongNumberArguments</b>
|
|
403
|
+
* </p>
|
|
404
|
+
* <p>The policy references an extension type with the wrong number of
|
|
405
|
+
* arguments.</p>
|
|
406
|
+
* </li>
|
|
407
|
+
* <li>
|
|
408
|
+
* <p>
|
|
409
|
+
* <b>FunctionArgumentValidationError</b>
|
|
410
|
+
* </p>
|
|
411
|
+
* <p>Cedar couldn't parse the argument passed to an extension type. For example,
|
|
412
|
+
* a string that is to be parsed as an IPv4 address can contain only digits and the
|
|
413
|
+
* period character.</p>
|
|
414
|
+
* </li>
|
|
415
|
+
* </ul>
|
|
416
|
+
*/
|
|
417
|
+
export declare class ValidationException extends __BaseException {
|
|
418
|
+
readonly name: "ValidationException";
|
|
419
|
+
readonly $fault: "client";
|
|
420
|
+
/**
|
|
421
|
+
* <p>The list of fields that aren't valid.</p>
|
|
422
|
+
*/
|
|
423
|
+
fieldList?: ValidationExceptionField[];
|
|
424
|
+
/**
|
|
425
|
+
* @internal
|
|
426
|
+
*/
|
|
427
|
+
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
|
|
428
|
+
}
|
|
429
|
+
/**
|
|
430
|
+
* @public
|
|
431
|
+
* <p>Contains information about a static policy.</p>
|
|
432
|
+
* <p>This data type is used as a field that is part of the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_PolicyDefinitionDetail.html">PolicyDefinitionDetail</a>
|
|
433
|
+
* type.</p>
|
|
434
|
+
*/
|
|
435
|
+
export interface StaticPolicyDefinition {
|
|
436
|
+
/**
|
|
437
|
+
* <p>The description of the static policy.</p>
|
|
438
|
+
*/
|
|
439
|
+
description?: string;
|
|
440
|
+
/**
|
|
441
|
+
* <p>The policy content of the static policy, written in the Cedar policy language.</p>
|
|
442
|
+
*/
|
|
443
|
+
statement: string | undefined;
|
|
444
|
+
}
|
|
445
|
+
/**
|
|
446
|
+
* @public
|
|
447
|
+
* <p>Contains information about a policy created by instantiating a policy template.</p>
|
|
448
|
+
*/
|
|
449
|
+
export interface TemplateLinkedPolicyDefinition {
|
|
450
|
+
/**
|
|
451
|
+
* <p>The unique identifier of the policy template used to create this policy.</p>
|
|
452
|
+
*/
|
|
453
|
+
policyTemplateId: string | undefined;
|
|
454
|
+
/**
|
|
455
|
+
* <p>The principal associated with this template-linked policy. Verified Permissions substitutes this principal for the
|
|
456
|
+
* <code>?principal</code> placeholder in the policy template when it evaluates an authorization
|
|
457
|
+
* request.</p>
|
|
458
|
+
*/
|
|
459
|
+
principal?: EntityIdentifier;
|
|
460
|
+
/**
|
|
461
|
+
* <p>The resource associated with this template-linked policy. Verified Permissions substitutes this resource for the
|
|
462
|
+
* <code>?resource</code> placeholder in the policy template when it evaluates an authorization
|
|
463
|
+
* request.</p>
|
|
464
|
+
*/
|
|
465
|
+
resource?: EntityIdentifier;
|
|
466
|
+
}
|
|
467
|
+
/**
|
|
468
|
+
* @public
|
|
469
|
+
* <p>A structure that contains the details for a Cedar policy definition. It includes the
|
|
470
|
+
* policy type, a description, and a policy body. This is a top level data type used to
|
|
471
|
+
* create a policy.</p>
|
|
472
|
+
* <p>This data type is used as a request parameter for the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreatePolicy.html">CreatePolicy</a> operation. This
|
|
473
|
+
* structure must always have either an <code>static</code> or a <code>templateLinked</code>
|
|
474
|
+
* element.</p>
|
|
475
|
+
*/
|
|
476
|
+
export type PolicyDefinition = PolicyDefinition.StaticMember | PolicyDefinition.TemplateLinkedMember | PolicyDefinition.$UnknownMember;
|
|
477
|
+
/**
|
|
478
|
+
* @public
|
|
479
|
+
*/
|
|
480
|
+
export declare namespace PolicyDefinition {
|
|
481
|
+
/**
|
|
482
|
+
* <p>A structure that describes a static policy. An static policy doesn't use a template or allow
|
|
483
|
+
* placeholders for entities.</p>
|
|
484
|
+
*/
|
|
485
|
+
interface StaticMember {
|
|
486
|
+
static: StaticPolicyDefinition;
|
|
487
|
+
templateLinked?: never;
|
|
488
|
+
$unknown?: never;
|
|
489
|
+
}
|
|
490
|
+
/**
|
|
491
|
+
* <p>A structure that describes a policy that was instantiated from a template. The
|
|
492
|
+
* template can specify placeholders for <code>principal</code> and <code>resource</code>.
|
|
493
|
+
* When you use <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreatePolicy.html">CreatePolicy</a> to create a policy from a template, you specify the exact
|
|
494
|
+
* principal and resource to use for the instantiated policy.</p>
|
|
495
|
+
*/
|
|
496
|
+
interface TemplateLinkedMember {
|
|
497
|
+
static?: never;
|
|
498
|
+
templateLinked: TemplateLinkedPolicyDefinition;
|
|
499
|
+
$unknown?: never;
|
|
500
|
+
}
|
|
501
|
+
interface $UnknownMember {
|
|
502
|
+
static?: never;
|
|
503
|
+
templateLinked?: never;
|
|
504
|
+
$unknown: [string, any];
|
|
505
|
+
}
|
|
506
|
+
interface Visitor<T> {
|
|
507
|
+
static: (value: StaticPolicyDefinition) => T;
|
|
508
|
+
templateLinked: (value: TemplateLinkedPolicyDefinition) => T;
|
|
509
|
+
_: (name: string, value: any) => T;
|
|
510
|
+
}
|
|
511
|
+
const visit: <T>(value: PolicyDefinition, visitor: Visitor<T>) => T;
|
|
512
|
+
}
|
|
513
|
+
/**
|
|
514
|
+
* @public
|
|
515
|
+
*/
|
|
516
|
+
export interface CreatePolicyInput {
|
|
517
|
+
/**
|
|
518
|
+
* <p>Specifies a unique, case-sensitive ID that you provide to
|
|
519
|
+
* ensure the idempotency of the request. This lets you safely retry the request without
|
|
520
|
+
* accidentally performing the same operation a second time. Passing the same value to a
|
|
521
|
+
* later call to an operation requires that you also pass the same value for all other
|
|
522
|
+
* parameters. We recommend that you use a <a href="https://wikipedia.org/wiki/Universally_unique_Id">UUID type of
|
|
523
|
+
* value.</a>.</p>
|
|
524
|
+
* <p>If you don't provide this value, then Amazon Web Services generates a random one for
|
|
525
|
+
* you.</p>
|
|
526
|
+
* <p>If you retry the operation with the same <code>ClientToken</code>, but with
|
|
527
|
+
* different parameters, the retry fails with an <code>IdempotentParameterMismatch</code>
|
|
528
|
+
* error.</p>
|
|
529
|
+
*/
|
|
530
|
+
clientToken?: string;
|
|
531
|
+
/**
|
|
532
|
+
* <p>Specifies the <code>PolicyStoreId</code> of the policy store you want to store the policy
|
|
533
|
+
* in.</p>
|
|
534
|
+
*/
|
|
535
|
+
policyStoreId: string | undefined;
|
|
536
|
+
/**
|
|
537
|
+
* <p>A structure that specifies the policy type and content to use for the new policy. You
|
|
538
|
+
* must include either a static or a templateLinked element. The policy content must be written
|
|
539
|
+
* in the Cedar policy language.</p>
|
|
540
|
+
*/
|
|
541
|
+
definition: PolicyDefinition | undefined;
|
|
542
|
+
}
|
|
543
|
+
/**
|
|
544
|
+
* @public
|
|
545
|
+
* @enum
|
|
546
|
+
*/
|
|
547
|
+
export declare const PolicyType: {
|
|
548
|
+
readonly STATIC: "STATIC";
|
|
549
|
+
readonly TEMPLATE_LINKED: "TEMPLATE_LINKED";
|
|
550
|
+
};
|
|
551
|
+
/**
|
|
552
|
+
* @public
|
|
553
|
+
*/
|
|
554
|
+
export type PolicyType = (typeof PolicyType)[keyof typeof PolicyType];
|
|
555
|
+
/**
|
|
556
|
+
* @public
|
|
557
|
+
*/
|
|
558
|
+
export interface CreatePolicyOutput {
|
|
559
|
+
/**
|
|
560
|
+
* <p>The ID of the policy store that contains the new policy.</p>
|
|
561
|
+
*/
|
|
562
|
+
policyStoreId: string | undefined;
|
|
563
|
+
/**
|
|
564
|
+
* <p>The unique ID of the new policy.</p>
|
|
565
|
+
*/
|
|
566
|
+
policyId: string | undefined;
|
|
567
|
+
/**
|
|
568
|
+
* <p>The policy type of the new policy.</p>
|
|
569
|
+
*/
|
|
570
|
+
policyType: PolicyType | string | undefined;
|
|
571
|
+
/**
|
|
572
|
+
* <p>The principal specified in the new policy's scope. This response element isn't present
|
|
573
|
+
* when <code>principal</code> isn't specified in the policy content.</p>
|
|
574
|
+
*/
|
|
575
|
+
principal?: EntityIdentifier;
|
|
576
|
+
/**
|
|
577
|
+
* <p>The resource specified in the new policy's scope. This response element isn't present
|
|
578
|
+
* when the <code>resource</code> isn't specified in the policy content.</p>
|
|
579
|
+
*/
|
|
580
|
+
resource?: EntityIdentifier;
|
|
581
|
+
/**
|
|
582
|
+
* <p>The date and time the policy was originally created.</p>
|
|
583
|
+
*/
|
|
584
|
+
createdDate: Date | undefined;
|
|
585
|
+
/**
|
|
586
|
+
* <p>The date and time the policy was last updated.</p>
|
|
587
|
+
*/
|
|
588
|
+
lastUpdatedDate: Date | undefined;
|
|
589
|
+
}
|
|
590
|
+
/**
|
|
591
|
+
* @public
|
|
592
|
+
* @enum
|
|
593
|
+
*/
|
|
594
|
+
export declare const ValidationMode: {
|
|
595
|
+
readonly OFF: "OFF";
|
|
596
|
+
readonly STRICT: "STRICT";
|
|
597
|
+
};
|
|
598
|
+
/**
|
|
599
|
+
* @public
|
|
600
|
+
*/
|
|
601
|
+
export type ValidationMode = (typeof ValidationMode)[keyof typeof ValidationMode];
|
|
602
|
+
/**
|
|
603
|
+
* @public
|
|
604
|
+
* <p>A structure that contains Cedar policy validation settings for the policy store. The
|
|
605
|
+
* validation mode determines which validation failures that Cedar considers serious
|
|
606
|
+
* enough to block acceptance of a new or edited static policy or policy template. </p>
|
|
607
|
+
* <p>This data type is used as a request parameter in the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreatePolicyStore.html">CreatePolicyStore</a> and <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdatePolicyStore.html">UpdatePolicyStore</a> operations.</p>
|
|
608
|
+
*/
|
|
609
|
+
export interface ValidationSettings {
|
|
610
|
+
/**
|
|
611
|
+
* <p>The validation mode currently configured for this policy store. The valid values are:</p>
|
|
612
|
+
* <ul>
|
|
613
|
+
* <li>
|
|
614
|
+
* <p>
|
|
615
|
+
* <b>OFF</b> – Neither Verified Permissions nor Cedar
|
|
616
|
+
* perform any validation on policies. No validation errors are reported by either
|
|
617
|
+
* service.</p>
|
|
618
|
+
* </li>
|
|
619
|
+
* <li>
|
|
620
|
+
* <p>
|
|
621
|
+
* <b>STRICT</b> – Requires a schema to be
|
|
622
|
+
* present in the policy store. Cedar performs validation on all submitted new or updated
|
|
623
|
+
* static policies and policy templates. Any that fail validation are rejected and Cedar doesn't store
|
|
624
|
+
* them in the policy store.</p>
|
|
625
|
+
* </li>
|
|
626
|
+
* </ul>
|
|
627
|
+
* <important>
|
|
628
|
+
* <p>If <code>Mode=STRICT</code> and the policy store doesn't contain a schema, Verified Permissions rejects
|
|
629
|
+
* all static policies and policy templates because there is no schema to validate against. </p>
|
|
630
|
+
* <p>To submit a static policy or policy template without a schema, you must turn off validation.</p>
|
|
631
|
+
* </important>
|
|
632
|
+
*/
|
|
633
|
+
mode: ValidationMode | string | undefined;
|
|
634
|
+
}
|
|
635
|
+
/**
|
|
636
|
+
* @public
|
|
637
|
+
*/
|
|
638
|
+
export interface CreatePolicyStoreInput {
|
|
639
|
+
/**
|
|
640
|
+
* <p>Specifies a unique, case-sensitive ID that you provide to
|
|
641
|
+
* ensure the idempotency of the request. This lets you safely retry the request without
|
|
642
|
+
* accidentally performing the same operation a second time. Passing the same value to a
|
|
643
|
+
* later call to an operation requires that you also pass the same value for all other
|
|
644
|
+
* parameters. We recommend that you use a <a href="https://wikipedia.org/wiki/Universally_unique_Id">UUID type of
|
|
645
|
+
* value.</a>.</p>
|
|
646
|
+
* <p>If you don't provide this value, then Amazon Web Services generates a random one for
|
|
647
|
+
* you.</p>
|
|
648
|
+
* <p>If you retry the operation with the same <code>ClientToken</code>, but with
|
|
649
|
+
* different parameters, the retry fails with an <code>IdempotentParameterMismatch</code>
|
|
650
|
+
* error.</p>
|
|
651
|
+
*/
|
|
652
|
+
clientToken?: string;
|
|
653
|
+
/**
|
|
654
|
+
* <p>Specifies the validation setting for this policy store.</p>
|
|
655
|
+
* <p>Currently, the only valid and required value is <code>Mode</code>.</p>
|
|
656
|
+
* <important>
|
|
657
|
+
* <p>We recommend that you turn on <code>STRICT</code> mode only after you define a
|
|
658
|
+
* schema. If a schema doesn't exist, then <code>STRICT</code> mode causes any policy
|
|
659
|
+
* to fail validation, and Verified Permissions rejects the policy. You can turn off validation by
|
|
660
|
+
* using the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdatePolicyStore">UpdatePolicyStore</a>. Then, when you have a schema defined, use <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdatePolicyStore">UpdatePolicyStore</a> again to turn validation back on.</p>
|
|
661
|
+
* </important>
|
|
662
|
+
*/
|
|
663
|
+
validationSettings: ValidationSettings | undefined;
|
|
664
|
+
}
|
|
665
|
+
/**
|
|
666
|
+
* @public
|
|
667
|
+
*/
|
|
668
|
+
export interface CreatePolicyStoreOutput {
|
|
669
|
+
/**
|
|
670
|
+
* <p>The unique ID of the new policy store.</p>
|
|
671
|
+
*/
|
|
672
|
+
policyStoreId: string | undefined;
|
|
673
|
+
/**
|
|
674
|
+
* <p>The Amazon Resource Name (ARN) of the new policy store.</p>
|
|
675
|
+
*/
|
|
676
|
+
arn: string | undefined;
|
|
677
|
+
/**
|
|
678
|
+
* <p>The date and time the policy store was originally created.</p>
|
|
679
|
+
*/
|
|
680
|
+
createdDate: Date | undefined;
|
|
681
|
+
/**
|
|
682
|
+
* <p>The date and time the policy store was last updated.</p>
|
|
683
|
+
*/
|
|
684
|
+
lastUpdatedDate: Date | undefined;
|
|
685
|
+
}
|
|
686
|
+
/**
|
|
687
|
+
* @public
|
|
688
|
+
*/
|
|
689
|
+
export interface CreatePolicyTemplateInput {
|
|
690
|
+
/**
|
|
691
|
+
* <p>Specifies a unique, case-sensitive ID that you provide to
|
|
692
|
+
* ensure the idempotency of the request. This lets you safely retry the request without
|
|
693
|
+
* accidentally performing the same operation a second time. Passing the same value to a
|
|
694
|
+
* later call to an operation requires that you also pass the same value for all other
|
|
695
|
+
* parameters. We recommend that you use a <a href="https://wikipedia.org/wiki/Universally_unique_Id">UUID type of
|
|
696
|
+
* value.</a>.</p>
|
|
697
|
+
* <p>If you don't provide this value, then Amazon Web Services generates a random one for
|
|
698
|
+
* you.</p>
|
|
699
|
+
* <p>If you retry the operation with the same <code>ClientToken</code>, but with
|
|
700
|
+
* different parameters, the retry fails with an <code>IdempotentParameterMismatch</code>
|
|
701
|
+
* error.</p>
|
|
702
|
+
*/
|
|
703
|
+
clientToken?: string;
|
|
704
|
+
/**
|
|
705
|
+
* <p>The ID of the policy store in which to create the policy template.</p>
|
|
706
|
+
*/
|
|
707
|
+
policyStoreId: string | undefined;
|
|
708
|
+
/**
|
|
709
|
+
* <p>Specifies a description for the policy template.</p>
|
|
710
|
+
*/
|
|
711
|
+
description?: string;
|
|
712
|
+
/**
|
|
713
|
+
* <p>Specifies the content that you want to use for the new policy template, written in the Cedar
|
|
714
|
+
* policy language.</p>
|
|
715
|
+
*/
|
|
716
|
+
statement: string | undefined;
|
|
717
|
+
}
|
|
718
|
+
/**
|
|
719
|
+
* @public
|
|
720
|
+
*/
|
|
721
|
+
export interface CreatePolicyTemplateOutput {
|
|
722
|
+
/**
|
|
723
|
+
* <p>The ID of the policy store that contains the policy template.</p>
|
|
724
|
+
*/
|
|
725
|
+
policyStoreId: string | undefined;
|
|
726
|
+
/**
|
|
727
|
+
* <p>The unique ID of the new policy template.</p>
|
|
728
|
+
*/
|
|
729
|
+
policyTemplateId: string | undefined;
|
|
730
|
+
/**
|
|
731
|
+
* <p>The date and time the policy template was originally created.</p>
|
|
732
|
+
*/
|
|
733
|
+
createdDate: Date | undefined;
|
|
734
|
+
/**
|
|
735
|
+
* <p>The date and time the policy template was most recently updated.</p>
|
|
736
|
+
*/
|
|
737
|
+
lastUpdatedDate: Date | undefined;
|
|
738
|
+
}
|
|
739
|
+
/**
|
|
740
|
+
* @public
|
|
741
|
+
* @enum
|
|
742
|
+
*/
|
|
743
|
+
export declare const Decision: {
|
|
744
|
+
readonly ALLOW: "ALLOW";
|
|
745
|
+
readonly DENY: "DENY";
|
|
746
|
+
};
|
|
747
|
+
/**
|
|
748
|
+
* @public
|
|
749
|
+
*/
|
|
750
|
+
export type Decision = (typeof Decision)[keyof typeof Decision];
|
|
751
|
+
/**
|
|
752
|
+
* @public
|
|
753
|
+
*/
|
|
754
|
+
export interface DeleteIdentitySourceInput {
|
|
755
|
+
/**
|
|
756
|
+
* <p>Specifies the ID of the policy store that contains the identity source that you want to delete.</p>
|
|
757
|
+
*/
|
|
758
|
+
policyStoreId: string | undefined;
|
|
759
|
+
/**
|
|
760
|
+
* <p>Specifies the ID of the identity source that you want to delete.</p>
|
|
761
|
+
*/
|
|
762
|
+
identitySourceId: string | undefined;
|
|
763
|
+
}
|
|
764
|
+
/**
|
|
765
|
+
* @public
|
|
766
|
+
*/
|
|
767
|
+
export interface DeleteIdentitySourceOutput {
|
|
768
|
+
}
|
|
769
|
+
/**
|
|
770
|
+
* @public
|
|
771
|
+
*/
|
|
772
|
+
export interface DeletePolicyInput {
|
|
773
|
+
/**
|
|
774
|
+
* <p>Specifies the ID of the policy store that contains the policy that you want to delete.</p>
|
|
775
|
+
*/
|
|
776
|
+
policyStoreId: string | undefined;
|
|
777
|
+
/**
|
|
778
|
+
* <p>Specifies the ID of the policy that you want to delete.</p>
|
|
779
|
+
*/
|
|
780
|
+
policyId: string | undefined;
|
|
781
|
+
}
|
|
782
|
+
/**
|
|
783
|
+
* @public
|
|
784
|
+
*/
|
|
785
|
+
export interface DeletePolicyOutput {
|
|
786
|
+
}
|
|
787
|
+
/**
|
|
788
|
+
* @public
|
|
789
|
+
*/
|
|
790
|
+
export interface DeletePolicyStoreInput {
|
|
791
|
+
/**
|
|
792
|
+
* <p>Specifies the ID of the policy store that you want to delete.</p>
|
|
793
|
+
*/
|
|
794
|
+
policyStoreId: string | undefined;
|
|
795
|
+
}
|
|
796
|
+
/**
|
|
797
|
+
* @public
|
|
798
|
+
*/
|
|
799
|
+
export interface DeletePolicyStoreOutput {
|
|
800
|
+
}
|
|
801
|
+
/**
|
|
802
|
+
* @public
|
|
803
|
+
*/
|
|
804
|
+
export interface DeletePolicyTemplateInput {
|
|
805
|
+
/**
|
|
806
|
+
* <p>Specifies the ID of the policy store that contains the policy template that you want to delete.</p>
|
|
807
|
+
*/
|
|
808
|
+
policyStoreId: string | undefined;
|
|
809
|
+
/**
|
|
810
|
+
* <p>Specifies the ID of the policy template that you want to delete.</p>
|
|
811
|
+
*/
|
|
812
|
+
policyTemplateId: string | undefined;
|
|
813
|
+
}
|
|
814
|
+
/**
|
|
815
|
+
* @public
|
|
816
|
+
*/
|
|
817
|
+
export interface DeletePolicyTemplateOutput {
|
|
818
|
+
}
|
|
819
|
+
/**
|
|
820
|
+
* @public
|
|
821
|
+
* <p>Contains information about one of the policies that determined an authorization
|
|
822
|
+
* decision.</p>
|
|
823
|
+
* <p>This data type is used as an element in a response parameter for the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorized.html">IsAuthorized</a>
|
|
824
|
+
* and <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorizedWithToken.html">IsAuthorizedWithToken</a> operations.</p>
|
|
825
|
+
* <p>Example: <code>"determiningPolicies":[\{"policyId":"SPEXAMPLEabcdefg111111"\}]</code>
|
|
826
|
+
* </p>
|
|
827
|
+
*/
|
|
828
|
+
export interface DeterminingPolicyItem {
|
|
829
|
+
/**
|
|
830
|
+
* <p>The Id of a policy that determined to an authorization decision.</p>
|
|
831
|
+
* <p>Example: <code>"policyId":"SPEXAMPLEabcdefg111111"</code>
|
|
832
|
+
* </p>
|
|
833
|
+
*/
|
|
834
|
+
policyId: string | undefined;
|
|
835
|
+
}
|
|
836
|
+
/**
|
|
837
|
+
* @public
|
|
838
|
+
* <p>Contains information about a principal or resource that can be referenced in a Cedar
|
|
839
|
+
* policy.</p>
|
|
840
|
+
* <p>This data type is used as part of the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_PolicyFilter.html">PolicyFilter</a> structure that is
|
|
841
|
+
* used as a request parameter for the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicies.html">ListPolicies</a> operation..</p>
|
|
842
|
+
*/
|
|
843
|
+
export type EntityReference = EntityReference.IdentifierMember | EntityReference.UnspecifiedMember | EntityReference.$UnknownMember;
|
|
844
|
+
/**
|
|
845
|
+
* @public
|
|
846
|
+
*/
|
|
847
|
+
export declare namespace EntityReference {
|
|
848
|
+
/**
|
|
849
|
+
* <p>Used to indicate that a principal or resource is not specified. This can be used to
|
|
850
|
+
* search for policies that are not associated with a specific principal or
|
|
851
|
+
* resource.</p>
|
|
852
|
+
*/
|
|
853
|
+
interface UnspecifiedMember {
|
|
854
|
+
unspecified: boolean;
|
|
855
|
+
identifier?: never;
|
|
856
|
+
$unknown?: never;
|
|
857
|
+
}
|
|
858
|
+
/**
|
|
859
|
+
* <p>The identifier of the entity. It can consist of either an EntityType and EntityId, a
|
|
860
|
+
* principal, or a resource.</p>
|
|
861
|
+
*/
|
|
862
|
+
interface IdentifierMember {
|
|
863
|
+
unspecified?: never;
|
|
864
|
+
identifier: EntityIdentifier;
|
|
865
|
+
$unknown?: never;
|
|
866
|
+
}
|
|
867
|
+
interface $UnknownMember {
|
|
868
|
+
unspecified?: never;
|
|
869
|
+
identifier?: never;
|
|
870
|
+
$unknown: [string, any];
|
|
871
|
+
}
|
|
872
|
+
interface Visitor<T> {
|
|
873
|
+
unspecified: (value: boolean) => T;
|
|
874
|
+
identifier: (value: EntityIdentifier) => T;
|
|
875
|
+
_: (name: string, value: any) => T;
|
|
876
|
+
}
|
|
877
|
+
const visit: <T>(value: EntityReference, visitor: Visitor<T>) => T;
|
|
878
|
+
}
|
|
879
|
+
/**
|
|
880
|
+
* @public
|
|
881
|
+
* <p>Contains a description of an evaluation error.</p>
|
|
882
|
+
* <p>This data type is used as a request parameter in the <a href="https://docs.aws.amazon.com/amazon-verified-permissions/latest/APIReference/API_IsAuthorized.html">IsAuthorized</a> and <a href="https://docs.aws.amazon.com/amazon-verified-permissions/latest/APIReference/API_IsAuthorizedWithToken.html">IsAuthorizedWithToken</a> operations.</p>
|
|
883
|
+
*/
|
|
884
|
+
export interface EvaluationErrorItem {
|
|
885
|
+
/**
|
|
886
|
+
* <p>The error description.</p>
|
|
887
|
+
*/
|
|
888
|
+
errorDescription: string | undefined;
|
|
889
|
+
}
|
|
890
|
+
/**
|
|
891
|
+
* @public
|
|
892
|
+
*/
|
|
893
|
+
export interface GetIdentitySourceInput {
|
|
894
|
+
/**
|
|
895
|
+
* <p>Specifies the ID of the policy store that contains the identity source you want information about.</p>
|
|
896
|
+
*/
|
|
897
|
+
policyStoreId: string | undefined;
|
|
898
|
+
/**
|
|
899
|
+
* <p>Specifies the ID of the identity source you want information about.</p>
|
|
900
|
+
*/
|
|
901
|
+
identitySourceId: string | undefined;
|
|
902
|
+
}
|
|
903
|
+
/**
|
|
904
|
+
* @public
|
|
905
|
+
* @enum
|
|
906
|
+
*/
|
|
907
|
+
export declare const OpenIdIssuer: {
|
|
908
|
+
readonly COGNITO: "COGNITO";
|
|
909
|
+
};
|
|
910
|
+
/**
|
|
911
|
+
* @public
|
|
912
|
+
*/
|
|
913
|
+
export type OpenIdIssuer = (typeof OpenIdIssuer)[keyof typeof OpenIdIssuer];
|
|
914
|
+
/**
|
|
915
|
+
* @public
|
|
916
|
+
* <p>A structure that contains configuration of the identity source.</p>
|
|
917
|
+
* <p>This data type is used as a response parameter for the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreateIdentitySource.html">CreateIdentitySource</a>
|
|
918
|
+
* operation.</p>
|
|
919
|
+
*/
|
|
920
|
+
export interface IdentitySourceDetails {
|
|
921
|
+
/**
|
|
922
|
+
* <p>The application client IDs associated with the specified Amazon Cognito user pool that are
|
|
923
|
+
* enabled for this identity source.</p>
|
|
924
|
+
*/
|
|
925
|
+
clientIds?: string[];
|
|
926
|
+
/**
|
|
927
|
+
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of the Amazon Cognito user pool whose identities are accessible to this Verified Permissions
|
|
928
|
+
* policy store.</p>
|
|
929
|
+
*/
|
|
930
|
+
userPoolArn?: string;
|
|
931
|
+
/**
|
|
932
|
+
* <p>The well-known URL that points to this user pool's OIDC discovery endpoint. This is a
|
|
933
|
+
* URL string in the following format. This URL replaces the placeholders for both the
|
|
934
|
+
* Amazon Web Services Region and the user pool identifier with those appropriate for this user
|
|
935
|
+
* pool.</p>
|
|
936
|
+
* <p>
|
|
937
|
+
* <code>https://cognito-idp.<i><region></i>.amazonaws.com/<i><user-pool-id></i>/.well-known/openid-configuration</code>
|
|
938
|
+
* </p>
|
|
939
|
+
*/
|
|
940
|
+
discoveryUrl?: string;
|
|
941
|
+
/**
|
|
942
|
+
* <p>A string that identifies the type of OIDC service represented by this identity source. </p>
|
|
943
|
+
* <p>At this time, the only valid value is <code>cognito</code>.</p>
|
|
944
|
+
*/
|
|
945
|
+
openIdIssuer?: OpenIdIssuer | string;
|
|
946
|
+
}
|
|
947
|
+
/**
|
|
948
|
+
* @public
|
|
949
|
+
*/
|
|
950
|
+
export interface GetIdentitySourceOutput {
|
|
951
|
+
/**
|
|
952
|
+
* <p>The date and time that the identity source was originally created.</p>
|
|
953
|
+
*/
|
|
954
|
+
createdDate: Date | undefined;
|
|
955
|
+
/**
|
|
956
|
+
* <p>A structure that describes the configuration of the identity source.</p>
|
|
957
|
+
*/
|
|
958
|
+
details: IdentitySourceDetails | undefined;
|
|
959
|
+
/**
|
|
960
|
+
* <p>The ID of the identity source.</p>
|
|
961
|
+
*/
|
|
962
|
+
identitySourceId: string | undefined;
|
|
963
|
+
/**
|
|
964
|
+
* <p>The date and time that the identity source was most recently updated.</p>
|
|
965
|
+
*/
|
|
966
|
+
lastUpdatedDate: Date | undefined;
|
|
967
|
+
/**
|
|
968
|
+
* <p>The ID of the policy store that contains the identity source.</p>
|
|
969
|
+
*/
|
|
970
|
+
policyStoreId: string | undefined;
|
|
971
|
+
/**
|
|
972
|
+
* <p>The data type of principals generated for identities authenticated by this
|
|
973
|
+
* identity source.</p>
|
|
974
|
+
*/
|
|
975
|
+
principalEntityType: string | undefined;
|
|
976
|
+
}
|
|
977
|
+
/**
|
|
978
|
+
* @public
|
|
979
|
+
*/
|
|
980
|
+
export interface GetPolicyInput {
|
|
981
|
+
/**
|
|
982
|
+
* <p>Specifies the ID of the policy store that contains the policy that you want information
|
|
983
|
+
* about.</p>
|
|
984
|
+
*/
|
|
985
|
+
policyStoreId: string | undefined;
|
|
986
|
+
/**
|
|
987
|
+
* <p>Specifies the ID of the policy you want information about.</p>
|
|
988
|
+
*/
|
|
989
|
+
policyId: string | undefined;
|
|
990
|
+
}
|
|
991
|
+
/**
|
|
992
|
+
* @public
|
|
993
|
+
* <p>A structure that contains details about a static policy. It includes the description and
|
|
994
|
+
* policy body.</p>
|
|
995
|
+
* <p>This data type is used within a <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_PolicyDefinition.html">PolicyDefinition</a> structure as
|
|
996
|
+
* part of a request parameter for the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreatePolicy.html">CreatePolicy</a> operation.</p>
|
|
997
|
+
*/
|
|
998
|
+
export interface StaticPolicyDefinitionDetail {
|
|
999
|
+
/**
|
|
1000
|
+
* <p>A description of the static policy.</p>
|
|
1001
|
+
*/
|
|
1002
|
+
description?: string;
|
|
1003
|
+
/**
|
|
1004
|
+
* <p>The content of the static policy written in the Cedar policy language.</p>
|
|
1005
|
+
*/
|
|
1006
|
+
statement: string | undefined;
|
|
1007
|
+
}
|
|
1008
|
+
/**
|
|
1009
|
+
* @public
|
|
1010
|
+
* <p>Contains information about a policy that was </p>
|
|
1011
|
+
* <p/>
|
|
1012
|
+
* <p>created by instantiating a policy template. </p>
|
|
1013
|
+
* <p>This </p>
|
|
1014
|
+
*/
|
|
1015
|
+
export interface TemplateLinkedPolicyDefinitionDetail {
|
|
1016
|
+
/**
|
|
1017
|
+
* <p>The unique identifier of the policy template used to create this policy.</p>
|
|
1018
|
+
*/
|
|
1019
|
+
policyTemplateId: string | undefined;
|
|
1020
|
+
/**
|
|
1021
|
+
* <p>The principal associated with this template-linked policy. Verified Permissions substitutes this principal for the
|
|
1022
|
+
* <code>?principal</code> placeholder in the policy template when it evaluates an authorization
|
|
1023
|
+
* request.</p>
|
|
1024
|
+
*/
|
|
1025
|
+
principal?: EntityIdentifier;
|
|
1026
|
+
/**
|
|
1027
|
+
* <p>The resource associated with this template-linked policy. Verified Permissions substitutes this resource for the
|
|
1028
|
+
* <code>?resource</code> placeholder in the policy template when it evaluates an authorization
|
|
1029
|
+
* request.</p>
|
|
1030
|
+
*/
|
|
1031
|
+
resource?: EntityIdentifier;
|
|
1032
|
+
}
|
|
1033
|
+
/**
|
|
1034
|
+
* @public
|
|
1035
|
+
* <p>A structure that describes a policy definition. It must always have either an
|
|
1036
|
+
* <code>static</code> or a <code>templateLinked</code> element.</p>
|
|
1037
|
+
* <p>This data type is used as a response parameter for the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_GetPolicy.html">GetPolicy</a> operation.</p>
|
|
1038
|
+
*/
|
|
1039
|
+
export type PolicyDefinitionDetail = PolicyDefinitionDetail.StaticMember | PolicyDefinitionDetail.TemplateLinkedMember | PolicyDefinitionDetail.$UnknownMember;
|
|
1040
|
+
/**
|
|
1041
|
+
* @public
|
|
1042
|
+
*/
|
|
1043
|
+
export declare namespace PolicyDefinitionDetail {
|
|
1044
|
+
/**
|
|
1045
|
+
* <p>Information about a static policy that wasn't created with a policy template.</p>
|
|
1046
|
+
*/
|
|
1047
|
+
interface StaticMember {
|
|
1048
|
+
static: StaticPolicyDefinitionDetail;
|
|
1049
|
+
templateLinked?: never;
|
|
1050
|
+
$unknown?: never;
|
|
1051
|
+
}
|
|
1052
|
+
/**
|
|
1053
|
+
* <p>Information about a template-linked policy that was created by instantiating a policy template.</p>
|
|
1054
|
+
*/
|
|
1055
|
+
interface TemplateLinkedMember {
|
|
1056
|
+
static?: never;
|
|
1057
|
+
templateLinked: TemplateLinkedPolicyDefinitionDetail;
|
|
1058
|
+
$unknown?: never;
|
|
1059
|
+
}
|
|
1060
|
+
interface $UnknownMember {
|
|
1061
|
+
static?: never;
|
|
1062
|
+
templateLinked?: never;
|
|
1063
|
+
$unknown: [string, any];
|
|
1064
|
+
}
|
|
1065
|
+
interface Visitor<T> {
|
|
1066
|
+
static: (value: StaticPolicyDefinitionDetail) => T;
|
|
1067
|
+
templateLinked: (value: TemplateLinkedPolicyDefinitionDetail) => T;
|
|
1068
|
+
_: (name: string, value: any) => T;
|
|
1069
|
+
}
|
|
1070
|
+
const visit: <T>(value: PolicyDefinitionDetail, visitor: Visitor<T>) => T;
|
|
1071
|
+
}
|
|
1072
|
+
/**
|
|
1073
|
+
* @public
|
|
1074
|
+
*/
|
|
1075
|
+
export interface GetPolicyOutput {
|
|
1076
|
+
/**
|
|
1077
|
+
* <p>The ID of the policy store that contains the policy that you want information about.</p>
|
|
1078
|
+
*/
|
|
1079
|
+
policyStoreId: string | undefined;
|
|
1080
|
+
/**
|
|
1081
|
+
* <p>The unique ID of the policy that you want information about.</p>
|
|
1082
|
+
*/
|
|
1083
|
+
policyId: string | undefined;
|
|
1084
|
+
/**
|
|
1085
|
+
* <p>The type of the policy.</p>
|
|
1086
|
+
*/
|
|
1087
|
+
policyType: PolicyType | string | undefined;
|
|
1088
|
+
/**
|
|
1089
|
+
* <p>The principal specified in the policy's scope. This element isn't included in the
|
|
1090
|
+
* response when <code>Principal</code> isn't present in the policy content.</p>
|
|
1091
|
+
*/
|
|
1092
|
+
principal?: EntityIdentifier;
|
|
1093
|
+
/**
|
|
1094
|
+
* <p>The resource specified in the policy's scope. This element isn't included in the
|
|
1095
|
+
* response when <code>Resource</code> isn't present in the policy content.</p>
|
|
1096
|
+
*/
|
|
1097
|
+
resource?: EntityIdentifier;
|
|
1098
|
+
/**
|
|
1099
|
+
* <p>The definition of the requested policy.</p>
|
|
1100
|
+
*/
|
|
1101
|
+
definition: PolicyDefinitionDetail | undefined;
|
|
1102
|
+
/**
|
|
1103
|
+
* <p>The date and time that the policy was originally created.</p>
|
|
1104
|
+
*/
|
|
1105
|
+
createdDate: Date | undefined;
|
|
1106
|
+
/**
|
|
1107
|
+
* <p>The date and time that the policy was last updated.</p>
|
|
1108
|
+
*/
|
|
1109
|
+
lastUpdatedDate: Date | undefined;
|
|
1110
|
+
}
|
|
1111
|
+
/**
|
|
1112
|
+
* @public
|
|
1113
|
+
*/
|
|
1114
|
+
export interface GetPolicyStoreInput {
|
|
1115
|
+
/**
|
|
1116
|
+
* <p>Specifies the ID of the policy store that you want information about.</p>
|
|
1117
|
+
*/
|
|
1118
|
+
policyStoreId: string | undefined;
|
|
1119
|
+
}
|
|
1120
|
+
/**
|
|
1121
|
+
* @public
|
|
1122
|
+
*/
|
|
1123
|
+
export interface GetPolicyStoreOutput {
|
|
1124
|
+
/**
|
|
1125
|
+
* <p>The ID of the policy store;</p>
|
|
1126
|
+
*/
|
|
1127
|
+
policyStoreId: string | undefined;
|
|
1128
|
+
/**
|
|
1129
|
+
* <p>The Amazon Resource Name (ARN) of the policy store.</p>
|
|
1130
|
+
*/
|
|
1131
|
+
arn: string | undefined;
|
|
1132
|
+
/**
|
|
1133
|
+
* <p>The current validation settings for the policy store.</p>
|
|
1134
|
+
*/
|
|
1135
|
+
validationSettings: ValidationSettings | undefined;
|
|
1136
|
+
/**
|
|
1137
|
+
* <p>The date and time that the policy store was originally created.</p>
|
|
1138
|
+
*/
|
|
1139
|
+
createdDate: Date | undefined;
|
|
1140
|
+
/**
|
|
1141
|
+
* <p>The date and time that the policy store was last updated.</p>
|
|
1142
|
+
*/
|
|
1143
|
+
lastUpdatedDate: Date | undefined;
|
|
1144
|
+
}
|
|
1145
|
+
/**
|
|
1146
|
+
* @public
|
|
1147
|
+
*/
|
|
1148
|
+
export interface GetPolicyTemplateInput {
|
|
1149
|
+
/**
|
|
1150
|
+
* <p>Specifies the ID of the policy store that contains the policy template that you want information
|
|
1151
|
+
* about.</p>
|
|
1152
|
+
*/
|
|
1153
|
+
policyStoreId: string | undefined;
|
|
1154
|
+
/**
|
|
1155
|
+
* <p>Specifies the ID of the policy template that you want information about.</p>
|
|
1156
|
+
*/
|
|
1157
|
+
policyTemplateId: string | undefined;
|
|
1158
|
+
}
|
|
1159
|
+
/**
|
|
1160
|
+
* @public
|
|
1161
|
+
*/
|
|
1162
|
+
export interface GetPolicyTemplateOutput {
|
|
1163
|
+
/**
|
|
1164
|
+
* <p>The ID of the policy store that contains the policy template.</p>
|
|
1165
|
+
*/
|
|
1166
|
+
policyStoreId: string | undefined;
|
|
1167
|
+
/**
|
|
1168
|
+
* <p>The ID of the policy template.</p>
|
|
1169
|
+
*/
|
|
1170
|
+
policyTemplateId: string | undefined;
|
|
1171
|
+
/**
|
|
1172
|
+
* <p>The description of the policy template.</p>
|
|
1173
|
+
*/
|
|
1174
|
+
description?: string;
|
|
1175
|
+
/**
|
|
1176
|
+
* <p>The content of the body of the policy template written in the Cedar policy language.</p>
|
|
1177
|
+
*/
|
|
1178
|
+
statement: string | undefined;
|
|
1179
|
+
/**
|
|
1180
|
+
* <p>The date and time that the policy template was originally created.</p>
|
|
1181
|
+
*/
|
|
1182
|
+
createdDate: Date | undefined;
|
|
1183
|
+
/**
|
|
1184
|
+
* <p>The date and time that the policy template was most recently updated.</p>
|
|
1185
|
+
*/
|
|
1186
|
+
lastUpdatedDate: Date | undefined;
|
|
1187
|
+
}
|
|
1188
|
+
/**
|
|
1189
|
+
* @public
|
|
1190
|
+
*/
|
|
1191
|
+
export interface GetSchemaInput {
|
|
1192
|
+
/**
|
|
1193
|
+
* <p>Specifies the ID of the policy store that contains the schema.</p>
|
|
1194
|
+
*/
|
|
1195
|
+
policyStoreId: string | undefined;
|
|
1196
|
+
}
|
|
1197
|
+
/**
|
|
1198
|
+
* @public
|
|
1199
|
+
*/
|
|
1200
|
+
export interface GetSchemaOutput {
|
|
1201
|
+
/**
|
|
1202
|
+
* <p>The ID of the policy store that contains the schema.</p>
|
|
1203
|
+
*/
|
|
1204
|
+
policyStoreId: string | undefined;
|
|
1205
|
+
/**
|
|
1206
|
+
* <p>The body of the schema, written in Cedar schema JSON.</p>
|
|
1207
|
+
*/
|
|
1208
|
+
schema: string | undefined;
|
|
1209
|
+
/**
|
|
1210
|
+
* <p>The date and time that the schema was originally created.</p>
|
|
1211
|
+
*/
|
|
1212
|
+
createdDate: Date | undefined;
|
|
1213
|
+
/**
|
|
1214
|
+
* <p>The date and time that the schema was most recently updated.</p>
|
|
1215
|
+
*/
|
|
1216
|
+
lastUpdatedDate: Date | undefined;
|
|
1217
|
+
}
|
|
1218
|
+
/**
|
|
1219
|
+
* @public
|
|
1220
|
+
* <p>A structure that defines characteristics of an identity source that you can use to
|
|
1221
|
+
* filter.</p>
|
|
1222
|
+
* <p>This data type is used as a request parameter for the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListIdentityStores.html">ListIdentityStores</a>
|
|
1223
|
+
* operation.</p>
|
|
1224
|
+
*/
|
|
1225
|
+
export interface IdentitySourceFilter {
|
|
1226
|
+
/**
|
|
1227
|
+
* <p>The Cedar entity type of the principals returned by the identity provider (IdP)
|
|
1228
|
+
* associated with this identity source.</p>
|
|
1229
|
+
*/
|
|
1230
|
+
principalEntityType?: string;
|
|
1231
|
+
}
|
|
1232
|
+
/**
|
|
1233
|
+
* @public
|
|
1234
|
+
*/
|
|
1235
|
+
export interface ListIdentitySourcesInput {
|
|
1236
|
+
/**
|
|
1237
|
+
* <p>Specifies the ID of the policy store that contains the identity sources that you want to list.</p>
|
|
1238
|
+
*/
|
|
1239
|
+
policyStoreId: string | undefined;
|
|
1240
|
+
/**
|
|
1241
|
+
* <p>Specifies that you want to receive the next page of results. Valid
|
|
1242
|
+
* only if you received a <code>NextToken</code> response in the previous request. If you
|
|
1243
|
+
* did, it indicates that more output is available. Set this parameter to the value
|
|
1244
|
+
* provided by the previous call's <code>NextToken</code> response to request the
|
|
1245
|
+
* next page of results.</p>
|
|
1246
|
+
*/
|
|
1247
|
+
nextToken?: string;
|
|
1248
|
+
/**
|
|
1249
|
+
* <p>Specifies the total number of results that you want included on each page
|
|
1250
|
+
* of the response. If you do not include this parameter, it defaults to a value that is
|
|
1251
|
+
* specific to the operation. If additional items exist beyond the number you specify, the
|
|
1252
|
+
* <code>NextToken</code> response element is returned with a value (not null).
|
|
1253
|
+
* Include the specified value as the <code>NextToken</code> request parameter in the next
|
|
1254
|
+
* call to the operation to get the next part of the results. Note that the service might
|
|
1255
|
+
* return fewer results than the maximum even when there are more results available. You
|
|
1256
|
+
* should check <code>NextToken</code> after every operation to ensure that you receive all
|
|
1257
|
+
* of the results.</p>
|
|
1258
|
+
*/
|
|
1259
|
+
maxResults?: number;
|
|
1260
|
+
/**
|
|
1261
|
+
* <p>Specifies characteristics of an identity source that you can use to limit the output to matching
|
|
1262
|
+
* identity sources.</p>
|
|
1263
|
+
*/
|
|
1264
|
+
filters?: IdentitySourceFilter[];
|
|
1265
|
+
}
|
|
1266
|
+
/**
|
|
1267
|
+
* @public
|
|
1268
|
+
* <p>A structure that contains configuration of the identity source.</p>
|
|
1269
|
+
* <p>This data type is used as a response parameter for the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreateIdentitySource.html">CreateIdentitySource</a>
|
|
1270
|
+
* operation.</p>
|
|
1271
|
+
*/
|
|
1272
|
+
export interface IdentitySourceItemDetails {
|
|
1273
|
+
/**
|
|
1274
|
+
* <p>The application client IDs associated with the specified Amazon Cognito user pool that are
|
|
1275
|
+
* enabled for this identity source.</p>
|
|
1276
|
+
*/
|
|
1277
|
+
clientIds?: string[];
|
|
1278
|
+
/**
|
|
1279
|
+
* <p>The Amazon Cognito user pool whose identities are accessible to this Verified Permissions policy store.</p>
|
|
1280
|
+
*/
|
|
1281
|
+
userPoolArn?: string;
|
|
1282
|
+
/**
|
|
1283
|
+
* <p>The well-known URL that points to this user pool's OIDC discovery endpoint. This is a
|
|
1284
|
+
* URL string in the following format. This URL replaces the placeholders for both the
|
|
1285
|
+
* Amazon Web Services Region and the user pool identifier with those appropriate for this user
|
|
1286
|
+
* pool.</p>
|
|
1287
|
+
* <p>
|
|
1288
|
+
* <code>https://cognito-idp.<i><region></i>.amazonaws.com/<i><user-pool-id></i>/.well-known/openid-configuration</code>
|
|
1289
|
+
* </p>
|
|
1290
|
+
*/
|
|
1291
|
+
discoveryUrl?: string;
|
|
1292
|
+
/**
|
|
1293
|
+
* <p>A string that identifies the type of OIDC service represented by this identity source. </p>
|
|
1294
|
+
* <p>At this time, the only valid value is <code>cognito</code>.</p>
|
|
1295
|
+
*/
|
|
1296
|
+
openIdIssuer?: OpenIdIssuer | string;
|
|
1297
|
+
}
|
|
1298
|
+
/**
|
|
1299
|
+
* @public
|
|
1300
|
+
* <p>A structure that defines an identity source.</p>
|
|
1301
|
+
* <p>This data type is used as a request parameter for the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListIdentityStores.html">ListIdentityStores</a>
|
|
1302
|
+
* operation.</p>
|
|
1303
|
+
*/
|
|
1304
|
+
export interface IdentitySourceItem {
|
|
1305
|
+
/**
|
|
1306
|
+
* <p>The date and time the identity source was originally created.</p>
|
|
1307
|
+
*/
|
|
1308
|
+
createdDate: Date | undefined;
|
|
1309
|
+
/**
|
|
1310
|
+
* <p>A structure that contains the details of the associated identity provider
|
|
1311
|
+
* (IdP).</p>
|
|
1312
|
+
*/
|
|
1313
|
+
details: IdentitySourceItemDetails | undefined;
|
|
1314
|
+
/**
|
|
1315
|
+
* <p>The unique identifier of the identity source.</p>
|
|
1316
|
+
*/
|
|
1317
|
+
identitySourceId: string | undefined;
|
|
1318
|
+
/**
|
|
1319
|
+
* <p>The date and time the identity source was most recently updated.</p>
|
|
1320
|
+
*/
|
|
1321
|
+
lastUpdatedDate: Date | undefined;
|
|
1322
|
+
/**
|
|
1323
|
+
* <p>The identifier of the policy store that contains the identity source.</p>
|
|
1324
|
+
*/
|
|
1325
|
+
policyStoreId: string | undefined;
|
|
1326
|
+
/**
|
|
1327
|
+
* <p>The Cedar entity type of the principals returned from the IdP associated with this
|
|
1328
|
+
* identity source.</p>
|
|
1329
|
+
*/
|
|
1330
|
+
principalEntityType: string | undefined;
|
|
1331
|
+
}
|
|
1332
|
+
/**
|
|
1333
|
+
* @public
|
|
1334
|
+
*/
|
|
1335
|
+
export interface ListIdentitySourcesOutput {
|
|
1336
|
+
/**
|
|
1337
|
+
* <p>If present, this value indicates that more output is available than
|
|
1338
|
+
* is included in the current response. Use this value in the <code>NextToken</code>
|
|
1339
|
+
* request parameter in a subsequent call to the operation to get the next part of the
|
|
1340
|
+
* output. You should repeat this until the <code>NextToken</code> response element comes
|
|
1341
|
+
* back as <code>null</code>. This indicates that this is the last page of results.</p>
|
|
1342
|
+
*/
|
|
1343
|
+
nextToken?: string;
|
|
1344
|
+
/**
|
|
1345
|
+
* <p>The list of identity sources stored in the specified policy store.</p>
|
|
1346
|
+
*/
|
|
1347
|
+
identitySources: IdentitySourceItem[] | undefined;
|
|
1348
|
+
}
|
|
1349
|
+
/**
|
|
1350
|
+
* @public
|
|
1351
|
+
* <p>Contains configuration details of a Amazon Cognito user pool for use with an identity source.</p>
|
|
1352
|
+
*/
|
|
1353
|
+
export interface UpdateCognitoUserPoolConfiguration {
|
|
1354
|
+
/**
|
|
1355
|
+
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of the Amazon Cognito user pool associated with this identity source.</p>
|
|
1356
|
+
*/
|
|
1357
|
+
userPoolArn: string | undefined;
|
|
1358
|
+
/**
|
|
1359
|
+
* <p>The client ID of an app client that is configured for the specified Amazon Cognito user
|
|
1360
|
+
* pool.</p>
|
|
1361
|
+
*/
|
|
1362
|
+
clientIds?: string[];
|
|
1363
|
+
}
|
|
1364
|
+
/**
|
|
1365
|
+
* @public
|
|
1366
|
+
* <p>Contains an updated configuration to replace the configuration in an existing
|
|
1367
|
+
* identity source.</p>
|
|
1368
|
+
* <note>
|
|
1369
|
+
* <p>At this time, the only valid member of this structure is a Amazon Cognito user pool
|
|
1370
|
+
* configuration.</p>
|
|
1371
|
+
* <p>You must specify a <code>userPoolArn</code>, and optionally, a
|
|
1372
|
+
* <code>ClientId</code>.</p>
|
|
1373
|
+
* </note>
|
|
1374
|
+
*/
|
|
1375
|
+
export type UpdateConfiguration = UpdateConfiguration.CognitoUserPoolConfigurationMember | UpdateConfiguration.$UnknownMember;
|
|
1376
|
+
/**
|
|
1377
|
+
* @public
|
|
1378
|
+
*/
|
|
1379
|
+
export declare namespace UpdateConfiguration {
|
|
1380
|
+
/**
|
|
1381
|
+
* <p>Contains configuration details of a Amazon Cognito user pool.</p>
|
|
1382
|
+
*/
|
|
1383
|
+
interface CognitoUserPoolConfigurationMember {
|
|
1384
|
+
cognitoUserPoolConfiguration: UpdateCognitoUserPoolConfiguration;
|
|
1385
|
+
$unknown?: never;
|
|
1386
|
+
}
|
|
1387
|
+
interface $UnknownMember {
|
|
1388
|
+
cognitoUserPoolConfiguration?: never;
|
|
1389
|
+
$unknown: [string, any];
|
|
1390
|
+
}
|
|
1391
|
+
interface Visitor<T> {
|
|
1392
|
+
cognitoUserPoolConfiguration: (value: UpdateCognitoUserPoolConfiguration) => T;
|
|
1393
|
+
_: (name: string, value: any) => T;
|
|
1394
|
+
}
|
|
1395
|
+
const visit: <T>(value: UpdateConfiguration, visitor: Visitor<T>) => T;
|
|
1396
|
+
}
|
|
1397
|
+
/**
|
|
1398
|
+
* @public
|
|
1399
|
+
*/
|
|
1400
|
+
export interface UpdateIdentitySourceInput {
|
|
1401
|
+
/**
|
|
1402
|
+
* <p>Specifies the ID of the policy store that contains the identity source that you want to update.</p>
|
|
1403
|
+
*/
|
|
1404
|
+
policyStoreId: string | undefined;
|
|
1405
|
+
/**
|
|
1406
|
+
* <p>Specifies the ID of the identity source that you want to update.</p>
|
|
1407
|
+
*/
|
|
1408
|
+
identitySourceId: string | undefined;
|
|
1409
|
+
/**
|
|
1410
|
+
* <p>Specifies the details required to communicate with the identity provider (IdP)
|
|
1411
|
+
* associated with this identity source.</p>
|
|
1412
|
+
* <note>
|
|
1413
|
+
* <p>At this time, the only valid member of this structure is a Amazon Cognito user pool
|
|
1414
|
+
* configuration.</p>
|
|
1415
|
+
* <p>You must specify a <code>userPoolArn</code>, and optionally, a
|
|
1416
|
+
* <code>ClientId</code>.</p>
|
|
1417
|
+
* </note>
|
|
1418
|
+
*/
|
|
1419
|
+
updateConfiguration: UpdateConfiguration | undefined;
|
|
1420
|
+
/**
|
|
1421
|
+
* <p>Specifies the data type of principals generated for identities authenticated by the
|
|
1422
|
+
* identity source.</p>
|
|
1423
|
+
*/
|
|
1424
|
+
principalEntityType?: string;
|
|
1425
|
+
}
|
|
1426
|
+
/**
|
|
1427
|
+
* @public
|
|
1428
|
+
*/
|
|
1429
|
+
export interface UpdateIdentitySourceOutput {
|
|
1430
|
+
/**
|
|
1431
|
+
* <p>The date and time that the updated identity source was originally created.</p>
|
|
1432
|
+
*/
|
|
1433
|
+
createdDate: Date | undefined;
|
|
1434
|
+
/**
|
|
1435
|
+
* <p>The ID of the updated identity source.</p>
|
|
1436
|
+
*/
|
|
1437
|
+
identitySourceId: string | undefined;
|
|
1438
|
+
/**
|
|
1439
|
+
* <p>The date and time that the identity source was most recently updated.</p>
|
|
1440
|
+
*/
|
|
1441
|
+
lastUpdatedDate: Date | undefined;
|
|
1442
|
+
/**
|
|
1443
|
+
* <p>The ID of the policy store that contains the updated identity source.</p>
|
|
1444
|
+
*/
|
|
1445
|
+
policyStoreId: string | undefined;
|
|
1446
|
+
}
|
|
1447
|
+
/**
|
|
1448
|
+
* @public
|
|
1449
|
+
*/
|
|
1450
|
+
export interface IsAuthorizedOutput {
|
|
1451
|
+
/**
|
|
1452
|
+
* <p>An authorization decision that indicates if the authorization request should be
|
|
1453
|
+
* allowed or denied.</p>
|
|
1454
|
+
*/
|
|
1455
|
+
decision: Decision | string | undefined;
|
|
1456
|
+
/**
|
|
1457
|
+
* <p>The list of determining policies used to make the authorization decision. For example,
|
|
1458
|
+
* if there are two matching policies, where one is a forbid and the other is a permit,
|
|
1459
|
+
* then the forbid policy will be the determining policy. In the case of multiple matching
|
|
1460
|
+
* permit policies then there would be multiple determining policies. In the case that no
|
|
1461
|
+
* policies match, and hence the response is DENY, there would be no determining
|
|
1462
|
+
* policies.</p>
|
|
1463
|
+
*/
|
|
1464
|
+
determiningPolicies: DeterminingPolicyItem[] | undefined;
|
|
1465
|
+
/**
|
|
1466
|
+
* <p>Errors that occurred while making an authorization decision, for example, a policy
|
|
1467
|
+
* references an Entity or entity Attribute that does not exist in the slice.</p>
|
|
1468
|
+
*/
|
|
1469
|
+
errors: EvaluationErrorItem[] | undefined;
|
|
1470
|
+
}
|
|
1471
|
+
/**
|
|
1472
|
+
* @public
|
|
1473
|
+
*/
|
|
1474
|
+
export interface IsAuthorizedWithTokenOutput {
|
|
1475
|
+
/**
|
|
1476
|
+
* <p>An authorization decision that indicates if the authorization request should be
|
|
1477
|
+
* allowed or denied.</p>
|
|
1478
|
+
*/
|
|
1479
|
+
decision: Decision | string | undefined;
|
|
1480
|
+
/**
|
|
1481
|
+
* <p>The list of determining policies used to make the authorization decision. For example,
|
|
1482
|
+
* if there are multiple matching policies, where at least one is a forbid policy, then
|
|
1483
|
+
* because forbid always overrides permit the forbid policies are the determining policies.
|
|
1484
|
+
* If all matching policies are permit policies, then those policies are the determining
|
|
1485
|
+
* policies. When no policies match and the response is the default DENY, there are no
|
|
1486
|
+
* determining policies.</p>
|
|
1487
|
+
*/
|
|
1488
|
+
determiningPolicies: DeterminingPolicyItem[] | undefined;
|
|
1489
|
+
/**
|
|
1490
|
+
* <p>Errors that occurred while making an authorization decision. For example, a policy
|
|
1491
|
+
* references an entity or entity attribute that does not exist in the slice.</p>
|
|
1492
|
+
*/
|
|
1493
|
+
errors: EvaluationErrorItem[] | undefined;
|
|
1494
|
+
}
|
|
1495
|
+
/**
|
|
1496
|
+
* @public
|
|
1497
|
+
* <p>Contains information about a filter to refine policies returned in a query.</p>
|
|
1498
|
+
* <p>This data type is used as a response parameter for the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicies.html">ListPolicies</a> operation.</p>
|
|
1499
|
+
*/
|
|
1500
|
+
export interface PolicyFilter {
|
|
1501
|
+
/**
|
|
1502
|
+
* <p>Filters the output to only policies that reference the specified principal.</p>
|
|
1503
|
+
*/
|
|
1504
|
+
principal?: EntityReference;
|
|
1505
|
+
/**
|
|
1506
|
+
* <p>Filters the output to only policies that reference the specified resource.</p>
|
|
1507
|
+
*/
|
|
1508
|
+
resource?: EntityReference;
|
|
1509
|
+
/**
|
|
1510
|
+
* <p>Filters the output to only policies of the specified type.</p>
|
|
1511
|
+
*/
|
|
1512
|
+
policyType?: PolicyType | string;
|
|
1513
|
+
/**
|
|
1514
|
+
* <p>Filters the output to only template-linked policies that were instantiated from the specified
|
|
1515
|
+
* policy template.</p>
|
|
1516
|
+
*/
|
|
1517
|
+
policyTemplateId?: string;
|
|
1518
|
+
}
|
|
1519
|
+
/**
|
|
1520
|
+
* @public
|
|
1521
|
+
*/
|
|
1522
|
+
export interface ListPoliciesInput {
|
|
1523
|
+
/**
|
|
1524
|
+
* <p>Specifies the ID of the policy store you want to list policies from.</p>
|
|
1525
|
+
*/
|
|
1526
|
+
policyStoreId: string | undefined;
|
|
1527
|
+
/**
|
|
1528
|
+
* <p>Specifies that you want to receive the next page of results. Valid
|
|
1529
|
+
* only if you received a <code>NextToken</code> response in the previous request. If you
|
|
1530
|
+
* did, it indicates that more output is available. Set this parameter to the value
|
|
1531
|
+
* provided by the previous call's <code>NextToken</code> response to request the
|
|
1532
|
+
* next page of results.</p>
|
|
1533
|
+
*/
|
|
1534
|
+
nextToken?: string;
|
|
1535
|
+
/**
|
|
1536
|
+
* <p>Specifies the total number of results that you want included on each page
|
|
1537
|
+
* of the response. If you do not include this parameter, it defaults to a value that is
|
|
1538
|
+
* specific to the operation. If additional items exist beyond the number you specify, the
|
|
1539
|
+
* <code>NextToken</code> response element is returned with a value (not null).
|
|
1540
|
+
* Include the specified value as the <code>NextToken</code> request parameter in the next
|
|
1541
|
+
* call to the operation to get the next part of the results. Note that the service might
|
|
1542
|
+
* return fewer results than the maximum even when there are more results available. You
|
|
1543
|
+
* should check <code>NextToken</code> after every operation to ensure that you receive all
|
|
1544
|
+
* of the results.</p>
|
|
1545
|
+
*/
|
|
1546
|
+
maxResults?: number;
|
|
1547
|
+
/**
|
|
1548
|
+
* <p>Specifies a filter that limits the response to only policies that match the specified
|
|
1549
|
+
* criteria. For example, you list only the policies that reference a specified
|
|
1550
|
+
* principal.</p>
|
|
1551
|
+
*/
|
|
1552
|
+
filter?: PolicyFilter;
|
|
1553
|
+
}
|
|
1554
|
+
/**
|
|
1555
|
+
* @public
|
|
1556
|
+
* <p>A structure that contains details about a static policy. It includes the description and
|
|
1557
|
+
* policy statement.</p>
|
|
1558
|
+
* <p>This data type is used within a <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_PolicyDefinition.html">PolicyDefinition</a> structure as
|
|
1559
|
+
* part of a request parameter for the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreatePolicy.html">CreatePolicy</a> operation.</p>
|
|
1560
|
+
*/
|
|
1561
|
+
export interface StaticPolicyDefinitionItem {
|
|
1562
|
+
/**
|
|
1563
|
+
* <p>A description of the static policy.</p>
|
|
1564
|
+
*/
|
|
1565
|
+
description?: string;
|
|
1566
|
+
}
|
|
1567
|
+
/**
|
|
1568
|
+
* @public
|
|
1569
|
+
* <p>Contains information about a policy created by instantiating a policy template. </p>
|
|
1570
|
+
* <p>This </p>
|
|
1571
|
+
*/
|
|
1572
|
+
export interface TemplateLinkedPolicyDefinitionItem {
|
|
1573
|
+
/**
|
|
1574
|
+
* <p>The unique identifier of the policy template used to create this policy.</p>
|
|
1575
|
+
*/
|
|
1576
|
+
policyTemplateId: string | undefined;
|
|
1577
|
+
/**
|
|
1578
|
+
* <p>The principal associated with this template-linked policy. Verified Permissions substitutes this principal for the
|
|
1579
|
+
* <code>?principal</code> placeholder in the policy template when it evaluates an authorization
|
|
1580
|
+
* request.</p>
|
|
1581
|
+
*/
|
|
1582
|
+
principal?: EntityIdentifier;
|
|
1583
|
+
/**
|
|
1584
|
+
* <p>The resource associated with this template-linked policy. Verified Permissions substitutes this resource for the
|
|
1585
|
+
* <code>?resource</code> placeholder in the policy template when it evaluates an authorization
|
|
1586
|
+
* request.</p>
|
|
1587
|
+
*/
|
|
1588
|
+
resource?: EntityIdentifier;
|
|
1589
|
+
}
|
|
1590
|
+
/**
|
|
1591
|
+
* @public
|
|
1592
|
+
* <p>A structure that describes a <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_PolicyDefinintion.html">PolicyDefinintion</a>. It will
|
|
1593
|
+
* always have either an <code>StaticPolicy</code> or a <code>TemplateLinkedPolicy</code>
|
|
1594
|
+
* element.</p>
|
|
1595
|
+
* <p>This data type is used as a response parameter for the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreatePolicy.html">CreatePolicy</a> and <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicies.html">ListPolicies</a>
|
|
1596
|
+
* operations. </p>
|
|
1597
|
+
*/
|
|
1598
|
+
export type PolicyDefinitionItem = PolicyDefinitionItem.StaticMember | PolicyDefinitionItem.TemplateLinkedMember | PolicyDefinitionItem.$UnknownMember;
|
|
1599
|
+
/**
|
|
1600
|
+
* @public
|
|
1601
|
+
*/
|
|
1602
|
+
export declare namespace PolicyDefinitionItem {
|
|
1603
|
+
/**
|
|
1604
|
+
* <p>Information about a static policy that wasn't created with a policy template.</p>
|
|
1605
|
+
*/
|
|
1606
|
+
interface StaticMember {
|
|
1607
|
+
static: StaticPolicyDefinitionItem;
|
|
1608
|
+
templateLinked?: never;
|
|
1609
|
+
$unknown?: never;
|
|
1610
|
+
}
|
|
1611
|
+
/**
|
|
1612
|
+
* <p>Information about a template-linked policy that was created by instantiating a policy template.</p>
|
|
1613
|
+
*/
|
|
1614
|
+
interface TemplateLinkedMember {
|
|
1615
|
+
static?: never;
|
|
1616
|
+
templateLinked: TemplateLinkedPolicyDefinitionItem;
|
|
1617
|
+
$unknown?: never;
|
|
1618
|
+
}
|
|
1619
|
+
interface $UnknownMember {
|
|
1620
|
+
static?: never;
|
|
1621
|
+
templateLinked?: never;
|
|
1622
|
+
$unknown: [string, any];
|
|
1623
|
+
}
|
|
1624
|
+
interface Visitor<T> {
|
|
1625
|
+
static: (value: StaticPolicyDefinitionItem) => T;
|
|
1626
|
+
templateLinked: (value: TemplateLinkedPolicyDefinitionItem) => T;
|
|
1627
|
+
_: (name: string, value: any) => T;
|
|
1628
|
+
}
|
|
1629
|
+
const visit: <T>(value: PolicyDefinitionItem, visitor: Visitor<T>) => T;
|
|
1630
|
+
}
|
|
1631
|
+
/**
|
|
1632
|
+
* @public
|
|
1633
|
+
* <p>Contains information about a policy.</p>
|
|
1634
|
+
* <p>This data type is used as a response parameter for the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicies.html">ListPolicies</a> operation.</p>
|
|
1635
|
+
*/
|
|
1636
|
+
export interface PolicyItem {
|
|
1637
|
+
/**
|
|
1638
|
+
* <p>The identifier of the PolicyStore where the policy you want information about is
|
|
1639
|
+
* stored.</p>
|
|
1640
|
+
*/
|
|
1641
|
+
policyStoreId: string | undefined;
|
|
1642
|
+
/**
|
|
1643
|
+
* <p>The identifier of the policy you want information about.</p>
|
|
1644
|
+
*/
|
|
1645
|
+
policyId: string | undefined;
|
|
1646
|
+
/**
|
|
1647
|
+
* <p>The type of the policy. This is one of the following values:</p>
|
|
1648
|
+
* <ul>
|
|
1649
|
+
* <li>
|
|
1650
|
+
* <p>
|
|
1651
|
+
* <code>static</code>
|
|
1652
|
+
* </p>
|
|
1653
|
+
* </li>
|
|
1654
|
+
* <li>
|
|
1655
|
+
* <p>
|
|
1656
|
+
* <code>templateLinked</code>
|
|
1657
|
+
* </p>
|
|
1658
|
+
* </li>
|
|
1659
|
+
* </ul>
|
|
1660
|
+
*/
|
|
1661
|
+
policyType: PolicyType | string | undefined;
|
|
1662
|
+
/**
|
|
1663
|
+
* <p>The principal associated with the policy.</p>
|
|
1664
|
+
*/
|
|
1665
|
+
principal?: EntityIdentifier;
|
|
1666
|
+
/**
|
|
1667
|
+
* <p>The resource associated with the policy.</p>
|
|
1668
|
+
*/
|
|
1669
|
+
resource?: EntityIdentifier;
|
|
1670
|
+
/**
|
|
1671
|
+
* <p>The policy definition of an item in the list of policies returned.</p>
|
|
1672
|
+
*/
|
|
1673
|
+
definition: PolicyDefinitionItem | undefined;
|
|
1674
|
+
/**
|
|
1675
|
+
* <p>The date and time the policy was created.</p>
|
|
1676
|
+
*/
|
|
1677
|
+
createdDate: Date | undefined;
|
|
1678
|
+
/**
|
|
1679
|
+
* <p>The date and time the policy was most recently updated.</p>
|
|
1680
|
+
*/
|
|
1681
|
+
lastUpdatedDate: Date | undefined;
|
|
1682
|
+
}
|
|
1683
|
+
/**
|
|
1684
|
+
* @public
|
|
1685
|
+
*/
|
|
1686
|
+
export interface ListPoliciesOutput {
|
|
1687
|
+
/**
|
|
1688
|
+
* <p>If present, this value indicates that more output is available than
|
|
1689
|
+
* is included in the current response. Use this value in the <code>NextToken</code>
|
|
1690
|
+
* request parameter in a subsequent call to the operation to get the next part of the
|
|
1691
|
+
* output. You should repeat this until the <code>NextToken</code> response element comes
|
|
1692
|
+
* back as <code>null</code>. This indicates that this is the last page of results.</p>
|
|
1693
|
+
*/
|
|
1694
|
+
nextToken?: string;
|
|
1695
|
+
/**
|
|
1696
|
+
* <p>Lists all policies that are available in the specified policy store.</p>
|
|
1697
|
+
*/
|
|
1698
|
+
policies: PolicyItem[] | undefined;
|
|
1699
|
+
}
|
|
1700
|
+
/**
|
|
1701
|
+
* @public
|
|
1702
|
+
*/
|
|
1703
|
+
export interface ListPolicyStoresInput {
|
|
1704
|
+
/**
|
|
1705
|
+
* <p>Specifies that you want to receive the next page of results. Valid
|
|
1706
|
+
* only if you received a <code>NextToken</code> response in the previous request. If you
|
|
1707
|
+
* did, it indicates that more output is available. Set this parameter to the value
|
|
1708
|
+
* provided by the previous call's <code>NextToken</code> response to request the
|
|
1709
|
+
* next page of results.</p>
|
|
1710
|
+
*/
|
|
1711
|
+
nextToken?: string;
|
|
1712
|
+
/**
|
|
1713
|
+
* <p>Specifies the total number of results that you want included on each page
|
|
1714
|
+
* of the response. If you do not include this parameter, it defaults to a value that is
|
|
1715
|
+
* specific to the operation. If additional items exist beyond the number you specify, the
|
|
1716
|
+
* <code>NextToken</code> response element is returned with a value (not null).
|
|
1717
|
+
* Include the specified value as the <code>NextToken</code> request parameter in the next
|
|
1718
|
+
* call to the operation to get the next part of the results. Note that the service might
|
|
1719
|
+
* return fewer results than the maximum even when there are more results available. You
|
|
1720
|
+
* should check <code>NextToken</code> after every operation to ensure that you receive all
|
|
1721
|
+
* of the results.</p>
|
|
1722
|
+
*/
|
|
1723
|
+
maxResults?: number;
|
|
1724
|
+
}
|
|
1725
|
+
/**
|
|
1726
|
+
* @public
|
|
1727
|
+
* <p>Contains information about a policy store.</p>
|
|
1728
|
+
* <p>This data type is used as a response parameter for the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicyStores.html">ListPolicyStores</a>
|
|
1729
|
+
* operation.</p>
|
|
1730
|
+
*/
|
|
1731
|
+
export interface PolicyStoreItem {
|
|
1732
|
+
/**
|
|
1733
|
+
* <p>The unique identifier of the policy store.</p>
|
|
1734
|
+
*/
|
|
1735
|
+
policyStoreId: string | undefined;
|
|
1736
|
+
/**
|
|
1737
|
+
* <p>The Amazon Resource Name (ARN) of the policy store.</p>
|
|
1738
|
+
*/
|
|
1739
|
+
arn: string | undefined;
|
|
1740
|
+
/**
|
|
1741
|
+
* <p>The date and time the policy was created.</p>
|
|
1742
|
+
*/
|
|
1743
|
+
createdDate: Date | undefined;
|
|
1744
|
+
}
|
|
1745
|
+
/**
|
|
1746
|
+
* @public
|
|
1747
|
+
*/
|
|
1748
|
+
export interface ListPolicyStoresOutput {
|
|
1749
|
+
/**
|
|
1750
|
+
* <p>If present, this value indicates that more output is available than
|
|
1751
|
+
* is included in the current response. Use this value in the <code>NextToken</code>
|
|
1752
|
+
* request parameter in a subsequent call to the operation to get the next part of the
|
|
1753
|
+
* output. You should repeat this until the <code>NextToken</code> response element comes
|
|
1754
|
+
* back as <code>null</code>. This indicates that this is the last page of results.</p>
|
|
1755
|
+
*/
|
|
1756
|
+
nextToken?: string;
|
|
1757
|
+
/**
|
|
1758
|
+
* <p>The list of policy stores in the account.</p>
|
|
1759
|
+
*/
|
|
1760
|
+
policyStores: PolicyStoreItem[] | undefined;
|
|
1761
|
+
}
|
|
1762
|
+
/**
|
|
1763
|
+
* @public
|
|
1764
|
+
*/
|
|
1765
|
+
export interface ListPolicyTemplatesInput {
|
|
1766
|
+
/**
|
|
1767
|
+
* <p>Specifies the ID of the policy store that contains the policy templates you want to list.</p>
|
|
1768
|
+
*/
|
|
1769
|
+
policyStoreId: string | undefined;
|
|
1770
|
+
/**
|
|
1771
|
+
* <p>Specifies that you want to receive the next page of results. Valid
|
|
1772
|
+
* only if you received a <code>NextToken</code> response in the previous request. If you
|
|
1773
|
+
* did, it indicates that more output is available. Set this parameter to the value
|
|
1774
|
+
* provided by the previous call's <code>NextToken</code> response to request the
|
|
1775
|
+
* next page of results.</p>
|
|
1776
|
+
*/
|
|
1777
|
+
nextToken?: string;
|
|
1778
|
+
/**
|
|
1779
|
+
* <p>Specifies the total number of results that you want included on each page
|
|
1780
|
+
* of the response. If you do not include this parameter, it defaults to a value that is
|
|
1781
|
+
* specific to the operation. If additional items exist beyond the number you specify, the
|
|
1782
|
+
* <code>NextToken</code> response element is returned with a value (not null).
|
|
1783
|
+
* Include the specified value as the <code>NextToken</code> request parameter in the next
|
|
1784
|
+
* call to the operation to get the next part of the results. Note that the service might
|
|
1785
|
+
* return fewer results than the maximum even when there are more results available. You
|
|
1786
|
+
* should check <code>NextToken</code> after every operation to ensure that you receive all
|
|
1787
|
+
* of the results.</p>
|
|
1788
|
+
*/
|
|
1789
|
+
maxResults?: number;
|
|
1790
|
+
}
|
|
1791
|
+
/**
|
|
1792
|
+
* @public
|
|
1793
|
+
* <p>Contains details about a policy template</p>
|
|
1794
|
+
* <p>This data type is used as a response parameter for the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicyTemplates.html">ListPolicyTemplates</a>
|
|
1795
|
+
* operation.</p>
|
|
1796
|
+
*/
|
|
1797
|
+
export interface PolicyTemplateItem {
|
|
1798
|
+
/**
|
|
1799
|
+
* <p>The unique identifier of the policy store that contains the template.</p>
|
|
1800
|
+
*/
|
|
1801
|
+
policyStoreId: string | undefined;
|
|
1802
|
+
/**
|
|
1803
|
+
* <p>The unique identifier of the policy template.</p>
|
|
1804
|
+
*/
|
|
1805
|
+
policyTemplateId: string | undefined;
|
|
1806
|
+
/**
|
|
1807
|
+
* <p>The description attached to the policy template.</p>
|
|
1808
|
+
*/
|
|
1809
|
+
description?: string;
|
|
1810
|
+
/**
|
|
1811
|
+
* <p>The date and time that the policy template was created.</p>
|
|
1812
|
+
*/
|
|
1813
|
+
createdDate: Date | undefined;
|
|
1814
|
+
/**
|
|
1815
|
+
* <p>The date and time that the policy template was most recently updated.</p>
|
|
1816
|
+
*/
|
|
1817
|
+
lastUpdatedDate: Date | undefined;
|
|
1818
|
+
}
|
|
1819
|
+
/**
|
|
1820
|
+
* @public
|
|
1821
|
+
*/
|
|
1822
|
+
export interface ListPolicyTemplatesOutput {
|
|
1823
|
+
/**
|
|
1824
|
+
* <p>If present, this value indicates that more output is available than
|
|
1825
|
+
* is included in the current response. Use this value in the <code>NextToken</code>
|
|
1826
|
+
* request parameter in a subsequent call to the operation to get the next part of the
|
|
1827
|
+
* output. You should repeat this until the <code>NextToken</code> response element comes
|
|
1828
|
+
* back as <code>null</code>. This indicates that this is the last page of results.</p>
|
|
1829
|
+
*/
|
|
1830
|
+
nextToken?: string;
|
|
1831
|
+
/**
|
|
1832
|
+
* <p>The list of the policy templates in the specified policy store.</p>
|
|
1833
|
+
*/
|
|
1834
|
+
policyTemplates: PolicyTemplateItem[] | undefined;
|
|
1835
|
+
}
|
|
1836
|
+
/**
|
|
1837
|
+
* @public
|
|
1838
|
+
* <p>Contains information about an update to a static policy.</p>
|
|
1839
|
+
*/
|
|
1840
|
+
export interface UpdateStaticPolicyDefinition {
|
|
1841
|
+
/**
|
|
1842
|
+
* <p>Specifies the description to be added to or replaced on the static policy.</p>
|
|
1843
|
+
*/
|
|
1844
|
+
description?: string;
|
|
1845
|
+
/**
|
|
1846
|
+
* <p>Specifies the Cedar policy language text to be added to or replaced on the static policy.</p>
|
|
1847
|
+
* <important>
|
|
1848
|
+
* <p>You can change only the following elements from the original content:</p>
|
|
1849
|
+
* <ul>
|
|
1850
|
+
* <li>
|
|
1851
|
+
* <p>The <code>action</code> referenced by the policy.</p>
|
|
1852
|
+
* </li>
|
|
1853
|
+
* <li>
|
|
1854
|
+
* <p>Any conditional clauses, such as <code>when</code> or <code>unless</code>
|
|
1855
|
+
* clauses.</p>
|
|
1856
|
+
* </li>
|
|
1857
|
+
* </ul>
|
|
1858
|
+
* <p>You <b>can't</b> change the following elements:</p>
|
|
1859
|
+
* <ul>
|
|
1860
|
+
* <li>
|
|
1861
|
+
* <p>Changing from <code>StaticPolicy</code> to
|
|
1862
|
+
* <code>TemplateLinkedPolicy</code>.</p>
|
|
1863
|
+
* </li>
|
|
1864
|
+
* <li>
|
|
1865
|
+
* <p>The effect (<code>permit</code> or <code>forbid</code>) of the
|
|
1866
|
+
* policy.</p>
|
|
1867
|
+
* </li>
|
|
1868
|
+
* <li>
|
|
1869
|
+
* <p>The <code>principal</code> referenced by the policy.</p>
|
|
1870
|
+
* </li>
|
|
1871
|
+
* <li>
|
|
1872
|
+
* <p>The <code>resource</code> referenced by the policy.</p>
|
|
1873
|
+
* </li>
|
|
1874
|
+
* </ul>
|
|
1875
|
+
* </important>
|
|
1876
|
+
*/
|
|
1877
|
+
statement: string | undefined;
|
|
1878
|
+
}
|
|
1879
|
+
/**
|
|
1880
|
+
* @public
|
|
1881
|
+
* <p>Contains information about updates to be applied to a policy.</p>
|
|
1882
|
+
* <p>This data type is used as a request parameter in the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdatePolicy.html">UpdatePolicy</a> operation.</p>
|
|
1883
|
+
*/
|
|
1884
|
+
export type UpdatePolicyDefinition = UpdatePolicyDefinition.StaticMember | UpdatePolicyDefinition.$UnknownMember;
|
|
1885
|
+
/**
|
|
1886
|
+
* @public
|
|
1887
|
+
*/
|
|
1888
|
+
export declare namespace UpdatePolicyDefinition {
|
|
1889
|
+
/**
|
|
1890
|
+
* <p>Contains details about the updates to be applied to a static policy.</p>
|
|
1891
|
+
*/
|
|
1892
|
+
interface StaticMember {
|
|
1893
|
+
static: UpdateStaticPolicyDefinition;
|
|
1894
|
+
$unknown?: never;
|
|
1895
|
+
}
|
|
1896
|
+
interface $UnknownMember {
|
|
1897
|
+
static?: never;
|
|
1898
|
+
$unknown: [string, any];
|
|
1899
|
+
}
|
|
1900
|
+
interface Visitor<T> {
|
|
1901
|
+
static: (value: UpdateStaticPolicyDefinition) => T;
|
|
1902
|
+
_: (name: string, value: any) => T;
|
|
1903
|
+
}
|
|
1904
|
+
const visit: <T>(value: UpdatePolicyDefinition, visitor: Visitor<T>) => T;
|
|
1905
|
+
}
|
|
1906
|
+
/**
|
|
1907
|
+
* @public
|
|
1908
|
+
*/
|
|
1909
|
+
export interface UpdatePolicyInput {
|
|
1910
|
+
/**
|
|
1911
|
+
* <p>Specifies the ID of the policy store that contains the policy that you want to update.</p>
|
|
1912
|
+
*/
|
|
1913
|
+
policyStoreId: string | undefined;
|
|
1914
|
+
/**
|
|
1915
|
+
* <p>Specifies the ID of the policy that you want to update. To find this value, you can
|
|
1916
|
+
* use <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicies.html">ListPolicies</a>.</p>
|
|
1917
|
+
*/
|
|
1918
|
+
policyId: string | undefined;
|
|
1919
|
+
/**
|
|
1920
|
+
* <p>Specifies the updated policy content that you want to replace on the specified policy.
|
|
1921
|
+
* The content must be valid Cedar policy language text.</p>
|
|
1922
|
+
* <p>You can change only the following elements from the policy definition:</p>
|
|
1923
|
+
* <ul>
|
|
1924
|
+
* <li>
|
|
1925
|
+
* <p>The <code>action</code> referenced by the policy.</p>
|
|
1926
|
+
* </li>
|
|
1927
|
+
* <li>
|
|
1928
|
+
* <p>Any conditional clauses, such as <code>when</code> or <code>unless</code>
|
|
1929
|
+
* clauses.</p>
|
|
1930
|
+
* </li>
|
|
1931
|
+
* </ul>
|
|
1932
|
+
* <p>You <b>can't</b> change the following elements:</p>
|
|
1933
|
+
* <ul>
|
|
1934
|
+
* <li>
|
|
1935
|
+
* <p>Changing from <code>static</code> to <code>templateLinked</code>.</p>
|
|
1936
|
+
* </li>
|
|
1937
|
+
* <li>
|
|
1938
|
+
* <p>Changing the effect of the policy from <code>permit</code> or
|
|
1939
|
+
* <code>forbid</code>.</p>
|
|
1940
|
+
* </li>
|
|
1941
|
+
* <li>
|
|
1942
|
+
* <p>The <code>principal</code> referenced by the policy.</p>
|
|
1943
|
+
* </li>
|
|
1944
|
+
* <li>
|
|
1945
|
+
* <p>The <code>resource</code> referenced by the policy.</p>
|
|
1946
|
+
* </li>
|
|
1947
|
+
* </ul>
|
|
1948
|
+
*/
|
|
1949
|
+
definition: UpdatePolicyDefinition | undefined;
|
|
1950
|
+
}
|
|
1951
|
+
/**
|
|
1952
|
+
* @public
|
|
1953
|
+
*/
|
|
1954
|
+
export interface UpdatePolicyOutput {
|
|
1955
|
+
/**
|
|
1956
|
+
* <p>The ID of the policy store that contains the policy that was updated.</p>
|
|
1957
|
+
*/
|
|
1958
|
+
policyStoreId: string | undefined;
|
|
1959
|
+
/**
|
|
1960
|
+
* <p>The ID of the policy that was updated.</p>
|
|
1961
|
+
*/
|
|
1962
|
+
policyId: string | undefined;
|
|
1963
|
+
/**
|
|
1964
|
+
* <p>The type of the policy that was updated.</p>
|
|
1965
|
+
*/
|
|
1966
|
+
policyType: PolicyType | string | undefined;
|
|
1967
|
+
/**
|
|
1968
|
+
* <p>The principal specified in the policy's scope. This element isn't included in the
|
|
1969
|
+
* response when <code>Principal</code> isn't present in the policy content.</p>
|
|
1970
|
+
*/
|
|
1971
|
+
principal?: EntityIdentifier;
|
|
1972
|
+
/**
|
|
1973
|
+
* <p>The resource specified in the policy's scope. This element isn't included in the
|
|
1974
|
+
* response when <code>Resource</code> isn't present in the policy content.</p>
|
|
1975
|
+
*/
|
|
1976
|
+
resource?: EntityIdentifier;
|
|
1977
|
+
/**
|
|
1978
|
+
* <p>The date and time that the policy was originally created.</p>
|
|
1979
|
+
*/
|
|
1980
|
+
createdDate: Date | undefined;
|
|
1981
|
+
/**
|
|
1982
|
+
* <p>The date and time that the policy was most recently updated.</p>
|
|
1983
|
+
*/
|
|
1984
|
+
lastUpdatedDate: Date | undefined;
|
|
1985
|
+
}
|
|
1986
|
+
/**
|
|
1987
|
+
* @public
|
|
1988
|
+
*/
|
|
1989
|
+
export interface UpdatePolicyTemplateInput {
|
|
1990
|
+
/**
|
|
1991
|
+
* <p>Specifies the ID of the policy store that contains the policy template that you want to update.</p>
|
|
1992
|
+
*/
|
|
1993
|
+
policyStoreId: string | undefined;
|
|
1994
|
+
/**
|
|
1995
|
+
* <p>Specifies the ID of the policy template that you want to update.</p>
|
|
1996
|
+
*/
|
|
1997
|
+
policyTemplateId: string | undefined;
|
|
1998
|
+
/**
|
|
1999
|
+
* <p>Specifies a new description to apply to the policy template.</p>
|
|
2000
|
+
*/
|
|
2001
|
+
description?: string;
|
|
2002
|
+
/**
|
|
2003
|
+
* <p>Specifies new statement content written in Cedar policy language to replace the
|
|
2004
|
+
* current body of the policy template.</p>
|
|
2005
|
+
* <p>You can change only the following elements of the policy body:</p>
|
|
2006
|
+
* <ul>
|
|
2007
|
+
* <li>
|
|
2008
|
+
* <p>The <code>action</code> referenced by the policy template.</p>
|
|
2009
|
+
* </li>
|
|
2010
|
+
* <li>
|
|
2011
|
+
* <p>Any conditional clauses, such as <code>when</code> or <code>unless</code>
|
|
2012
|
+
* clauses.</p>
|
|
2013
|
+
* </li>
|
|
2014
|
+
* </ul>
|
|
2015
|
+
* <p>You <b>can't</b> change the following elements:</p>
|
|
2016
|
+
* <ul>
|
|
2017
|
+
* <li>
|
|
2018
|
+
* <p>The effect (<code>permit</code> or <code>forbid</code>) of the policy template.</p>
|
|
2019
|
+
* </li>
|
|
2020
|
+
* <li>
|
|
2021
|
+
* <p>The <code>principal</code> referenced by the policy template.</p>
|
|
2022
|
+
* </li>
|
|
2023
|
+
* <li>
|
|
2024
|
+
* <p>The <code>resource</code> referenced by the policy template.</p>
|
|
2025
|
+
* </li>
|
|
2026
|
+
* </ul>
|
|
2027
|
+
*/
|
|
2028
|
+
statement: string | undefined;
|
|
2029
|
+
}
|
|
2030
|
+
/**
|
|
2031
|
+
* @public
|
|
2032
|
+
*/
|
|
2033
|
+
export interface UpdatePolicyTemplateOutput {
|
|
2034
|
+
/**
|
|
2035
|
+
* <p>The ID of the policy store that contains the updated policy template.</p>
|
|
2036
|
+
*/
|
|
2037
|
+
policyStoreId: string | undefined;
|
|
2038
|
+
/**
|
|
2039
|
+
* <p>The ID of the updated policy template.</p>
|
|
2040
|
+
*/
|
|
2041
|
+
policyTemplateId: string | undefined;
|
|
2042
|
+
/**
|
|
2043
|
+
* <p>The date and time that the policy template was originally created.</p>
|
|
2044
|
+
*/
|
|
2045
|
+
createdDate: Date | undefined;
|
|
2046
|
+
/**
|
|
2047
|
+
* <p>The date and time that the policy template was most recently updated.</p>
|
|
2048
|
+
*/
|
|
2049
|
+
lastUpdatedDate: Date | undefined;
|
|
2050
|
+
}
|
|
2051
|
+
/**
|
|
2052
|
+
* @public
|
|
2053
|
+
* <p>Contains a list of principal types, resource types, and actions that can be specified
|
|
2054
|
+
* in policies stored in the same policy store. If the validation mode for the policy store is set to
|
|
2055
|
+
* <code>STRICT</code>, then policies that can't be validated by this schema are
|
|
2056
|
+
* rejected by Verified Permissions and can't be stored in the policy store.</p>
|
|
2057
|
+
*/
|
|
2058
|
+
export type SchemaDefinition = SchemaDefinition.CedarJsonMember | SchemaDefinition.$UnknownMember;
|
|
2059
|
+
/**
|
|
2060
|
+
* @public
|
|
2061
|
+
*/
|
|
2062
|
+
export declare namespace SchemaDefinition {
|
|
2063
|
+
/**
|
|
2064
|
+
* <p>A JSON string representation of the schema supported by applications that use this
|
|
2065
|
+
* policy store. For more information, see <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/userguide/schema.html">Policy store schema</a> in the
|
|
2066
|
+
* <i>Amazon Verified Permissions User Guide</i>.</p>
|
|
2067
|
+
*/
|
|
2068
|
+
interface CedarJsonMember {
|
|
2069
|
+
cedarJson: string;
|
|
2070
|
+
$unknown?: never;
|
|
2071
|
+
}
|
|
2072
|
+
interface $UnknownMember {
|
|
2073
|
+
cedarJson?: never;
|
|
2074
|
+
$unknown: [string, any];
|
|
2075
|
+
}
|
|
2076
|
+
interface Visitor<T> {
|
|
2077
|
+
cedarJson: (value: string) => T;
|
|
2078
|
+
_: (name: string, value: any) => T;
|
|
2079
|
+
}
|
|
2080
|
+
const visit: <T>(value: SchemaDefinition, visitor: Visitor<T>) => T;
|
|
2081
|
+
}
|
|
2082
|
+
/**
|
|
2083
|
+
* @public
|
|
2084
|
+
*/
|
|
2085
|
+
export interface PutSchemaInput {
|
|
2086
|
+
/**
|
|
2087
|
+
* <p>Specifies the ID of the policy store in which to place the schema.</p>
|
|
2088
|
+
*/
|
|
2089
|
+
policyStoreId: string | undefined;
|
|
2090
|
+
/**
|
|
2091
|
+
* <p>Specifies the definition of the schema to be stored. The schema definition must be
|
|
2092
|
+
* written in Cedar schema JSON.</p>
|
|
2093
|
+
*/
|
|
2094
|
+
definition: SchemaDefinition | undefined;
|
|
2095
|
+
}
|
|
2096
|
+
/**
|
|
2097
|
+
* @public
|
|
2098
|
+
*/
|
|
2099
|
+
export interface PutSchemaOutput {
|
|
2100
|
+
/**
|
|
2101
|
+
* <p>The unique ID of the policy store that contains the schema.</p>
|
|
2102
|
+
*/
|
|
2103
|
+
policyStoreId: string | undefined;
|
|
2104
|
+
/**
|
|
2105
|
+
* <p>Identifies the namespaces of the entities referenced by this schema.</p>
|
|
2106
|
+
*/
|
|
2107
|
+
namespaces: string[] | undefined;
|
|
2108
|
+
/**
|
|
2109
|
+
* <p>The date and time that the schema was originally created.</p>
|
|
2110
|
+
*/
|
|
2111
|
+
createdDate: Date | undefined;
|
|
2112
|
+
/**
|
|
2113
|
+
* <p>The date and time that the schema was last updated.</p>
|
|
2114
|
+
*/
|
|
2115
|
+
lastUpdatedDate: Date | undefined;
|
|
2116
|
+
}
|
|
2117
|
+
/**
|
|
2118
|
+
* @public
|
|
2119
|
+
*/
|
|
2120
|
+
export interface UpdatePolicyStoreInput {
|
|
2121
|
+
/**
|
|
2122
|
+
* <p>Specifies the ID of the policy store that you want to update</p>
|
|
2123
|
+
*/
|
|
2124
|
+
policyStoreId: string | undefined;
|
|
2125
|
+
/**
|
|
2126
|
+
* <p>A structure that defines the validation settings that want to enable for the
|
|
2127
|
+
* policy store.</p>
|
|
2128
|
+
*/
|
|
2129
|
+
validationSettings: ValidationSettings | undefined;
|
|
2130
|
+
}
|
|
2131
|
+
/**
|
|
2132
|
+
* @public
|
|
2133
|
+
*/
|
|
2134
|
+
export interface UpdatePolicyStoreOutput {
|
|
2135
|
+
/**
|
|
2136
|
+
* <p>The ID of the updated policy store.</p>
|
|
2137
|
+
*/
|
|
2138
|
+
policyStoreId: string | undefined;
|
|
2139
|
+
/**
|
|
2140
|
+
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of the updated policy store.</p>
|
|
2141
|
+
*/
|
|
2142
|
+
arn: string | undefined;
|
|
2143
|
+
/**
|
|
2144
|
+
* <p>The date and time that the policy store was originally created.</p>
|
|
2145
|
+
*/
|
|
2146
|
+
createdDate: Date | undefined;
|
|
2147
|
+
/**
|
|
2148
|
+
* <p>The date and time that the policy store was most recently updated.</p>
|
|
2149
|
+
*/
|
|
2150
|
+
lastUpdatedDate: Date | undefined;
|
|
2151
|
+
}
|
|
2152
|
+
/**
|
|
2153
|
+
* @public
|
|
2154
|
+
* <p>The value of an attribute.</p>
|
|
2155
|
+
* <p>Contains information about the runtime context for a request for which an
|
|
2156
|
+
* authorization decision is made. </p>
|
|
2157
|
+
* <p>This data type is used as a member of the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ContextDefinition.html">ContextDefinition</a> structure
|
|
2158
|
+
* which is uses as a request parameter for the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorized.html">IsAuthorized</a> and <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorizedWithToken.html">IsAuthorizedWithToken</a> operations.</p>
|
|
2159
|
+
*/
|
|
2160
|
+
export type AttributeValue = AttributeValue.BooleanMember | AttributeValue.EntityIdentifierMember | AttributeValue.LongMember | AttributeValue.RecordMember | AttributeValue.SetMember | AttributeValue.StringMember | AttributeValue.$UnknownMember;
|
|
2161
|
+
/**
|
|
2162
|
+
* @public
|
|
2163
|
+
*/
|
|
2164
|
+
export declare namespace AttributeValue {
|
|
2165
|
+
/**
|
|
2166
|
+
* <p>An attribute value of <a href="docs.cedarpolicy.comcedar-syntax-datatypes.html#datatype-boolean">Boolean</a>
|
|
2167
|
+
* type.</p>
|
|
2168
|
+
* <p>Example: <code>\{"boolean": true\}</code>
|
|
2169
|
+
* </p>
|
|
2170
|
+
*/
|
|
2171
|
+
interface BooleanMember {
|
|
2172
|
+
boolean: boolean;
|
|
2173
|
+
entityIdentifier?: never;
|
|
2174
|
+
long?: never;
|
|
2175
|
+
string?: never;
|
|
2176
|
+
set?: never;
|
|
2177
|
+
record?: never;
|
|
2178
|
+
$unknown?: never;
|
|
2179
|
+
}
|
|
2180
|
+
/**
|
|
2181
|
+
* <p>An attribute value of type <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_EntityIdentifier.html">EntityIdentifier</a>.</p>
|
|
2182
|
+
* <p>Example: <code>"entityIdentifier": \{ "entityId": "<id>", "entityType":
|
|
2183
|
+
* "<entity type>"\}</code>
|
|
2184
|
+
* </p>
|
|
2185
|
+
*/
|
|
2186
|
+
interface EntityIdentifierMember {
|
|
2187
|
+
boolean?: never;
|
|
2188
|
+
entityIdentifier: EntityIdentifier;
|
|
2189
|
+
long?: never;
|
|
2190
|
+
string?: never;
|
|
2191
|
+
set?: never;
|
|
2192
|
+
record?: never;
|
|
2193
|
+
$unknown?: never;
|
|
2194
|
+
}
|
|
2195
|
+
/**
|
|
2196
|
+
* <p>An attribute value of <a href="docs.cedarpolicy.comcedar-syntax-datatypes.html#datatype-long">Long</a>
|
|
2197
|
+
* type.</p>
|
|
2198
|
+
* <p>Example: <code>\{"long": 0\}</code>
|
|
2199
|
+
* </p>
|
|
2200
|
+
*/
|
|
2201
|
+
interface LongMember {
|
|
2202
|
+
boolean?: never;
|
|
2203
|
+
entityIdentifier?: never;
|
|
2204
|
+
long: number;
|
|
2205
|
+
string?: never;
|
|
2206
|
+
set?: never;
|
|
2207
|
+
record?: never;
|
|
2208
|
+
$unknown?: never;
|
|
2209
|
+
}
|
|
2210
|
+
/**
|
|
2211
|
+
* <p>An attribute value of <a href="docs.cedarpolicy.comcedar-syntax-datatypes.html#datatype-string">String</a>
|
|
2212
|
+
* type.</p>
|
|
2213
|
+
* <p>Example: <code>\{"string": "abc"\}</code>
|
|
2214
|
+
* </p>
|
|
2215
|
+
*/
|
|
2216
|
+
interface StringMember {
|
|
2217
|
+
boolean?: never;
|
|
2218
|
+
entityIdentifier?: never;
|
|
2219
|
+
long?: never;
|
|
2220
|
+
string: string;
|
|
2221
|
+
set?: never;
|
|
2222
|
+
record?: never;
|
|
2223
|
+
$unknown?: never;
|
|
2224
|
+
}
|
|
2225
|
+
/**
|
|
2226
|
+
* <p>An attribute value of <a href="docs.cedarpolicy.comcedar-syntax-datatypes.html#datatype-set">Set</a>
|
|
2227
|
+
* type.</p>
|
|
2228
|
+
* <p>Example: <code>\{"set": [ \{\} ] \}</code>
|
|
2229
|
+
* </p>
|
|
2230
|
+
*/
|
|
2231
|
+
interface SetMember {
|
|
2232
|
+
boolean?: never;
|
|
2233
|
+
entityIdentifier?: never;
|
|
2234
|
+
long?: never;
|
|
2235
|
+
string?: never;
|
|
2236
|
+
set: AttributeValue[];
|
|
2237
|
+
record?: never;
|
|
2238
|
+
$unknown?: never;
|
|
2239
|
+
}
|
|
2240
|
+
/**
|
|
2241
|
+
* <p>An attribute value of <a href="docs.cedarpolicy.comcedar-syntax-datatypes.html#datatype-record">Record</a>
|
|
2242
|
+
* type.</p>
|
|
2243
|
+
* <p>Example: <code>\{"record": \{ "keyName": \{\} \} \}</code>
|
|
2244
|
+
* </p>
|
|
2245
|
+
*/
|
|
2246
|
+
interface RecordMember {
|
|
2247
|
+
boolean?: never;
|
|
2248
|
+
entityIdentifier?: never;
|
|
2249
|
+
long?: never;
|
|
2250
|
+
string?: never;
|
|
2251
|
+
set?: never;
|
|
2252
|
+
record: Record<string, AttributeValue>;
|
|
2253
|
+
$unknown?: never;
|
|
2254
|
+
}
|
|
2255
|
+
interface $UnknownMember {
|
|
2256
|
+
boolean?: never;
|
|
2257
|
+
entityIdentifier?: never;
|
|
2258
|
+
long?: never;
|
|
2259
|
+
string?: never;
|
|
2260
|
+
set?: never;
|
|
2261
|
+
record?: never;
|
|
2262
|
+
$unknown: [string, any];
|
|
2263
|
+
}
|
|
2264
|
+
interface Visitor<T> {
|
|
2265
|
+
boolean: (value: boolean) => T;
|
|
2266
|
+
entityIdentifier: (value: EntityIdentifier) => T;
|
|
2267
|
+
long: (value: number) => T;
|
|
2268
|
+
string: (value: string) => T;
|
|
2269
|
+
set: (value: AttributeValue[]) => T;
|
|
2270
|
+
record: (value: Record<string, AttributeValue>) => T;
|
|
2271
|
+
_: (name: string, value: any) => T;
|
|
2272
|
+
}
|
|
2273
|
+
const visit: <T>(value: AttributeValue, visitor: Visitor<T>) => T;
|
|
2274
|
+
}
|
|
2275
|
+
/**
|
|
2276
|
+
* @public
|
|
2277
|
+
* <p>Contains additional details about the context of the request. Verified Permissions evaluates this
|
|
2278
|
+
* information in an authorization request as part of the <code>when</code> and
|
|
2279
|
+
* <code>unless</code> clauses in a policy.</p>
|
|
2280
|
+
* <p>This data type is used as a request parameter for the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorized.html">IsAuthorized</a> and <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorizedWithToken.html">IsAuthorizedWithToken</a> operations.</p>
|
|
2281
|
+
* <p>Example:
|
|
2282
|
+
* <code>"context":\{"Context":\{"<KeyName1>":\{"boolean":true\},"<KeyName2>":\{"long":1234\}\}\}</code>
|
|
2283
|
+
* </p>
|
|
2284
|
+
*/
|
|
2285
|
+
export type ContextDefinition = ContextDefinition.ContextMapMember | ContextDefinition.$UnknownMember;
|
|
2286
|
+
/**
|
|
2287
|
+
* @public
|
|
2288
|
+
*/
|
|
2289
|
+
export declare namespace ContextDefinition {
|
|
2290
|
+
/**
|
|
2291
|
+
* <p>An list of attributes that are needed to successfully evaluate an authorization
|
|
2292
|
+
* request. Each attribute in this array must include a map of a data type and its
|
|
2293
|
+
* value.</p>
|
|
2294
|
+
* <p>Example:
|
|
2295
|
+
* <code>"Context":\{"<KeyName1>":\{"boolean":true\},"<KeyName2>":\{"long":1234\}\}</code>
|
|
2296
|
+
* </p>
|
|
2297
|
+
*/
|
|
2298
|
+
interface ContextMapMember {
|
|
2299
|
+
contextMap: Record<string, AttributeValue>;
|
|
2300
|
+
$unknown?: never;
|
|
2301
|
+
}
|
|
2302
|
+
interface $UnknownMember {
|
|
2303
|
+
contextMap?: never;
|
|
2304
|
+
$unknown: [string, any];
|
|
2305
|
+
}
|
|
2306
|
+
interface Visitor<T> {
|
|
2307
|
+
contextMap: (value: Record<string, AttributeValue>) => T;
|
|
2308
|
+
_: (name: string, value: any) => T;
|
|
2309
|
+
}
|
|
2310
|
+
const visit: <T>(value: ContextDefinition, visitor: Visitor<T>) => T;
|
|
2311
|
+
}
|
|
2312
|
+
/**
|
|
2313
|
+
* @public
|
|
2314
|
+
* <p>Contains information about an entity that can be referenced in a Cedar
|
|
2315
|
+
* policy.</p>
|
|
2316
|
+
* <p>This data type is used as one of the fields in the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_EntitiesDefinition.html">EntitiesDefinition</a>
|
|
2317
|
+
* structure.</p>
|
|
2318
|
+
* <p>
|
|
2319
|
+
* <code>\{
|
|
2320
|
+
* "id": \{
|
|
2321
|
+
* "entityType": "Photo",
|
|
2322
|
+
* "entityId": "VacationPhoto94.jpg"
|
|
2323
|
+
* \},
|
|
2324
|
+
* "Attributes": \{\},
|
|
2325
|
+
* "Parents": [
|
|
2326
|
+
* \{
|
|
2327
|
+
* "entityType": "Album",
|
|
2328
|
+
* "entityId": "alice_folder"
|
|
2329
|
+
* \}
|
|
2330
|
+
* ]
|
|
2331
|
+
* \}</code>
|
|
2332
|
+
* </p>
|
|
2333
|
+
*/
|
|
2334
|
+
export interface EntityItem {
|
|
2335
|
+
/**
|
|
2336
|
+
* <p>The identifier of the entity.</p>
|
|
2337
|
+
*/
|
|
2338
|
+
identifier: EntityIdentifier | undefined;
|
|
2339
|
+
/**
|
|
2340
|
+
* <p>A list of attributes for the entity.</p>
|
|
2341
|
+
*/
|
|
2342
|
+
attributes?: Record<string, AttributeValue>;
|
|
2343
|
+
/**
|
|
2344
|
+
* <p>The parents in the hierarchy that contains the entity.</p>
|
|
2345
|
+
*/
|
|
2346
|
+
parents?: EntityIdentifier[];
|
|
2347
|
+
}
|
|
2348
|
+
/**
|
|
2349
|
+
* @public
|
|
2350
|
+
* <p>Contains the list of entities to be considered during an authorization request. This
|
|
2351
|
+
* includes all principals, resources, and actions required to successfully evaluate the
|
|
2352
|
+
* request.</p>
|
|
2353
|
+
* <p>This data type is used as a field in the response parameter for the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorized.html">IsAuthorized</a>
|
|
2354
|
+
* and <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorizedWithToken.html">IsAuthorizedWithToken</a> operations.</p>
|
|
2355
|
+
*/
|
|
2356
|
+
export type EntitiesDefinition = EntitiesDefinition.EntityListMember | EntitiesDefinition.$UnknownMember;
|
|
2357
|
+
/**
|
|
2358
|
+
* @public
|
|
2359
|
+
*/
|
|
2360
|
+
export declare namespace EntitiesDefinition {
|
|
2361
|
+
/**
|
|
2362
|
+
* <p>An array of entities that are needed to successfully evaluate an authorization
|
|
2363
|
+
* request. Each entity in this array must include an identifier for the entity, the
|
|
2364
|
+
* attributes of the entity, and a list of any parent entities.</p>
|
|
2365
|
+
*/
|
|
2366
|
+
interface EntityListMember {
|
|
2367
|
+
entityList: EntityItem[];
|
|
2368
|
+
$unknown?: never;
|
|
2369
|
+
}
|
|
2370
|
+
interface $UnknownMember {
|
|
2371
|
+
entityList?: never;
|
|
2372
|
+
$unknown: [string, any];
|
|
2373
|
+
}
|
|
2374
|
+
interface Visitor<T> {
|
|
2375
|
+
entityList: (value: EntityItem[]) => T;
|
|
2376
|
+
_: (name: string, value: any) => T;
|
|
2377
|
+
}
|
|
2378
|
+
const visit: <T>(value: EntitiesDefinition, visitor: Visitor<T>) => T;
|
|
2379
|
+
}
|
|
2380
|
+
/**
|
|
2381
|
+
* @public
|
|
2382
|
+
*/
|
|
2383
|
+
export interface IsAuthorizedInput {
|
|
2384
|
+
/**
|
|
2385
|
+
* <p>Specifies the ID of the policy store. Policies in this policy store will be used to make an
|
|
2386
|
+
* authorization decision for the input.</p>
|
|
2387
|
+
*/
|
|
2388
|
+
policyStoreId: string | undefined;
|
|
2389
|
+
/**
|
|
2390
|
+
* <p>Specifies the principal for which the authorization decision is to be made.</p>
|
|
2391
|
+
*/
|
|
2392
|
+
principal?: EntityIdentifier;
|
|
2393
|
+
/**
|
|
2394
|
+
* <p>Specifies the requested action to be authorized. For example, is the principal
|
|
2395
|
+
* authorized to perform this action on the resource?</p>
|
|
2396
|
+
*/
|
|
2397
|
+
action?: ActionIdentifier;
|
|
2398
|
+
/**
|
|
2399
|
+
* <p>Specifies the resource for which the authorization decision is to be made.</p>
|
|
2400
|
+
*/
|
|
2401
|
+
resource?: EntityIdentifier;
|
|
2402
|
+
/**
|
|
2403
|
+
* <p>Specifies additional context that can be used to make more granular authorization
|
|
2404
|
+
* decisions.</p>
|
|
2405
|
+
*/
|
|
2406
|
+
context?: ContextDefinition;
|
|
2407
|
+
/**
|
|
2408
|
+
* <p>Specifies the list of entities and their associated attributes that Verified Permissions can examine
|
|
2409
|
+
* when evaluating the policies.</p>
|
|
2410
|
+
*/
|
|
2411
|
+
entities?: EntitiesDefinition;
|
|
2412
|
+
}
|
|
2413
|
+
/**
|
|
2414
|
+
* @public
|
|
2415
|
+
*/
|
|
2416
|
+
export interface IsAuthorizedWithTokenInput {
|
|
2417
|
+
/**
|
|
2418
|
+
* <p>Specifies the ID of the policy store. Policies in this policy store will be used to make an
|
|
2419
|
+
* authorization decision for the input.</p>
|
|
2420
|
+
*/
|
|
2421
|
+
policyStoreId: string | undefined;
|
|
2422
|
+
/**
|
|
2423
|
+
* <p>Specifies an identity token for the principal to be authorized. This token is provided
|
|
2424
|
+
* to you by the identity provider (IdP) associated with the specified identity source. You must
|
|
2425
|
+
* specify either an <code>AccessToken</code> or an <code>IdentityToken</code>, but not
|
|
2426
|
+
* both.</p>
|
|
2427
|
+
*/
|
|
2428
|
+
identityToken?: string;
|
|
2429
|
+
/**
|
|
2430
|
+
* <p>Specifies an access token for the principal to be authorized. This token is provided
|
|
2431
|
+
* to you by the identity provider (IdP) associated with the specified identity source. You must
|
|
2432
|
+
* specify either an <code>AccessToken</code> or an <code>IdentityToken</code>, but not
|
|
2433
|
+
* both.</p>
|
|
2434
|
+
*/
|
|
2435
|
+
accessToken?: string;
|
|
2436
|
+
/**
|
|
2437
|
+
* <p>Specifies the requested action to be authorized. Is the specified principal authorized
|
|
2438
|
+
* to perform this action on the specified resource.</p>
|
|
2439
|
+
*/
|
|
2440
|
+
action?: ActionIdentifier;
|
|
2441
|
+
/**
|
|
2442
|
+
* <p>Specifies the resource for which the authorization decision is made. For example, is
|
|
2443
|
+
* the principal allowed to perform the action on the resource?</p>
|
|
2444
|
+
*/
|
|
2445
|
+
resource?: EntityIdentifier;
|
|
2446
|
+
/**
|
|
2447
|
+
* <p>Specifies additional context that can be used to make more granular authorization
|
|
2448
|
+
* decisions.</p>
|
|
2449
|
+
*/
|
|
2450
|
+
context?: ContextDefinition;
|
|
2451
|
+
/**
|
|
2452
|
+
* <p>Specifies the list of entities and their associated attributes that Verified Permissions can examine
|
|
2453
|
+
* when evaluating the policies.</p>
|
|
2454
|
+
*/
|
|
2455
|
+
entities?: EntitiesDefinition;
|
|
2456
|
+
}
|