@aws-sdk/client-verifiedpermissions 3.1013.0 → 3.1014.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/README.md +28 -0
- package/dist-cjs/index.js +67 -0
- package/dist-cjs/schemas/schemas_0.js +116 -30
- package/dist-es/VerifiedPermissions.js +10 -0
- package/dist-es/commands/CreatePolicyStoreAliasCommand.js +16 -0
- package/dist-es/commands/DeletePolicyStoreAliasCommand.js +16 -0
- package/dist-es/commands/GetPolicyStoreAliasCommand.js +16 -0
- package/dist-es/commands/ListPolicyStoreAliasesCommand.js +16 -0
- package/dist-es/commands/index.js +4 -0
- package/dist-es/models/enums.js +6 -0
- package/dist-es/pagination/ListPolicyStoreAliasesPaginator.js +4 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/schemas/schemas_0.js +112 -26
- package/dist-types/VerifiedPermissions.d.ts +36 -0
- package/dist-types/VerifiedPermissionsClient.d.ts +6 -2
- package/dist-types/commands/BatchGetPolicyCommand.d.ts +58 -1
- package/dist-types/commands/CreateIdentitySourceCommand.d.ts +1 -1
- package/dist-types/commands/CreatePolicyCommand.d.ts +4 -35
- package/dist-types/commands/CreatePolicyStoreAliasCommand.d.ts +118 -0
- package/dist-types/commands/CreatePolicyStoreCommand.d.ts +1 -1
- package/dist-types/commands/CreatePolicyTemplateCommand.d.ts +3 -1
- package/dist-types/commands/DeleteIdentitySourceCommand.d.ts +1 -1
- package/dist-types/commands/DeletePolicyCommand.d.ts +1 -1
- package/dist-types/commands/DeletePolicyStoreAliasCommand.d.ts +100 -0
- package/dist-types/commands/DeletePolicyTemplateCommand.d.ts +1 -1
- package/dist-types/commands/GetPolicyCommand.d.ts +32 -0
- package/dist-types/commands/GetPolicyStoreAliasCommand.d.ts +112 -0
- package/dist-types/commands/GetPolicyTemplateCommand.d.ts +29 -0
- package/dist-types/commands/ListPoliciesCommand.d.ts +3 -0
- package/dist-types/commands/ListPolicyStoreAliasesCommand.d.ts +166 -0
- package/dist-types/commands/ListPolicyTemplatesCommand.d.ts +3 -0
- package/dist-types/commands/PutSchemaCommand.d.ts +1 -1
- package/dist-types/commands/UpdateIdentitySourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdatePolicyCommand.d.ts +3 -1
- package/dist-types/commands/UpdatePolicyStoreCommand.d.ts +1 -1
- package/dist-types/commands/UpdatePolicyTemplateCommand.d.ts +3 -1
- package/dist-types/commands/index.d.ts +4 -0
- package/dist-types/models/enums.d.ts +14 -0
- package/dist-types/models/errors.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +250 -33
- package/dist-types/pagination/ListPolicyStoreAliasesPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/schemas/schemas_0.d.ts +14 -0
- package/dist-types/ts3.4/VerifiedPermissions.d.ts +76 -0
- package/dist-types/ts3.4/VerifiedPermissionsClient.d.ts +24 -0
- package/dist-types/ts3.4/commands/CreatePolicyStoreAliasCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeletePolicyStoreAliasCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetPolicyStoreAliasCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListPolicyStoreAliasesCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/index.d.ts +4 -0
- package/dist-types/ts3.4/models/enums.d.ts +7 -0
- package/dist-types/ts3.4/models/models_0.d.ts +53 -0
- package/dist-types/ts3.4/pagination/ListPolicyStoreAliasesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +14 -0
- package/package.json +12 -12
|
@@ -0,0 +1,112 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { GetPolicyStoreAliasInput, GetPolicyStoreAliasOutput } from "../models/models_0";
|
|
4
|
+
import type { ServiceInputTypes, ServiceOutputTypes, VerifiedPermissionsClientResolvedConfig } from "../VerifiedPermissionsClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetPolicyStoreAliasCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetPolicyStoreAliasCommandInput extends GetPolicyStoreAliasInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetPolicyStoreAliasCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetPolicyStoreAliasCommandOutput extends GetPolicyStoreAliasOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetPolicyStoreAliasCommand_base: {
|
|
25
|
+
new (input: GetPolicyStoreAliasCommandInput): import("@smithy/smithy-client").CommandImpl<GetPolicyStoreAliasCommandInput, GetPolicyStoreAliasCommandOutput, VerifiedPermissionsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: GetPolicyStoreAliasCommandInput): import("@smithy/smithy-client").CommandImpl<GetPolicyStoreAliasCommandInput, GetPolicyStoreAliasCommandOutput, VerifiedPermissionsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Retrieves details about the specified policy store alias.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { VerifiedPermissionsClient, GetPolicyStoreAliasCommand } from "@aws-sdk/client-verifiedpermissions"; // ES Modules import
|
|
35
|
+
* // const { VerifiedPermissionsClient, GetPolicyStoreAliasCommand } = require("@aws-sdk/client-verifiedpermissions"); // CommonJS import
|
|
36
|
+
* // import type { VerifiedPermissionsClientConfig } from "@aws-sdk/client-verifiedpermissions";
|
|
37
|
+
* const config = {}; // type is VerifiedPermissionsClientConfig
|
|
38
|
+
* const client = new VerifiedPermissionsClient(config);
|
|
39
|
+
* const input = { // GetPolicyStoreAliasInput
|
|
40
|
+
* aliasName: "STRING_VALUE", // required
|
|
41
|
+
* };
|
|
42
|
+
* const command = new GetPolicyStoreAliasCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // { // GetPolicyStoreAliasOutput
|
|
45
|
+
* // aliasName: "STRING_VALUE", // required
|
|
46
|
+
* // policyStoreId: "STRING_VALUE", // required
|
|
47
|
+
* // aliasArn: "STRING_VALUE", // required
|
|
48
|
+
* // createdAt: new Date("TIMESTAMP"), // required
|
|
49
|
+
* // state: "Active" || "PendingDeletion", // required
|
|
50
|
+
* // };
|
|
51
|
+
*
|
|
52
|
+
* ```
|
|
53
|
+
*
|
|
54
|
+
* @param GetPolicyStoreAliasCommandInput - {@link GetPolicyStoreAliasCommandInput}
|
|
55
|
+
* @returns {@link GetPolicyStoreAliasCommandOutput}
|
|
56
|
+
* @see {@link GetPolicyStoreAliasCommandInput} for command's `input` shape.
|
|
57
|
+
* @see {@link GetPolicyStoreAliasCommandOutput} for command's `response` shape.
|
|
58
|
+
* @see {@link VerifiedPermissionsClientResolvedConfig | config} for VerifiedPermissionsClient's `config` shape.
|
|
59
|
+
*
|
|
60
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
61
|
+
* <p>The request failed because it references a resource that doesn't exist.</p>
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
64
|
+
* <p>You don't have sufficient access to perform this action.</p>
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link InternalServerException} (server fault)
|
|
67
|
+
* <p>The request failed because of an internal error. Try your request again later</p>
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
70
|
+
* <p>The request failed because it exceeded a throttling quota.</p>
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link ValidationException} (client fault)
|
|
73
|
+
* <p>The request failed because one or more input parameters don't satisfy their constraint requirements. The output is provided as a list of fields and a reason for each field that isn't valid.</p> <p>The possible reasons include the following:</p> <ul> <li> <p> <b>UnrecognizedEntityType</b> </p> <p>The policy includes an entity type that isn't found in the schema.</p> </li> <li> <p> <b>UnrecognizedActionId</b> </p> <p>The policy includes an action id that isn't found in the schema.</p> </li> <li> <p> <b>InvalidActionApplication</b> </p> <p>The policy includes an action that, according to the schema, doesn't support the specified principal and resource.</p> </li> <li> <p> <b>UnexpectedType</b> </p> <p>The policy included an operand that isn't a valid type for the specified operation.</p> </li> <li> <p> <b>IncompatibleTypes</b> </p> <p>The types of elements included in a <code>set</code>, or the types of expressions used in an <code>if...then...else</code> clause aren't compatible in this context.</p> </li> <li> <p> <b>MissingAttribute</b> </p> <p>The policy attempts to access a record or entity attribute that isn't specified in the schema. Test for the existence of the attribute first before attempting to access its value. For more information, see the <a href="https://docs.cedarpolicy.com/policies/syntax-operators.html#has-presence-of-attribute-test">has (presence of attribute test) operator</a> in the <i>Cedar Policy Language Guide</i>.</p> </li> <li> <p> <b>UnsafeOptionalAttributeAccess</b> </p> <p>The policy attempts to access a record or entity attribute that is optional and isn't guaranteed to be present. Test for the existence of the attribute first before attempting to access its value. For more information, see the <a href="https://docs.cedarpolicy.com/policies/syntax-operators.html#has-presence-of-attribute-test">has (presence of attribute test) operator</a> in the <i>Cedar Policy Language Guide</i>.</p> </li> <li> <p> <b>ImpossiblePolicy</b> </p> <p>Cedar has determined that a policy condition always evaluates to false. If the policy is always false, it can never apply to any query, and so it can never affect an authorization decision.</p> </li> <li> <p> <b>WrongNumberArguments</b> </p> <p>The policy references an extension type with the wrong number of arguments.</p> </li> <li> <p> <b>FunctionArgumentValidationError</b> </p> <p>Cedar couldn't parse the argument passed to an extension type. For example, a string that is to be parsed as an IPv4 address can contain only digits and the period character.</p> </li> </ul>
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link VerifiedPermissionsServiceException}
|
|
76
|
+
* <p>Base exception class for all service exceptions from VerifiedPermissions service.</p>
|
|
77
|
+
*
|
|
78
|
+
*
|
|
79
|
+
* @example GetPolicyStoreAlias
|
|
80
|
+
* ```javascript
|
|
81
|
+
* // The following example retrieves details about the policy store alias with name example-policy-store.
|
|
82
|
+
* const input = {
|
|
83
|
+
* aliasName: "policy-store-alias/example-policy-store"
|
|
84
|
+
* };
|
|
85
|
+
* const command = new GetPolicyStoreAliasCommand(input);
|
|
86
|
+
* const response = await client.send(command);
|
|
87
|
+
* /* response is
|
|
88
|
+
* {
|
|
89
|
+
* aliasArn: "arn:aws:verifiedpermissions:us-east-1:123456789012:policy-store-alias/example-policy-store",
|
|
90
|
+
* aliasName: "policy-store-alias/example-policy-store",
|
|
91
|
+
* createdAt: "2024-01-15T12:30:00.52Z",
|
|
92
|
+
* policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a",
|
|
93
|
+
* state: "Active"
|
|
94
|
+
* }
|
|
95
|
+
* *\/
|
|
96
|
+
* ```
|
|
97
|
+
*
|
|
98
|
+
* @public
|
|
99
|
+
*/
|
|
100
|
+
export declare class GetPolicyStoreAliasCommand extends GetPolicyStoreAliasCommand_base {
|
|
101
|
+
/** @internal type navigation helper, not in runtime. */
|
|
102
|
+
protected static __types: {
|
|
103
|
+
api: {
|
|
104
|
+
input: GetPolicyStoreAliasInput;
|
|
105
|
+
output: GetPolicyStoreAliasOutput;
|
|
106
|
+
};
|
|
107
|
+
sdk: {
|
|
108
|
+
input: GetPolicyStoreAliasCommandInput;
|
|
109
|
+
output: GetPolicyStoreAliasCommandOutput;
|
|
110
|
+
};
|
|
111
|
+
};
|
|
112
|
+
}
|
|
@@ -49,6 +49,7 @@ declare const GetPolicyTemplateCommand_base: {
|
|
|
49
49
|
* // statement: "STRING_VALUE", // required
|
|
50
50
|
* // createdDate: new Date("TIMESTAMP"), // required
|
|
51
51
|
* // lastUpdatedDate: new Date("TIMESTAMP"), // required
|
|
52
|
+
* // name: "STRING_VALUE",
|
|
52
53
|
* // };
|
|
53
54
|
*
|
|
54
55
|
* ```
|
|
@@ -105,6 +106,34 @@ declare const GetPolicyTemplateCommand_base: {
|
|
|
105
106
|
* *\/
|
|
106
107
|
* ```
|
|
107
108
|
*
|
|
109
|
+
* @example To retrieve a policy template by name
|
|
110
|
+
* ```javascript
|
|
111
|
+
* // The following example retrieves the details of a policy template using its name instead of its ID.
|
|
112
|
+
* const input = {
|
|
113
|
+
* policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a",
|
|
114
|
+
* policyTemplateId: "name/example-policy-template"
|
|
115
|
+
* };
|
|
116
|
+
* const command = new GetPolicyTemplateCommand(input);
|
|
117
|
+
* const response = await client.send(command);
|
|
118
|
+
* /* response is
|
|
119
|
+
* {
|
|
120
|
+
* createdDate: "2024-08-12T18:20:50.99Z",
|
|
121
|
+
* description: "Template for research dept",
|
|
122
|
+
* lastUpdatedDate: "2024-08-12T18:20:50.99Z",
|
|
123
|
+
* name: "name/example-policy-template",
|
|
124
|
+
* policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a",
|
|
125
|
+
* policyTemplateId: "PTEXAMPLEabcdefg111111",
|
|
126
|
+
* statement: `permit(
|
|
127
|
+
* principal ?principal,
|
|
128
|
+
* action == Action::"view",
|
|
129
|
+
* resource in ?resource
|
|
130
|
+
* ) when {
|
|
131
|
+
* principal has department && principal.department == "research"
|
|
132
|
+
* };`
|
|
133
|
+
* }
|
|
134
|
+
* *\/
|
|
135
|
+
* ```
|
|
136
|
+
*
|
|
108
137
|
* @public
|
|
109
138
|
*/
|
|
110
139
|
export declare class GetPolicyTemplateCommand extends GetPolicyTemplateCommand_base {
|
|
@@ -101,6 +101,7 @@ declare const ListPoliciesCommand_base: {
|
|
|
101
101
|
* // createdDate: new Date("TIMESTAMP"), // required
|
|
102
102
|
* // lastUpdatedDate: new Date("TIMESTAMP"), // required
|
|
103
103
|
* // effect: "Permit" || "Forbid",
|
|
104
|
+
* // name: "STRING_VALUE",
|
|
104
105
|
* // },
|
|
105
106
|
* // ],
|
|
106
107
|
* // };
|
|
@@ -151,6 +152,7 @@ declare const ListPoliciesCommand_base: {
|
|
|
151
152
|
* }
|
|
152
153
|
* },
|
|
153
154
|
* lastUpdatedDate: "2024-08-12T18:20:50.99Z",
|
|
155
|
+
* name: "name/example-policy",
|
|
154
156
|
* policyId: "9wYxMpljbbZQb5fcZHyJhY",
|
|
155
157
|
* policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a",
|
|
156
158
|
* policyType: "STATIC",
|
|
@@ -171,6 +173,7 @@ declare const ListPoliciesCommand_base: {
|
|
|
171
173
|
* }
|
|
172
174
|
* },
|
|
173
175
|
* lastUpdatedDate: "2024-08-12T18:20:50.99Z",
|
|
176
|
+
* name: "name/example-policy-2",
|
|
174
177
|
* policyId: "Et9KxMplyaDdyurDw8TeFa",
|
|
175
178
|
* policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a",
|
|
176
179
|
* policyType: "STATIC",
|
|
@@ -0,0 +1,166 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { ListPolicyStoreAliasesInput, ListPolicyStoreAliasesOutput } from "../models/models_0";
|
|
4
|
+
import type { ServiceInputTypes, ServiceOutputTypes, VerifiedPermissionsClientResolvedConfig } from "../VerifiedPermissionsClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListPolicyStoreAliasesCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListPolicyStoreAliasesCommandInput extends ListPolicyStoreAliasesInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListPolicyStoreAliasesCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListPolicyStoreAliasesCommandOutput extends ListPolicyStoreAliasesOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListPolicyStoreAliasesCommand_base: {
|
|
25
|
+
new (input: ListPolicyStoreAliasesCommandInput): import("@smithy/smithy-client").CommandImpl<ListPolicyStoreAliasesCommandInput, ListPolicyStoreAliasesCommandOutput, VerifiedPermissionsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (...[input]: [] | [ListPolicyStoreAliasesCommandInput]): import("@smithy/smithy-client").CommandImpl<ListPolicyStoreAliasesCommandInput, ListPolicyStoreAliasesCommandOutput, VerifiedPermissionsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Returns a paginated list of all policy store aliases in the calling Amazon Web Services account.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { VerifiedPermissionsClient, ListPolicyStoreAliasesCommand } from "@aws-sdk/client-verifiedpermissions"; // ES Modules import
|
|
35
|
+
* // const { VerifiedPermissionsClient, ListPolicyStoreAliasesCommand } = require("@aws-sdk/client-verifiedpermissions"); // CommonJS import
|
|
36
|
+
* // import type { VerifiedPermissionsClientConfig } from "@aws-sdk/client-verifiedpermissions";
|
|
37
|
+
* const config = {}; // type is VerifiedPermissionsClientConfig
|
|
38
|
+
* const client = new VerifiedPermissionsClient(config);
|
|
39
|
+
* const input = { // ListPolicyStoreAliasesInput
|
|
40
|
+
* nextToken: "STRING_VALUE",
|
|
41
|
+
* maxResults: Number("int"),
|
|
42
|
+
* filter: { // PolicyStoreAliasFilter
|
|
43
|
+
* policyStoreId: "STRING_VALUE",
|
|
44
|
+
* },
|
|
45
|
+
* };
|
|
46
|
+
* const command = new ListPolicyStoreAliasesCommand(input);
|
|
47
|
+
* const response = await client.send(command);
|
|
48
|
+
* // { // ListPolicyStoreAliasesOutput
|
|
49
|
+
* // nextToken: "STRING_VALUE",
|
|
50
|
+
* // policyStoreAliases: [ // PolicyStoreAliasList // required
|
|
51
|
+
* // { // PolicyStoreAliasItem
|
|
52
|
+
* // aliasName: "STRING_VALUE", // required
|
|
53
|
+
* // policyStoreId: "STRING_VALUE", // required
|
|
54
|
+
* // aliasArn: "STRING_VALUE", // required
|
|
55
|
+
* // createdAt: new Date("TIMESTAMP"), // required
|
|
56
|
+
* // state: "Active" || "PendingDeletion", // required
|
|
57
|
+
* // },
|
|
58
|
+
* // ],
|
|
59
|
+
* // };
|
|
60
|
+
*
|
|
61
|
+
* ```
|
|
62
|
+
*
|
|
63
|
+
* @param ListPolicyStoreAliasesCommandInput - {@link ListPolicyStoreAliasesCommandInput}
|
|
64
|
+
* @returns {@link ListPolicyStoreAliasesCommandOutput}
|
|
65
|
+
* @see {@link ListPolicyStoreAliasesCommandInput} for command's `input` shape.
|
|
66
|
+
* @see {@link ListPolicyStoreAliasesCommandOutput} for command's `response` shape.
|
|
67
|
+
* @see {@link VerifiedPermissionsClientResolvedConfig | config} for VerifiedPermissionsClient's `config` shape.
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
70
|
+
* <p>You don't have sufficient access to perform this action.</p>
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link InternalServerException} (server fault)
|
|
73
|
+
* <p>The request failed because of an internal error. Try your request again later</p>
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
76
|
+
* <p>The request failed because it exceeded a throttling quota.</p>
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link ValidationException} (client fault)
|
|
79
|
+
* <p>The request failed because one or more input parameters don't satisfy their constraint requirements. The output is provided as a list of fields and a reason for each field that isn't valid.</p> <p>The possible reasons include the following:</p> <ul> <li> <p> <b>UnrecognizedEntityType</b> </p> <p>The policy includes an entity type that isn't found in the schema.</p> </li> <li> <p> <b>UnrecognizedActionId</b> </p> <p>The policy includes an action id that isn't found in the schema.</p> </li> <li> <p> <b>InvalidActionApplication</b> </p> <p>The policy includes an action that, according to the schema, doesn't support the specified principal and resource.</p> </li> <li> <p> <b>UnexpectedType</b> </p> <p>The policy included an operand that isn't a valid type for the specified operation.</p> </li> <li> <p> <b>IncompatibleTypes</b> </p> <p>The types of elements included in a <code>set</code>, or the types of expressions used in an <code>if...then...else</code> clause aren't compatible in this context.</p> </li> <li> <p> <b>MissingAttribute</b> </p> <p>The policy attempts to access a record or entity attribute that isn't specified in the schema. Test for the existence of the attribute first before attempting to access its value. For more information, see the <a href="https://docs.cedarpolicy.com/policies/syntax-operators.html#has-presence-of-attribute-test">has (presence of attribute test) operator</a> in the <i>Cedar Policy Language Guide</i>.</p> </li> <li> <p> <b>UnsafeOptionalAttributeAccess</b> </p> <p>The policy attempts to access a record or entity attribute that is optional and isn't guaranteed to be present. Test for the existence of the attribute first before attempting to access its value. For more information, see the <a href="https://docs.cedarpolicy.com/policies/syntax-operators.html#has-presence-of-attribute-test">has (presence of attribute test) operator</a> in the <i>Cedar Policy Language Guide</i>.</p> </li> <li> <p> <b>ImpossiblePolicy</b> </p> <p>Cedar has determined that a policy condition always evaluates to false. If the policy is always false, it can never apply to any query, and so it can never affect an authorization decision.</p> </li> <li> <p> <b>WrongNumberArguments</b> </p> <p>The policy references an extension type with the wrong number of arguments.</p> </li> <li> <p> <b>FunctionArgumentValidationError</b> </p> <p>Cedar couldn't parse the argument passed to an extension type. For example, a string that is to be parsed as an IPv4 address can contain only digits and the period character.</p> </li> </ul>
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link VerifiedPermissionsServiceException}
|
|
82
|
+
* <p>Base exception class for all service exceptions from VerifiedPermissions service.</p>
|
|
83
|
+
*
|
|
84
|
+
*
|
|
85
|
+
* @example ListPolicyStoreAliases - Example 1
|
|
86
|
+
* ```javascript
|
|
87
|
+
* // The following example lists all policy store aliases in the AWS account in the AWS Region in which you call the operation.
|
|
88
|
+
* const input = { /* empty *\/ };
|
|
89
|
+
* const command = new ListPolicyStoreAliasesCommand(input);
|
|
90
|
+
* const response = await client.send(command);
|
|
91
|
+
* /* response is
|
|
92
|
+
* {
|
|
93
|
+
* policyStoreAliases: [
|
|
94
|
+
* {
|
|
95
|
+
* aliasArn: "arn:aws:verifiedpermissions:us-east-1:123456789012:policy-store-alias/example-policy-store",
|
|
96
|
+
* aliasName: "policy-store-alias/example-policy-store",
|
|
97
|
+
* createdAt: "2024-01-15T12:30:00.52Z",
|
|
98
|
+
* policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a",
|
|
99
|
+
* state: "Active"
|
|
100
|
+
* },
|
|
101
|
+
* {
|
|
102
|
+
* aliasArn: "arn:aws:verifiedpermissions:us-east-1:123456789012:policy-store-alias/example-policy-store-2",
|
|
103
|
+
* aliasName: "policy-store-alias/example-policy-store-2",
|
|
104
|
+
* createdAt: "2024-01-16T09:15:00.52Z",
|
|
105
|
+
* policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a",
|
|
106
|
+
* state: "Active"
|
|
107
|
+
* },
|
|
108
|
+
* {
|
|
109
|
+
* aliasArn: "arn:aws:verifiedpermissions:us-east-1:123456789012:policy-store-alias/example-policy-store-3",
|
|
110
|
+
* aliasName: "policy-store-alias/example-policy-store-3",
|
|
111
|
+
* createdAt: "2024-01-17T14:45:00.52Z",
|
|
112
|
+
* policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a",
|
|
113
|
+
* state: "Active"
|
|
114
|
+
* }
|
|
115
|
+
* ]
|
|
116
|
+
* }
|
|
117
|
+
* *\/
|
|
118
|
+
* ```
|
|
119
|
+
*
|
|
120
|
+
* @example ListPolicyStoreAliases - Example 2
|
|
121
|
+
* ```javascript
|
|
122
|
+
* // The following example lists all policy store aliases associated with the policy store with ID C7v5xMplfFH3i3e4Jrzb1a
|
|
123
|
+
* const input = {
|
|
124
|
+
* filter: {
|
|
125
|
+
* policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a"
|
|
126
|
+
* }
|
|
127
|
+
* };
|
|
128
|
+
* const command = new ListPolicyStoreAliasesCommand(input);
|
|
129
|
+
* const response = await client.send(command);
|
|
130
|
+
* /* response is
|
|
131
|
+
* {
|
|
132
|
+
* policyStoreAliases: [
|
|
133
|
+
* {
|
|
134
|
+
* aliasArn: "arn:aws:verifiedpermissions:us-east-1:123456789012:policy-store-alias/example-policy-store",
|
|
135
|
+
* aliasName: "policy-store-alias/example-policy-store",
|
|
136
|
+
* createdAt: "2024-01-15T12:30:00.52Z",
|
|
137
|
+
* policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a",
|
|
138
|
+
* state: "Active"
|
|
139
|
+
* },
|
|
140
|
+
* {
|
|
141
|
+
* aliasArn: "arn:aws:verifiedpermissions:us-east-1:123456789012:policy-store-alias/example-policy-store-2",
|
|
142
|
+
* aliasName: "policy-store-alias/example-policy-store-2",
|
|
143
|
+
* createdAt: "2024-01-16T09:15:00.52Z",
|
|
144
|
+
* policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a",
|
|
145
|
+
* state: "Active"
|
|
146
|
+
* }
|
|
147
|
+
* ]
|
|
148
|
+
* }
|
|
149
|
+
* *\/
|
|
150
|
+
* ```
|
|
151
|
+
*
|
|
152
|
+
* @public
|
|
153
|
+
*/
|
|
154
|
+
export declare class ListPolicyStoreAliasesCommand extends ListPolicyStoreAliasesCommand_base {
|
|
155
|
+
/** @internal type navigation helper, not in runtime. */
|
|
156
|
+
protected static __types: {
|
|
157
|
+
api: {
|
|
158
|
+
input: ListPolicyStoreAliasesInput;
|
|
159
|
+
output: ListPolicyStoreAliasesOutput;
|
|
160
|
+
};
|
|
161
|
+
sdk: {
|
|
162
|
+
input: ListPolicyStoreAliasesCommandInput;
|
|
163
|
+
output: ListPolicyStoreAliasesCommandOutput;
|
|
164
|
+
};
|
|
165
|
+
};
|
|
166
|
+
}
|
|
@@ -52,6 +52,7 @@ declare const ListPolicyTemplatesCommand_base: {
|
|
|
52
52
|
* // description: "STRING_VALUE",
|
|
53
53
|
* // createdDate: new Date("TIMESTAMP"), // required
|
|
54
54
|
* // lastUpdatedDate: new Date("TIMESTAMP"), // required
|
|
55
|
+
* // name: "STRING_VALUE",
|
|
55
56
|
* // },
|
|
56
57
|
* // ],
|
|
57
58
|
* // };
|
|
@@ -98,6 +99,7 @@ declare const ListPolicyTemplatesCommand_base: {
|
|
|
98
99
|
* createdDate: "2024-08-12T18:20:50.99Z",
|
|
99
100
|
* description: "Generic template",
|
|
100
101
|
* lastUpdatedDate: "2024-08-12T18:20:50.99Z",
|
|
102
|
+
* name: "name/example-policy-template",
|
|
101
103
|
* policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a",
|
|
102
104
|
* policyTemplateId: "PTEXAMPLEabcdefg111111"
|
|
103
105
|
* },
|
|
@@ -105,6 +107,7 @@ declare const ListPolicyTemplatesCommand_base: {
|
|
|
105
107
|
* createdDate: "2024-08-12T18:20:50.99Z",
|
|
106
108
|
* description: "Template for research dept",
|
|
107
109
|
* lastUpdatedDate: "2024-08-12T18:20:50.99Z",
|
|
110
|
+
* name: "name/example-policy-template-2",
|
|
108
111
|
* policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a",
|
|
109
112
|
* policyTemplateId: "PTEXAMPLEabcdefg222222"
|
|
110
113
|
* }
|
|
@@ -62,7 +62,7 @@ declare const PutSchemaCommand_base: {
|
|
|
62
62
|
* @see {@link VerifiedPermissionsClientResolvedConfig | config} for VerifiedPermissionsClient's `config` shape.
|
|
63
63
|
*
|
|
64
64
|
* @throws {@link ConflictException} (client fault)
|
|
65
|
-
* <p>The request failed because another request to modify a resource occurred at the same.</p>
|
|
65
|
+
* <p>The request failed because another request to modify a resource occurred at the same time.</p>
|
|
66
66
|
*
|
|
67
67
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
68
68
|
* <p>The request failed because it references a resource that doesn't exist.</p>
|
|
@@ -92,7 +92,7 @@ declare const UpdateIdentitySourceCommand_base: {
|
|
|
92
92
|
* @see {@link VerifiedPermissionsClientResolvedConfig | config} for VerifiedPermissionsClient's `config` shape.
|
|
93
93
|
*
|
|
94
94
|
* @throws {@link ConflictException} (client fault)
|
|
95
|
-
* <p>The request failed because another request to modify a resource occurred at the same.</p>
|
|
95
|
+
* <p>The request failed because another request to modify a resource occurred at the same time.</p>
|
|
96
96
|
*
|
|
97
97
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
98
98
|
* <p>The request failed because it references a resource that doesn't exist.</p>
|
|
@@ -45,6 +45,7 @@ declare const UpdatePolicyCommand_base: {
|
|
|
45
45
|
* statement: "STRING_VALUE", // required
|
|
46
46
|
* },
|
|
47
47
|
* },
|
|
48
|
+
* name: "STRING_VALUE",
|
|
48
49
|
* };
|
|
49
50
|
* const command = new UpdatePolicyCommand(input);
|
|
50
51
|
* const response = await client.send(command);
|
|
@@ -80,7 +81,7 @@ declare const UpdatePolicyCommand_base: {
|
|
|
80
81
|
* @see {@link VerifiedPermissionsClientResolvedConfig | config} for VerifiedPermissionsClient's `config` shape.
|
|
81
82
|
*
|
|
82
83
|
* @throws {@link ConflictException} (client fault)
|
|
83
|
-
* <p>The request failed because another request to modify a resource occurred at the same.</p>
|
|
84
|
+
* <p>The request failed because another request to modify a resource occurred at the same time.</p>
|
|
84
85
|
*
|
|
85
86
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
86
87
|
* <p>The request failed because it references a resource that doesn't exist.</p>
|
|
@@ -113,6 +114,7 @@ declare const UpdatePolicyCommand_base: {
|
|
|
113
114
|
* statement: `permit(principal, action, resource in Album::"public_folder");`
|
|
114
115
|
* }
|
|
115
116
|
* },
|
|
117
|
+
* name: "name/example-policy-2",
|
|
116
118
|
* policyId: "9wYxMpljbbZQb5fcZHyJhY",
|
|
117
119
|
* policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a"
|
|
118
120
|
* };
|
|
@@ -62,7 +62,7 @@ declare const UpdatePolicyStoreCommand_base: {
|
|
|
62
62
|
* @see {@link VerifiedPermissionsClientResolvedConfig | config} for VerifiedPermissionsClient's `config` shape.
|
|
63
63
|
*
|
|
64
64
|
* @throws {@link ConflictException} (client fault)
|
|
65
|
-
* <p>The request failed because another request to modify a resource occurred at the same.</p>
|
|
65
|
+
* <p>The request failed because another request to modify a resource occurred at the same time.</p>
|
|
66
66
|
*
|
|
67
67
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
68
68
|
* <p>The request failed because it references a resource that doesn't exist.</p>
|
|
@@ -41,6 +41,7 @@ declare const UpdatePolicyTemplateCommand_base: {
|
|
|
41
41
|
* policyTemplateId: "STRING_VALUE", // required
|
|
42
42
|
* description: "STRING_VALUE",
|
|
43
43
|
* statement: "STRING_VALUE", // required
|
|
44
|
+
* name: "STRING_VALUE",
|
|
44
45
|
* };
|
|
45
46
|
* const command = new UpdatePolicyTemplateCommand(input);
|
|
46
47
|
* const response = await client.send(command);
|
|
@@ -60,7 +61,7 @@ declare const UpdatePolicyTemplateCommand_base: {
|
|
|
60
61
|
* @see {@link VerifiedPermissionsClientResolvedConfig | config} for VerifiedPermissionsClient's `config` shape.
|
|
61
62
|
*
|
|
62
63
|
* @throws {@link ConflictException} (client fault)
|
|
63
|
-
* <p>The request failed because another request to modify a resource occurred at the same.</p>
|
|
64
|
+
* <p>The request failed because another request to modify a resource occurred at the same time.</p>
|
|
64
65
|
*
|
|
65
66
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
66
67
|
* <p>The request failed because it references a resource that doesn't exist.</p>
|
|
@@ -91,6 +92,7 @@ declare const UpdatePolicyTemplateCommand_base: {
|
|
|
91
92
|
* Example strings might be displayed wrapped across multiple lines here for readability, but the operation requires the parameters be submitted as single line strings.
|
|
92
93
|
* const input = {
|
|
93
94
|
* description: "My updated template description",
|
|
95
|
+
* name: "name/example-policy-template-2",
|
|
94
96
|
* policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a",
|
|
95
97
|
* policyTemplateId: "PTEXAMPLEabcdefg111111",
|
|
96
98
|
* statement: `"ResearchAccess"
|
|
@@ -3,14 +3,17 @@ export * from "./BatchIsAuthorizedCommand";
|
|
|
3
3
|
export * from "./BatchIsAuthorizedWithTokenCommand";
|
|
4
4
|
export * from "./CreateIdentitySourceCommand";
|
|
5
5
|
export * from "./CreatePolicyCommand";
|
|
6
|
+
export * from "./CreatePolicyStoreAliasCommand";
|
|
6
7
|
export * from "./CreatePolicyStoreCommand";
|
|
7
8
|
export * from "./CreatePolicyTemplateCommand";
|
|
8
9
|
export * from "./DeleteIdentitySourceCommand";
|
|
9
10
|
export * from "./DeletePolicyCommand";
|
|
11
|
+
export * from "./DeletePolicyStoreAliasCommand";
|
|
10
12
|
export * from "./DeletePolicyStoreCommand";
|
|
11
13
|
export * from "./DeletePolicyTemplateCommand";
|
|
12
14
|
export * from "./GetIdentitySourceCommand";
|
|
13
15
|
export * from "./GetPolicyCommand";
|
|
16
|
+
export * from "./GetPolicyStoreAliasCommand";
|
|
14
17
|
export * from "./GetPolicyStoreCommand";
|
|
15
18
|
export * from "./GetPolicyTemplateCommand";
|
|
16
19
|
export * from "./GetSchemaCommand";
|
|
@@ -18,6 +21,7 @@ export * from "./IsAuthorizedCommand";
|
|
|
18
21
|
export * from "./IsAuthorizedWithTokenCommand";
|
|
19
22
|
export * from "./ListIdentitySourcesCommand";
|
|
20
23
|
export * from "./ListPoliciesCommand";
|
|
24
|
+
export * from "./ListPolicyStoreAliasesCommand";
|
|
21
25
|
export * from "./ListPolicyStoresCommand";
|
|
22
26
|
export * from "./ListPolicyTemplatesCommand";
|
|
23
27
|
export * from "./ListTagsForResourceCommand";
|
|
@@ -1,9 +1,22 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @public
|
|
3
|
+
* @enum
|
|
4
|
+
*/
|
|
5
|
+
export declare const AliasState: {
|
|
6
|
+
readonly ACTIVE: "Active";
|
|
7
|
+
readonly PENDING_DELETION: "PendingDeletion";
|
|
8
|
+
};
|
|
9
|
+
/**
|
|
10
|
+
* @public
|
|
11
|
+
*/
|
|
12
|
+
export type AliasState = (typeof AliasState)[keyof typeof AliasState];
|
|
1
13
|
/**
|
|
2
14
|
* @public
|
|
3
15
|
* @enum
|
|
4
16
|
*/
|
|
5
17
|
export declare const BatchGetPolicyErrorCode: {
|
|
6
18
|
readonly POLICY_NOT_FOUND: "POLICY_NOT_FOUND";
|
|
19
|
+
readonly POLICY_STORE_ALIAS_NOT_FOUND: "POLICY_STORE_ALIAS_NOT_FOUND";
|
|
7
20
|
readonly POLICY_STORE_NOT_FOUND: "POLICY_STORE_NOT_FOUND";
|
|
8
21
|
};
|
|
9
22
|
/**
|
|
@@ -42,6 +55,7 @@ export declare const ResourceType: {
|
|
|
42
55
|
readonly IDENTITY_SOURCE: "IDENTITY_SOURCE";
|
|
43
56
|
readonly POLICY: "POLICY";
|
|
44
57
|
readonly POLICY_STORE: "POLICY_STORE";
|
|
58
|
+
readonly POLICY_STORE_ALIAS: "POLICY_STORE_ALIAS";
|
|
45
59
|
readonly POLICY_TEMPLATE: "POLICY_TEMPLATE";
|
|
46
60
|
readonly SCHEMA: "SCHEMA";
|
|
47
61
|
};
|
|
@@ -92,7 +92,7 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
92
92
|
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
93
93
|
}
|
|
94
94
|
/**
|
|
95
|
-
* <p>The request failed because another request to modify a resource occurred at the same.</p>
|
|
95
|
+
* <p>The request failed because another request to modify a resource occurred at the same time.</p>
|
|
96
96
|
* @public
|
|
97
97
|
*/
|
|
98
98
|
export declare class ConflictException extends __BaseException {
|