aws-sdk-verifiedpermissions 1.15.0 → 1.17.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -283,8 +283,8 @@ module Aws::VerifiedPermissions
283
283
  # Verified Permissions.
284
284
  #
285
285
  # This data type is used as a field that is part of an
286
- # [Configuration][1] structure that is used as a parameter to the
287
- # [Configuration][1].
286
+ # [Configuration][1] structure that is used as a parameter to
287
+ # [CreateIdentitySource][2].
288
288
  #
289
289
  # Example:`"CognitoUserPoolConfiguration":\{"UserPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","ClientIds":
290
290
  # ["a1b2c3d4e5f6g7h8i9j0kalbmc"]\}`
@@ -292,6 +292,7 @@ module Aws::VerifiedPermissions
292
292
  #
293
293
  #
294
294
  # [1]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_Configuration.html
295
+ # [2]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreateIdentitySource.html
295
296
  #
296
297
  # @!attribute [rw] user_pool_arn
297
298
  # The [Amazon Resource Name (ARN)][1] of the Amazon Cognito user pool
@@ -321,6 +322,112 @@ module Aws::VerifiedPermissions
321
322
  include Aws::Structure
322
323
  end
323
324
 
325
+ # The configuration for an identity source that represents a connection
326
+ # to an Amazon Cognito user pool used as an identity provider for
327
+ # Verified Permissions.
328
+ #
329
+ # This data type is used as a field that is part of an
330
+ # [ConfigurationDetail][1] structure that is part of the response to
331
+ # [GetIdentitySource][2].
332
+ #
333
+ # Example:`"CognitoUserPoolConfiguration":\{"UserPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","ClientIds":
334
+ # ["a1b2c3d4e5f6g7h8i9j0kalbmc"]\}`
335
+ #
336
+ #
337
+ #
338
+ # [1]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ConfigurationDetail.html
339
+ # [2]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_GetIdentitySource.html
340
+ #
341
+ # @!attribute [rw] user_pool_arn
342
+ # The [Amazon Resource Name (ARN)][1] of the Amazon Cognito user pool
343
+ # that contains the identities to be authorized.
344
+ #
345
+ # Example: `"userPoolArn":
346
+ # "arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5"`
347
+ #
348
+ #
349
+ #
350
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
351
+ # @return [String]
352
+ #
353
+ # @!attribute [rw] client_ids
354
+ # The unique application client IDs that are associated with the
355
+ # specified Amazon Cognito user pool.
356
+ #
357
+ # Example: `"clientIds": ["&ExampleCogClientId;"]`
358
+ # @return [Array<String>]
359
+ #
360
+ # @!attribute [rw] issuer
361
+ # The OpenID Connect (OIDC) `issuer` ID of the Amazon Cognito user
362
+ # pool that contains the identities to be authorized.
363
+ #
364
+ # Example: `"issuer":
365
+ # "https://cognito-idp.us-east-1.amazonaws.com/us-east-1_1a2b3c4d5"`
366
+ # @return [String]
367
+ #
368
+ # @see http://docs.aws.amazon.com/goto/WebAPI/verifiedpermissions-2021-12-01/CognitoUserPoolConfigurationDetail AWS API Documentation
369
+ #
370
+ class CognitoUserPoolConfigurationDetail < Struct.new(
371
+ :user_pool_arn,
372
+ :client_ids,
373
+ :issuer)
374
+ SENSITIVE = []
375
+ include Aws::Structure
376
+ end
377
+
378
+ # The configuration for an identity source that represents a connection
379
+ # to an Amazon Cognito user pool used as an identity provider for
380
+ # Verified Permissions.
381
+ #
382
+ # This data type is used as a field that is part of the
383
+ # [ConfigurationItem][1] structure that is part of the response to
384
+ # [ListIdentitySources][2].
385
+ #
386
+ # Example:`"CognitoUserPoolConfiguration":\{"UserPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","ClientIds":
387
+ # ["a1b2c3d4e5f6g7h8i9j0kalbmc"]\}`
388
+ #
389
+ #
390
+ #
391
+ # [1]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ConfigurationItem.html
392
+ # [2]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListIdentitySources.html
393
+ #
394
+ # @!attribute [rw] user_pool_arn
395
+ # The [Amazon Resource Name (ARN)][1] of the Amazon Cognito user pool
396
+ # that contains the identities to be authorized.
397
+ #
398
+ # Example: `"userPoolArn":
399
+ # "arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5"`
400
+ #
401
+ #
402
+ #
403
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
404
+ # @return [String]
405
+ #
406
+ # @!attribute [rw] client_ids
407
+ # The unique application client IDs that are associated with the
408
+ # specified Amazon Cognito user pool.
409
+ #
410
+ # Example: `"clientIds": ["&ExampleCogClientId;"]`
411
+ # @return [Array<String>]
412
+ #
413
+ # @!attribute [rw] issuer
414
+ # The OpenID Connect (OIDC) `issuer` ID of the Amazon Cognito user
415
+ # pool that contains the identities to be authorized.
416
+ #
417
+ # Example: `"issuer":
418
+ # "https://cognito-idp.us-east-1.amazonaws.com/us-east-1_1a2b3c4d5"`
419
+ # @return [String]
420
+ #
421
+ # @see http://docs.aws.amazon.com/goto/WebAPI/verifiedpermissions-2021-12-01/CognitoUserPoolConfigurationItem AWS API Documentation
422
+ #
423
+ class CognitoUserPoolConfigurationItem < Struct.new(
424
+ :user_pool_arn,
425
+ :client_ids,
426
+ :issuer)
427
+ SENSITIVE = []
428
+ include Aws::Structure
429
+ end
430
+
324
431
  # Contains configuration information used when creating a new identity
