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