aws-sdk-cognitoidentityprovider 1.85.0 → 1.86.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-cognitoidentityprovider/client.rb +1 -1
- data/lib/aws-sdk-cognitoidentityprovider/plugins/endpoints.rb +1 -0
- data/lib/aws-sdk-cognitoidentityprovider.rb +1 -1
- data/sig/client.rbs +1780 -0
- data/sig/errors.rbs +139 -0
- data/sig/resource.rbs +80 -0
- data/sig/types.rbs +2051 -0
- data/sig/waiters.rbs +13 -0
- metadata +13 -8
data/sig/client.rbs
ADDED
|
@@ -0,0 +1,1780 @@
|
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
|
2
|
+
#
|
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
|
5
|
+
#
|
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
|
7
|
+
|
|
8
|
+
module Aws
|
|
9
|
+
module CognitoIdentityProvider
|
|
10
|
+
class Client < ::Seahorse::Client::Base
|
|
11
|
+
include ::Aws::ClientStubs
|
|
12
|
+
|
|
13
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#initialize-instance_method
|
|
14
|
+
def self.new: (
|
|
15
|
+
?credentials: untyped,
|
|
16
|
+
?region: String,
|
|
17
|
+
?access_key_id: String,
|
|
18
|
+
?active_endpoint_cache: bool,
|
|
19
|
+
?adaptive_retry_wait_to_fill: bool,
|
|
20
|
+
?client_side_monitoring: bool,
|
|
21
|
+
?client_side_monitoring_client_id: String,
|
|
22
|
+
?client_side_monitoring_host: String,
|
|
23
|
+
?client_side_monitoring_port: Integer,
|
|
24
|
+
?client_side_monitoring_publisher: untyped,
|
|
25
|
+
?convert_params: bool,
|
|
26
|
+
?correct_clock_skew: bool,
|
|
27
|
+
?defaults_mode: String,
|
|
28
|
+
?disable_host_prefix_injection: bool,
|
|
29
|
+
?disable_request_compression: bool,
|
|
30
|
+
?endpoint: String,
|
|
31
|
+
?endpoint_cache_max_entries: Integer,
|
|
32
|
+
?endpoint_cache_max_threads: Integer,
|
|
33
|
+
?endpoint_cache_poll_interval: Integer,
|
|
34
|
+
?endpoint_discovery: bool,
|
|
35
|
+
?ignore_configured_endpoint_urls: bool,
|
|
36
|
+
?log_formatter: untyped,
|
|
37
|
+
?log_level: Symbol,
|
|
38
|
+
?logger: untyped,
|
|
39
|
+
?max_attempts: Integer,
|
|
40
|
+
?profile: String,
|
|
41
|
+
?request_min_compression_size_bytes: Integer,
|
|
42
|
+
?retry_backoff: Proc,
|
|
43
|
+
?retry_base_delay: Float,
|
|
44
|
+
?retry_jitter: (:none | :equal | :full | ^(Integer) -> Integer),
|
|
45
|
+
?retry_limit: Integer,
|
|
46
|
+
?retry_max_delay: Integer,
|
|
47
|
+
?retry_mode: ("legacy" | "standard" | "adaptive"),
|
|
48
|
+
?sdk_ua_app_id: String,
|
|
49
|
+
?secret_access_key: String,
|
|
50
|
+
?session_token: String,
|
|
51
|
+
?simple_json: bool,
|
|
52
|
+
?stub_responses: untyped,
|
|
53
|
+
?token_provider: untyped,
|
|
54
|
+
?use_dualstack_endpoint: bool,
|
|
55
|
+
?use_fips_endpoint: bool,
|
|
56
|
+
?validate_params: bool,
|
|
57
|
+
?endpoint_provider: untyped,
|
|
58
|
+
?http_proxy: String,
|
|
59
|
+
?http_open_timeout: (Float | Integer),
|
|
60
|
+
?http_read_timeout: (Float | Integer),
|
|
61
|
+
?http_idle_timeout: (Float | Integer),
|
|
62
|
+
?http_continue_timeout: (Float | Integer),
|
|
63
|
+
?ssl_timeout: (Float | Integer | nil),
|
|
64
|
+
?http_wire_trace: bool,
|
|
65
|
+
?ssl_verify_peer: bool,
|
|
66
|
+
?ssl_ca_bundle: String,
|
|
67
|
+
?ssl_ca_directory: String,
|
|
68
|
+
?ssl_ca_store: String,
|
|
69
|
+
?on_chunk_received: Proc,
|
|
70
|
+
?on_chunk_sent: Proc,
|
|
71
|
+
?raise_response_errors: bool
|
|
72
|
+
) -> instance
|
|
73
|
+
| (?Hash[Symbol, untyped]) -> instance
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
interface _AddCustomAttributesResponseSuccess
|
|
77
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::AddCustomAttributesResponse]
|
|
78
|
+
end
|
|
79
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#add_custom_attributes-instance_method
|
|
80
|
+
def add_custom_attributes: (
|
|
81
|
+
user_pool_id: ::String,
|
|
82
|
+
custom_attributes: Array[
|
|
83
|
+
{
|
|
84
|
+
name: ::String?,
|
|
85
|
+
attribute_data_type: ("String" | "Number" | "DateTime" | "Boolean")?,
|
|
86
|
+
developer_only_attribute: bool?,
|
|
87
|
+
mutable: bool?,
|
|
88
|
+
required: bool?,
|
|
89
|
+
number_attribute_constraints: {
|
|
90
|
+
min_value: ::String?,
|
|
91
|
+
max_value: ::String?
|
|
92
|
+
}?,
|
|
93
|
+
string_attribute_constraints: {
|
|
94
|
+
min_length: ::String?,
|
|
95
|
+
max_length: ::String?
|
|
96
|
+
}?
|
|
97
|
+
},
|
|
98
|
+
]
|
|
99
|
+
) -> _AddCustomAttributesResponseSuccess
|
|
100
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _AddCustomAttributesResponseSuccess
|
|
101
|
+
|
|
102
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#admin_add_user_to_group-instance_method
|
|
103
|
+
def admin_add_user_to_group: (
|
|
104
|
+
user_pool_id: ::String,
|
|
105
|
+
username: ::String,
|
|
106
|
+
group_name: ::String
|
|
107
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
108
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
109
|
+
|
|
110
|
+
interface _AdminConfirmSignUpResponseSuccess
|
|
111
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::AdminConfirmSignUpResponse]
|
|
112
|
+
end
|
|
113
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#admin_confirm_sign_up-instance_method
|
|
114
|
+
def admin_confirm_sign_up: (
|
|
115
|
+
user_pool_id: ::String,
|
|
116
|
+
username: ::String,
|
|
117
|
+
?client_metadata: Hash[::String, ::String]
|
|
118
|
+
) -> _AdminConfirmSignUpResponseSuccess
|
|
119
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _AdminConfirmSignUpResponseSuccess
|
|
120
|
+
|
|
121
|
+
interface _AdminCreateUserResponseSuccess
|
|
122
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::AdminCreateUserResponse]
|
|
123
|
+
def user: () -> Types::UserType
|
|
124
|
+
end
|
|
125
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#admin_create_user-instance_method
|
|
126
|
+
def admin_create_user: (
|
|
127
|
+
user_pool_id: ::String,
|
|
128
|
+
username: ::String,
|
|
129
|
+
?user_attributes: Array[
|
|
130
|
+
{
|
|
131
|
+
name: ::String,
|
|
132
|
+
value: ::String?
|
|
133
|
+
},
|
|
134
|
+
],
|
|
135
|
+
?validation_data: Array[
|
|
136
|
+
{
|
|
137
|
+
name: ::String,
|
|
138
|
+
value: ::String?
|
|
139
|
+
},
|
|
140
|
+
],
|
|
141
|
+
?temporary_password: ::String,
|
|
142
|
+
?force_alias_creation: bool,
|
|
143
|
+
?message_action: ("RESEND" | "SUPPRESS"),
|
|
144
|
+
?desired_delivery_mediums: Array[("SMS" | "EMAIL")],
|
|
145
|
+
?client_metadata: Hash[::String, ::String]
|
|
146
|
+
) -> _AdminCreateUserResponseSuccess
|
|
147
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _AdminCreateUserResponseSuccess
|
|
148
|
+
|
|
149
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#admin_delete_user-instance_method
|
|
150
|
+
def admin_delete_user: (
|
|
151
|
+
user_pool_id: ::String,
|
|
152
|
+
username: ::String
|
|
153
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
154
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
155
|
+
|
|
156
|
+
interface _AdminDeleteUserAttributesResponseSuccess
|
|
157
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::AdminDeleteUserAttributesResponse]
|
|
158
|
+
end
|
|
159
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#admin_delete_user_attributes-instance_method
|
|
160
|
+
def admin_delete_user_attributes: (
|
|
161
|
+
user_pool_id: ::String,
|
|
162
|
+
username: ::String,
|
|
163
|
+
user_attribute_names: Array[::String]
|
|
164
|
+
) -> _AdminDeleteUserAttributesResponseSuccess
|
|
165
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _AdminDeleteUserAttributesResponseSuccess
|
|
166
|
+
|
|
167
|
+
interface _AdminDisableProviderForUserResponseSuccess
|
|
168
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::AdminDisableProviderForUserResponse]
|
|
169
|
+
end
|
|
170
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#admin_disable_provider_for_user-instance_method
|
|
171
|
+
def admin_disable_provider_for_user: (
|
|
172
|
+
user_pool_id: ::String,
|
|
173
|
+
user: {
|
|
174
|
+
provider_name: ::String?,
|
|
175
|
+
provider_attribute_name: ::String?,
|
|
176
|
+
provider_attribute_value: ::String?
|
|
177
|
+
}
|
|
178
|
+
) -> _AdminDisableProviderForUserResponseSuccess
|
|
179
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _AdminDisableProviderForUserResponseSuccess
|
|
180
|
+
|
|
181
|
+
interface _AdminDisableUserResponseSuccess
|
|
182
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::AdminDisableUserResponse]
|
|
183
|
+
end
|
|
184
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#admin_disable_user-instance_method
|
|
185
|
+
def admin_disable_user: (
|
|
186
|
+
user_pool_id: ::String,
|
|
187
|
+
username: ::String
|
|
188
|
+
) -> _AdminDisableUserResponseSuccess
|
|
189
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _AdminDisableUserResponseSuccess
|
|
190
|
+
|
|
191
|
+
interface _AdminEnableUserResponseSuccess
|
|
192
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::AdminEnableUserResponse]
|
|
193
|
+
end
|
|
194
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#admin_enable_user-instance_method
|
|
195
|
+
def admin_enable_user: (
|
|
196
|
+
user_pool_id: ::String,
|
|
197
|
+
username: ::String
|
|
198
|
+
) -> _AdminEnableUserResponseSuccess
|
|
199
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _AdminEnableUserResponseSuccess
|
|
200
|
+
|
|
201
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#admin_forget_device-instance_method
|
|
202
|
+
def admin_forget_device: (
|
|
203
|
+
user_pool_id: ::String,
|
|
204
|
+
username: ::String,
|
|
205
|
+
device_key: ::String
|
|
206
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
207
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
208
|
+
|
|
209
|
+
interface _AdminGetDeviceResponseSuccess
|
|
210
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::AdminGetDeviceResponse]
|
|
211
|
+
def device: () -> Types::DeviceType
|
|
212
|
+
end
|
|
213
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#admin_get_device-instance_method
|
|
214
|
+
def admin_get_device: (
|
|
215
|
+
device_key: ::String,
|
|
216
|
+
user_pool_id: ::String,
|
|
217
|
+
username: ::String
|
|
218
|
+
) -> _AdminGetDeviceResponseSuccess
|
|
219
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _AdminGetDeviceResponseSuccess
|
|
220
|
+
|
|
221
|
+
interface _AdminGetUserResponseSuccess
|
|
222
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::AdminGetUserResponse]
|
|
223
|
+
def username: () -> ::String
|
|
224
|
+
def user_attributes: () -> ::Array[Types::AttributeType]
|
|
225
|
+
def user_create_date: () -> ::Time
|
|
226
|
+
def user_last_modified_date: () -> ::Time
|
|
227
|
+
def enabled: () -> bool
|
|
228
|
+
def user_status: () -> ("UNCONFIRMED" | "CONFIRMED" | "ARCHIVED" | "COMPROMISED" | "UNKNOWN" | "RESET_REQUIRED" | "FORCE_CHANGE_PASSWORD")
|
|
229
|
+
def mfa_options: () -> ::Array[Types::MFAOptionType]
|
|
230
|
+
def preferred_mfa_setting: () -> ::String
|
|
231
|
+
def user_mfa_setting_list: () -> ::Array[::String]
|
|
232
|
+
end
|
|
233
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#admin_get_user-instance_method
|
|
234
|
+
def admin_get_user: (
|
|
235
|
+
user_pool_id: ::String,
|
|
236
|
+
username: ::String
|
|
237
|
+
) -> _AdminGetUserResponseSuccess
|
|
238
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _AdminGetUserResponseSuccess
|
|
239
|
+
|
|
240
|
+
interface _AdminInitiateAuthResponseSuccess
|
|
241
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::AdminInitiateAuthResponse]
|
|
242
|
+
def challenge_name: () -> ("SMS_MFA" | "SOFTWARE_TOKEN_MFA" | "SELECT_MFA_TYPE" | "MFA_SETUP" | "PASSWORD_VERIFIER" | "CUSTOM_CHALLENGE" | "DEVICE_SRP_AUTH" | "DEVICE_PASSWORD_VERIFIER" | "ADMIN_NO_SRP_AUTH" | "NEW_PASSWORD_REQUIRED")
|
|
243
|
+
def session: () -> ::String
|
|
244
|
+
def challenge_parameters: () -> ::Hash[::String, ::String]
|
|
245
|
+
def authentication_result: () -> Types::AuthenticationResultType
|
|
246
|
+
end
|
|
247
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#admin_initiate_auth-instance_method
|
|
248
|
+
def admin_initiate_auth: (
|
|
249
|
+
user_pool_id: ::String,
|
|
250
|
+
client_id: ::String,
|
|
251
|
+
auth_flow: ("USER_SRP_AUTH" | "REFRESH_TOKEN_AUTH" | "REFRESH_TOKEN" | "CUSTOM_AUTH" | "ADMIN_NO_SRP_AUTH" | "USER_PASSWORD_AUTH" | "ADMIN_USER_PASSWORD_AUTH"),
|
|
252
|
+
?auth_parameters: Hash[::String, ::String],
|
|
253
|
+
?client_metadata: Hash[::String, ::String],
|
|
254
|
+
?analytics_metadata: {
|
|
255
|
+
analytics_endpoint_id: ::String?
|
|
256
|
+
},
|
|
257
|
+
?context_data: {
|
|
258
|
+
ip_address: ::String,
|
|
259
|
+
server_name: ::String,
|
|
260
|
+
server_path: ::String,
|
|
261
|
+
http_headers: Array[
|
|
262
|
+
{
|
|
263
|
+
header_name: ::String?,
|
|
264
|
+
header_value: ::String?
|
|
265
|
+
},
|
|
266
|
+
],
|
|
267
|
+
encoded_data: ::String?
|
|
268
|
+
}
|
|
269
|
+
) -> _AdminInitiateAuthResponseSuccess
|
|
270
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _AdminInitiateAuthResponseSuccess
|
|
271
|
+
|
|
272
|
+
interface _AdminLinkProviderForUserResponseSuccess
|
|
273
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::AdminLinkProviderForUserResponse]
|
|
274
|
+
end
|
|
275
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#admin_link_provider_for_user-instance_method
|
|
276
|
+
def admin_link_provider_for_user: (
|
|
277
|
+
user_pool_id: ::String,
|
|
278
|
+
destination_user: {
|
|
279
|
+
provider_name: ::String?,
|
|
280
|
+
provider_attribute_name: ::String?,
|
|
281
|
+
provider_attribute_value: ::String?
|
|
282
|
+
},
|
|
283
|
+
source_user: {
|
|
284
|
+
provider_name: ::String?,
|
|
285
|
+
provider_attribute_name: ::String?,
|
|
286
|
+
provider_attribute_value: ::String?
|
|
287
|
+
}
|
|
288
|
+
) -> _AdminLinkProviderForUserResponseSuccess
|
|
289
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _AdminLinkProviderForUserResponseSuccess
|
|
290
|
+
|
|
291
|
+
interface _AdminListDevicesResponseSuccess
|
|
292
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::AdminListDevicesResponse]
|
|
293
|
+
def devices: () -> ::Array[Types::DeviceType]
|
|
294
|
+
def pagination_token: () -> ::String
|
|
295
|
+
end
|
|
296
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#admin_list_devices-instance_method
|
|
297
|
+
def admin_list_devices: (
|
|
298
|
+
user_pool_id: ::String,
|
|
299
|
+
username: ::String,
|
|
300
|
+
?limit: ::Integer,
|
|
301
|
+
?pagination_token: ::String
|
|
302
|
+
) -> _AdminListDevicesResponseSuccess
|
|
303
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _AdminListDevicesResponseSuccess
|
|
304
|
+
|
|
305
|
+
interface _AdminListGroupsForUserResponseSuccess
|
|
306
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::AdminListGroupsForUserResponse]
|
|
307
|
+
def groups: () -> ::Array[Types::GroupType]
|
|
308
|
+
def next_token: () -> ::String
|
|
309
|
+
end
|
|
310
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#admin_list_groups_for_user-instance_method
|
|
311
|
+
def admin_list_groups_for_user: (
|
|
312
|
+
username: ::String,
|
|
313
|
+
user_pool_id: ::String,
|
|
314
|
+
?limit: ::Integer,
|
|
315
|
+
?next_token: ::String
|
|
316
|
+
) -> _AdminListGroupsForUserResponseSuccess
|
|
317
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _AdminListGroupsForUserResponseSuccess
|
|
318
|
+
|
|
319
|
+
interface _AdminListUserAuthEventsResponseSuccess
|
|
320
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::AdminListUserAuthEventsResponse]
|
|
321
|
+
def auth_events: () -> ::Array[Types::AuthEventType]
|
|
322
|
+
def next_token: () -> ::String
|
|
323
|
+
end
|
|
324
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#admin_list_user_auth_events-instance_method
|
|
325
|
+
def admin_list_user_auth_events: (
|
|
326
|
+
user_pool_id: ::String,
|
|
327
|
+
username: ::String,
|
|
328
|
+
?max_results: ::Integer,
|
|
329
|
+
?next_token: ::String
|
|
330
|
+
) -> _AdminListUserAuthEventsResponseSuccess
|
|
331
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _AdminListUserAuthEventsResponseSuccess
|
|
332
|
+
|
|
333
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#admin_remove_user_from_group-instance_method
|
|
334
|
+
def admin_remove_user_from_group: (
|
|
335
|
+
user_pool_id: ::String,
|
|
336
|
+
username: ::String,
|
|
337
|
+
group_name: ::String
|
|
338
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
339
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
340
|
+
|
|
341
|
+
interface _AdminResetUserPasswordResponseSuccess
|
|
342
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::AdminResetUserPasswordResponse]
|
|
343
|
+
end
|
|
344
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#admin_reset_user_password-instance_method
|
|
345
|
+
def admin_reset_user_password: (
|
|
346
|
+
user_pool_id: ::String,
|
|
347
|
+
username: ::String,
|
|
348
|
+
?client_metadata: Hash[::String, ::String]
|
|
349
|
+
) -> _AdminResetUserPasswordResponseSuccess
|
|
350
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _AdminResetUserPasswordResponseSuccess
|
|
351
|
+
|
|
352
|
+
interface _AdminRespondToAuthChallengeResponseSuccess
|
|
353
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::AdminRespondToAuthChallengeResponse]
|
|
354
|
+
def challenge_name: () -> ("SMS_MFA" | "SOFTWARE_TOKEN_MFA" | "SELECT_MFA_TYPE" | "MFA_SETUP" | "PASSWORD_VERIFIER" | "CUSTOM_CHALLENGE" | "DEVICE_SRP_AUTH" | "DEVICE_PASSWORD_VERIFIER" | "ADMIN_NO_SRP_AUTH" | "NEW_PASSWORD_REQUIRED")
|
|
355
|
+
def session: () -> ::String
|
|
356
|
+
def challenge_parameters: () -> ::Hash[::String, ::String]
|
|
357
|
+
def authentication_result: () -> Types::AuthenticationResultType
|
|
358
|
+
end
|
|
359
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#admin_respond_to_auth_challenge-instance_method
|
|
360
|
+
def admin_respond_to_auth_challenge: (
|
|
361
|
+
user_pool_id: ::String,
|
|
362
|
+
client_id: ::String,
|
|
363
|
+
challenge_name: ("SMS_MFA" | "SOFTWARE_TOKEN_MFA" | "SELECT_MFA_TYPE" | "MFA_SETUP" | "PASSWORD_VERIFIER" | "CUSTOM_CHALLENGE" | "DEVICE_SRP_AUTH" | "DEVICE_PASSWORD_VERIFIER" | "ADMIN_NO_SRP_AUTH" | "NEW_PASSWORD_REQUIRED"),
|
|
364
|
+
?challenge_responses: Hash[::String, ::String],
|
|
365
|
+
?session: ::String,
|
|
366
|
+
?analytics_metadata: {
|
|
367
|
+
analytics_endpoint_id: ::String?
|
|
368
|
+
},
|
|
369
|
+
?context_data: {
|
|
370
|
+
ip_address: ::String,
|
|
371
|
+
server_name: ::String,
|
|
372
|
+
server_path: ::String,
|
|
373
|
+
http_headers: Array[
|
|
374
|
+
{
|
|
375
|
+
header_name: ::String?,
|
|
376
|
+
header_value: ::String?
|
|
377
|
+
},
|
|
378
|
+
],
|
|
379
|
+
encoded_data: ::String?
|
|
380
|
+
},
|
|
381
|
+
?client_metadata: Hash[::String, ::String]
|
|
382
|
+
) -> _AdminRespondToAuthChallengeResponseSuccess
|
|
383
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _AdminRespondToAuthChallengeResponseSuccess
|
|
384
|
+
|
|
385
|
+
interface _AdminSetUserMFAPreferenceResponseSuccess
|
|
386
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::AdminSetUserMFAPreferenceResponse]
|
|
387
|
+
end
|
|
388
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#admin_set_user_mfa_preference-instance_method
|
|
389
|
+
def admin_set_user_mfa_preference: (
|
|
390
|
+
?sms_mfa_settings: {
|
|
391
|
+
enabled: bool?,
|
|
392
|
+
preferred_mfa: bool?
|
|
393
|
+
},
|
|
394
|
+
?software_token_mfa_settings: {
|
|
395
|
+
enabled: bool?,
|
|
396
|
+
preferred_mfa: bool?
|
|
397
|
+
},
|
|
398
|
+
username: ::String,
|
|
399
|
+
user_pool_id: ::String
|
|
400
|
+
) -> _AdminSetUserMFAPreferenceResponseSuccess
|
|
401
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _AdminSetUserMFAPreferenceResponseSuccess
|
|
402
|
+
|
|
403
|
+
interface _AdminSetUserPasswordResponseSuccess
|
|
404
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::AdminSetUserPasswordResponse]
|
|
405
|
+
end
|
|
406
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#admin_set_user_password-instance_method
|
|
407
|
+
def admin_set_user_password: (
|
|
408
|
+
user_pool_id: ::String,
|
|
409
|
+
username: ::String,
|
|
410
|
+
password: ::String,
|
|
411
|
+
?permanent: bool
|
|
412
|
+
) -> _AdminSetUserPasswordResponseSuccess
|
|
413
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _AdminSetUserPasswordResponseSuccess
|
|
414
|
+
|
|
415
|
+
interface _AdminSetUserSettingsResponseSuccess
|
|
416
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::AdminSetUserSettingsResponse]
|
|
417
|
+
end
|
|
418
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#admin_set_user_settings-instance_method
|
|
419
|
+
def admin_set_user_settings: (
|
|
420
|
+
user_pool_id: ::String,
|
|
421
|
+
username: ::String,
|
|
422
|
+
mfa_options: Array[
|
|
423
|
+
{
|
|
424
|
+
delivery_medium: ("SMS" | "EMAIL")?,
|
|
425
|
+
attribute_name: ::String?
|
|
426
|
+
},
|
|
427
|
+
]
|
|
428
|
+
) -> _AdminSetUserSettingsResponseSuccess
|
|
429
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _AdminSetUserSettingsResponseSuccess
|
|
430
|
+
|
|
431
|
+
interface _AdminUpdateAuthEventFeedbackResponseSuccess
|
|
432
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::AdminUpdateAuthEventFeedbackResponse]
|
|
433
|
+
end
|
|
434
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#admin_update_auth_event_feedback-instance_method
|
|
435
|
+
def admin_update_auth_event_feedback: (
|
|
436
|
+
user_pool_id: ::String,
|
|
437
|
+
username: ::String,
|
|
438
|
+
event_id: ::String,
|
|
439
|
+
feedback_value: ("Valid" | "Invalid")
|
|
440
|
+
) -> _AdminUpdateAuthEventFeedbackResponseSuccess
|
|
441
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _AdminUpdateAuthEventFeedbackResponseSuccess
|
|
442
|
+
|
|
443
|
+
interface _AdminUpdateDeviceStatusResponseSuccess
|
|
444
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::AdminUpdateDeviceStatusResponse]
|
|
445
|
+
end
|
|
446
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#admin_update_device_status-instance_method
|
|
447
|
+
def admin_update_device_status: (
|
|
448
|
+
user_pool_id: ::String,
|
|
449
|
+
username: ::String,
|
|
450
|
+
device_key: ::String,
|
|
451
|
+
?device_remembered_status: ("remembered" | "not_remembered")
|
|
452
|
+
) -> _AdminUpdateDeviceStatusResponseSuccess
|
|
453
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _AdminUpdateDeviceStatusResponseSuccess
|
|
454
|
+
|
|
455
|
+
interface _AdminUpdateUserAttributesResponseSuccess
|
|
456
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::AdminUpdateUserAttributesResponse]
|
|
457
|
+
end
|
|
458
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#admin_update_user_attributes-instance_method
|
|
459
|
+
def admin_update_user_attributes: (
|
|
460
|
+
user_pool_id: ::String,
|
|
461
|
+
username: ::String,
|
|
462
|
+
user_attributes: Array[
|
|
463
|
+
{
|
|
464
|
+
name: ::String,
|
|
465
|
+
value: ::String?
|
|
466
|
+
},
|
|
467
|
+
],
|
|
468
|
+
?client_metadata: Hash[::String, ::String]
|
|
469
|
+
) -> _AdminUpdateUserAttributesResponseSuccess
|
|
470
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _AdminUpdateUserAttributesResponseSuccess
|
|
471
|
+
|
|
472
|
+
interface _AdminUserGlobalSignOutResponseSuccess
|
|
473
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::AdminUserGlobalSignOutResponse]
|
|
474
|
+
end
|
|
475
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#admin_user_global_sign_out-instance_method
|
|
476
|
+
def admin_user_global_sign_out: (
|
|
477
|
+
user_pool_id: ::String,
|
|
478
|
+
username: ::String
|
|
479
|
+
) -> _AdminUserGlobalSignOutResponseSuccess
|
|
480
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _AdminUserGlobalSignOutResponseSuccess
|
|
481
|
+
|
|
482
|
+
interface _AssociateSoftwareTokenResponseSuccess
|
|
483
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::AssociateSoftwareTokenResponse]
|
|
484
|
+
def secret_code: () -> ::String
|
|
485
|
+
def session: () -> ::String
|
|
486
|
+
end
|
|
487
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#associate_software_token-instance_method
|
|
488
|
+
def associate_software_token: (
|
|
489
|
+
?access_token: ::String,
|
|
490
|
+
?session: ::String
|
|
491
|
+
) -> _AssociateSoftwareTokenResponseSuccess
|
|
492
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _AssociateSoftwareTokenResponseSuccess
|
|
493
|
+
|
|
494
|
+
interface _ChangePasswordResponseSuccess
|
|
495
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ChangePasswordResponse]
|
|
496
|
+
end
|
|
497
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#change_password-instance_method
|
|
498
|
+
def change_password: (
|
|
499
|
+
previous_password: ::String,
|
|
500
|
+
proposed_password: ::String,
|
|
501
|
+
access_token: ::String
|
|
502
|
+
) -> _ChangePasswordResponseSuccess
|
|
503
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ChangePasswordResponseSuccess
|
|
504
|
+
|
|
505
|
+
interface _ConfirmDeviceResponseSuccess
|
|
506
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ConfirmDeviceResponse]
|
|
507
|
+
def user_confirmation_necessary: () -> bool
|
|
508
|
+
end
|
|
509
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#confirm_device-instance_method
|
|
510
|
+
def confirm_device: (
|
|
511
|
+
access_token: ::String,
|
|
512
|
+
device_key: ::String,
|
|
513
|
+
?device_secret_verifier_config: {
|
|
514
|
+
password_verifier: ::String?,
|
|
515
|
+
salt: ::String?
|
|
516
|
+
},
|
|
517
|
+
?device_name: ::String
|
|
518
|
+
) -> _ConfirmDeviceResponseSuccess
|
|
519
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ConfirmDeviceResponseSuccess
|
|
520
|
+
|
|
521
|
+
interface _ConfirmForgotPasswordResponseSuccess
|
|
522
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ConfirmForgotPasswordResponse]
|
|
523
|
+
end
|
|
524
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#confirm_forgot_password-instance_method
|
|
525
|
+
def confirm_forgot_password: (
|
|
526
|
+
client_id: ::String,
|
|
527
|
+
?secret_hash: ::String,
|
|
528
|
+
username: ::String,
|
|
529
|
+
confirmation_code: ::String,
|
|
530
|
+
password: ::String,
|
|
531
|
+
?analytics_metadata: {
|
|
532
|
+
analytics_endpoint_id: ::String?
|
|
533
|
+
},
|
|
534
|
+
?user_context_data: {
|
|
535
|
+
ip_address: ::String?,
|
|
536
|
+
encoded_data: ::String?
|
|
537
|
+
},
|
|
538
|
+
?client_metadata: Hash[::String, ::String]
|
|
539
|
+
) -> _ConfirmForgotPasswordResponseSuccess
|
|
540
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ConfirmForgotPasswordResponseSuccess
|
|
541
|
+
|
|
542
|
+
interface _ConfirmSignUpResponseSuccess
|
|
543
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ConfirmSignUpResponse]
|
|
544
|
+
end
|
|
545
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#confirm_sign_up-instance_method
|
|
546
|
+
def confirm_sign_up: (
|
|
547
|
+
client_id: ::String,
|
|
548
|
+
?secret_hash: ::String,
|
|
549
|
+
username: ::String,
|
|
550
|
+
confirmation_code: ::String,
|
|
551
|
+
?force_alias_creation: bool,
|
|
552
|
+
?analytics_metadata: {
|
|
553
|
+
analytics_endpoint_id: ::String?
|
|
554
|
+
},
|
|
555
|
+
?user_context_data: {
|
|
556
|
+
ip_address: ::String?,
|
|
557
|
+
encoded_data: ::String?
|
|
558
|
+
},
|
|
559
|
+
?client_metadata: Hash[::String, ::String]
|
|
560
|
+
) -> _ConfirmSignUpResponseSuccess
|
|
561
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ConfirmSignUpResponseSuccess
|
|
562
|
+
|
|
563
|
+
interface _CreateGroupResponseSuccess
|
|
564
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateGroupResponse]
|
|
565
|
+
def group: () -> Types::GroupType
|
|
566
|
+
end
|
|
567
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#create_group-instance_method
|
|
568
|
+
def create_group: (
|
|
569
|
+
group_name: ::String,
|
|
570
|
+
user_pool_id: ::String,
|
|
571
|
+
?description: ::String,
|
|
572
|
+
?role_arn: ::String,
|
|
573
|
+
?precedence: ::Integer
|
|
574
|
+
) -> _CreateGroupResponseSuccess
|
|
575
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateGroupResponseSuccess
|
|
576
|
+
|
|
577
|
+
interface _CreateIdentityProviderResponseSuccess
|
|
578
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateIdentityProviderResponse]
|
|
579
|
+
def identity_provider: () -> Types::IdentityProviderType
|
|
580
|
+
end
|
|
581
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#create_identity_provider-instance_method
|
|
582
|
+
def create_identity_provider: (
|
|
583
|
+
user_pool_id: ::String,
|
|
584
|
+
provider_name: ::String,
|
|
585
|
+
provider_type: ("SAML" | "Facebook" | "Google" | "LoginWithAmazon" | "SignInWithApple" | "OIDC"),
|
|
586
|
+
provider_details: Hash[::String, ::String],
|
|
587
|
+
?attribute_mapping: Hash[::String, ::String],
|
|
588
|
+
?idp_identifiers: Array[::String]
|
|
589
|
+
) -> _CreateIdentityProviderResponseSuccess
|
|
590
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateIdentityProviderResponseSuccess
|
|
591
|
+
|
|
592
|
+
interface _CreateResourceServerResponseSuccess
|
|
593
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateResourceServerResponse]
|
|
594
|
+
def resource_server: () -> Types::ResourceServerType
|
|
595
|
+
end
|
|
596
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#create_resource_server-instance_method
|
|
597
|
+
def create_resource_server: (
|
|
598
|
+
user_pool_id: ::String,
|
|
599
|
+
identifier: ::String,
|
|
600
|
+
name: ::String,
|
|
601
|
+
?scopes: Array[
|
|
602
|
+
{
|
|
603
|
+
scope_name: ::String,
|
|
604
|
+
scope_description: ::String
|
|
605
|
+
},
|
|
606
|
+
]
|
|
607
|
+
) -> _CreateResourceServerResponseSuccess
|
|
608
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateResourceServerResponseSuccess
|
|
609
|
+
|
|
610
|
+
interface _CreateUserImportJobResponseSuccess
|
|
611
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateUserImportJobResponse]
|
|
612
|
+
def user_import_job: () -> Types::UserImportJobType
|
|
613
|
+
end
|
|
614
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#create_user_import_job-instance_method
|
|
615
|
+
def create_user_import_job: (
|
|
616
|
+
job_name: ::String,
|
|
617
|
+
user_pool_id: ::String,
|
|
618
|
+
cloud_watch_logs_role_arn: ::String
|
|
619
|
+
) -> _CreateUserImportJobResponseSuccess
|
|
620
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateUserImportJobResponseSuccess
|
|
621
|
+
|
|
622
|
+
interface _CreateUserPoolResponseSuccess
|
|
623
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateUserPoolResponse]
|
|
624
|
+
def user_pool: () -> Types::UserPoolType
|
|
625
|
+
end
|
|
626
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#create_user_pool-instance_method
|
|
627
|
+
def create_user_pool: (
|
|
628
|
+
pool_name: ::String,
|
|
629
|
+
?policies: {
|
|
630
|
+
password_policy: {
|
|
631
|
+
minimum_length: ::Integer?,
|
|
632
|
+
require_uppercase: bool?,
|
|
633
|
+
require_lowercase: bool?,
|
|
634
|
+
require_numbers: bool?,
|
|
635
|
+
require_symbols: bool?,
|
|
636
|
+
temporary_password_validity_days: ::Integer?
|
|
637
|
+
}?
|
|
638
|
+
},
|
|
639
|
+
?deletion_protection: ("ACTIVE" | "INACTIVE"),
|
|
640
|
+
?lambda_config: {
|
|
641
|
+
pre_sign_up: ::String?,
|
|
642
|
+
custom_message: ::String?,
|
|
643
|
+
post_confirmation: ::String?,
|
|
644
|
+
pre_authentication: ::String?,
|
|
645
|
+
post_authentication: ::String?,
|
|
646
|
+
define_auth_challenge: ::String?,
|
|
647
|
+
create_auth_challenge: ::String?,
|
|
648
|
+
verify_auth_challenge_response: ::String?,
|
|
649
|
+
pre_token_generation: ::String?,
|
|
650
|
+
pre_token_generation_config: {
|
|
651
|
+
lambda_version: ("V1_0" | "V2_0"),
|
|
652
|
+
lambda_arn: ::String
|
|
653
|
+
}?,
|
|
654
|
+
user_migration: ::String?,
|
|
655
|
+
custom_sms_sender: {
|
|
656
|
+
lambda_version: ("V1_0"),
|
|
657
|
+
lambda_arn: ::String
|
|
658
|
+
}?,
|
|
659
|
+
custom_email_sender: {
|
|
660
|
+
lambda_version: ("V1_0"),
|
|
661
|
+
lambda_arn: ::String
|
|
662
|
+
}?,
|
|
663
|
+
kms_key_id: ::String?
|
|
664
|
+
},
|
|
665
|
+
?auto_verified_attributes: Array[("phone_number" | "email")],
|
|
666
|
+
?alias_attributes: Array[("phone_number" | "email" | "preferred_username")],
|
|
667
|
+
?username_attributes: Array[("phone_number" | "email")],
|
|
668
|
+
?sms_verification_message: ::String,
|
|
669
|
+
?email_verification_message: ::String,
|
|
670
|
+
?email_verification_subject: ::String,
|
|
671
|
+
?verification_message_template: {
|
|
672
|
+
sms_message: ::String?,
|
|
673
|
+
email_message: ::String?,
|
|
674
|
+
email_subject: ::String?,
|
|
675
|
+
email_message_by_link: ::String?,
|
|
676
|
+
email_subject_by_link: ::String?,
|
|
677
|
+
default_email_option: ("CONFIRM_WITH_LINK" | "CONFIRM_WITH_CODE")?
|
|
678
|
+
},
|
|
679
|
+
?sms_authentication_message: ::String,
|
|
680
|
+
?mfa_configuration: ("OFF" | "ON" | "OPTIONAL"),
|
|
681
|
+
?user_attribute_update_settings: {
|
|
682
|
+
attributes_require_verification_before_update: Array[("phone_number" | "email")]?
|
|
683
|
+
},
|
|
684
|
+
?device_configuration: {
|
|
685
|
+
challenge_required_on_new_device: bool?,
|
|
686
|
+
device_only_remembered_on_user_prompt: bool?
|
|
687
|
+
},
|
|
688
|
+
?email_configuration: {
|
|
689
|
+
source_arn: ::String?,
|
|
690
|
+
reply_to_email_address: ::String?,
|
|
691
|
+
email_sending_account: ("COGNITO_DEFAULT" | "DEVELOPER")?,
|
|
692
|
+
from: ::String?,
|
|
693
|
+
configuration_set: ::String?
|
|
694
|
+
},
|
|
695
|
+
?sms_configuration: {
|
|
696
|
+
sns_caller_arn: ::String,
|
|
697
|
+
external_id: ::String?,
|
|
698
|
+
sns_region: ::String?
|
|
699
|
+
},
|
|
700
|
+
?user_pool_tags: Hash[::String, ::String],
|
|
701
|
+
?admin_create_user_config: {
|
|
702
|
+
allow_admin_create_user_only: bool?,
|
|
703
|
+
unused_account_validity_days: ::Integer?,
|
|
704
|
+
invite_message_template: {
|
|
705
|
+
sms_message: ::String?,
|
|
706
|
+
email_message: ::String?,
|
|
707
|
+
email_subject: ::String?
|
|
708
|
+
}?
|
|
709
|
+
},
|
|
710
|
+
?schema: Array[
|
|
711
|
+
{
|
|
712
|
+
name: ::String?,
|
|
713
|
+
attribute_data_type: ("String" | "Number" | "DateTime" | "Boolean")?,
|
|
714
|
+
developer_only_attribute: bool?,
|
|
715
|
+
mutable: bool?,
|
|
716
|
+
required: bool?,
|
|
717
|
+
number_attribute_constraints: {
|
|
718
|
+
min_value: ::String?,
|
|
719
|
+
max_value: ::String?
|
|
720
|
+
}?,
|
|
721
|
+
string_attribute_constraints: {
|
|
722
|
+
min_length: ::String?,
|
|
723
|
+
max_length: ::String?
|
|
724
|
+
}?
|
|
725
|
+
},
|
|
726
|
+
],
|
|
727
|
+
?user_pool_add_ons: {
|
|
728
|
+
advanced_security_mode: ("OFF" | "AUDIT" | "ENFORCED")
|
|
729
|
+
},
|
|
730
|
+
?username_configuration: {
|
|
731
|
+
case_sensitive: bool
|
|
732
|
+
},
|
|
733
|
+
?account_recovery_setting: {
|
|
734
|
+
recovery_mechanisms: Array[
|
|
735
|
+
{
|
|
736
|
+
priority: ::Integer,
|
|
737
|
+
name: ("verified_email" | "verified_phone_number" | "admin_only")
|
|
738
|
+
},
|
|
739
|
+
]?
|
|
740
|
+
}
|
|
741
|
+
) -> _CreateUserPoolResponseSuccess
|
|
742
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateUserPoolResponseSuccess
|
|
743
|
+
|
|
744
|
+
interface _CreateUserPoolClientResponseSuccess
|
|
745
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateUserPoolClientResponse]
|
|
746
|
+
def user_pool_client: () -> Types::UserPoolClientType
|
|
747
|
+
end
|
|
748
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#create_user_pool_client-instance_method
|
|
749
|
+
def create_user_pool_client: (
|
|
750
|
+
user_pool_id: ::String,
|
|
751
|
+
client_name: ::String,
|
|
752
|
+
?generate_secret: bool,
|
|
753
|
+
?refresh_token_validity: ::Integer,
|
|
754
|
+
?access_token_validity: ::Integer,
|
|
755
|
+
?id_token_validity: ::Integer,
|
|
756
|
+
?token_validity_units: {
|
|
757
|
+
access_token: ("seconds" | "minutes" | "hours" | "days")?,
|
|
758
|
+
id_token: ("seconds" | "minutes" | "hours" | "days")?,
|
|
759
|
+
refresh_token: ("seconds" | "minutes" | "hours" | "days")?
|
|
760
|
+
},
|
|
761
|
+
?read_attributes: Array[::String],
|
|
762
|
+
?write_attributes: Array[::String],
|
|
763
|
+
?explicit_auth_flows: Array[("ADMIN_NO_SRP_AUTH" | "CUSTOM_AUTH_FLOW_ONLY" | "USER_PASSWORD_AUTH" | "ALLOW_ADMIN_USER_PASSWORD_AUTH" | "ALLOW_CUSTOM_AUTH" | "ALLOW_USER_PASSWORD_AUTH" | "ALLOW_USER_SRP_AUTH" | "ALLOW_REFRESH_TOKEN_AUTH")],
|
|
764
|
+
?supported_identity_providers: Array[::String],
|
|
765
|
+
?callback_urls: Array[::String],
|
|
766
|
+
?logout_urls: Array[::String],
|
|
767
|
+
?default_redirect_uri: ::String,
|
|
768
|
+
?allowed_o_auth_flows: Array[("code" | "implicit" | "client_credentials")],
|
|
769
|
+
?allowed_o_auth_scopes: Array[::String],
|
|
770
|
+
?allowed_o_auth_flows_user_pool_client: bool,
|
|
771
|
+
?analytics_configuration: {
|
|
772
|
+
application_id: ::String?,
|
|
773
|
+
application_arn: ::String?,
|
|
774
|
+
role_arn: ::String?,
|
|
775
|
+
external_id: ::String?,
|
|
776
|
+
user_data_shared: bool?
|
|
777
|
+
},
|
|
778
|
+
?prevent_user_existence_errors: ("LEGACY" | "ENABLED"),
|
|
779
|
+
?enable_token_revocation: bool,
|
|
780
|
+
?enable_propagate_additional_user_context_data: bool,
|
|
781
|
+
?auth_session_validity: ::Integer
|
|
782
|
+
) -> _CreateUserPoolClientResponseSuccess
|
|
783
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateUserPoolClientResponseSuccess
|
|
784
|
+
|
|
785
|
+
interface _CreateUserPoolDomainResponseSuccess
|
|
786
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateUserPoolDomainResponse]
|
|
787
|
+
def cloud_front_domain: () -> ::String
|
|
788
|
+
end
|
|
789
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#create_user_pool_domain-instance_method
|
|
790
|
+
def create_user_pool_domain: (
|
|
791
|
+
domain: ::String,
|
|
792
|
+
user_pool_id: ::String,
|
|
793
|
+
?custom_domain_config: {
|
|
794
|
+
certificate_arn: ::String
|
|
795
|
+
}
|
|
796
|
+
) -> _CreateUserPoolDomainResponseSuccess
|
|
797
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateUserPoolDomainResponseSuccess
|
|
798
|
+
|
|
799
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#delete_group-instance_method
|
|
800
|
+
def delete_group: (
|
|
801
|
+
group_name: ::String,
|
|
802
|
+
user_pool_id: ::String
|
|
803
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
804
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
805
|
+
|
|
806
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#delete_identity_provider-instance_method
|
|
807
|
+
def delete_identity_provider: (
|
|
808
|
+
user_pool_id: ::String,
|
|
809
|
+
provider_name: ::String
|
|
810
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
811
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
812
|
+
|
|
813
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#delete_resource_server-instance_method
|
|
814
|
+
def delete_resource_server: (
|
|
815
|
+
user_pool_id: ::String,
|
|
816
|
+
identifier: ::String
|
|
817
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
818
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
819
|
+
|
|
820
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#delete_user-instance_method
|
|
821
|
+
def delete_user: (
|
|
822
|
+
access_token: ::String
|
|
823
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
824
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
825
|
+
|
|
826
|
+
interface _DeleteUserAttributesResponseSuccess
|
|
827
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DeleteUserAttributesResponse]
|
|
828
|
+
end
|
|
829
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#delete_user_attributes-instance_method
|
|
830
|
+
def delete_user_attributes: (
|
|
831
|
+
user_attribute_names: Array[::String],
|
|
832
|
+
access_token: ::String
|
|
833
|
+
) -> _DeleteUserAttributesResponseSuccess
|
|
834
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteUserAttributesResponseSuccess
|
|
835
|
+
|
|
836
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#delete_user_pool-instance_method
|
|
837
|
+
def delete_user_pool: (
|
|
838
|
+
user_pool_id: ::String
|
|
839
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
840
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
841
|
+
|
|
842
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#delete_user_pool_client-instance_method
|
|
843
|
+
def delete_user_pool_client: (
|
|
844
|
+
user_pool_id: ::String,
|
|
845
|
+
client_id: ::String
|
|
846
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
847
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
848
|
+
|
|
849
|
+
interface _DeleteUserPoolDomainResponseSuccess
|
|
850
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DeleteUserPoolDomainResponse]
|
|
851
|
+
end
|
|
852
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#delete_user_pool_domain-instance_method
|
|
853
|
+
def delete_user_pool_domain: (
|
|
854
|
+
domain: ::String,
|
|
855
|
+
user_pool_id: ::String
|
|
856
|
+
) -> _DeleteUserPoolDomainResponseSuccess
|
|
857
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteUserPoolDomainResponseSuccess
|
|
858
|
+
|
|
859
|
+
interface _DescribeIdentityProviderResponseSuccess
|
|
860
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DescribeIdentityProviderResponse]
|
|
861
|
+
def identity_provider: () -> Types::IdentityProviderType
|
|
862
|
+
end
|
|
863
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#describe_identity_provider-instance_method
|
|
864
|
+
def describe_identity_provider: (
|
|
865
|
+
user_pool_id: ::String,
|
|
866
|
+
provider_name: ::String
|
|
867
|
+
) -> _DescribeIdentityProviderResponseSuccess
|
|
868
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeIdentityProviderResponseSuccess
|
|
869
|
+
|
|
870
|
+
interface _DescribeResourceServerResponseSuccess
|
|
871
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DescribeResourceServerResponse]
|
|
872
|
+
def resource_server: () -> Types::ResourceServerType
|
|
873
|
+
end
|
|
874
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#describe_resource_server-instance_method
|
|
875
|
+
def describe_resource_server: (
|
|
876
|
+
user_pool_id: ::String,
|
|
877
|
+
identifier: ::String
|
|
878
|
+
) -> _DescribeResourceServerResponseSuccess
|
|
879
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeResourceServerResponseSuccess
|
|
880
|
+
|
|
881
|
+
interface _DescribeRiskConfigurationResponseSuccess
|
|
882
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DescribeRiskConfigurationResponse]
|
|
883
|
+
def risk_configuration: () -> Types::RiskConfigurationType
|
|
884
|
+
end
|
|
885
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#describe_risk_configuration-instance_method
|
|
886
|
+
def describe_risk_configuration: (
|
|
887
|
+
user_pool_id: ::String,
|
|
888
|
+
?client_id: ::String
|
|
889
|
+
) -> _DescribeRiskConfigurationResponseSuccess
|
|
890
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeRiskConfigurationResponseSuccess
|
|
891
|
+
|
|
892
|
+
interface _DescribeUserImportJobResponseSuccess
|
|
893
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DescribeUserImportJobResponse]
|
|
894
|
+
def user_import_job: () -> Types::UserImportJobType
|
|
895
|
+
end
|
|
896
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#describe_user_import_job-instance_method
|
|
897
|
+
def describe_user_import_job: (
|
|
898
|
+
user_pool_id: ::String,
|
|
899
|
+
job_id: ::String
|
|
900
|
+
) -> _DescribeUserImportJobResponseSuccess
|
|
901
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeUserImportJobResponseSuccess
|
|
902
|
+
|
|
903
|
+
interface _DescribeUserPoolResponseSuccess
|
|
904
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DescribeUserPoolResponse]
|
|
905
|
+
def user_pool: () -> Types::UserPoolType
|
|
906
|
+
end
|
|
907
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#describe_user_pool-instance_method
|
|
908
|
+
def describe_user_pool: (
|
|
909
|
+
user_pool_id: ::String
|
|
910
|
+
) -> _DescribeUserPoolResponseSuccess
|
|
911
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeUserPoolResponseSuccess
|
|
912
|
+
|
|
913
|
+
interface _DescribeUserPoolClientResponseSuccess
|
|
914
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DescribeUserPoolClientResponse]
|
|
915
|
+
def user_pool_client: () -> Types::UserPoolClientType
|
|
916
|
+
end
|
|
917
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#describe_user_pool_client-instance_method
|
|
918
|
+
def describe_user_pool_client: (
|
|
919
|
+
user_pool_id: ::String,
|
|
920
|
+
client_id: ::String
|
|
921
|
+
) -> _DescribeUserPoolClientResponseSuccess
|
|
922
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeUserPoolClientResponseSuccess
|
|
923
|
+
|
|
924
|
+
interface _DescribeUserPoolDomainResponseSuccess
|
|
925
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DescribeUserPoolDomainResponse]
|
|
926
|
+
def domain_description: () -> Types::DomainDescriptionType
|
|
927
|
+
end
|
|
928
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#describe_user_pool_domain-instance_method
|
|
929
|
+
def describe_user_pool_domain: (
|
|
930
|
+
domain: ::String
|
|
931
|
+
) -> _DescribeUserPoolDomainResponseSuccess
|
|
932
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeUserPoolDomainResponseSuccess
|
|
933
|
+
|
|
934
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#forget_device-instance_method
|
|
935
|
+
def forget_device: (
|
|
936
|
+
?access_token: ::String,
|
|
937
|
+
device_key: ::String
|
|
938
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
939
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
940
|
+
|
|
941
|
+
interface _ForgotPasswordResponseSuccess
|
|
942
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ForgotPasswordResponse]
|
|
943
|
+
def code_delivery_details: () -> Types::CodeDeliveryDetailsType
|
|
944
|
+
end
|
|
945
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#forgot_password-instance_method
|
|
946
|
+
def forgot_password: (
|
|
947
|
+
client_id: ::String,
|
|
948
|
+
?secret_hash: ::String,
|
|
949
|
+
?user_context_data: {
|
|
950
|
+
ip_address: ::String?,
|
|
951
|
+
encoded_data: ::String?
|
|
952
|
+
},
|
|
953
|
+
username: ::String,
|
|
954
|
+
?analytics_metadata: {
|
|
955
|
+
analytics_endpoint_id: ::String?
|
|
956
|
+
},
|
|
957
|
+
?client_metadata: Hash[::String, ::String]
|
|
958
|
+
) -> _ForgotPasswordResponseSuccess
|
|
959
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ForgotPasswordResponseSuccess
|
|
960
|
+
|
|
961
|
+
interface _GetCSVHeaderResponseSuccess
|
|
962
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetCSVHeaderResponse]
|
|
963
|
+
def user_pool_id: () -> ::String
|
|
964
|
+
def csv_header: () -> ::Array[::String]
|
|
965
|
+
end
|
|
966
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#get_csv_header-instance_method
|
|
967
|
+
def get_csv_header: (
|
|
968
|
+
user_pool_id: ::String
|
|
969
|
+
) -> _GetCSVHeaderResponseSuccess
|
|
970
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetCSVHeaderResponseSuccess
|
|
971
|
+
|
|
972
|
+
interface _GetDeviceResponseSuccess
|
|
973
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetDeviceResponse]
|
|
974
|
+
def device: () -> Types::DeviceType
|
|
975
|
+
end
|
|
976
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#get_device-instance_method
|
|
977
|
+
def get_device: (
|
|
978
|
+
device_key: ::String,
|
|
979
|
+
?access_token: ::String
|
|
980
|
+
) -> _GetDeviceResponseSuccess
|
|
981
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetDeviceResponseSuccess
|
|
982
|
+
|
|
983
|
+
interface _GetGroupResponseSuccess
|
|
984
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetGroupResponse]
|
|
985
|
+
def group: () -> Types::GroupType
|
|
986
|
+
end
|
|
987
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#get_group-instance_method
|
|
988
|
+
def get_group: (
|
|
989
|
+
group_name: ::String,
|
|
990
|
+
user_pool_id: ::String
|
|
991
|
+
) -> _GetGroupResponseSuccess
|
|
992
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetGroupResponseSuccess
|
|
993
|
+
|
|
994
|
+
interface _GetIdentityProviderByIdentifierResponseSuccess
|
|
995
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetIdentityProviderByIdentifierResponse]
|
|
996
|
+
def identity_provider: () -> Types::IdentityProviderType
|
|
997
|
+
end
|
|
998
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#get_identity_provider_by_identifier-instance_method
|
|
999
|
+
def get_identity_provider_by_identifier: (
|
|
1000
|
+
user_pool_id: ::String,
|
|
1001
|
+
idp_identifier: ::String
|
|
1002
|
+
) -> _GetIdentityProviderByIdentifierResponseSuccess
|
|
1003
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetIdentityProviderByIdentifierResponseSuccess
|
|
1004
|
+
|
|
1005
|
+
interface _GetLogDeliveryConfigurationResponseSuccess
|
|
1006
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetLogDeliveryConfigurationResponse]
|
|
1007
|
+
def log_delivery_configuration: () -> Types::LogDeliveryConfigurationType
|
|
1008
|
+
end
|
|
1009
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#get_log_delivery_configuration-instance_method
|
|
1010
|
+
def get_log_delivery_configuration: (
|
|
1011
|
+
user_pool_id: ::String
|
|
1012
|
+
) -> _GetLogDeliveryConfigurationResponseSuccess
|
|
1013
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetLogDeliveryConfigurationResponseSuccess
|
|
1014
|
+
|
|
1015
|
+
interface _GetSigningCertificateResponseSuccess
|
|
1016
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetSigningCertificateResponse]
|
|
1017
|
+
def certificate: () -> ::String
|
|
1018
|
+
end
|
|
1019
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#get_signing_certificate-instance_method
|
|
1020
|
+
def get_signing_certificate: (
|
|
1021
|
+
user_pool_id: ::String
|
|
1022
|
+
) -> _GetSigningCertificateResponseSuccess
|
|
1023
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetSigningCertificateResponseSuccess
|
|
1024
|
+
|
|
1025
|
+
interface _GetUICustomizationResponseSuccess
|
|
1026
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetUICustomizationResponse]
|
|
1027
|
+
def ui_customization: () -> Types::UICustomizationType
|
|
1028
|
+
end
|
|
1029
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#get_ui_customization-instance_method
|
|
1030
|
+
def get_ui_customization: (
|
|
1031
|
+
user_pool_id: ::String,
|
|
1032
|
+
?client_id: ::String
|
|
1033
|
+
) -> _GetUICustomizationResponseSuccess
|
|
1034
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetUICustomizationResponseSuccess
|
|
1035
|
+
|
|
1036
|
+
interface _GetUserResponseSuccess
|
|
1037
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetUserResponse]
|
|
1038
|
+
def username: () -> ::String
|
|
1039
|
+
def user_attributes: () -> ::Array[Types::AttributeType]
|
|
1040
|
+
def mfa_options: () -> ::Array[Types::MFAOptionType]
|
|
1041
|
+
def preferred_mfa_setting: () -> ::String
|
|
1042
|
+
def user_mfa_setting_list: () -> ::Array[::String]
|
|
1043
|
+
end
|
|
1044
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#get_user-instance_method
|
|
1045
|
+
def get_user: (
|
|
1046
|
+
access_token: ::String
|
|
1047
|
+
) -> _GetUserResponseSuccess
|
|
1048
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetUserResponseSuccess
|
|
1049
|
+
|
|
1050
|
+
interface _GetUserAttributeVerificationCodeResponseSuccess
|
|
1051
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetUserAttributeVerificationCodeResponse]
|
|
1052
|
+
def code_delivery_details: () -> Types::CodeDeliveryDetailsType
|
|
1053
|
+
end
|
|
1054
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#get_user_attribute_verification_code-instance_method
|
|
1055
|
+
def get_user_attribute_verification_code: (
|
|
1056
|
+
access_token: ::String,
|
|
1057
|
+
attribute_name: ::String,
|
|
1058
|
+
?client_metadata: Hash[::String, ::String]
|
|
1059
|
+
) -> _GetUserAttributeVerificationCodeResponseSuccess
|
|
1060
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetUserAttributeVerificationCodeResponseSuccess
|
|
1061
|
+
|
|
1062
|
+
interface _GetUserPoolMfaConfigResponseSuccess
|
|
1063
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetUserPoolMfaConfigResponse]
|
|
1064
|
+
def sms_mfa_configuration: () -> Types::SmsMfaConfigType
|
|
1065
|
+
def software_token_mfa_configuration: () -> Types::SoftwareTokenMfaConfigType
|
|
1066
|
+
def mfa_configuration: () -> ("OFF" | "ON" | "OPTIONAL")
|
|
1067
|
+
end
|
|
1068
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#get_user_pool_mfa_config-instance_method
|
|
1069
|
+
def get_user_pool_mfa_config: (
|
|
1070
|
+
user_pool_id: ::String
|
|
1071
|
+
) -> _GetUserPoolMfaConfigResponseSuccess
|
|
1072
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetUserPoolMfaConfigResponseSuccess
|
|
1073
|
+
|
|
1074
|
+
interface _GlobalSignOutResponseSuccess
|
|
1075
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GlobalSignOutResponse]
|
|
1076
|
+
end
|
|
1077
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#global_sign_out-instance_method
|
|
1078
|
+
def global_sign_out: (
|
|
1079
|
+
access_token: ::String
|
|
1080
|
+
) -> _GlobalSignOutResponseSuccess
|
|
1081
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GlobalSignOutResponseSuccess
|
|
1082
|
+
|
|
1083
|
+
interface _InitiateAuthResponseSuccess
|
|
1084
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::InitiateAuthResponse]
|
|
1085
|
+
def challenge_name: () -> ("SMS_MFA" | "SOFTWARE_TOKEN_MFA" | "SELECT_MFA_TYPE" | "MFA_SETUP" | "PASSWORD_VERIFIER" | "CUSTOM_CHALLENGE" | "DEVICE_SRP_AUTH" | "DEVICE_PASSWORD_VERIFIER" | "ADMIN_NO_SRP_AUTH" | "NEW_PASSWORD_REQUIRED")
|
|
1086
|
+
def session: () -> ::String
|
|
1087
|
+
def challenge_parameters: () -> ::Hash[::String, ::String]
|
|
1088
|
+
def authentication_result: () -> Types::AuthenticationResultType
|
|
1089
|
+
end
|
|
1090
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#initiate_auth-instance_method
|
|
1091
|
+
def initiate_auth: (
|
|
1092
|
+
auth_flow: ("USER_SRP_AUTH" | "REFRESH_TOKEN_AUTH" | "REFRESH_TOKEN" | "CUSTOM_AUTH" | "ADMIN_NO_SRP_AUTH" | "USER_PASSWORD_AUTH" | "ADMIN_USER_PASSWORD_AUTH"),
|
|
1093
|
+
?auth_parameters: Hash[::String, ::String],
|
|
1094
|
+
?client_metadata: Hash[::String, ::String],
|
|
1095
|
+
client_id: ::String,
|
|
1096
|
+
?analytics_metadata: {
|
|
1097
|
+
analytics_endpoint_id: ::String?
|
|
1098
|
+
},
|
|
1099
|
+
?user_context_data: {
|
|
1100
|
+
ip_address: ::String?,
|
|
1101
|
+
encoded_data: ::String?
|
|
1102
|
+
}
|
|
1103
|
+
) -> _InitiateAuthResponseSuccess
|
|
1104
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _InitiateAuthResponseSuccess
|
|
1105
|
+
|
|
1106
|
+
interface _ListDevicesResponseSuccess
|
|
1107
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListDevicesResponse]
|
|
1108
|
+
def devices: () -> ::Array[Types::DeviceType]
|
|
1109
|
+
def pagination_token: () -> ::String
|
|
1110
|
+
end
|
|
1111
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#list_devices-instance_method
|
|
1112
|
+
def list_devices: (
|
|
1113
|
+
access_token: ::String,
|
|
1114
|
+
?limit: ::Integer,
|
|
1115
|
+
?pagination_token: ::String
|
|
1116
|
+
) -> _ListDevicesResponseSuccess
|
|
1117
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListDevicesResponseSuccess
|
|
1118
|
+
|
|
1119
|
+
interface _ListGroupsResponseSuccess
|
|
1120
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListGroupsResponse]
|
|
1121
|
+
def groups: () -> ::Array[Types::GroupType]
|
|
1122
|
+
def next_token: () -> ::String
|
|
1123
|
+
end
|
|
1124
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#list_groups-instance_method
|
|
1125
|
+
def list_groups: (
|
|
1126
|
+
user_pool_id: ::String,
|
|
1127
|
+
?limit: ::Integer,
|
|
1128
|
+
?next_token: ::String
|
|
1129
|
+
) -> _ListGroupsResponseSuccess
|
|
1130
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListGroupsResponseSuccess
|
|
1131
|
+
|
|
1132
|
+
interface _ListIdentityProvidersResponseSuccess
|
|
1133
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListIdentityProvidersResponse]
|
|
1134
|
+
def providers: () -> ::Array[Types::ProviderDescription]
|
|
1135
|
+
def next_token: () -> ::String
|
|
1136
|
+
end
|
|
1137
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#list_identity_providers-instance_method
|
|
1138
|
+
def list_identity_providers: (
|
|
1139
|
+
user_pool_id: ::String,
|
|
1140
|
+
?max_results: ::Integer,
|
|
1141
|
+
?next_token: ::String
|
|
1142
|
+
) -> _ListIdentityProvidersResponseSuccess
|
|
1143
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListIdentityProvidersResponseSuccess
|
|
1144
|
+
|
|
1145
|
+
interface _ListResourceServersResponseSuccess
|
|
1146
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListResourceServersResponse]
|
|
1147
|
+
def resource_servers: () -> ::Array[Types::ResourceServerType]
|
|
1148
|
+
def next_token: () -> ::String
|
|
1149
|
+
end
|
|
1150
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#list_resource_servers-instance_method
|
|
1151
|
+
def list_resource_servers: (
|
|
1152
|
+
user_pool_id: ::String,
|
|
1153
|
+
?max_results: ::Integer,
|
|
1154
|
+
?next_token: ::String
|
|
1155
|
+
) -> _ListResourceServersResponseSuccess
|
|
1156
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListResourceServersResponseSuccess
|
|
1157
|
+
|
|
1158
|
+
interface _ListTagsForResourceResponseSuccess
|
|
1159
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListTagsForResourceResponse]
|
|
1160
|
+
def tags: () -> ::Hash[::String, ::String]
|
|
1161
|
+
end
|
|
1162
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#list_tags_for_resource-instance_method
|
|
1163
|
+
def list_tags_for_resource: (
|
|
1164
|
+
resource_arn: ::String
|
|
1165
|
+
) -> _ListTagsForResourceResponseSuccess
|
|
1166
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListTagsForResourceResponseSuccess
|
|
1167
|
+
|
|
1168
|
+
interface _ListUserImportJobsResponseSuccess
|
|
1169
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListUserImportJobsResponse]
|
|
1170
|
+
def user_import_jobs: () -> ::Array[Types::UserImportJobType]
|
|
1171
|
+
def pagination_token: () -> ::String
|
|
1172
|
+
end
|
|
1173
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#list_user_import_jobs-instance_method
|
|
1174
|
+
def list_user_import_jobs: (
|
|
1175
|
+
user_pool_id: ::String,
|
|
1176
|
+
max_results: ::Integer,
|
|
1177
|
+
?pagination_token: ::String
|
|
1178
|
+
) -> _ListUserImportJobsResponseSuccess
|
|
1179
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListUserImportJobsResponseSuccess
|
|
1180
|
+
|
|
1181
|
+
interface _ListUserPoolClientsResponseSuccess
|
|
1182
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListUserPoolClientsResponse]
|
|
1183
|
+
def user_pool_clients: () -> ::Array[Types::UserPoolClientDescription]
|
|
1184
|
+
def next_token: () -> ::String
|
|
1185
|
+
end
|
|
1186
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#list_user_pool_clients-instance_method
|
|
1187
|
+
def list_user_pool_clients: (
|
|
1188
|
+
user_pool_id: ::String,
|
|
1189
|
+
?max_results: ::Integer,
|
|
1190
|
+
?next_token: ::String
|
|
1191
|
+
) -> _ListUserPoolClientsResponseSuccess
|
|
1192
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListUserPoolClientsResponseSuccess
|
|
1193
|
+
|
|
1194
|
+
interface _ListUserPoolsResponseSuccess
|
|
1195
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListUserPoolsResponse]
|
|
1196
|
+
def user_pools: () -> ::Array[Types::UserPoolDescriptionType]
|
|
1197
|
+
def next_token: () -> ::String
|
|
1198
|
+
end
|
|
1199
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#list_user_pools-instance_method
|
|
1200
|
+
def list_user_pools: (
|
|
1201
|
+
?next_token: ::String,
|
|
1202
|
+
max_results: ::Integer
|
|
1203
|
+
) -> _ListUserPoolsResponseSuccess
|
|
1204
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListUserPoolsResponseSuccess
|
|
1205
|
+
|
|
1206
|
+
interface _ListUsersResponseSuccess
|
|
1207
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListUsersResponse]
|
|
1208
|
+
def users: () -> ::Array[Types::UserType]
|
|
1209
|
+
def pagination_token: () -> ::String
|
|
1210
|
+
end
|
|
1211
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#list_users-instance_method
|
|
1212
|
+
def list_users: (
|
|
1213
|
+
user_pool_id: ::String,
|
|
1214
|
+
?attributes_to_get: Array[::String],
|
|
1215
|
+
?limit: ::Integer,
|
|
1216
|
+
?pagination_token: ::String,
|
|
1217
|
+
?filter: ::String
|
|
1218
|
+
) -> _ListUsersResponseSuccess
|
|
1219
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListUsersResponseSuccess
|
|
1220
|
+
|
|
1221
|
+
interface _ListUsersInGroupResponseSuccess
|
|
1222
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListUsersInGroupResponse]
|
|
1223
|
+
def users: () -> ::Array[Types::UserType]
|
|
1224
|
+
def next_token: () -> ::String
|
|
1225
|
+
end
|
|
1226
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#list_users_in_group-instance_method
|
|
1227
|
+
def list_users_in_group: (
|
|
1228
|
+
user_pool_id: ::String,
|
|
1229
|
+
group_name: ::String,
|
|
1230
|
+
?limit: ::Integer,
|
|
1231
|
+
?next_token: ::String
|
|
1232
|
+
) -> _ListUsersInGroupResponseSuccess
|
|
1233
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListUsersInGroupResponseSuccess
|
|
1234
|
+
|
|
1235
|
+
interface _ResendConfirmationCodeResponseSuccess
|
|
1236
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ResendConfirmationCodeResponse]
|
|
1237
|
+
def code_delivery_details: () -> Types::CodeDeliveryDetailsType
|
|
1238
|
+
end
|
|
1239
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#resend_confirmation_code-instance_method
|
|
1240
|
+
def resend_confirmation_code: (
|
|
1241
|
+
client_id: ::String,
|
|
1242
|
+
?secret_hash: ::String,
|
|
1243
|
+
?user_context_data: {
|
|
1244
|
+
ip_address: ::String?,
|
|
1245
|
+
encoded_data: ::String?
|
|
1246
|
+
},
|
|
1247
|
+
username: ::String,
|
|
1248
|
+
?analytics_metadata: {
|
|
1249
|
+
analytics_endpoint_id: ::String?
|
|
1250
|
+
},
|
|
1251
|
+
?client_metadata: Hash[::String, ::String]
|
|
1252
|
+
) -> _ResendConfirmationCodeResponseSuccess
|
|
1253
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ResendConfirmationCodeResponseSuccess
|
|
1254
|
+
|
|
1255
|
+
interface _RespondToAuthChallengeResponseSuccess
|
|
1256
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::RespondToAuthChallengeResponse]
|
|
1257
|
+
def challenge_name: () -> ("SMS_MFA" | "SOFTWARE_TOKEN_MFA" | "SELECT_MFA_TYPE" | "MFA_SETUP" | "PASSWORD_VERIFIER" | "CUSTOM_CHALLENGE" | "DEVICE_SRP_AUTH" | "DEVICE_PASSWORD_VERIFIER" | "ADMIN_NO_SRP_AUTH" | "NEW_PASSWORD_REQUIRED")
|
|
1258
|
+
def session: () -> ::String
|
|
1259
|
+
def challenge_parameters: () -> ::Hash[::String, ::String]
|
|
1260
|
+
def authentication_result: () -> Types::AuthenticationResultType
|
|
1261
|
+
end
|
|
1262
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#respond_to_auth_challenge-instance_method
|
|
1263
|
+
def respond_to_auth_challenge: (
|
|
1264
|
+
client_id: ::String,
|
|
1265
|
+
challenge_name: ("SMS_MFA" | "SOFTWARE_TOKEN_MFA" | "SELECT_MFA_TYPE" | "MFA_SETUP" | "PASSWORD_VERIFIER" | "CUSTOM_CHALLENGE" | "DEVICE_SRP_AUTH" | "DEVICE_PASSWORD_VERIFIER" | "ADMIN_NO_SRP_AUTH" | "NEW_PASSWORD_REQUIRED"),
|
|
1266
|
+
?session: ::String,
|
|
1267
|
+
?challenge_responses: Hash[::String, ::String],
|
|
1268
|
+
?analytics_metadata: {
|
|
1269
|
+
analytics_endpoint_id: ::String?
|
|
1270
|
+
},
|
|
1271
|
+
?user_context_data: {
|
|
1272
|
+
ip_address: ::String?,
|
|
1273
|
+
encoded_data: ::String?
|
|
1274
|
+
},
|
|
1275
|
+
?client_metadata: Hash[::String, ::String]
|
|
1276
|
+
) -> _RespondToAuthChallengeResponseSuccess
|
|
1277
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _RespondToAuthChallengeResponseSuccess
|
|
1278
|
+
|
|
1279
|
+
interface _RevokeTokenResponseSuccess
|
|
1280
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::RevokeTokenResponse]
|
|
1281
|
+
end
|
|
1282
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#revoke_token-instance_method
|
|
1283
|
+
def revoke_token: (
|
|
1284
|
+
token: ::String,
|
|
1285
|
+
client_id: ::String,
|
|
1286
|
+
?client_secret: ::String
|
|
1287
|
+
) -> _RevokeTokenResponseSuccess
|
|
1288
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _RevokeTokenResponseSuccess
|
|
1289
|
+
|
|
1290
|
+
interface _SetLogDeliveryConfigurationResponseSuccess
|
|
1291
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::SetLogDeliveryConfigurationResponse]
|
|
1292
|
+
def log_delivery_configuration: () -> Types::LogDeliveryConfigurationType
|
|
1293
|
+
end
|
|
1294
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#set_log_delivery_configuration-instance_method
|
|
1295
|
+
def set_log_delivery_configuration: (
|
|
1296
|
+
user_pool_id: ::String,
|
|
1297
|
+
log_configurations: Array[
|
|
1298
|
+
{
|
|
1299
|
+
log_level: ("ERROR"),
|
|
1300
|
+
event_source: ("userNotification"),
|
|
1301
|
+
cloud_watch_logs_configuration: {
|
|
1302
|
+
log_group_arn: ::String?
|
|
1303
|
+
}?
|
|
1304
|
+
},
|
|
1305
|
+
]
|
|
1306
|
+
) -> _SetLogDeliveryConfigurationResponseSuccess
|
|
1307
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _SetLogDeliveryConfigurationResponseSuccess
|
|
1308
|
+
|
|
1309
|
+
interface _SetRiskConfigurationResponseSuccess
|
|
1310
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::SetRiskConfigurationResponse]
|
|
1311
|
+
def risk_configuration: () -> Types::RiskConfigurationType
|
|
1312
|
+
end
|
|
1313
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#set_risk_configuration-instance_method
|
|
1314
|
+
def set_risk_configuration: (
|
|
1315
|
+
user_pool_id: ::String,
|
|
1316
|
+
?client_id: ::String,
|
|
1317
|
+
?compromised_credentials_risk_configuration: {
|
|
1318
|
+
event_filter: Array[("SIGN_IN" | "PASSWORD_CHANGE" | "SIGN_UP")]?,
|
|
1319
|
+
actions: {
|
|
1320
|
+
event_action: ("BLOCK" | "NO_ACTION")
|
|
1321
|
+
}
|
|
1322
|
+
},
|
|
1323
|
+
?account_takeover_risk_configuration: {
|
|
1324
|
+
notify_configuration: {
|
|
1325
|
+
from: ::String?,
|
|
1326
|
+
reply_to: ::String?,
|
|
1327
|
+
source_arn: ::String,
|
|
1328
|
+
block_email: {
|
|
1329
|
+
subject: ::String,
|
|
1330
|
+
html_body: ::String?,
|
|
1331
|
+
text_body: ::String?
|
|
1332
|
+
}?,
|
|
1333
|
+
no_action_email: {
|
|
1334
|
+
subject: ::String,
|
|
1335
|
+
html_body: ::String?,
|
|
1336
|
+
text_body: ::String?
|
|
1337
|
+
}?,
|
|
1338
|
+
mfa_email: {
|
|
1339
|
+
subject: ::String,
|
|
1340
|
+
html_body: ::String?,
|
|
1341
|
+
text_body: ::String?
|
|
1342
|
+
}?
|
|
1343
|
+
}?,
|
|
1344
|
+
actions: {
|
|
1345
|
+
low_action: {
|
|
1346
|
+
notify: bool,
|
|
1347
|
+
event_action: ("BLOCK" | "MFA_IF_CONFIGURED" | "MFA_REQUIRED" | "NO_ACTION")
|
|
1348
|
+
}?,
|
|
1349
|
+
medium_action: {
|
|
1350
|
+
notify: bool,
|
|
1351
|
+
event_action: ("BLOCK" | "MFA_IF_CONFIGURED" | "MFA_REQUIRED" | "NO_ACTION")
|
|
1352
|
+
}?,
|
|
1353
|
+
high_action: {
|
|
1354
|
+
notify: bool,
|
|
1355
|
+
event_action: ("BLOCK" | "MFA_IF_CONFIGURED" | "MFA_REQUIRED" | "NO_ACTION")
|
|
1356
|
+
}?
|
|
1357
|
+
}
|
|
1358
|
+
},
|
|
1359
|
+
?risk_exception_configuration: {
|
|
1360
|
+
blocked_ip_range_list: Array[::String]?,
|
|
1361
|
+
skipped_ip_range_list: Array[::String]?
|
|
1362
|
+
}
|
|
1363
|
+
) -> _SetRiskConfigurationResponseSuccess
|
|
1364
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _SetRiskConfigurationResponseSuccess
|
|
1365
|
+
|
|
1366
|
+
interface _SetUICustomizationResponseSuccess
|
|
1367
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::SetUICustomizationResponse]
|
|
1368
|
+
def ui_customization: () -> Types::UICustomizationType
|
|
1369
|
+
end
|
|
1370
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#set_ui_customization-instance_method
|
|
1371
|
+
def set_ui_customization: (
|
|
1372
|
+
user_pool_id: ::String,
|
|
1373
|
+
?client_id: ::String,
|
|
1374
|
+
?css: ::String,
|
|
1375
|
+
?image_file: ::String
|
|
1376
|
+
) -> _SetUICustomizationResponseSuccess
|
|
1377
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _SetUICustomizationResponseSuccess
|
|
1378
|
+
|
|
1379
|
+
interface _SetUserMFAPreferenceResponseSuccess
|
|
1380
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::SetUserMFAPreferenceResponse]
|
|
1381
|
+
end
|
|
1382
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#set_user_mfa_preference-instance_method
|
|
1383
|
+
def set_user_mfa_preference: (
|
|
1384
|
+
?sms_mfa_settings: {
|
|
1385
|
+
enabled: bool?,
|
|
1386
|
+
preferred_mfa: bool?
|
|
1387
|
+
},
|
|
1388
|
+
?software_token_mfa_settings: {
|
|
1389
|
+
enabled: bool?,
|
|
1390
|
+
preferred_mfa: bool?
|
|
1391
|
+
},
|
|
1392
|
+
access_token: ::String
|
|
1393
|
+
) -> _SetUserMFAPreferenceResponseSuccess
|
|
1394
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _SetUserMFAPreferenceResponseSuccess
|
|
1395
|
+
|
|
1396
|
+
interface _SetUserPoolMfaConfigResponseSuccess
|
|
1397
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::SetUserPoolMfaConfigResponse]
|
|
1398
|
+
def sms_mfa_configuration: () -> Types::SmsMfaConfigType
|
|
1399
|
+
def software_token_mfa_configuration: () -> Types::SoftwareTokenMfaConfigType
|
|
1400
|
+
def mfa_configuration: () -> ("OFF" | "ON" | "OPTIONAL")
|
|
1401
|
+
end
|
|
1402
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#set_user_pool_mfa_config-instance_method
|
|
1403
|
+
def set_user_pool_mfa_config: (
|
|
1404
|
+
user_pool_id: ::String,
|
|
1405
|
+
?sms_mfa_configuration: {
|
|
1406
|
+
sms_authentication_message: ::String?,
|
|
1407
|
+
sms_configuration: {
|
|
1408
|
+
sns_caller_arn: ::String,
|
|
1409
|
+
external_id: ::String?,
|
|
1410
|
+
sns_region: ::String?
|
|
1411
|
+
}?
|
|
1412
|
+
},
|
|
1413
|
+
?software_token_mfa_configuration: {
|
|
1414
|
+
enabled: bool?
|
|
1415
|
+
},
|
|
1416
|
+
?mfa_configuration: ("OFF" | "ON" | "OPTIONAL")
|
|
1417
|
+
) -> _SetUserPoolMfaConfigResponseSuccess
|
|
1418
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _SetUserPoolMfaConfigResponseSuccess
|
|
1419
|
+
|
|
1420
|
+
interface _SetUserSettingsResponseSuccess
|
|
1421
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::SetUserSettingsResponse]
|
|
1422
|
+
end
|
|
1423
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#set_user_settings-instance_method
|
|
1424
|
+
def set_user_settings: (
|
|
1425
|
+
access_token: ::String,
|
|
1426
|
+
mfa_options: Array[
|
|
1427
|
+
{
|
|
1428
|
+
delivery_medium: ("SMS" | "EMAIL")?,
|
|
1429
|
+
attribute_name: ::String?
|
|
1430
|
+
},
|
|
1431
|
+
]
|
|
1432
|
+
) -> _SetUserSettingsResponseSuccess
|
|
1433
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _SetUserSettingsResponseSuccess
|
|
1434
|
+
|
|
1435
|
+
interface _SignUpResponseSuccess
|
|
1436
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::SignUpResponse]
|
|
1437
|
+
def user_confirmed: () -> bool
|
|
1438
|
+
def code_delivery_details: () -> Types::CodeDeliveryDetailsType
|
|
1439
|
+
def user_sub: () -> ::String
|
|
1440
|
+
end
|
|
1441
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#sign_up-instance_method
|
|
1442
|
+
def sign_up: (
|
|
1443
|
+
client_id: ::String,
|
|
1444
|
+
?secret_hash: ::String,
|
|
1445
|
+
username: ::String,
|
|
1446
|
+
password: ::String,
|
|
1447
|
+
?user_attributes: Array[
|
|
1448
|
+
{
|
|
1449
|
+
name: ::String,
|
|
1450
|
+
value: ::String?
|
|
1451
|
+
},
|
|
1452
|
+
],
|
|
1453
|
+
?validation_data: Array[
|
|
1454
|
+
{
|
|
1455
|
+
name: ::String,
|
|
1456
|
+
value: ::String?
|
|
1457
|
+
},
|
|
1458
|
+
],
|
|
1459
|
+
?analytics_metadata: {
|
|
1460
|
+
analytics_endpoint_id: ::String?
|
|
1461
|
+
},
|
|
1462
|
+
?user_context_data: {
|
|
1463
|
+
ip_address: ::String?,
|
|
1464
|
+
encoded_data: ::String?
|
|
1465
|
+
},
|
|
1466
|
+
?client_metadata: Hash[::String, ::String]
|
|
1467
|
+
) -> _SignUpResponseSuccess
|
|
1468
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _SignUpResponseSuccess
|
|
1469
|
+
|
|
1470
|
+
interface _StartUserImportJobResponseSuccess
|
|
1471
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::StartUserImportJobResponse]
|
|
1472
|
+
def user_import_job: () -> Types::UserImportJobType
|
|
1473
|
+
end
|
|
1474
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#start_user_import_job-instance_method
|
|
1475
|
+
def start_user_import_job: (
|
|
1476
|
+
user_pool_id: ::String,
|
|
1477
|
+
job_id: ::String
|
|
1478
|
+
) -> _StartUserImportJobResponseSuccess
|
|
1479
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _StartUserImportJobResponseSuccess
|
|
1480
|
+
|
|
1481
|
+
interface _StopUserImportJobResponseSuccess
|
|
1482
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::StopUserImportJobResponse]
|
|
1483
|
+
def user_import_job: () -> Types::UserImportJobType
|
|
1484
|
+
end
|
|
1485
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#stop_user_import_job-instance_method
|
|
1486
|
+
def stop_user_import_job: (
|
|
1487
|
+
user_pool_id: ::String,
|
|
1488
|
+
job_id: ::String
|
|
1489
|
+
) -> _StopUserImportJobResponseSuccess
|
|
1490
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _StopUserImportJobResponseSuccess
|
|
1491
|
+
|
|
1492
|
+
interface _TagResourceResponseSuccess
|
|
1493
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::TagResourceResponse]
|
|
1494
|
+
end
|
|
1495
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#tag_resource-instance_method
|
|
1496
|
+
def tag_resource: (
|
|
1497
|
+
resource_arn: ::String,
|
|
1498
|
+
tags: Hash[::String, ::String]
|
|
1499
|
+
) -> _TagResourceResponseSuccess
|
|
1500
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _TagResourceResponseSuccess
|
|
1501
|
+
|
|
1502
|
+
interface _UntagResourceResponseSuccess
|
|
1503
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UntagResourceResponse]
|
|
1504
|
+
end
|
|
1505
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#untag_resource-instance_method
|
|
1506
|
+
def untag_resource: (
|
|
1507
|
+
resource_arn: ::String,
|
|
1508
|
+
tag_keys: Array[::String]
|
|
1509
|
+
) -> _UntagResourceResponseSuccess
|
|
1510
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UntagResourceResponseSuccess
|
|
1511
|
+
|
|
1512
|
+
interface _UpdateAuthEventFeedbackResponseSuccess
|
|
1513
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateAuthEventFeedbackResponse]
|
|
1514
|
+
end
|
|
1515
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#update_auth_event_feedback-instance_method
|
|
1516
|
+
def update_auth_event_feedback: (
|
|
1517
|
+
user_pool_id: ::String,
|
|
1518
|
+
username: ::String,
|
|
1519
|
+
event_id: ::String,
|
|
1520
|
+
feedback_token: ::String,
|
|
1521
|
+
feedback_value: ("Valid" | "Invalid")
|
|
1522
|
+
) -> _UpdateAuthEventFeedbackResponseSuccess
|
|
1523
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateAuthEventFeedbackResponseSuccess
|
|
1524
|
+
|
|
1525
|
+
interface _UpdateDeviceStatusResponseSuccess
|
|
1526
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateDeviceStatusResponse]
|
|
1527
|
+
end
|
|
1528
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#update_device_status-instance_method
|
|
1529
|
+
def update_device_status: (
|
|
1530
|
+
access_token: ::String,
|
|
1531
|
+
device_key: ::String,
|
|
1532
|
+
?device_remembered_status: ("remembered" | "not_remembered")
|
|
1533
|
+
) -> _UpdateDeviceStatusResponseSuccess
|
|
1534
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateDeviceStatusResponseSuccess
|
|
1535
|
+
|
|
1536
|
+
interface _UpdateGroupResponseSuccess
|
|
1537
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateGroupResponse]
|
|
1538
|
+
def group: () -> Types::GroupType
|
|
1539
|
+
end
|
|
1540
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#update_group-instance_method
|
|
1541
|
+
def update_group: (
|
|
1542
|
+
group_name: ::String,
|
|
1543
|
+
user_pool_id: ::String,
|
|
1544
|
+
?description: ::String,
|
|
1545
|
+
?role_arn: ::String,
|
|
1546
|
+
?precedence: ::Integer
|
|
1547
|
+
) -> _UpdateGroupResponseSuccess
|
|
1548
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateGroupResponseSuccess
|
|
1549
|
+
|
|
1550
|
+
interface _UpdateIdentityProviderResponseSuccess
|
|
1551
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateIdentityProviderResponse]
|
|
1552
|
+
def identity_provider: () -> Types::IdentityProviderType
|
|
1553
|
+
end
|
|
1554
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#update_identity_provider-instance_method
|
|
1555
|
+
def update_identity_provider: (
|
|
1556
|
+
user_pool_id: ::String,
|
|
1557
|
+
provider_name: ::String,
|
|
1558
|
+
?provider_details: Hash[::String, ::String],
|
|
1559
|
+
?attribute_mapping: Hash[::String, ::String],
|
|
1560
|
+
?idp_identifiers: Array[::String]
|
|
1561
|
+
) -> _UpdateIdentityProviderResponseSuccess
|
|
1562
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateIdentityProviderResponseSuccess
|
|
1563
|
+
|
|
1564
|
+
interface _UpdateResourceServerResponseSuccess
|
|
1565
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateResourceServerResponse]
|
|
1566
|
+
def resource_server: () -> Types::ResourceServerType
|
|
1567
|
+
end
|
|
1568
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#update_resource_server-instance_method
|
|
1569
|
+
def update_resource_server: (
|
|
1570
|
+
user_pool_id: ::String,
|
|
1571
|
+
identifier: ::String,
|
|
1572
|
+
name: ::String,
|
|
1573
|
+
?scopes: Array[
|
|
1574
|
+
{
|
|
1575
|
+
scope_name: ::String,
|
|
1576
|
+
scope_description: ::String
|
|
1577
|
+
},
|
|
1578
|
+
]
|
|
1579
|
+
) -> _UpdateResourceServerResponseSuccess
|
|
1580
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateResourceServerResponseSuccess
|
|
1581
|
+
|
|
1582
|
+
interface _UpdateUserAttributesResponseSuccess
|
|
1583
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateUserAttributesResponse]
|
|
1584
|
+
def code_delivery_details_list: () -> ::Array[Types::CodeDeliveryDetailsType]
|
|
1585
|
+
end
|
|
1586
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#update_user_attributes-instance_method
|
|
1587
|
+
def update_user_attributes: (
|
|
1588
|
+
user_attributes: Array[
|
|
1589
|
+
{
|
|
1590
|
+
name: ::String,
|
|
1591
|
+
value: ::String?
|
|
1592
|
+
},
|
|
1593
|
+
],
|
|
1594
|
+
access_token: ::String,
|
|
1595
|
+
?client_metadata: Hash[::String, ::String]
|
|
1596
|
+
) -> _UpdateUserAttributesResponseSuccess
|
|
1597
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateUserAttributesResponseSuccess
|
|
1598
|
+
|
|
1599
|
+
interface _UpdateUserPoolResponseSuccess
|
|
1600
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateUserPoolResponse]
|
|
1601
|
+
end
|
|
1602
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#update_user_pool-instance_method
|
|
1603
|
+
def update_user_pool: (
|
|
1604
|
+
user_pool_id: ::String,
|
|
1605
|
+
?policies: {
|
|
1606
|
+
password_policy: {
|
|
1607
|
+
minimum_length: ::Integer?,
|
|
1608
|
+
require_uppercase: bool?,
|
|
1609
|
+
require_lowercase: bool?,
|
|
1610
|
+
require_numbers: bool?,
|
|
1611
|
+
require_symbols: bool?,
|
|
1612
|
+
temporary_password_validity_days: ::Integer?
|
|
1613
|
+
}?
|
|
1614
|
+
},
|
|
1615
|
+
?deletion_protection: ("ACTIVE" | "INACTIVE"),
|
|
1616
|
+
?lambda_config: {
|
|
1617
|
+
pre_sign_up: ::String?,
|
|
1618
|
+
custom_message: ::String?,
|
|
1619
|
+
post_confirmation: ::String?,
|
|
1620
|
+
pre_authentication: ::String?,
|
|
1621
|
+
post_authentication: ::String?,
|
|
1622
|
+
define_auth_challenge: ::String?,
|
|
1623
|
+
create_auth_challenge: ::String?,
|
|
1624
|
+
verify_auth_challenge_response: ::String?,
|
|
1625
|
+
pre_token_generation: ::String?,
|
|
1626
|
+
pre_token_generation_config: {
|
|
1627
|
+
lambda_version: ("V1_0" | "V2_0"),
|
|
1628
|
+
lambda_arn: ::String
|
|
1629
|
+
}?,
|
|
1630
|
+
user_migration: ::String?,
|
|
1631
|
+
custom_sms_sender: {
|
|
1632
|
+
lambda_version: ("V1_0"),
|
|
1633
|
+
lambda_arn: ::String
|
|
1634
|
+
}?,
|
|
1635
|
+
custom_email_sender: {
|
|
1636
|
+
lambda_version: ("V1_0"),
|
|
1637
|
+
lambda_arn: ::String
|
|
1638
|
+
}?,
|
|
1639
|
+
kms_key_id: ::String?
|
|
1640
|
+
},
|
|
1641
|
+
?auto_verified_attributes: Array[("phone_number" | "email")],
|
|
1642
|
+
?sms_verification_message: ::String,
|
|
1643
|
+
?email_verification_message: ::String,
|
|
1644
|
+
?email_verification_subject: ::String,
|
|
1645
|
+
?verification_message_template: {
|
|
1646
|
+
sms_message: ::String?,
|
|
1647
|
+
email_message: ::String?,
|
|
1648
|
+
email_subject: ::String?,
|
|
1649
|
+
email_message_by_link: ::String?,
|
|
1650
|
+
email_subject_by_link: ::String?,
|
|
1651
|
+
default_email_option: ("CONFIRM_WITH_LINK" | "CONFIRM_WITH_CODE")?
|
|
1652
|
+
},
|
|
1653
|
+
?sms_authentication_message: ::String,
|
|
1654
|
+
?user_attribute_update_settings: {
|
|
1655
|
+
attributes_require_verification_before_update: Array[("phone_number" | "email")]?
|
|
1656
|
+
},
|
|
1657
|
+
?mfa_configuration: ("OFF" | "ON" | "OPTIONAL"),
|
|
1658
|
+
?device_configuration: {
|
|
1659
|
+
challenge_required_on_new_device: bool?,
|
|
1660
|
+
device_only_remembered_on_user_prompt: bool?
|
|
1661
|
+
},
|
|
1662
|
+
?email_configuration: {
|
|
1663
|
+
source_arn: ::String?,
|
|
1664
|
+
reply_to_email_address: ::String?,
|
|
1665
|
+
email_sending_account: ("COGNITO_DEFAULT" | "DEVELOPER")?,
|
|
1666
|
+
from: ::String?,
|
|
1667
|
+
configuration_set: ::String?
|
|
1668
|
+
},
|
|
1669
|
+
?sms_configuration: {
|
|
1670
|
+
sns_caller_arn: ::String,
|
|
1671
|
+
external_id: ::String?,
|
|
1672
|
+
sns_region: ::String?
|
|
1673
|
+
},
|
|
1674
|
+
?user_pool_tags: Hash[::String, ::String],
|
|
1675
|
+
?admin_create_user_config: {
|
|
1676
|
+
allow_admin_create_user_only: bool?,
|
|
1677
|
+
unused_account_validity_days: ::Integer?,
|
|
1678
|
+
invite_message_template: {
|
|
1679
|
+
sms_message: ::String?,
|
|
1680
|
+
email_message: ::String?,
|
|
1681
|
+
email_subject: ::String?
|
|
1682
|
+
}?
|
|
1683
|
+
},
|
|
1684
|
+
?user_pool_add_ons: {
|
|
1685
|
+
advanced_security_mode: ("OFF" | "AUDIT" | "ENFORCED")
|
|
1686
|
+
},
|
|
1687
|
+
?account_recovery_setting: {
|
|
1688
|
+
recovery_mechanisms: Array[
|
|
1689
|
+
{
|
|
1690
|
+
priority: ::Integer,
|
|
1691
|
+
name: ("verified_email" | "verified_phone_number" | "admin_only")
|
|
1692
|
+
},
|
|
1693
|
+
]?
|
|
1694
|
+
}
|
|
1695
|
+
) -> _UpdateUserPoolResponseSuccess
|
|
1696
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateUserPoolResponseSuccess
|
|
1697
|
+
|
|
1698
|
+
interface _UpdateUserPoolClientResponseSuccess
|
|
1699
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateUserPoolClientResponse]
|
|
1700
|
+
def user_pool_client: () -> Types::UserPoolClientType
|
|
1701
|
+
end
|
|
1702
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#update_user_pool_client-instance_method
|
|
1703
|
+
def update_user_pool_client: (
|
|
1704
|
+
user_pool_id: ::String,
|
|
1705
|
+
client_id: ::String,
|
|
1706
|
+
?client_name: ::String,
|
|
1707
|
+
?refresh_token_validity: ::Integer,
|
|
1708
|
+
?access_token_validity: ::Integer,
|
|
1709
|
+
?id_token_validity: ::Integer,
|
|
1710
|
+
?token_validity_units: {
|
|
1711
|
+
access_token: ("seconds" | "minutes" | "hours" | "days")?,
|
|
1712
|
+
id_token: ("seconds" | "minutes" | "hours" | "days")?,
|
|
1713
|
+
refresh_token: ("seconds" | "minutes" | "hours" | "days")?
|
|
1714
|
+
},
|
|
1715
|
+
?read_attributes: Array[::String],
|
|
1716
|
+
?write_attributes: Array[::String],
|
|
1717
|
+
?explicit_auth_flows: Array[("ADMIN_NO_SRP_AUTH" | "CUSTOM_AUTH_FLOW_ONLY" | "USER_PASSWORD_AUTH" | "ALLOW_ADMIN_USER_PASSWORD_AUTH" | "ALLOW_CUSTOM_AUTH" | "ALLOW_USER_PASSWORD_AUTH" | "ALLOW_USER_SRP_AUTH" | "ALLOW_REFRESH_TOKEN_AUTH")],
|
|
1718
|
+
?supported_identity_providers: Array[::String],
|
|
1719
|
+
?callback_urls: Array[::String],
|
|
1720
|
+
?logout_urls: Array[::String],
|
|
1721
|
+
?default_redirect_uri: ::String,
|
|
1722
|
+
?allowed_o_auth_flows: Array[("code" | "implicit" | "client_credentials")],
|
|
1723
|
+
?allowed_o_auth_scopes: Array[::String],
|
|
1724
|
+
?allowed_o_auth_flows_user_pool_client: bool,
|
|
1725
|
+
?analytics_configuration: {
|
|
1726
|
+
application_id: ::String?,
|
|
1727
|
+
application_arn: ::String?,
|
|
1728
|
+
role_arn: ::String?,
|
|
1729
|
+
external_id: ::String?,
|
|
1730
|
+
user_data_shared: bool?
|
|
1731
|
+
},
|
|
1732
|
+
?prevent_user_existence_errors: ("LEGACY" | "ENABLED"),
|
|
1733
|
+
?enable_token_revocation: bool,
|
|
1734
|
+
?enable_propagate_additional_user_context_data: bool,
|
|
1735
|
+
?auth_session_validity: ::Integer
|
|
1736
|
+
) -> _UpdateUserPoolClientResponseSuccess
|
|
1737
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateUserPoolClientResponseSuccess
|
|
1738
|
+
|
|
1739
|
+
interface _UpdateUserPoolDomainResponseSuccess
|
|
1740
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateUserPoolDomainResponse]
|
|
1741
|
+
def cloud_front_domain: () -> ::String
|
|
1742
|
+
end
|
|
1743
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#update_user_pool_domain-instance_method
|
|
1744
|
+
def update_user_pool_domain: (
|
|
1745
|
+
domain: ::String,
|
|
1746
|
+
user_pool_id: ::String,
|
|
1747
|
+
custom_domain_config: {
|
|
1748
|
+
certificate_arn: ::String
|
|
1749
|
+
}
|
|
1750
|
+
) -> _UpdateUserPoolDomainResponseSuccess
|
|
1751
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateUserPoolDomainResponseSuccess
|
|
1752
|
+
|
|
1753
|
+
interface _VerifySoftwareTokenResponseSuccess
|
|
1754
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::VerifySoftwareTokenResponse]
|
|
1755
|
+
def status: () -> ("SUCCESS" | "ERROR")
|
|
1756
|
+
def session: () -> ::String
|
|
1757
|
+
end
|
|
1758
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#verify_software_token-instance_method
|
|
1759
|
+
def verify_software_token: (
|
|
1760
|
+
?access_token: ::String,
|
|
1761
|
+
?session: ::String,
|
|
1762
|
+
user_code: ::String,
|
|
1763
|
+
?friendly_device_name: ::String
|
|
1764
|
+
) -> _VerifySoftwareTokenResponseSuccess
|
|
1765
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _VerifySoftwareTokenResponseSuccess
|
|
1766
|
+
|
|
1767
|
+
interface _VerifyUserAttributeResponseSuccess
|
|
1768
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::VerifyUserAttributeResponse]
|
|
1769
|
+
end
|
|
1770
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#verify_user_attribute-instance_method
|
|
1771
|
+
def verify_user_attribute: (
|
|
1772
|
+
access_token: ::String,
|
|
1773
|
+
attribute_name: ::String,
|
|
1774
|
+
code: ::String
|
|
1775
|
+
) -> _VerifyUserAttributeResponseSuccess
|
|
1776
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _VerifyUserAttributeResponseSuccess
|
|
1777
|
+
end
|
|
1778
|
+
end
|
|
1779
|
+
end
|
|
1780
|
+
|