325
432
  # source.
326
433
  #
@@ -368,6 +475,84 @@ module Aws::VerifiedPermissions
368
475
  class Unknown < Configuration; end
369
476
  end
370
477
 
478
+ # Contains configuration information about an identity source.
479
+ #
480
+ # This data type is a response parameter to the [GetIdentitySource][1]
481
+ # operation.
482
+ #
483
+ #
484
+ #
485
+ # [1]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_GetIdentitySource.html
486
+ #
487
+ # @note ConfigurationDetail is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of ConfigurationDetail corresponding to the set member.
488
+ #
489
+ # @!attribute [rw] cognito_user_pool_configuration
490
+ # Contains configuration details of a Amazon Cognito user pool that
491
+ # Verified Permissions can use as a source of authenticated identities
492
+ # as entities. It specifies the [Amazon Resource Name (ARN)][1] of a
493
+ # Amazon Cognito user pool and one or more application client IDs.
494
+ #
495
+ # Example:
496
+ # `"configuration":\{"cognitoUserPoolConfiguration":\{"userPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","clientIds":
497
+ # ["a1b2c3d4e5f6g7h8i9j0kalbmc"]\}\}`
498
+ #
499
+ #
500
+ #
501
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
502
+ # @return [Types::CognitoUserPoolConfigurationDetail]
503
+ #
504
+ # @see http://docs.aws.amazon.com/goto/WebAPI/verifiedpermissions-2021-12-01/ConfigurationDetail AWS API Documentation
505
+ #
506
+ class ConfigurationDetail < Struct.new(
507
+ :cognito_user_pool_configuration,
508
+ :unknown)
509
+ SENSITIVE = []
510
+ include Aws::Structure
511
+ include Aws::Structure::Union
512
+
513
+ class CognitoUserPoolConfiguration < ConfigurationDetail; end
514
+ class Unknown < ConfigurationDetail; end
515
+ end
516
+
517
+ # Contains configuration information about an identity source.
518
+ #
519
+ # This data type is a response parameter to the [ListIdentitySources][1]
520
+ # operation.
521
+ #
522
+ #
523
+ #
524
+ # [1]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListIdentitySources.html
525
+ #
526
+ # @note ConfigurationItem is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of ConfigurationItem corresponding to the set member.
527
+ #
528
+ # @!attribute [rw] cognito_user_pool_configuration
529
+ # Contains configuration details of a Amazon Cognito user pool that
530
+ # Verified Permissions can use as a source of authenticated identities
531
+ # as entities. It specifies the [Amazon Resource Name (ARN)][1] of a
532
+ # Amazon Cognito user pool and one or more application client IDs.
533
+ #
534
+ # Example:
535
+ # `"configuration":\{"cognitoUserPoolConfiguration":\{"userPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","clientIds":
536
+ # ["a1b2c3d4e5f6g7h8i9j0kalbmc"]\}\}`
537
+ #
538
+ #
539
+ #
540
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
541
+ # @return [Types::CognitoUserPoolConfigurationItem]
542
+ #
543
+ # @see http://docs.aws.amazon.com/goto/WebAPI/verifiedpermissions-2021-12-01/ConfigurationItem AWS API Documentation
544
+ #
545
+ class ConfigurationItem < Struct.new(
546
+ :cognito_user_pool_configuration,
547
+ :unknown)
548
+ SENSITIVE = []
549
+ include Aws::Structure
550
+ include Aws::Structure::Union
551
+
552
+ class CognitoUserPoolConfiguration < ConfigurationItem; end
553
+ class Unknown < ConfigurationItem; end
554
+ end
555
+
371
556
  # The request failed because another request to modify a resource
372
557
  # occurred at the same.
373
558
  #
@@ -442,8 +627,13 @@ module Aws::VerifiedPermissions
442
627
  # a random one for you.
443
628
  #
444
629
  # If you retry the operation with the same `ClientToken`, but with
