1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package types
import (
smithydocument "github.com/aws/smithy-go/document"
"time"
)
// Contains information about an action for a request for which an authorization
// decision is made. This data type is used as a request parameter to the
// IsAuthorized (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorized.html)
// , BatchIsAuthorized (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_BatchIsAuthorized.html)
// , and IsAuthorizedWithToken (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorizedWithToken.html)
// operations. Example: { "actionId": "<action name>", "actionType": "Action" }
type ActionIdentifier struct {
// The ID of an action.
//
// This member is required.
ActionId *string
// The type of an action.
//
// This member is required.
ActionType *string
noSmithyDocumentSerde
}
// The value of an attribute. Contains information about the runtime context for a
// request for which an authorization decision is made. This data type is used as a
// member of the ContextDefinition (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ContextDefinition.html)
// structure which is uses as a request parameter for the IsAuthorized (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorized.html)
// , BatchIsAuthorized (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_BatchIsAuthorized.html)
// , and IsAuthorizedWithToken (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorizedWithToken.html)
// operations.
//
// The following types satisfy this interface:
//
// AttributeValueMemberBoolean
// AttributeValueMemberEntityIdentifier
// AttributeValueMemberLong
// AttributeValueMemberRecord
// AttributeValueMemberSet
// AttributeValueMemberString
type AttributeValue interface {
isAttributeValue()
}
// An attribute value of Boolean (https://docs.cedarpolicy.com/policies/syntax-datatypes.html#boolean)
// type. Example: {"boolean": true}
type AttributeValueMemberBoolean struct {
Value bool
noSmithyDocumentSerde
}
func (*AttributeValueMemberBoolean) isAttributeValue() {}
// An attribute value of type EntityIdentifier (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_EntityIdentifier.html)
// . Example: "entityIdentifier": { "entityId": "<id>", "entityType": "<entity
// type>"}
type AttributeValueMemberEntityIdentifier struct {
Value EntityIdentifier
noSmithyDocumentSerde
}
func (*AttributeValueMemberEntityIdentifier) isAttributeValue() {}
// An attribute value of Long (https://docs.cedarpolicy.com/policies/syntax-datatypes.html#long)
// type. Example: {"long": 0}
type AttributeValueMemberLong struct {
Value int64
noSmithyDocumentSerde
}
func (*AttributeValueMemberLong) isAttributeValue() {}
// An attribute value of Record (https://docs.cedarpolicy.com/policies/syntax-datatypes.html#record)
// type. Example: {"record": { "keyName": {} } }
type AttributeValueMemberRecord struct {
Value map[string]AttributeValue
noSmithyDocumentSerde
}
func (*AttributeValueMemberRecord) isAttributeValue() {}
// An attribute value of Set (https://docs.cedarpolicy.com/policies/syntax-datatypes.html#set)
// type. Example: {"set": [ {} ] }
type AttributeValueMemberSet struct {
Value []AttributeValue
noSmithyDocumentSerde
}
func (*AttributeValueMemberSet) isAttributeValue() {}
// An attribute value of String (https://docs.cedarpolicy.com/policies/syntax-datatypes.html#string)
// type. Example: {"string": "abc"}
type AttributeValueMemberString struct {
Value string
noSmithyDocumentSerde
}
func (*AttributeValueMemberString) isAttributeValue() {}
// An authorization request that you include in a BatchIsAuthorized API request.
type BatchIsAuthorizedInputItem struct {
// Specifies the requested action to be authorized. For example, is the principal
// authorized to perform this action on the resource?
Action *ActionIdentifier
// Specifies additional context that can be used to make more granular
// authorization decisions.
Context ContextDefinition
// Specifies the principal for which the authorization decision is to be made.
Principal *EntityIdentifier
// Specifies the resource for which the authorization decision is to be made.
Resource *EntityIdentifier
noSmithyDocumentSerde
}
// The decision, based on policy evaluation, from an individual authorization
// request in a BatchIsAuthorized API request.
type BatchIsAuthorizedOutputItem struct {
// An authorization decision that indicates if the authorization request should be
// allowed or denied.
//
// This member is required.
Decision Decision
// 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.
//
// This member is required.
DeterminingPolicies []DeterminingPolicyItem
// 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.
//
// This member is required.
Errors []EvaluationErrorItem
// The authorization request that initiated the decision.
//
// This member is required.
Request *BatchIsAuthorizedInputItem
noSmithyDocumentSerde
}
// The configuration for an identity source that represents a connection to an
// Amazon Cognito user pool used as an identity provider for Verified Permissions.
// This data type is used as a field that is part of an Configuration (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_Configuration.html)
// structure that is used as a parameter to the Configuration (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_Configuration.html)
// . Example:
// "CognitoUserPoolConfiguration":{"UserPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","ClientIds":
// ["a1b2c3d4e5f6g7h8i9j0kalbmc"]}
type CognitoUserPoolConfiguration struct {
// The Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
// of the Amazon Cognito user pool that contains the identities to be authorized.
// Example: "UserPoolArn":
// "arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5"
//
// This member is required.
UserPoolArn *string
// The unique application client IDs that are associated with the specified Amazon
// Cognito user pool. Example: "ClientIds": ["&ExampleCogClientId;"]
ClientIds []string
noSmithyDocumentSerde
}
// Contains configuration information used when creating a new identity source. At
// this time, the only valid member of this structure is a Amazon Cognito user pool
// configuration. You must specify a userPoolArn , and optionally, a ClientId .
// This data type is used as a request parameter for the CreateIdentitySource (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreateIdentitySource.html)
// operation.
//
// The following types satisfy this interface:
//
// ConfigurationMemberCognitoUserPoolConfiguration
type Configuration interface {
isConfiguration()
}
// Contains configuration details of a Amazon Cognito user pool that Verified
// Permissions can use as a source of authenticated identities as entities. It
// specifies the Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
// of a Amazon Cognito user pool and one or more application client IDs. Example:
// "configuration":{"cognitoUserPoolConfiguration":{"userPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","clientIds":
// ["a1b2c3d4e5f6g7h8i9j0kalbmc"]}}
type ConfigurationMemberCognitoUserPoolConfiguration struct {
Value CognitoUserPoolConfiguration
noSmithyDocumentSerde
}
func (*ConfigurationMemberCognitoUserPoolConfiguration) isConfiguration() {}
// Contains additional details about the context of the request. Verified
// Permissions evaluates this information in an authorization request as part of
// the when and unless clauses in a policy. This data type is used as a request
// parameter for the IsAuthorized (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorized.html)
// , BatchIsAuthorized (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_BatchIsAuthorized.html)
// , and IsAuthorizedWithToken (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorizedWithToken.html)
// operations. Example:
// "context":{"contextMap":{"<KeyName1>":{"boolean":true},"<KeyName2>":{"long":1234}}}
//
// The following types satisfy this interface:
//
// ContextDefinitionMemberContextMap
type ContextDefinition interface {
isContextDefinition()
}
// An list of attributes that are needed to successfully evaluate an authorization
// request. Each attribute in this array must include a map of a data type and its
// value. Example:
// "contextMap":{"<KeyName1>":{"boolean":true},"<KeyName2>":{"long":1234}}
type ContextDefinitionMemberContextMap struct {
Value map[string]AttributeValue
noSmithyDocumentSerde
}
func (*ContextDefinitionMemberContextMap) isContextDefinition() {}
// Contains information about one of the policies that determined an authorization
// decision. This data type is used as an element in a response parameter for the
// IsAuthorized (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorized.html)
// , BatchIsAuthorized (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_BatchIsAuthorized.html)
// , and IsAuthorizedWithToken (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorizedWithToken.html)
// operations. Example:
// "determiningPolicies":[{"policyId":"SPEXAMPLEabcdefg111111"}]
type DeterminingPolicyItem struct {
// The Id of a policy that determined to an authorization decision. Example:
// "policyId":"SPEXAMPLEabcdefg111111"
//
// This member is required.
PolicyId *string
noSmithyDocumentSerde
}
// 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. This data type is used as a field in the response
// parameter for the IsAuthorized (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorized.html)
// and IsAuthorizedWithToken (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorizedWithToken.html)
// operations.
//
// The following types satisfy this interface:
//
// EntitiesDefinitionMemberEntityList
type EntitiesDefinition interface {
isEntitiesDefinition()
}
// 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.
type EntitiesDefinitionMemberEntityList struct {
Value []EntityItem
noSmithyDocumentSerde
}
func (*EntitiesDefinitionMemberEntityList) isEntitiesDefinition() {}
// Contains the identifier of an entity, including its ID and type. This data type
// is used as a request parameter for IsAuthorized (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorized.html)
// operation, and as a response parameter for the CreatePolicy (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreatePolicy.html)
// , GetPolicy (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_GetPolicy.html)
// , and UpdatePolicy (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdatePolicy.html)
// operations. Example: {"entityId":"string","entityType":"string"}
type EntityIdentifier struct {
// The identifier of an entity. "entityId":"identifier"
//
// This member is required.
EntityId *string
// The type of an entity. Example: "entityType":"typeName"
//
// This member is required.
EntityType *string
noSmithyDocumentSerde
}
// Contains information about an entity that can be referenced in a Cedar policy.
// This data type is used as one of the fields in the EntitiesDefinition (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_EntitiesDefinition.html)
// structure. { "identifier": { "entityType": "Photo", "entityId":
// "VacationPhoto94.jpg" }, "attributes": {}, "parents": [ { "entityType": "Album",
// "entityId": "alice_folder" } ] }
type EntityItem struct {
// The identifier of the entity.
//
// This member is required.
Identifier *EntityIdentifier
// A list of attributes for the entity.
Attributes map[string]AttributeValue
// The parents in the hierarchy that contains the entity.
Parents []EntityIdentifier
noSmithyDocumentSerde
}
// Contains information about a principal or resource that can be referenced in a
// Cedar policy. This data type is used as part of the PolicyFilter (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_PolicyFilter.html)
// structure that is used as a request parameter for the ListPolicies (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicies.html)
// operation..
//
// The following types satisfy this interface:
//
// EntityReferenceMemberIdentifier
// EntityReferenceMemberUnspecified
type EntityReference interface {
isEntityReference()
}
// The identifier of the entity. It can consist of either an EntityType and
// EntityId, a principal, or a resource.
type EntityReferenceMemberIdentifier struct {
Value EntityIdentifier
noSmithyDocumentSerde
}
func (*EntityReferenceMemberIdentifier) isEntityReference() {}
// 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.
type EntityReferenceMemberUnspecified struct {
Value bool
noSmithyDocumentSerde
}
func (*EntityReferenceMemberUnspecified) isEntityReference() {}
// Contains a description of an evaluation error. This data type is a response
// parameter of the IsAuthorized (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorized.html)
// , BatchIsAuthorized (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_BatchIsAuthorized.html)
// , and IsAuthorizedWithToken (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorizedWithToken.html)
// operations.
type EvaluationErrorItem struct {
// The error description.
//
// This member is required.
ErrorDescription *string
noSmithyDocumentSerde
}
// A structure that contains configuration of the identity source. This data type
// is used as a response parameter for the CreateIdentitySource (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreateIdentitySource.html)
// operation.
type IdentitySourceDetails struct {
// The application client IDs associated with the specified Amazon Cognito user
// pool that are enabled for this identity source.
ClientIds []string
// 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.
// https://cognito-idp.<region>.amazonaws.com/<user-pool-id>/.well-known/openid-configuration
DiscoveryUrl *string
// A string that identifies the type of OIDC service represented by this identity
// source. At this time, the only valid value is cognito .
OpenIdIssuer OpenIdIssuer
// The Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
// of the Amazon Cognito user pool whose identities are accessible to this Verified
// Permissions policy store.
UserPoolArn *string
noSmithyDocumentSerde
}
// A structure that defines characteristics of an identity source that you can use
// to filter. This data type is used as a request parameter for the
// ListIdentityStores (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListIdentityStores.html)
// operation.
type IdentitySourceFilter struct {
// The Cedar entity type of the principals returned by the identity provider (IdP)
// associated with this identity source.
PrincipalEntityType *string
noSmithyDocumentSerde
}
// A structure that defines an identity source. This data type is used as a
// request parameter for the ListIdentityStores (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListIdentityStores.html)
// operation.
type IdentitySourceItem struct {
// The date and time the identity source was originally created.
//
// This member is required.
CreatedDate *time.Time
// A structure that contains the details of the associated identity provider (IdP).
//
// This member is required.
Details *IdentitySourceItemDetails
// The unique identifier of the identity source.
//
// This member is required.
IdentitySourceId *string
// The date and time the identity source was most recently updated.
//
// This member is required.
LastUpdatedDate *time.Time
// The identifier of the policy store that contains the identity source.
//
// This member is required.
PolicyStoreId *string
// The Cedar entity type of the principals returned from the IdP associated with
// this identity source.
//
// This member is required.
PrincipalEntityType *string
noSmithyDocumentSerde
}
// A structure that contains configuration of the identity source. This data type
// is used as a response parameter for the CreateIdentitySource (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreateIdentitySource.html)
// operation.
type IdentitySourceItemDetails struct {
// The application client IDs associated with the specified Amazon Cognito user
// pool that are enabled for this identity source.
ClientIds []string
// 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.
// https://cognito-idp.<region>.amazonaws.com/<user-pool-id>/.well-known/openid-configuration
DiscoveryUrl *string
// A string that identifies the type of OIDC service represented by this identity
// source. At this time, the only valid value is cognito .
OpenIdIssuer OpenIdIssuer
// The Amazon Cognito user pool whose identities are accessible to this Verified
// Permissions policy store.
UserPoolArn *string
noSmithyDocumentSerde
}
// 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. This data type is used as a request parameter
// for the CreatePolicy (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreatePolicy.html)
// operation. This structure must always have either an static or a templateLinked
// element.
//
// The following types satisfy this interface:
//
// PolicyDefinitionMemberStatic
// PolicyDefinitionMemberTemplateLinked
type PolicyDefinition interface {
isPolicyDefinition()
}
// A structure that describes a static policy. An static policy doesn't use a
// template or allow placeholders for entities.
type PolicyDefinitionMemberStatic struct {
Value StaticPolicyDefinition
noSmithyDocumentSerde
}
func (*PolicyDefinitionMemberStatic) isPolicyDefinition() {}
// A structure that describes a policy that was instantiated from a template. The
// template can specify placeholders for principal and resource . When you use
// CreatePolicy (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreatePolicy.html)
// to create a policy from a template, you specify the exact principal and resource
// to use for the instantiated policy.
type PolicyDefinitionMemberTemplateLinked struct {
Value TemplateLinkedPolicyDefinition
noSmithyDocumentSerde
}
func (*PolicyDefinitionMemberTemplateLinked) isPolicyDefinition() {}
// A structure that describes a policy definition. It must always have either an
// static or a templateLinked element. This data type is used as a response
// parameter for the GetPolicy (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_GetPolicy.html)
// operation.
//
// The following types satisfy this interface:
//
// PolicyDefinitionDetailMemberStatic
// PolicyDefinitionDetailMemberTemplateLinked
type PolicyDefinitionDetail interface {
isPolicyDefinitionDetail()
}
// Information about a static policy that wasn't created with a policy template.
type PolicyDefinitionDetailMemberStatic struct {
Value StaticPolicyDefinitionDetail
noSmithyDocumentSerde
}
func (*PolicyDefinitionDetailMemberStatic) isPolicyDefinitionDetail() {}
// Information about a template-linked policy that was created by instantiating a
// policy template.
type PolicyDefinitionDetailMemberTemplateLinked struct {
Value TemplateLinkedPolicyDefinitionDetail
noSmithyDocumentSerde
}
func (*PolicyDefinitionDetailMemberTemplateLinked) isPolicyDefinitionDetail() {}
// A structure that describes a PolicyDefinintion (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_PolicyDefinintion.html)
// . It will always have either an StaticPolicy or a TemplateLinkedPolicy element.
// This data type is used as a response parameter for the CreatePolicy (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreatePolicy.html)
// and ListPolicies (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicies.html)
// operations.
//
// The following types satisfy this interface:
//
// PolicyDefinitionItemMemberStatic
// PolicyDefinitionItemMemberTemplateLinked
type PolicyDefinitionItem interface {
isPolicyDefinitionItem()
}
// Information about a static policy that wasn't created with a policy template.
type PolicyDefinitionItemMemberStatic struct {
Value StaticPolicyDefinitionItem
noSmithyDocumentSerde
}
func (*PolicyDefinitionItemMemberStatic) isPolicyDefinitionItem() {}
// Information about a template-linked policy that was created by instantiating a
// policy template.
type PolicyDefinitionItemMemberTemplateLinked struct {
Value TemplateLinkedPolicyDefinitionItem
noSmithyDocumentSerde
}
func (*PolicyDefinitionItemMemberTemplateLinked) isPolicyDefinitionItem() {}
// Contains information about a filter to refine policies returned in a query.
// This data type is used as a response parameter for the ListPolicies (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicies.html)
// operation.
type PolicyFilter struct {
// Filters the output to only template-linked policies that were instantiated from
// the specified policy template.
PolicyTemplateId *string
// Filters the output to only policies of the specified type.
PolicyType PolicyType
// Filters the output to only policies that reference the specified principal.
Principal EntityReference
// Filters the output to only policies that reference the specified resource.
Resource EntityReference
noSmithyDocumentSerde
}
// Contains information about a policy. This data type is used as a response
// parameter for the ListPolicies (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicies.html)
// operation.
type PolicyItem struct {
// The date and time the policy was created.
//
// This member is required.
CreatedDate *time.Time
// The policy definition of an item in the list of policies returned.
//
// This member is required.
Definition PolicyDefinitionItem
// The date and time the policy was most recently updated.
//
// This member is required.
LastUpdatedDate *time.Time
// The identifier of the policy you want information about.
//
// This member is required.
PolicyId *string
// The identifier of the PolicyStore where the policy you want information about
// is stored.
//
// This member is required.
PolicyStoreId *string
// The type of the policy. This is one of the following values:
// - static
// - templateLinked
//
// This member is required.
PolicyType PolicyType
// The principal associated with the policy.
Principal *EntityIdentifier
// The resource associated with the policy.
Resource *EntityIdentifier
noSmithyDocumentSerde
}
// Contains information about a policy store. This data type is used as a response
// parameter for the ListPolicyStores (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicyStores.html)
// operation.
type PolicyStoreItem struct {
// The Amazon Resource Name (ARN) of the policy store.
//
// This member is required.
Arn *string
// The date and time the policy was created.
//
// This member is required.
CreatedDate *time.Time
// The unique identifier of the policy store.
//
// This member is required.
PolicyStoreId *string
// Descriptive text that you can provide to help with identification of the
// current policy store.
Description *string
// The date and time the policy store was most recently updated.
LastUpdatedDate *time.Time
noSmithyDocumentSerde
}
// Contains details about a policy template This data type is used as a response
// parameter for the ListPolicyTemplates (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicyTemplates.html)
// operation.
type PolicyTemplateItem struct {
// The date and time that the policy template was created.
//
// This member is required.
CreatedDate *time.Time
// The date and time that the policy template was most recently updated.
//
// This member is required.
LastUpdatedDate *time.Time
// The unique identifier of the policy store that contains the template.
//
// This member is required.
PolicyStoreId *string
// The unique identifier of the policy template.
//
// This member is required.
PolicyTemplateId *string
// The description attached to the policy template.
Description *string
noSmithyDocumentSerde
}
// Contains information about a resource conflict.
type ResourceConflict struct {
// The unique identifier of the resource involved in a conflict.
//
// This member is required.
ResourceId *string
// The type of the resource involved in a conflict.
//
// This member is required.
ResourceType ResourceType
noSmithyDocumentSerde
}
// 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 STRICT , then policies that can't be validated by
// this schema are rejected by Verified Permissions and can't be stored in the
// policy store.
//
// The following types satisfy this interface:
//
// SchemaDefinitionMemberCedarJson
type SchemaDefinition interface {
isSchemaDefinition()
}
// A JSON string representation of the schema supported by applications that use
// this policy store. For more information, see Policy store schema (https://docs.aws.amazon.com/verifiedpermissions/latest/userguide/schema.html)
// in the Amazon Verified Permissions User Guide.
type SchemaDefinitionMemberCedarJson struct {
Value string
noSmithyDocumentSerde
}
func (*SchemaDefinitionMemberCedarJson) isSchemaDefinition() {}
// Contains information about a static policy. This data type is used as a field
// that is part of the PolicyDefinitionDetail (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_PolicyDefinitionDetail.html)
// type.
type StaticPolicyDefinition struct {
// The policy content of the static policy, written in the Cedar policy language.
//
// This member is required.
Statement *string
// The description of the static policy.
Description *string
noSmithyDocumentSerde
}
// A structure that contains details about a static policy. It includes the
// description and policy body. This data type is used within a PolicyDefinition (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_PolicyDefinition.html)
// structure as part of a request parameter for the CreatePolicy (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreatePolicy.html)
// operation.
type StaticPolicyDefinitionDetail struct {
// The content of the static policy written in the Cedar policy language.
//
// This member is required.
Statement *string
// A description of the static policy.
Description *string
noSmithyDocumentSerde
}
// A structure that contains details about a static policy. It includes the
// description and policy statement. This data type is used within a
// PolicyDefinition (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_PolicyDefinition.html)
// structure as part of a request parameter for the CreatePolicy (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreatePolicy.html)
// operation.
type StaticPolicyDefinitionItem struct {
// A description of the static policy.
Description *string
noSmithyDocumentSerde
}
// Contains information about a policy created by instantiating a policy template.
type TemplateLinkedPolicyDefinition struct {
// The unique identifier of the policy template used to create this policy.
//
// This member is required.
PolicyTemplateId *string
// The principal associated with this template-linked policy. Verified Permissions
// substitutes this principal for the ?principal placeholder in the policy
// template when it evaluates an authorization request.
Principal *EntityIdentifier
// The resource associated with this template-linked policy. Verified Permissions
// substitutes this resource for the ?resource placeholder in the policy template
// when it evaluates an authorization request.
Resource *EntityIdentifier
noSmithyDocumentSerde
}
// Contains information about a policy that was created by instantiating a policy
// template. This
type TemplateLinkedPolicyDefinitionDetail struct {
// The unique identifier of the policy template used to create this policy.
//
// This member is required.
PolicyTemplateId *string
// The principal associated with this template-linked policy. Verified Permissions
// substitutes this principal for the ?principal placeholder in the policy
// template when it evaluates an authorization request.
Principal *EntityIdentifier
// The resource associated with this template-linked policy. Verified Permissions
// substitutes this resource for the ?resource placeholder in the policy template
// when it evaluates an authorization request.
Resource *EntityIdentifier
noSmithyDocumentSerde
}
// Contains information about a policy created by instantiating a policy template.
// This
type TemplateLinkedPolicyDefinitionItem struct {
// The unique identifier of the policy template used to create this policy.
//
// This member is required.
PolicyTemplateId *string
// The principal associated with this template-linked policy. Verified Permissions
// substitutes this principal for the ?principal placeholder in the policy
// template when it evaluates an authorization request.
Principal *EntityIdentifier
// The resource associated with this template-linked policy. Verified Permissions
// substitutes this resource for the ?resource placeholder in the policy template
// when it evaluates an authorization request.
Resource *EntityIdentifier
noSmithyDocumentSerde
}
// Contains configuration details of a Amazon Cognito user pool for use with an
// identity source.
type UpdateCognitoUserPoolConfiguration struct {
// The Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
// of the Amazon Cognito user pool associated with this identity source.
//
// This member is required.
UserPoolArn *string
// The client ID of an app client that is configured for the specified Amazon
// Cognito user pool.
ClientIds []string
noSmithyDocumentSerde
}
// Contains an updated configuration to replace the configuration in an existing
// identity source. At this time, the only valid member of this structure is a
// Amazon Cognito user pool configuration. You must specify a userPoolArn , and
// optionally, a ClientId .
//
// The following types satisfy this interface:
//
// UpdateConfigurationMemberCognitoUserPoolConfiguration
type UpdateConfiguration interface {
isUpdateConfiguration()
}
// Contains configuration details of a Amazon Cognito user pool.
type UpdateConfigurationMemberCognitoUserPoolConfiguration struct {
Value UpdateCognitoUserPoolConfiguration
noSmithyDocumentSerde
}
func (*UpdateConfigurationMemberCognitoUserPoolConfiguration) isUpdateConfiguration() {}
// Contains information about updates to be applied to a policy. This data type is
// used as a request parameter in the UpdatePolicy (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdatePolicy.html)
// operation.
//
// The following types satisfy this interface:
//
// UpdatePolicyDefinitionMemberStatic
type UpdatePolicyDefinition interface {
isUpdatePolicyDefinition()
}
// Contains details about the updates to be applied to a static policy.
type UpdatePolicyDefinitionMemberStatic struct {
Value UpdateStaticPolicyDefinition
noSmithyDocumentSerde
}
func (*UpdatePolicyDefinitionMemberStatic) isUpdatePolicyDefinition() {}
// Contains information about an update to a static policy.
type UpdateStaticPolicyDefinition struct {
// Specifies the Cedar policy language text to be added to or replaced on the
// static policy. You can change only the following elements from the original
// content:
// - The action referenced by the policy.
// - Any conditional clauses, such as when or unless clauses.
// You can't change the following elements:
// - Changing from StaticPolicy to TemplateLinkedPolicy .
// - The effect ( permit or forbid ) of the policy.
// - The principal referenced by the policy.
// - The resource referenced by the policy.
//
// This member is required.
Statement *string
// Specifies the description to be added to or replaced on the static policy.
Description *string
noSmithyDocumentSerde
}
// Details about a field that failed policy validation.
type ValidationExceptionField struct {
// Describes the policy validation error.
//
// This member is required.
Message *string
// The path to the specific element that Verified Permissions found to be not
// valid.
//
// This member is required.
Path *string
noSmithyDocumentSerde
}
// 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. This data type is used as a request parameter in the
// CreatePolicyStore (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreatePolicyStore.html)
// and UpdatePolicyStore (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdatePolicyStore.html)
// operations.
type ValidationSettings struct {
// The validation mode currently configured for this policy store. The valid
// values are:
// - OFF – Neither Verified Permissions nor Cedar perform any validation on
// policies. No validation errors are reported by either service.
// - STRICT – 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.
// If Mode=STRICT 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. To submit a static policy or policy template without
// a schema, you must turn off validation.
//
// This member is required.
Mode ValidationMode
noSmithyDocumentSerde
}
type noSmithyDocumentSerde = smithydocument.NoSerde
// UnknownUnionMember is returned when a union member is returned over the wire,
// but has an unknown tag.
type UnknownUnionMember struct {
Tag string
Value []byte
noSmithyDocumentSerde
}
func (*UnknownUnionMember) isAttributeValue() {}
func (*UnknownUnionMember) isConfiguration() {}
func (*UnknownUnionMember) isContextDefinition() {}
func (*UnknownUnionMember) isEntitiesDefinition() {}
func (*UnknownUnionMember) isEntityReference() {}
func (*UnknownUnionMember) isPolicyDefinition() {}
func (*UnknownUnionMember) isPolicyDefinitionDetail() {}
func (*UnknownUnionMember) isPolicyDefinitionItem() {}
func (*UnknownUnionMember) isSchemaDefinition() {}
func (*UnknownUnionMember) isUpdateConfiguration() {}
func (*UnknownUnionMember) isUpdatePolicyDefinition() {}
|