aws-sdk-cognitoidentityprovider 1.0.0.rc12 → 1.0.0.rc13
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -314,7 +314,7 @@ module Aws::CognitoIdentityProvider
|
|
314
314
|
# user.
|
315
315
|
#
|
316
316
|
# @!attribute [rw] user
|
317
|
-
# The
|
317
|
+
# The newly created user.
|
318
318
|
# @return [Types::UserType]
|
319
319
|
#
|
320
320
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminCreateUserResponse AWS API Documentation
|
@@ -396,6 +396,38 @@ module Aws::CognitoIdentityProvider
|
|
396
396
|
include Aws::Structure
|
397
397
|
end
|
398
398
|
|
399
|
+
# @note When making an API call, you may pass AdminDisableProviderForUserRequest
|
400
|
+
# data as a hash:
|
401
|
+
#
|
402
|
+
# {
|
403
|
+
# user_pool_id: "StringType", # required
|
404
|
+
# user: { # required
|
405
|
+
# provider_name: "ProviderNameType",
|
406
|
+
# provider_attribute_name: "StringType",
|
407
|
+
# provider_attribute_value: "StringType",
|
408
|
+
# },
|
409
|
+
# }
|
410
|
+
#
|
411
|
+
# @!attribute [rw] user_pool_id
|
412
|
+
# The user pool ID for the user pool.
|
413
|
+
# @return [String]
|
414
|
+
#
|
415
|
+
# @!attribute [rw] user
|
416
|
+
# The user to be disabled.
|
417
|
+
# @return [Types::ProviderUserIdentifierType]
|
418
|
+
#
|
419
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminDisableProviderForUserRequest AWS API Documentation
|
420
|
+
#
|
421
|
+
class AdminDisableProviderForUserRequest < Struct.new(
|
422
|
+
:user_pool_id,
|
423
|
+
:user)
|
424
|
+
include Aws::Structure
|
425
|
+
end
|
426
|
+
|
427
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminDisableProviderForUserResponse AWS API Documentation
|
428
|
+
#
|
429
|
+
class AdminDisableProviderForUserResponse < Aws::EmptyStructure; end
|
430
|
+
|
399
431
|
# Represents the request to disable any user as an administrator.
|
400
432
|
#
|
401
433
|
# @note When making an API call, you may pass AdminDisableUserRequest
|
@@ -789,6 +821,81 @@ module Aws::CognitoIdentityProvider
|
|
789
821
|
include Aws::Structure
|
790
822
|
end
|
791
823
|
|
824
|
+
# @note When making an API call, you may pass AdminLinkProviderForUserRequest
|
825
|
+
# data as a hash:
|
826
|
+
#
|
827
|
+
# {
|
828
|
+
# user_pool_id: "StringType", # required
|
829
|
+
# destination_user: { # required
|
830
|
+
# provider_name: "ProviderNameType",
|
831
|
+
# provider_attribute_name: "StringType",
|
832
|
+
# provider_attribute_value: "StringType",
|
833
|
+
# },
|
834
|
+
# source_user: { # required
|
835
|
+
# provider_name: "ProviderNameType",
|
836
|
+
# provider_attribute_name: "StringType",
|
837
|
+
# provider_attribute_value: "StringType",
|
838
|
+
# },
|
839
|
+
# }
|
840
|
+
#
|
841
|
+
# @!attribute [rw] user_pool_id
|
842
|
+
# The user pool ID for the user pool.
|
843
|
+
# @return [String]
|
844
|
+
#
|
845
|
+
# @!attribute [rw] destination_user
|
846
|
+
# The existing user in the user pool to be linked to the external
|
847
|
+
# identity provider user account. Can be a native (Username +
|
848
|
+
# Password) Cognito User Pools user or a federated user (for example,
|
849
|
+
# a SAML or Facebook user). If the user doesn't exist, an exception
|
850
|
+
# is thrown. This is the user that is returned when the new user (with
|
851
|
+
# the linked identity provider attribute) signs in.
|
852
|
+
#
|
853
|
+
# The `ProviderAttributeValue` for the `DestinationUser` must match
|
854
|
+
# the username for the user in the user pool. The
|
855
|
+
# `ProviderAttributeName` will always be ignored.
|
856
|
+
# @return [Types::ProviderUserIdentifierType]
|
857
|
+
#
|
858
|
+
# @!attribute [rw] source_user
|
859
|
+
# An external identity provider account for a user who does not
|
860
|
+
# currently exist yet in the user pool. This user must be a federated
|
861
|
+
# user (for example, a SAML or Facebook user), not another native
|
862
|
+
# user.
|
863
|
+
#
|
864
|
+
# If the `SourceUser` is a federated social identity provider user
|
865
|
+
# (Facebook, Google, or Login with Amazon), you must set the
|
866
|
+
# `ProviderAttributeName` to `Cognito_Subject`. For social identity
|
867
|
+
# providers, the `ProviderName` will be `Facebook`, `Google`, or
|
868
|
+
# `LoginWithAmazon`, and Cognito will automatically parse the
|
869
|
+
# Facebook, Google, and Login with Amazon tokens for `id`, `sub`, and
|
870
|
+
# `user_id`, respectively. The `ProviderAttributeValue` for the user
|
871
|
+
# must be the same value as the `id`, `sub`, or `user_id` value found
|
872
|
+
# in the social identity provider token.
|
873
|
+
#
|
874
|
+
#
|
875
|
+
#
|
876
|
+
# For SAML, the `ProviderAttributeName` can be any value that matches
|
877
|
+
# a claim in the SAML assertion. If you wish to link SAML users based
|
878
|
+
# on the subject of the SAML assertion, you should map the subject to
|
879
|
+
# a claim through the SAML identity provider and submit that claim
|
880
|
+
# name as the `ProviderAttributeName`. If you set
|
881
|
+
# `ProviderAttributeName` to `Cognito_Subject`, Cognito will
|
882
|
+
# automatically parse the default unique identifier found in the
|
883
|
+
# subject from the SAML token.
|
884
|
+
# @return [Types::ProviderUserIdentifierType]
|
885
|
+
#
|
886
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminLinkProviderForUserRequest AWS API Documentation
|
887
|
+
#
|
888
|
+
class AdminLinkProviderForUserRequest < Struct.new(
|
889
|
+
:user_pool_id,
|
890
|
+
:destination_user,
|
891
|
+
:source_user)
|
892
|
+
include Aws::Structure
|
893
|
+
end
|
894
|
+
|
895
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminLinkProviderForUserResponse AWS API Documentation
|
896
|
+
#
|
897
|
+
class AdminLinkProviderForUserResponse < Aws::EmptyStructure; end
|
898
|
+
|
792
899
|
# Represents the request to list devices, as an administrator.
|
793
900
|
#
|
794
901
|
# @note When making an API call, you may pass AdminListDevicesRequest
|
@@ -1443,7 +1550,7 @@ module Aws::CognitoIdentityProvider
|
|
1443
1550
|
# }
|
1444
1551
|
#
|
1445
1552
|
# @!attribute [rw] client_id
|
1446
|
-
# The ID of the
|
1553
|
+
# The app client ID of the app associated with the user pool.
|
1447
1554
|
# @return [String]
|
1448
1555
|
#
|
1449
1556
|
# @!attribute [rw] secret_hash
|
@@ -1500,7 +1607,7 @@ module Aws::CognitoIdentityProvider
|
|
1500
1607
|
# }
|
1501
1608
|
#
|
1502
1609
|
# @!attribute [rw] client_id
|
1503
|
-
# The ID of the client associated with the user pool.
|
1610
|
+
# The ID of the app client associated with the user pool.
|
1504
1611
|
# @return [String]
|
1505
1612
|
#
|
1506
1613
|
# @!attribute [rw] secret_hash
|
@@ -1620,13 +1727,13 @@ module Aws::CognitoIdentityProvider
|
|
1620
1727
|
#
|
1621
1728
|
# {
|
1622
1729
|
# user_pool_id: "UserPoolIdType", # required
|
1623
|
-
# provider_name: "
|
1624
|
-
# provider_type: "SAML", # required, accepts SAML
|
1730
|
+
# provider_name: "ProviderNameTypeV1", # required
|
1731
|
+
# provider_type: "SAML", # required, accepts SAML, Facebook, Google, LoginWithAmazon
|
1625
1732
|
# provider_details: { # required
|
1626
1733
|
# "StringType" => "StringType",
|
1627
1734
|
# },
|
1628
1735
|
# attribute_mapping: {
|
1629
|
-
# "
|
1736
|
+
# "AttributeMappingKeyType" => "StringType",
|
1630
1737
|
# },
|
1631
1738
|
# idp_identifiers: ["IdpIdentifierType"],
|
1632
1739
|
# }
|
@@ -1680,6 +1787,61 @@ module Aws::CognitoIdentityProvider
|
|
1680
1787
|
include Aws::Structure
|
1681
1788
|
end
|
1682
1789
|
|
1790
|
+
# @note When making an API call, you may pass CreateResourceServerRequest
|
1791
|
+
# data as a hash:
|
1792
|
+
#
|
1793
|
+
# {
|
1794
|
+
# user_pool_id: "UserPoolIdType", # required
|
1795
|
+
# identifier: "ResourceServerIdentifierType", # required
|
1796
|
+
# name: "ResourceServerNameType", # required
|
1797
|
+
# scopes: [
|
1798
|
+
# {
|
1799
|
+
# scope_name: "ResourceServerScopeNameType", # required
|
1800
|
+
# scope_description: "ResourceServerScopeDescriptionType", # required
|
1801
|
+
# },
|
1802
|
+
# ],
|
1803
|
+
# }
|
1804
|
+
#
|
1805
|
+
# @!attribute [rw] user_pool_id
|
1806
|
+
# The user pool ID for the user pool.
|
1807
|
+
# @return [String]
|
1808
|
+
#
|
1809
|
+
# @!attribute [rw] identifier
|
1810
|
+
# A unique resource server identifier for the resource server. This
|
1811
|
+
# could be an HTTPS endpoint where the resource server is located. For
|
1812
|
+
# example, `https://my-weather-api.example.com`.
|
1813
|
+
# @return [String]
|
1814
|
+
#
|
1815
|
+
# @!attribute [rw] name
|
1816
|
+
# A friendly name for the resource server.
|
1817
|
+
# @return [String]
|
1818
|
+
#
|
1819
|
+
# @!attribute [rw] scopes
|
1820
|
+
# A list of scopes. Each scope is map, where the keys are `name` and
|
1821
|
+
# `description`.
|
1822
|
+
# @return [Array<Types::ResourceServerScopeType>]
|
1823
|
+
#
|
1824
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/CreateResourceServerRequest AWS API Documentation
|
1825
|
+
#
|
1826
|
+
class CreateResourceServerRequest < Struct.new(
|
1827
|
+
:user_pool_id,
|
1828
|
+
:identifier,
|
1829
|
+
:name,
|
1830
|
+
:scopes)
|
1831
|
+
include Aws::Structure
|
1832
|
+
end
|
1833
|
+
|
1834
|
+
# @!attribute [rw] resource_server
|
1835
|
+
# The newly created resource server.
|
1836
|
+
# @return [Types::ResourceServerType]
|
1837
|
+
#
|
1838
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/CreateResourceServerResponse AWS API Documentation
|
1839
|
+
#
|
1840
|
+
class CreateResourceServerResponse < Struct.new(
|
1841
|
+
:resource_server)
|
1842
|
+
include Aws::Structure
|
1843
|
+
end
|
1844
|
+
|
1683
1845
|
# Represents the request to create the user import job.
|
1684
1846
|
#
|
1685
1847
|
# @note When making an API call, you may pass CreateUserImportJobRequest
|
@@ -1910,6 +2072,14 @@ module Aws::CognitoIdentityProvider
|
|
1910
2072
|
# sms_verification_message: "SmsVerificationMessageType",
|
1911
2073
|
# email_verification_message: "EmailVerificationMessageType",
|
1912
2074
|
# email_verification_subject: "EmailVerificationSubjectType",
|
2075
|
+
# verification_message_template: {
|
2076
|
+
# sms_message: "SmsVerificationMessageType",
|
2077
|
+
# email_message: "EmailVerificationMessageType",
|
2078
|
+
# email_subject: "EmailVerificationSubjectType",
|
2079
|
+
# email_message_by_link: "EmailVerificationMessageByLinkType",
|
2080
|
+
# email_subject_by_link: "EmailVerificationSubjectByLinkType",
|
2081
|
+
# default_email_option: "CONFIRM_WITH_LINK", # accepts CONFIRM_WITH_LINK, CONFIRM_WITH_CODE
|
2082
|
+
# },
|
1913
2083
|
# sms_authentication_message: "SmsVerificationMessageType",
|
1914
2084
|
# mfa_configuration: "OFF", # accepts OFF, ON, OPTIONAL
|
1915
2085
|
# device_configuration: {
|
@@ -1994,6 +2164,11 @@ module Aws::CognitoIdentityProvider
|
|
1994
2164
|
# A string representing the email verification subject.
|
1995
2165
|
# @return [String]
|
1996
2166
|
#
|
2167
|
+
# @!attribute [rw] verification_message_template
|
2168
|
+
# The template for the verification message that the user sees when
|
2169
|
+
# the app requests permission to access the user's information.
|
2170
|
+
# @return [Types::VerificationMessageTemplateType]
|
2171
|
+
#
|
1997
2172
|
# @!attribute [rw] sms_authentication_message
|
1998
2173
|
# A string representing the SMS authentication message.
|
1999
2174
|
# @return [String]
|
@@ -2044,6 +2219,7 @@ module Aws::CognitoIdentityProvider
|
|
2044
2219
|
:sms_verification_message,
|
2045
2220
|
:email_verification_message,
|
2046
2221
|
:email_verification_subject,
|
2222
|
+
:verification_message_template,
|
2047
2223
|
:sms_authentication_message,
|
2048
2224
|
:mfa_configuration,
|
2049
2225
|
:device_configuration,
|
@@ -2117,6 +2293,30 @@ module Aws::CognitoIdentityProvider
|
|
2117
2293
|
include Aws::Structure
|
2118
2294
|
end
|
2119
2295
|
|
2296
|
+
# @note When making an API call, you may pass DeleteResourceServerRequest
|
2297
|
+
# data as a hash:
|
2298
|
+
#
|
2299
|
+
# {
|
2300
|
+
# user_pool_id: "UserPoolIdType", # required
|
2301
|
+
# identifier: "ResourceServerIdentifierType", # required
|
2302
|
+
# }
|
2303
|
+
#
|
2304
|
+
# @!attribute [rw] user_pool_id
|
2305
|
+
# The user pool ID for the user pool that hosts the resource server.
|
2306
|
+
# @return [String]
|
2307
|
+
#
|
2308
|
+
# @!attribute [rw] identifier
|
2309
|
+
# The identifier for the resource server.
|
2310
|
+
# @return [String]
|
2311
|
+
#
|
2312
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DeleteResourceServerRequest AWS API Documentation
|
2313
|
+
#
|
2314
|
+
class DeleteResourceServerRequest < Struct.new(
|
2315
|
+
:user_pool_id,
|
2316
|
+
:identifier)
|
2317
|
+
include Aws::Structure
|
2318
|
+
end
|
2319
|
+
|
2120
2320
|
# Represents the request to delete user attributes.
|
2121
2321
|
#
|
2122
2322
|
# @note When making an API call, you may pass DeleteUserAttributesRequest
|
@@ -2169,7 +2369,7 @@ module Aws::CognitoIdentityProvider
|
|
2169
2369
|
# @return [String]
|
2170
2370
|
#
|
2171
2371
|
# @!attribute [rw] client_id
|
2172
|
-
# The ID of the
|
2372
|
+
# The app client ID of the app associated with the user pool.
|
2173
2373
|
# @return [String]
|
2174
2374
|
#
|
2175
2375
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DeleteUserPoolClientRequest AWS API Documentation
|
@@ -2283,6 +2483,41 @@ module Aws::CognitoIdentityProvider
|
|
2283
2483
|
include Aws::Structure
|
2284
2484
|
end
|
2285
2485
|
|
2486
|
+
# @note When making an API call, you may pass DescribeResourceServerRequest
|
2487
|
+
# data as a hash:
|
2488
|
+
#
|
2489
|
+
# {
|
2490
|
+
# user_pool_id: "UserPoolIdType", # required
|
2491
|
+
# identifier: "ResourceServerIdentifierType", # required
|
2492
|
+
# }
|
2493
|
+
#
|
2494
|
+
# @!attribute [rw] user_pool_id
|
2495
|
+
# The user pool ID for the user pool that hosts the resource server.
|
2496
|
+
# @return [String]
|
2497
|
+
#
|
2498
|
+
# @!attribute [rw] identifier
|
2499
|
+
# The identifier for the resource server
|
2500
|
+
# @return [String]
|
2501
|
+
#
|
2502
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DescribeResourceServerRequest AWS API Documentation
|
2503
|
+
#
|
2504
|
+
class DescribeResourceServerRequest < Struct.new(
|
2505
|
+
:user_pool_id,
|
2506
|
+
:identifier)
|
2507
|
+
include Aws::Structure
|
2508
|
+
end
|
2509
|
+
|
2510
|
+
# @!attribute [rw] resource_server
|
2511
|
+
# The resource server.
|
2512
|
+
# @return [Types::ResourceServerType]
|
2513
|
+
#
|
2514
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DescribeResourceServerResponse AWS API Documentation
|
2515
|
+
#
|
2516
|
+
class DescribeResourceServerResponse < Struct.new(
|
2517
|
+
:resource_server)
|
2518
|
+
include Aws::Structure
|
2519
|
+
end
|
2520
|
+
|
2286
2521
|
# Represents the request to describe the user import job.
|
2287
2522
|
#
|
2288
2523
|
# @note When making an API call, you may pass DescribeUserImportJobRequest
|
@@ -2339,7 +2574,7 @@ module Aws::CognitoIdentityProvider
|
|
2339
2574
|
# @return [String]
|
2340
2575
|
#
|
2341
2576
|
# @!attribute [rw] client_id
|
2342
|
-
# The ID of the
|
2577
|
+
# The app client ID of the app associated with the user pool.
|
2343
2578
|
# @return [String]
|
2344
2579
|
#
|
2345
2580
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DescribeUserPoolClientRequest AWS API Documentation
|
@@ -2810,6 +3045,41 @@ module Aws::CognitoIdentityProvider
|
|
2810
3045
|
include Aws::Structure
|
2811
3046
|
end
|
2812
3047
|
|
3048
|
+
# @note When making an API call, you may pass GetUICustomizationRequest
|
3049
|
+
# data as a hash:
|
3050
|
+
#
|
3051
|
+
# {
|
3052
|
+
# user_pool_id: "UserPoolIdType", # required
|
3053
|
+
# client_id: "ClientIdType",
|
3054
|
+
# }
|
3055
|
+
#
|
3056
|
+
# @!attribute [rw] user_pool_id
|
3057
|
+
# The user pool ID for the user pool.
|
3058
|
+
# @return [String]
|
3059
|
+
#
|
3060
|
+
# @!attribute [rw] client_id
|
3061
|
+
# The client ID for the client app.
|
3062
|
+
# @return [String]
|
3063
|
+
#
|
3064
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/GetUICustomizationRequest AWS API Documentation
|
3065
|
+
#
|
3066
|
+
class GetUICustomizationRequest < Struct.new(
|
3067
|
+
:user_pool_id,
|
3068
|
+
:client_id)
|
3069
|
+
include Aws::Structure
|
3070
|
+
end
|
3071
|
+
|
3072
|
+
# @!attribute [rw] ui_customization
|
3073
|
+
# The UI customization information.
|
3074
|
+
# @return [Types::UICustomizationType]
|
3075
|
+
#
|
3076
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/GetUICustomizationResponse AWS API Documentation
|
3077
|
+
#
|
3078
|
+
class GetUICustomizationResponse < Struct.new(
|
3079
|
+
:ui_customization)
|
3080
|
+
include Aws::Structure
|
3081
|
+
end
|
3082
|
+
|
2813
3083
|
# Represents the request to get user attribute verification.
|
2814
3084
|
#
|
2815
3085
|
# @note When making an API call, you may pass GetUserAttributeVerificationCodeRequest
|
@@ -3394,6 +3664,52 @@ module Aws::CognitoIdentityProvider
|
|
3394
3664
|
include Aws::Structure
|
3395
3665
|
end
|
3396
3666
|
|
3667
|
+
# @note When making an API call, you may pass ListResourceServersRequest
|
3668
|
+
# data as a hash:
|
3669
|
+
#
|
3670
|
+
# {
|
3671
|
+
# user_pool_id: "UserPoolIdType", # required
|
3672
|
+
# max_results: 1,
|
3673
|
+
# next_token: "PaginationKeyType",
|
3674
|
+
# }
|
3675
|
+
#
|
3676
|
+
# @!attribute [rw] user_pool_id
|
3677
|
+
# The user pool ID for the user pool.
|
3678
|
+
# @return [String]
|
3679
|
+
#
|
3680
|
+
# @!attribute [rw] max_results
|
3681
|
+
# The maximum number of resource servers to return.
|
3682
|
+
# @return [Integer]
|
3683
|
+
#
|
3684
|
+
# @!attribute [rw] next_token
|
3685
|
+
# A pagination token.
|
3686
|
+
# @return [String]
|
3687
|
+
#
|
3688
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ListResourceServersRequest AWS API Documentation
|
3689
|
+
#
|
3690
|
+
class ListResourceServersRequest < Struct.new(
|
3691
|
+
:user_pool_id,
|
3692
|
+
:max_results,
|
3693
|
+
:next_token)
|
3694
|
+
include Aws::Structure
|
3695
|
+
end
|
3696
|
+
|
3697
|
+
# @!attribute [rw] resource_servers
|
3698
|
+
# The resource servers.
|
3699
|
+
# @return [Array<Types::ResourceServerType>]
|
3700
|
+
#
|
3701
|
+
# @!attribute [rw] next_token
|
3702
|
+
# A pagination token.
|
3703
|
+
# @return [String]
|
3704
|
+
#
|
3705
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ListResourceServersResponse AWS API Documentation
|
3706
|
+
#
|
3707
|
+
class ListResourceServersResponse < Struct.new(
|
3708
|
+
:resource_servers,
|
3709
|
+
:next_token)
|
3710
|
+
include Aws::Structure
|
3711
|
+
end
|
3712
|
+
|
3397
3713
|
# Represents the request to list the user import jobs.
|
3398
3714
|
#
|
3399
3715
|
# @note When making an API call, you may pass ListUserImportJobsRequest
|
@@ -3911,6 +4227,42 @@ module Aws::CognitoIdentityProvider
|
|
3911
4227
|
include Aws::Structure
|
3912
4228
|
end
|
3913
4229
|
|
4230
|
+
# A container for information about an identity provider for a user
|
4231
|
+
# pool.
|
4232
|
+
#
|
4233
|
+
# @note When making an API call, you may pass ProviderUserIdentifierType
|
4234
|
+
# data as a hash:
|
4235
|
+
#
|
4236
|
+
# {
|
4237
|
+
# provider_name: "ProviderNameType",
|
4238
|
+
# provider_attribute_name: "StringType",
|
4239
|
+
# provider_attribute_value: "StringType",
|
4240
|
+
# }
|
4241
|
+
#
|
4242
|
+
# @!attribute [rw] provider_name
|
4243
|
+
# The name of the provider, for example, Facebook, Google, or Login
|
4244
|
+
# with Amazon.
|
4245
|
+
# @return [String]
|
4246
|
+
#
|
4247
|
+
# @!attribute [rw] provider_attribute_name
|
4248
|
+
# The name of the provider attribute to link to, for example,
|
4249
|
+
# `NameID`.
|
4250
|
+
# @return [String]
|
4251
|
+
#
|
4252
|
+
# @!attribute [rw] provider_attribute_value
|
4253
|
+
# The value of the provider attribute to link to, for example,
|
4254
|
+
# `xxxxx_account`.
|
4255
|
+
# @return [String]
|
4256
|
+
#
|
4257
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ProviderUserIdentifierType AWS API Documentation
|
4258
|
+
#
|
4259
|
+
class ProviderUserIdentifierType < Struct.new(
|
4260
|
+
:provider_name,
|
4261
|
+
:provider_attribute_name,
|
4262
|
+
:provider_attribute_value)
|
4263
|
+
include Aws::Structure
|
4264
|
+
end
|
4265
|
+
|
3914
4266
|
# Represents the request to resend the confirmation code.
|
3915
4267
|
#
|
3916
4268
|
# @note When making an API call, you may pass ResendConfirmationCodeRequest
|
@@ -3961,6 +4313,60 @@ module Aws::CognitoIdentityProvider
|
|
3961
4313
|
include Aws::Structure
|
3962
4314
|
end
|
3963
4315
|
|
4316
|
+
# A resource server scope.
|
4317
|
+
#
|
4318
|
+
# @note When making an API call, you may pass ResourceServerScopeType
|
4319
|
+
# data as a hash:
|
4320
|
+
#
|
4321
|
+
# {
|
4322
|
+
# scope_name: "ResourceServerScopeNameType", # required
|
4323
|
+
# scope_description: "ResourceServerScopeDescriptionType", # required
|
4324
|
+
# }
|
4325
|
+
#
|
4326
|
+
# @!attribute [rw] scope_name
|
4327
|
+
# The name of the scope.
|
4328
|
+
# @return [String]
|
4329
|
+
#
|
4330
|
+
# @!attribute [rw] scope_description
|
4331
|
+
# A description of the scope.
|
4332
|
+
# @return [String]
|
4333
|
+
#
|
4334
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ResourceServerScopeType AWS API Documentation
|
4335
|
+
#
|
4336
|
+
class ResourceServerScopeType < Struct.new(
|
4337
|
+
:scope_name,
|
4338
|
+
:scope_description)
|
4339
|
+
include Aws::Structure
|
4340
|
+
end
|
4341
|
+
|
4342
|
+
# A container for information about a resource server for a user pool.
|
4343
|
+
#
|
4344
|
+
# @!attribute [rw] user_pool_id
|
4345
|
+
# The user pool ID for the user pool that hosts the resource server.
|
4346
|
+
# @return [String]
|
4347
|
+
#
|
4348
|
+
# @!attribute [rw] identifier
|
4349
|
+
# The identifier for the resource server.
|
4350
|
+
# @return [String]
|
4351
|
+
#
|
4352
|
+
# @!attribute [rw] name
|
4353
|
+
# The name of the resource server.
|
4354
|
+
# @return [String]
|
4355
|
+
#
|
4356
|
+
# @!attribute [rw] scopes
|
4357
|
+
# A list of scopes that are defined for the resource server.
|
4358
|
+
# @return [Array<Types::ResourceServerScopeType>]
|
4359
|
+
#
|
4360
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ResourceServerType AWS API Documentation
|
4361
|
+
#
|
4362
|
+
class ResourceServerType < Struct.new(
|
4363
|
+
:user_pool_id,
|
4364
|
+
:identifier,
|
4365
|
+
:name,
|
4366
|
+
:scopes)
|
4367
|
+
include Aws::Structure
|
4368
|
+
end
|
4369
|
+
|
3964
4370
|
# The request to respond to an authentication challenge.
|
3965
4371
|
#
|
3966
4372
|
# @note When making an API call, you may pass RespondToAuthChallengeRequest
|
@@ -4123,6 +4529,53 @@ module Aws::CognitoIdentityProvider
|
|
4123
4529
|
include Aws::Structure
|
4124
4530
|
end
|
4125
4531
|
|
4532
|
+
# @note When making an API call, you may pass SetUICustomizationRequest
|
4533
|
+
# data as a hash:
|
4534
|
+
#
|
4535
|
+
# {
|
4536
|
+
# user_pool_id: "UserPoolIdType", # required
|
4537
|
+
# client_id: "ClientIdType",
|
4538
|
+
# css: "CSSType",
|
4539
|
+
# image_file: "data",
|
4540
|
+
# }
|
4541
|
+
#
|
4542
|
+
# @!attribute [rw] user_pool_id
|
4543
|
+
# The user pool ID for the user pool.
|
4544
|
+
# @return [String]
|
4545
|
+
#
|
4546
|
+
# @!attribute [rw] client_id
|
4547
|
+
# The client ID for the client app.
|
4548
|
+
# @return [String]
|
4549
|
+
#
|
4550
|
+
# @!attribute [rw] css
|
4551
|
+
# The CSS values in the UI customization.
|
4552
|
+
# @return [String]
|
4553
|
+
#
|
4554
|
+
# @!attribute [rw] image_file
|
4555
|
+
# The uploaded logo image for the UI customization.
|
4556
|
+
# @return [String]
|
4557
|
+
#
|
4558
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/SetUICustomizationRequest AWS API Documentation
|
4559
|
+
#
|
4560
|
+
class SetUICustomizationRequest < Struct.new(
|
4561
|
+
:user_pool_id,
|
4562
|
+
:client_id,
|
4563
|
+
:css,
|
4564
|
+
:image_file)
|
4565
|
+
include Aws::Structure
|
4566
|
+
end
|
4567
|
+
|
4568
|
+
# @!attribute [rw] ui_customization
|
4569
|
+
# The UI customization information.
|
4570
|
+
# @return [Types::UICustomizationType]
|
4571
|
+
#
|
4572
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/SetUICustomizationResponse AWS API Documentation
|
4573
|
+
#
|
4574
|
+
class SetUICustomizationResponse < Struct.new(
|
4575
|
+
:ui_customization)
|
4576
|
+
include Aws::Structure
|
4577
|
+
end
|
4578
|
+
|
4126
4579
|
# Represents the request to set user settings.
|
4127
4580
|
#
|
4128
4581
|
# @note When making an API call, you may pass SetUserSettingsRequest
|
@@ -4387,6 +4840,50 @@ module Aws::CognitoIdentityProvider
|
|
4387
4840
|
include Aws::Structure
|
4388
4841
|
end
|
4389
4842
|
|
4843
|
+
# A container for the UI customization information for a user pool's
|
4844
|
+
# built-in app UI.
|
4845
|
+
#
|
4846
|
+
# @!attribute [rw] user_pool_id
|
4847
|
+
# The user pool ID for the user pool.
|
4848
|
+
# @return [String]
|
4849
|
+
#
|
4850
|
+
# @!attribute [rw] client_id
|
4851
|
+
# The client ID for the client app.
|
4852
|
+
# @return [String]
|
4853
|
+
#
|
4854
|
+
# @!attribute [rw] image_url
|
4855
|
+
# The logo image for the UI customization.
|
4856
|
+
# @return [String]
|
4857
|
+
#
|
4858
|
+
# @!attribute [rw] css
|
4859
|
+
# The CSS values in the UI customization.
|
4860
|
+
# @return [String]
|
4861
|
+
#
|
4862
|
+
# @!attribute [rw] css_version
|
4863
|
+
# The CSS version number.
|
4864
|
+
# @return [String]
|
4865
|
+
#
|
4866
|
+
# @!attribute [rw] last_modified_date
|
4867
|
+
# The last-modified date for the UI customization.
|
4868
|
+
# @return [Time]
|
4869
|
+
#
|
4870
|
+
# @!attribute [rw] creation_date
|
4871
|
+
# The creation date for the UI customization.
|
4872
|
+
# @return [Time]
|
4873
|
+
#
|
4874
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UICustomizationType AWS API Documentation
|
4875
|
+
#
|
4876
|
+
class UICustomizationType < Struct.new(
|
4877
|
+
:user_pool_id,
|
4878
|
+
:client_id,
|
4879
|
+
:image_url,
|
4880
|
+
:css,
|
4881
|
+
:css_version,
|
4882
|
+
:last_modified_date,
|
4883
|
+
:creation_date)
|
4884
|
+
include Aws::Structure
|
4885
|
+
end
|
4886
|
+
|
4390
4887
|
# Represents the request to update the device status.
|
4391
4888
|
#
|
4392
4889
|
# @note When making an API call, you may pass UpdateDeviceStatusRequest
|
@@ -4490,7 +4987,7 @@ module Aws::CognitoIdentityProvider
|
|
4490
4987
|
# "StringType" => "StringType",
|
4491
4988
|
# },
|
4492
4989
|
# attribute_mapping: {
|
4493
|
-
# "
|
4990
|
+
# "AttributeMappingKeyType" => "StringType",
|
4494
4991
|
# },
|
4495
4992
|
# idp_identifiers: ["IdpIdentifierType"],
|
4496
4993
|
# }
|
@@ -4538,6 +5035,58 @@ module Aws::CognitoIdentityProvider
|
|
4538
5035
|
include Aws::Structure
|
4539
5036
|
end
|
4540
5037
|
|
5038
|
+
# @note When making an API call, you may pass UpdateResourceServerRequest
|
5039
|
+
# data as a hash:
|
5040
|
+
#
|
5041
|
+
# {
|
5042
|
+
# user_pool_id: "UserPoolIdType", # required
|
5043
|
+
# identifier: "ResourceServerIdentifierType", # required
|
5044
|
+
# name: "ResourceServerNameType", # required
|
5045
|
+
# scopes: [
|
5046
|
+
# {
|
5047
|
+
# scope_name: "ResourceServerScopeNameType", # required
|
5048
|
+
# scope_description: "ResourceServerScopeDescriptionType", # required
|
5049
|
+
# },
|
5050
|
+
# ],
|
5051
|
+
# }
|
5052
|
+
#
|
5053
|
+
# @!attribute [rw] user_pool_id
|
5054
|
+
# The user pool ID for the user pool.
|
5055
|
+
# @return [String]
|
5056
|
+
#
|
5057
|
+
# @!attribute [rw] identifier
|
5058
|
+
# The identifier for the resource server.
|
5059
|
+
# @return [String]
|
5060
|
+
#
|
5061
|
+
# @!attribute [rw] name
|
5062
|
+
# The name of the resource server.
|
5063
|
+
# @return [String]
|
5064
|
+
#
|
5065
|
+
# @!attribute [rw] scopes
|
5066
|
+
# The scope values to be set for the resource server.
|
5067
|
+
# @return [Array<Types::ResourceServerScopeType>]
|
5068
|
+
#
|
5069
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UpdateResourceServerRequest AWS API Documentation
|
5070
|
+
#
|
5071
|
+
class UpdateResourceServerRequest < Struct.new(
|
5072
|
+
:user_pool_id,
|
5073
|
+
:identifier,
|
5074
|
+
:name,
|
5075
|
+
:scopes)
|
5076
|
+
include Aws::Structure
|
5077
|
+
end
|
5078
|
+
|
5079
|
+
# @!attribute [rw] resource_server
|
5080
|
+
# The resource server.
|
5081
|
+
# @return [Types::ResourceServerType]
|
5082
|
+
#
|
5083
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UpdateResourceServerResponse AWS API Documentation
|
5084
|
+
#
|
5085
|
+
class UpdateResourceServerResponse < Struct.new(
|
5086
|
+
:resource_server)
|
5087
|
+
include Aws::Structure
|
5088
|
+
end
|
5089
|
+
|
4541
5090
|
# Represents the request to update user attributes.
|
4542
5091
|
#
|
4543
5092
|
# @note When making an API call, you may pass UpdateUserAttributesRequest
|
@@ -4649,7 +5198,7 @@ module Aws::CognitoIdentityProvider
|
|
4649
5198
|
# @return [Array<String>]
|
4650
5199
|
#
|
4651
5200
|
# @!attribute [rw] logout_urls
|
4652
|
-
# A list
|
5201
|
+
# A list of allowed logout URLs for the identity providers.
|
4653
5202
|
# @return [Array<String>]
|
4654
5203
|
#
|
4655
5204
|
# @!attribute [rw] default_redirect_uri
|
@@ -4740,6 +5289,14 @@ module Aws::CognitoIdentityProvider
|
|
4740
5289
|
# sms_verification_message: "SmsVerificationMessageType",
|
4741
5290
|
# email_verification_message: "EmailVerificationMessageType",
|
4742
5291
|
# email_verification_subject: "EmailVerificationSubjectType",
|
5292
|
+
# verification_message_template: {
|
5293
|
+
# sms_message: "SmsVerificationMessageType",
|
5294
|
+
# email_message: "EmailVerificationMessageType",
|
5295
|
+
# email_subject: "EmailVerificationSubjectType",
|
5296
|
+
# email_message_by_link: "EmailVerificationMessageByLinkType",
|
5297
|
+
# email_subject_by_link: "EmailVerificationSubjectByLinkType",
|
5298
|
+
# default_email_option: "CONFIRM_WITH_LINK", # accepts CONFIRM_WITH_LINK, CONFIRM_WITH_CODE
|
5299
|
+
# },
|
4743
5300
|
# sms_authentication_message: "SmsVerificationMessageType",
|
4744
5301
|
# mfa_configuration: "OFF", # accepts OFF, ON, OPTIONAL
|
4745
5302
|
# device_configuration: {
|
@@ -4798,6 +5355,10 @@ module Aws::CognitoIdentityProvider
|
|
4798
5355
|
# The subject of the email verification message.
|
4799
5356
|
# @return [String]
|
4800
5357
|
#
|
5358
|
+
# @!attribute [rw] verification_message_template
|
5359
|
+
# The template for verification messages.
|
5360
|
+
# @return [Types::VerificationMessageTemplateType]
|
5361
|
+
#
|
4801
5362
|
# @!attribute [rw] sms_authentication_message
|
4802
5363
|
# The contents of the SMS authentication message.
|
4803
5364
|
# @return [String]
|
@@ -4850,6 +5411,7 @@ module Aws::CognitoIdentityProvider
|
|
4850
5411
|
:sms_verification_message,
|
4851
5412
|
:email_verification_message,
|
4852
5413
|
:email_verification_subject,
|
5414
|
+
:verification_message_template,
|
4853
5415
|
:sms_authentication_message,
|
4854
5416
|
:mfa_configuration,
|
4855
5417
|
:device_configuration,
|
@@ -4988,7 +5550,7 @@ module Aws::CognitoIdentityProvider
|
|
4988
5550
|
include Aws::Structure
|
4989
5551
|
end
|
4990
5552
|
|
4991
|
-
#
|
5553
|
+
# Contains information about a user pool client.
|
4992
5554
|
#
|
4993
5555
|
# @!attribute [rw] user_pool_id
|
4994
5556
|
# The user pool ID for the user pool client.
|
@@ -5041,7 +5603,7 @@ module Aws::CognitoIdentityProvider
|
|
5041
5603
|
# @return [Array<String>]
|
5042
5604
|
#
|
5043
5605
|
# @!attribute [rw] logout_urls
|
5044
|
-
# A list
|
5606
|
+
# A list of allowed logout URLs for the identity providers.
|
5045
5607
|
# @return [Array<String>]
|
5046
5608
|
#
|
5047
5609
|
# @!attribute [rw] default_redirect_uri
|
@@ -5213,6 +5775,10 @@ module Aws::CognitoIdentityProvider
|
|
5213
5775
|
# The subject of the email verification message.
|
5214
5776
|
# @return [String]
|
5215
5777
|
#
|
5778
|
+
# @!attribute [rw] verification_message_template
|
5779
|
+
# The template for verification messages.
|
5780
|
+
# @return [Types::VerificationMessageTemplateType]
|
5781
|
+
#
|
5216
5782
|
# @!attribute [rw] sms_authentication_message
|
5217
5783
|
# The contents of the SMS authentication message.
|
5218
5784
|
# @return [String]
|
@@ -5286,6 +5852,7 @@ module Aws::CognitoIdentityProvider
|
|
5286
5852
|
:sms_verification_message,
|
5287
5853
|
:email_verification_message,
|
5288
5854
|
:email_verification_subject,
|
5855
|
+
:verification_message_template,
|
5289
5856
|
:sms_authentication_message,
|
5290
5857
|
:mfa_configuration,
|
5291
5858
|
:device_configuration,
|
@@ -5352,6 +5919,58 @@ module Aws::CognitoIdentityProvider
|
|
5352
5919
|
include Aws::Structure
|
5353
5920
|
end
|
5354
5921
|
|
5922
|
+
# The template for verification messages.
|
5923
|
+
#
|
5924
|
+
# @note When making an API call, you may pass VerificationMessageTemplateType
|
5925
|
+
# data as a hash:
|
5926
|
+
#
|
5927
|
+
# {
|
5928
|
+
# sms_message: "SmsVerificationMessageType",
|
5929
|
+
# email_message: "EmailVerificationMessageType",
|
5930
|
+
# email_subject: "EmailVerificationSubjectType",
|
5931
|
+
# email_message_by_link: "EmailVerificationMessageByLinkType",
|
5932
|
+
# email_subject_by_link: "EmailVerificationSubjectByLinkType",
|
5933
|
+
# default_email_option: "CONFIRM_WITH_LINK", # accepts CONFIRM_WITH_LINK, CONFIRM_WITH_CODE
|
5934
|
+
# }
|
5935
|
+
#
|
5936
|
+
# @!attribute [rw] sms_message
|
5937
|
+
# The SMS message template.
|
5938
|
+
# @return [String]
|
5939
|
+
#
|
5940
|
+
# @!attribute [rw] email_message
|
5941
|
+
# The email message template.
|
5942
|
+
# @return [String]
|
5943
|
+
#
|
5944
|
+
# @!attribute [rw] email_subject
|
5945
|
+
# The subject line for the email message template.
|
5946
|
+
# @return [String]
|
5947
|
+
#
|
5948
|
+
# @!attribute [rw] email_message_by_link
|
5949
|
+
# The email message template for sending a confirmation link to the
|
5950
|
+
# user.
|
5951
|
+
# @return [String]
|
5952
|
+
#
|
5953
|
+
# @!attribute [rw] email_subject_by_link
|
5954
|
+
# The subject line for the email message template for sending a
|
5955
|
+
# confirmation link to the user.
|
5956
|
+
# @return [String]
|
5957
|
+
#
|
5958
|
+
# @!attribute [rw] default_email_option
|
5959
|
+
# The default email option.
|
5960
|
+
# @return [String]
|
5961
|
+
#
|
5962
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/VerificationMessageTemplateType AWS API Documentation
|
5963
|
+
#
|
5964
|
+
class VerificationMessageTemplateType < Struct.new(
|
5965
|
+
:sms_message,
|
5966
|
+
:email_message,
|
5967
|
+
:email_subject,
|
5968
|
+
:email_message_by_link,
|
5969
|
+
:email_subject_by_link,
|
5970
|
+
:default_email_option)
|
5971
|
+
include Aws::Structure
|
5972
|
+
end
|
5973
|
+
|
5355
5974
|
# Represents the request to verify user attributes.
|
5356
5975
|
#
|
5357
5976
|
# @note When making an API call, you may pass VerifyUserAttributeRequest
|