445
- # different parameters, the retry fails with an
446
- # `IdempotentParameterMismatch` error.
630
+ # different parameters, the retry fails with an `ConflictException`
631
+ # error.
632
+ #
633
+ # Verified Permissions recognizes a `ClientToken` for eight hours.
634
+ # After eight hours, the next request with the same parameters
635
+ # performs the operation again regardless of the value of
636
+ # `ClientToken`.
447
637
  #
448
638
  # **A suitable default value is auto-generated.** You should normally
449
639
  # not need to pass this option.
@@ -527,8 +717,13 @@ module Aws::VerifiedPermissions
527
717
  # a random one for you.
528
718
  #
529
719
  # If you retry the operation with the same `ClientToken`, but with
530
- # different parameters, the retry fails with an
531
- # `IdempotentParameterMismatch` error.
720
+ # different parameters, the retry fails with an `ConflictException`
721
+ # error.
722
+ #
723
+ # Verified Permissions recognizes a `ClientToken` for eight hours.
724
+ # After eight hours, the next request with the same parameters
725
+ # performs the operation again regardless of the value of
726
+ # `ClientToken`.
532
727
  #
533
728
  # **A suitable default value is auto-generated.** You should normally
534
729
  # not need to pass this option.
@@ -618,8 +813,13 @@ module Aws::VerifiedPermissions
618
813
  # a random one for you.
619
814
  #
620
815
  # If you retry the operation with the same `ClientToken`, but with
621
- # different parameters, the retry fails with an
622
- # `IdempotentParameterMismatch` error.
816
+ # different parameters, the retry fails with an `ConflictException`
817
+ # error.
818
+ #
819
+ # Verified Permissions recognizes a `ClientToken` for eight hours.
820
+ # After eight hours, the next request with the same parameters
821
+ # performs the operation again regardless of the value of
822
+ # `ClientToken`.
623
823
  #
624
824
  # **A suitable default value is auto-generated.** You should normally
625
825
  # not need to pass this option.
@@ -700,8 +900,13 @@ module Aws::VerifiedPermissions
700
900
  # a random one for you.
701
901
  #
702
902
  # If you retry the operation with the same `ClientToken`, but with
703
- # different parameters, the retry fails with an
704
- # `IdempotentParameterMismatch` error.
903
+ # different parameters, the retry fails with an `ConflictException`
904
+ # error.
905
+ #
906
+ # Verified Permissions recognizes a `ClientToken` for eight hours.
907
+ # After eight hours, the next request with the same parameters
908
+ # performs the operation again regardless of the value of
909
+ # `ClientToken`.
705
910
  #
706
911
  # **A suitable default value is auto-generated.** You should normally
707
912
  # not need to pass this option.
@@ -1086,6 +1291,10 @@ module Aws::VerifiedPermissions
1086
1291
  # by this identity source.
1087
1292
  # @return [String]
1088
1293
  #
1294
+ # @!attribute [rw] configuration
1295
+ # Contains configuration information about an identity source.
1296
+ # @return [Types::ConfigurationDetail]
1297
+ #
1089
1298
  # @see http://docs.aws.amazon.com/goto/WebAPI/verifiedpermissions-2021-12-01/GetIdentitySourceOutput AWS API Documentation
1090
1299
  #
1091
1300
  class GetIdentitySourceOutput < Struct.new(
@@ -1094,7 +1303,8 @@ module Aws::VerifiedPermissions
1094
1303
  :identity_source_id,
1095
1304
  :last_updated_date,
1096
1305
  :policy_store_id,
1097
- :principal_entity_type)
1306
+ :principal_entity_type,
1307
+ :configuration)
1098
1308
  SENSITIVE = [:principal_entity_type]
1099
1309
  include Aws::Structure
1100
1310
  end
@@ -1324,12 +1534,13 @@ module Aws::VerifiedPermissions
1324
1534
 
1325
1535
  # A structure that contains configuration of the identity source.
1326
1536
  #
1327
- # This data type is used as a response parameter for the
1328
- # [CreateIdentitySource][1] operation.
1537
+ # This data type was a response parameter for the [GetIdentitySource][1]
1538
+ # operation. Replaced by [ConfigurationDetail][2].
1329
1539
  #
1330
1540
  #
1331
1541
  #
1332
- # [1]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreateIdentitySource.html
1542
+ # [1]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_GetIdentitySource.html
1543
+ # [2]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ConfigurationDetail.html
1333
1544
  #
1334
1545
  # @!attribute [rw] client_ids
1335
1546
  # The application client IDs associated with the specified Amazon
@@ -1377,8 +1588,8 @@ module Aws::VerifiedPermissions
1377
1588
  # A structure that defines characteristics of an identity source that
1378
1589
  # you can use to filter.
1379
1590
  #
1380
- # This data type is used as a request parameter for the
1381
- # [ListIdentityStores][1] operation.
1591
+ # This data type is a request parameter for the [ListIdentityStores][1]
1592
+ # operation.
1382
1593
  #
1383
1594
  #
1384
1595
  #
@@ -1399,12 +1610,12 @@ module Aws::VerifiedPermissions
1399
1610
 
1400
1611
  # A structure that defines an identity source.
1401
1612
  #
1402
- # This data type is used as a request parameter for the
1403
- # [ListIdentityStores][1] operation.
1613
+ # This data type is a response parameter to the [ListIdentitySources][1]
1614
+ # operation.
1404
1615
  #
1405
1616
  #
1406
1617
  #
1407
- # [1]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListIdentityStores.html
1618
+ # [1]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListIdentitySources.html
1408
1619
  #
1409
1620
  # @!attribute [rw] created_date
1410
1621
  # The date and time the identity source was originally created.
@@ -1433,6 +1644,10 @@ module Aws::VerifiedPermissions
1433
1644
  # associated with this identity source.
1434
1645
  # @return [String]
1435
1646
  #
1647
+ # @!attribute [rw] configuration
1648
+ # Contains configuration information about an identity source.
1649
+ # @return [Types::ConfigurationItem]
1650
+ #
1436
1651
  # @see http://docs.aws.amazon.com/goto/WebAPI/verifiedpermissions-2021-12-01/IdentitySourceItem AWS API Documentation
1437
1652
  #
1438
1653
  class IdentitySourceItem < Struct.new(
@@ -1441,19 +1656,22 @@ module Aws::VerifiedPermissions
1441
1656
  :identity_source_id,
1442
1657
  :last_updated_date,
1443
1658
  :policy_store_id,
1444
- :principal_entity_type)
1659
+ :principal_entity_type,
1660
+ :configuration)
1445
1661
  SENSITIVE = [:principal_entity_type]
1446
1662
  include Aws::Structure
1447
1663
  end
1448
1664
 
1449
1665
  # A structure that contains configuration of the identity source.
1450
1666
  #
1451
- # This data type is used as a response parameter for the
1452
- # [CreateIdentitySource][1] operation.
1667
+ # This data type was a response parameter for the
1668
+ # [ListIdentitySources][1] operation. Replaced by
1669
+ # [ConfigurationItem][2].
1453
1670
  #
1454
1671
  #
1455
1672
  #
1456
- # [1]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreateIdentitySource.html
1673
+ # [1]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListIdentitySources.html
1674
+ # [2]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ConfigurationItem.html
1457
1675
  #
1458
1676
  # @!attribute [rw] client_ids
1459
1677
  # The application client IDs associated with the specified Amazon
@@ -1597,14 +1815,20 @@ module Aws::VerifiedPermissions
1597
1815
  # Specifies an identity token for the principal to be authorized. This
1598
1816
  # token is provided to you by the identity provider (IdP) associated
1599
1817
  # with the specified identity source. You must specify either an
1600
- # `AccessToken` or an `IdentityToken`, or both.
1818
+ # `accessToken`, an `identityToken`, or both.
1819
+ #
1820
+ # Must be an ID token. Verified Permissions returns an error if the
1821
+ # `token_use` claim in the submitted token isn't `id`.
1601
1822
  # @return [String]
1602
1823
  #
1603
1824
  # @!attribute [rw] access_token
1604
1825
  # Specifies an access token for the principal to be authorized. This
1605
1826
  # token is provided to you by the identity provider (IdP) associated
1606
1827
  # with the specified identity source. You must specify either an
1607
- # `AccessToken`, or an `IdentityToken`, or both.
1828
+ # `accessToken`, an `identityToken`, or both.
1829
+ #
1830
+ # Must be an access token. Verified Permissions returns an error if
1831
+ # the `token_use` claim in the submitted token isn't `access`.
1608
1832
  # @return [String]
1609
1833
  #
1610
1834
  # @!attribute [rw] action
@@ -2509,13 +2733,8 @@ module Aws::VerifiedPermissions
2509
2733
  include Aws::Structure
2510
2734
  end
2511
2735
 
2512
- # Contains information about a policy that was
2513
- #
2514
- #
2515
- #
2516
- # created by instantiating a policy template.
2517
- #
2518
- # This
2736
+ # Contains information about a policy that was created by instantiating
2737
+ # a policy template.
2519
2738
  #
2520
2739
  # @!attribute [rw] policy_template_id
2521
2740
  # The unique identifier of the policy template used to create this
@@ -53,6 +53,6 @@ require_relative 'aws-sdk-verifiedpermissions/customizations'
53
53
  # @!group service
54
54
  module Aws::VerifiedPermissions
55
55
 
56
- GEM_VERSION = '1.15.0'
56
+ GEM_VERSION = '1.17.0'
57
57
 
58
58
  end