aws-sdk-cognitoidentityprovider 1.166.0 → 1.167.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 +434 -1
- data/lib/aws-sdk-cognitoidentityprovider/client_api.rb +155 -0
- data/lib/aws-sdk-cognitoidentityprovider/types.rb +358 -0
- data/lib/aws-sdk-cognitoidentityprovider.rb +1 -1
- data/sig/client.rbs +57 -0
- data/sig/types.rbs +81 -0
- metadata +3 -3
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: a29b79e86b56a2d75b25ae2c725f6c532f2eccf3c9598f05a96c2cdb7ab26fcb
|
|
4
|
+
data.tar.gz: d273c685c85e0c159cca7ff022a8969361abc7c8947c84742d46f26ebf577cbf
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: c557e46d16f86cb6248a00670ee82e7c431537439b6d085c43877cc5de08dd7da28fec1e2ad57316531bfa244ac7b06c20aeef94a655d23d3f4bb5583bf036b5
|
|
7
|
+
data.tar.gz: fbd7d7fc323a3325fb92a5ef95c7f522a106dbe325122240700b81a5d92b0b45bb094dd97a5d5b59e4acc93f15cf9a72be3652612b4687c863efc9586da7480e
|
data/CHANGELOG.md
CHANGED
data/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.
|
|
1
|
+
1.167.0
|
|
@@ -3910,6 +3910,73 @@ module Aws::CognitoIdentityProvider
|
|
|
3910
3910
|
req.send_request(options)
|
|
3911
3911
|
end
|
|
3912
3912
|
|
|
3913
|
+
# Cancels a point-in-time recovery of a user pool before Amazon Cognito
|
|
3914
|
+
# applies any changes. You can cancel a recovery when its status is
|
|
3915
|
+
# `PREVIEW_GENERATING` or `PREVIEW_GENERATED`. When you cancel a
|
|
3916
|
+
# recovery, Amazon Cognito discards the recovery preview, resumes write
|
|
3917
|
+
# operations in the user pool, and sets the status of the recovery to
|
|
3918
|
+
# `PREVIEW_CANCELLED`. Your user pool data doesn't change.
|
|
3919
|
+
#
|
|
3920
|
+
# You can't cancel a recovery after you start it with a request.
|
|
3921
|
+
#
|
|
3922
|
+
# <note markdown="1"> Amazon Cognito evaluates Identity and Access Management (IAM) policies
|
|
3923
|
+
# in requests for this API operation. For this operation, you must use
|
|
3924
|
+
# IAM credentials to authorize requests, and you must grant yourself the
|
|
3925
|
+
# corresponding IAM permission in a policy.
|
|
3926
|
+
#
|
|
3927
|
+
# **Learn more**
|
|
3928
|
+
#
|
|
3929
|
+
# * [Signing Amazon Web Services API Requests][1]
|
|
3930
|
+
#
|
|
3931
|
+
# * [Using the Amazon Cognito user pools API and user pool endpoints][2]
|
|
3932
|
+
#
|
|
3933
|
+
# </note>
|
|
3934
|
+
#
|
|
3935
|
+
#
|
|
3936
|
+
#
|
|
3937
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html
|
|
3938
|
+
# [2]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html
|
|
3939
|
+
#
|
|
3940
|
+
# @option params [required, String] :user_pool_id
|
|
3941
|
+
# The ID of the user pool that contains the recovery that you want to
|
|
3942
|
+
# cancel.
|
|
3943
|
+
#
|
|
3944
|
+
# @option params [required, String] :restore_id
|
|
3945
|
+
# The ID of the recovery that you want to cancel. Amazon Cognito returns
|
|
3946
|
+
# this ID in the response to an `InitiatePointInTimeRecovery` request.
|
|
3947
|
+
#
|
|
3948
|
+
# @return [Types::CancelPointInTimeRecoveryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
3949
|
+
#
|
|
3950
|
+
# * {Types::CancelPointInTimeRecoveryResponse#restoration #restoration} => Types::RestorationType
|
|
3951
|
+
#
|
|
3952
|
+
# @example Request syntax with placeholder values
|
|
3953
|
+
#
|
|
3954
|
+
# resp = client.cancel_point_in_time_recovery({
|
|
3955
|
+
# user_pool_id: "UserPoolIdType", # required
|
|
3956
|
+
# restore_id: "RestoreIdType", # required
|
|
3957
|
+
# })
|
|
3958
|
+
#
|
|
3959
|
+
# @example Response structure
|
|
3960
|
+
#
|
|
3961
|
+
# resp.restoration.restore_id #=> String
|
|
3962
|
+
# resp.restoration.restore_status #=> String, one of "PREVIEW_GENERATING", "PREVIEW_GENERATED", "PREVIEW_CANCELLED", "PREVIEW_GENERATION_FAILED", "PREVIEW_EXPIRED", "RESTORING", "RESTORE_COMPLETED", "TEMPORARY_INTERNAL_ERROR_SEE_SUPPORT_CASE", "AWS_ABORTED"
|
|
3963
|
+
# resp.restoration.restore_timestamp #=> Time
|
|
3964
|
+
# resp.restoration.trigger_timestamp #=> Time
|
|
3965
|
+
# resp.restoration.restore_preview #=> Array
|
|
3966
|
+
# resp.restoration.restore_preview[0].entity #=> String
|
|
3967
|
+
# resp.restoration.restore_preview[0].create_count #=> Integer
|
|
3968
|
+
# resp.restoration.restore_preview[0].update_count #=> Integer
|
|
3969
|
+
# resp.restoration.restore_preview[0].delete_count #=> Integer
|
|
3970
|
+
#
|
|
3971
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/CancelPointInTimeRecovery AWS API Documentation
|
|
3972
|
+
#
|
|
3973
|
+
# @overload cancel_point_in_time_recovery(params = {})
|
|
3974
|
+
# @param [Hash] params ({})
|
|
3975
|
+
def cancel_point_in_time_recovery(params = {}, options = {})
|
|
3976
|
+
req = build_request(:cancel_point_in_time_recovery, params)
|
|
3977
|
+
req.send_request(options)
|
|
3978
|
+
end
|
|
3979
|
+
|
|
3913
3980
|
# Changes the password for the currently signed-in user.
|
|
3914
3981
|
#
|
|
3915
3982
|
# Authorize this action with a signed-in user's access token. It must
|
|
@@ -7750,6 +7817,72 @@ module Aws::CognitoIdentityProvider
|
|
|
7750
7817
|
req.send_request(options)
|
|
7751
7818
|
end
|
|
7752
7819
|
|
|
7820
|
+
# Returns details about a point-in-time recovery of a user pool,
|
|
7821
|
+
# including its status and the point in time that it restores the user
|
|
7822
|
+
# pool to. After Amazon Cognito generates the recovery preview, the
|
|
7823
|
+
# response also includes the number of entities that the recovery
|
|
7824
|
+
# creates, updates, and deletes. Review the preview before you apply the
|
|
7825
|
+
# recovery with a request or discard it with a request.
|
|
7826
|
+
#
|
|
7827
|
+
# <note markdown="1"> Amazon Cognito evaluates Identity and Access Management (IAM) policies
|
|
7828
|
+
# in requests for this API operation. For this operation, you must use
|
|
7829
|
+
# IAM credentials to authorize requests, and you must grant yourself the
|
|
7830
|
+
# corresponding IAM permission in a policy.
|
|
7831
|
+
#
|
|
7832
|
+
# **Learn more**
|
|
7833
|
+
#
|
|
7834
|
+
# * [Signing Amazon Web Services API Requests][1]
|
|
7835
|
+
#
|
|
7836
|
+
# * [Using the Amazon Cognito user pools API and user pool endpoints][2]
|
|
7837
|
+
#
|
|
7838
|
+
# </note>
|
|
7839
|
+
#
|
|
7840
|
+
#
|
|
7841
|
+
#
|
|
7842
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html
|
|
7843
|
+
# [2]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html
|
|
7844
|
+
#
|
|
7845
|
+
# @option params [required, String] :user_pool_id
|
|
7846
|
+
# The ID of the user pool that contains the recovery that you want to
|
|
7847
|
+
# describe.
|
|
7848
|
+
#
|
|
7849
|
+
# @option params [required, String] :restore_id
|
|
7850
|
+
# The ID of the recovery that you want to describe. Amazon Cognito
|
|
7851
|
+
# returns this ID in the response to an `InitiatePointInTimeRecovery`
|
|
7852
|
+
# request.
|
|
7853
|
+
#
|
|
7854
|
+
# @return [Types::DescribePointInTimeRecoveryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
7855
|
+
#
|
|
7856
|
+
# * {Types::DescribePointInTimeRecoveryResponse#restoration #restoration} => Types::RestorationType
|
|
7857
|
+
#
|
|
7858
|
+
# @example Request syntax with placeholder values
|
|
7859
|
+
#
|
|
7860
|
+
# resp = client.describe_point_in_time_recovery({
|
|
7861
|
+
# user_pool_id: "UserPoolIdType", # required
|
|
7862
|
+
# restore_id: "RestoreIdType", # required
|
|
7863
|
+
# })
|
|
7864
|
+
#
|
|
7865
|
+
# @example Response structure
|
|
7866
|
+
#
|
|
7867
|
+
# resp.restoration.restore_id #=> String
|
|
7868
|
+
# resp.restoration.restore_status #=> String, one of "PREVIEW_GENERATING", "PREVIEW_GENERATED", "PREVIEW_CANCELLED", "PREVIEW_GENERATION_FAILED", "PREVIEW_EXPIRED", "RESTORING", "RESTORE_COMPLETED", "TEMPORARY_INTERNAL_ERROR_SEE_SUPPORT_CASE", "AWS_ABORTED"
|
|
7869
|
+
# resp.restoration.restore_timestamp #=> Time
|
|
7870
|
+
# resp.restoration.trigger_timestamp #=> Time
|
|
7871
|
+
# resp.restoration.restore_preview #=> Array
|
|
7872
|
+
# resp.restoration.restore_preview[0].entity #=> String
|
|
7873
|
+
# resp.restoration.restore_preview[0].create_count #=> Integer
|
|
7874
|
+
# resp.restoration.restore_preview[0].update_count #=> Integer
|
|
7875
|
+
# resp.restoration.restore_preview[0].delete_count #=> Integer
|
|
7876
|
+
#
|
|
7877
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DescribePointInTimeRecovery AWS API Documentation
|
|
7878
|
+
#
|
|
7879
|
+
# @overload describe_point_in_time_recovery(params = {})
|
|
7880
|
+
# @param [Hash] params ({})
|
|
7881
|
+
def describe_point_in_time_recovery(params = {}, options = {})
|
|
7882
|
+
req = build_request(:describe_point_in_time_recovery, params)
|
|
7883
|
+
req.send_request(options)
|
|
7884
|
+
end
|
|
7885
|
+
|
|
7753
7886
|
# Describes a resource server. For more information about resource
|
|
7754
7887
|
# servers, see [Access control with resource servers][1].
|
|
7755
7888
|
#
|
|
@@ -10350,6 +10483,165 @@ module Aws::CognitoIdentityProvider
|
|
|
10350
10483
|
req.send_request(options)
|
|
10351
10484
|
end
|
|
10352
10485
|
|
|
10486
|
+
# Initiates a point-in-time recovery of a user pool to a time in the
|
|
10487
|
+
# past that you specify. This operation is the first step of a recovery
|
|
10488
|
+
# and doesn't change your user pool data. Amazon Cognito pauses write
|
|
10489
|
+
# operations in the user pool and generates a recovery preview when
|
|
10490
|
+
# capacity is available in the Amazon Web Services Region, so the
|
|
10491
|
+
# preview might not be available immediately. The preview shows the
|
|
10492
|
+
# number of entities that the recovery creates, updates, and deletes. To
|
|
10493
|
+
# check the status of the recovery and review the preview, make a
|
|
10494
|
+
# request. When the status is `PREVIEW_GENERATED`, apply the recovery
|
|
10495
|
+
# with a request or discard it with a request. The time that it takes to
|
|
10496
|
+
# generate the recovery preview doesn't depend on the size of your user
|
|
10497
|
+
# pool.
|
|
10498
|
+
#
|
|
10499
|
+
# Point-in-time recovery is a disaster recovery feature. Use it to
|
|
10500
|
+
# recover from accidental or unauthorized changes that affect your user
|
|
10501
|
+
# data, for example the deletion or corruption of many users. Don't use
|
|
10502
|
+
# point-in-time recovery to remove users that were created recently or
|
|
10503
|
+
# to revert changes to individual users. To delete or update individual
|
|
10504
|
+
# users, use operations like and .
|
|
10505
|
+
#
|
|
10506
|
+
# While a recovery is in progress, Amazon Cognito blocks operations that
|
|
10507
|
+
# write to the user pool, for example user sign-up, user creation, and
|
|
10508
|
+
# attribute updates. Sign-in and read operations continue to work, with
|
|
10509
|
+
# the following exceptions.
|
|
10510
|
+
#
|
|
10511
|
+
# * Users who must set a new password, set up MFA, or respond to a TOTP
|
|
10512
|
+
# MFA challenge can't complete sign-in. Sign-in with the
|
|
10513
|
+
# `NEW_PASSWORD_REQUIRED`, `MFA_SETUP`, and `SOFTWARE_TOKEN_MFA`
|
|
10514
|
+
# challenges fails until the recovery ends.
|
|
10515
|
+
#
|
|
10516
|
+
# * Federated users can sign in only if they have previously signed in
|
|
10517
|
+
# to the user pool and their attributes from the external identity
|
|
10518
|
+
# provider haven't changed.
|
|
10519
|
+
#
|
|
10520
|
+
# * You can't create or start user import jobs. Start your import jobs
|
|
10521
|
+
# after the recovery ends.
|
|
10522
|
+
#
|
|
10523
|
+
# If you don't start or cancel the recovery within 24 hours after you
|
|
10524
|
+
# initiate it, the recovery preview expires. Amazon Cognito then resumes
|
|
10525
|
+
# write operations and doesn't change your user pool data. The 24-hour
|
|
10526
|
+
# period includes the time that Amazon Cognito waits for available
|
|
10527
|
+
# capacity.
|
|
10528
|
+
#
|
|
10529
|
+
# A point-in-time recovery restores user data, including user profiles
|
|
10530
|
+
# and attributes, group memberships, passwords, MFA settings, and
|
|
10531
|
+
# passkeys. It doesn't restore user pool configuration, for example app
|
|
10532
|
+
# clients, the attribute schema, encryption settings, or multi-Region
|
|
10533
|
+
# replication settings. Users who changed their password after the
|
|
10534
|
+
# recovery point keep their current password.
|
|
10535
|
+
#
|
|
10536
|
+
# The following requirements and limits apply to point-in-time recovery.
|
|
10537
|
+
#
|
|
10538
|
+
# * Your user pool must be on the Essentials or Plus [feature plan][1].
|
|
10539
|
+
# With the Essentials feature plan, you can recover your user pool to
|
|
10540
|
+
# a point in time up to 1 day in the past. With the Plus feature plan,
|
|
10541
|
+
# you can recover up to 14 days in the past. Your user pool must have
|
|
10542
|
+
# been on the required feature plan at the recovery point. For
|
|
10543
|
+
# example, to recover to a point in time 14 days ago, your user pool
|
|
10544
|
+
# must have been on the Plus feature plan for the past 14 days.
|
|
10545
|
+
#
|
|
10546
|
+
# * The recovery point must be at least 15 minutes in the past and
|
|
10547
|
+
# can't be earlier than the creation time of the user pool.
|
|
10548
|
+
#
|
|
10549
|
+
# * A user pool can have only one active recovery at a time.
|
|
10550
|
+
#
|
|
10551
|
+
# * An Amazon Web Services account can have up to five active recoveries
|
|
10552
|
+
# at a time across all of its user pools. An organization in Amazon
|
|
10553
|
+
# Web Services Organizations can have up to ten active recoveries at a
|
|
10554
|
+
# time across all of its accounts.
|
|
10555
|
+
#
|
|
10556
|
+
# * You can complete one recovery of a user pool in a 24-hour period.
|
|
10557
|
+
#
|
|
10558
|
+
# * You can create up to three recovery previews of a user pool, ten
|
|
10559
|
+
# recovery previews in an Amazon Web Services account, and 15 recovery
|
|
10560
|
+
# previews in an organization in Amazon Web Services Organizations in
|
|
10561
|
+
# a 24-hour period. You can create up to ten recovery previews of a
|
|
10562
|
+
# user pool in a 30-day period.
|
|
10563
|
+
#
|
|
10564
|
+
# * You can't initiate a recovery while a user import job is in
|
|
10565
|
+
# progress in your user pool. Wait for the import job to complete, or
|
|
10566
|
+
# stop it with a request, and then initiate the recovery.
|
|
10567
|
+
#
|
|
10568
|
+
# * In a user pool with multi-Region replication, you can initiate a
|
|
10569
|
+
# recovery only in the primary Amazon Web Services Region, and only
|
|
10570
|
+
# after replication is complete.
|
|
10571
|
+
#
|
|
10572
|
+
# * If your user pool uses a customer managed key in KMS for encryption,
|
|
10573
|
+
# the key must remain enabled and accessible to Amazon Cognito for the
|
|
10574
|
+
# duration of the recovery.
|
|
10575
|
+
#
|
|
10576
|
+
# * Some user pools don't support point-in-time recovery, for example
|
|
10577
|
+
# some older user pools and user pools that contain user data with
|
|
10578
|
+
# characters or formats that point-in-time recovery doesn't support.
|
|
10579
|
+
# If your user pool doesn't support it, Amazon Cognito returns an
|
|
10580
|
+
# error when you initiate a recovery. To get help with this
|
|
10581
|
+
# limitation, contact Amazon Web Services Support.
|
|
10582
|
+
#
|
|
10583
|
+
# <note markdown="1"> Amazon Cognito evaluates Identity and Access Management (IAM) policies
|
|
10584
|
+
# in requests for this API operation. For this operation, you must use
|
|
10585
|
+
# IAM credentials to authorize requests, and you must grant yourself the
|
|
10586
|
+
# corresponding IAM permission in a policy.
|
|
10587
|
+
#
|
|
10588
|
+
# **Learn more**
|
|
10589
|
+
#
|
|
10590
|
+
# * [Signing Amazon Web Services API Requests][2]
|
|
10591
|
+
#
|
|
10592
|
+
# * [Using the Amazon Cognito user pools API and user pool endpoints][3]
|
|
10593
|
+
#
|
|
10594
|
+
# </note>
|
|
10595
|
+
#
|
|
10596
|
+
#
|
|
10597
|
+
#
|
|
10598
|
+
# [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-sign-in-feature-plans.html
|
|
10599
|
+
# [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html
|
|
10600
|
+
# [3]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html
|
|
10601
|
+
#
|
|
10602
|
+
# @option params [required, String] :user_pool_id
|
|
10603
|
+
# The ID of the user pool that you want to recover.
|
|
10604
|
+
#
|
|
10605
|
+
# @option params [required, Time,DateTime,Date,Integer,String] :restore_timestamp
|
|
10606
|
+
# The point in time that you want to recover your user pool to. Amazon
|
|
10607
|
+
# Cognito reverts changes to user data that occurred after this time.
|
|
10608
|
+
# The recovery point must be at least 15 minutes in the past and within
|
|
10609
|
+
# the recovery period of your user pool feature plan: up to 1 day in the
|
|
10610
|
+
# past with the Essentials feature plan, or up to 14 days in the past
|
|
10611
|
+
# with the Plus feature plan.
|
|
10612
|
+
#
|
|
10613
|
+
# @return [Types::InitiatePointInTimeRecoveryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
10614
|
+
#
|
|
10615
|
+
# * {Types::InitiatePointInTimeRecoveryResponse#restoration #restoration} => Types::RestorationType
|
|
10616
|
+
#
|
|
10617
|
+
# @example Request syntax with placeholder values
|
|
10618
|
+
#
|
|
10619
|
+
# resp = client.initiate_point_in_time_recovery({
|
|
10620
|
+
# user_pool_id: "UserPoolIdType", # required
|
|
10621
|
+
# restore_timestamp: Time.now, # required
|
|
10622
|
+
# })
|
|
10623
|
+
#
|
|
10624
|
+
# @example Response structure
|
|
10625
|
+
#
|
|
10626
|
+
# resp.restoration.restore_id #=> String
|
|
10627
|
+
# resp.restoration.restore_status #=> String, one of "PREVIEW_GENERATING", "PREVIEW_GENERATED", "PREVIEW_CANCELLED", "PREVIEW_GENERATION_FAILED", "PREVIEW_EXPIRED", "RESTORING", "RESTORE_COMPLETED", "TEMPORARY_INTERNAL_ERROR_SEE_SUPPORT_CASE", "AWS_ABORTED"
|
|
10628
|
+
# resp.restoration.restore_timestamp #=> Time
|
|
10629
|
+
# resp.restoration.trigger_timestamp #=> Time
|
|
10630
|
+
# resp.restoration.restore_preview #=> Array
|
|
10631
|
+
# resp.restoration.restore_preview[0].entity #=> String
|
|
10632
|
+
# resp.restoration.restore_preview[0].create_count #=> Integer
|
|
10633
|
+
# resp.restoration.restore_preview[0].update_count #=> Integer
|
|
10634
|
+
# resp.restoration.restore_preview[0].delete_count #=> Integer
|
|
10635
|
+
#
|
|
10636
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/InitiatePointInTimeRecovery AWS API Documentation
|
|
10637
|
+
#
|
|
10638
|
+
# @overload initiate_point_in_time_recovery(params = {})
|
|
10639
|
+
# @param [Hash] params ({})
|
|
10640
|
+
def initiate_point_in_time_recovery(params = {}, options = {})
|
|
10641
|
+
req = build_request(:initiate_point_in_time_recovery, params)
|
|
10642
|
+
req.send_request(options)
|
|
10643
|
+
end
|
|
10644
|
+
|
|
10353
10645
|
# Lists the devices that Amazon Cognito has registered to the currently
|
|
10354
10646
|
# signed-in user. For more information about device authentication, see
|
|
10355
10647
|
# [Working with user devices in your user pool][1].
|
|
@@ -10564,6 +10856,76 @@ module Aws::CognitoIdentityProvider
|
|
|
10564
10856
|
req.send_request(options)
|
|
10565
10857
|
end
|
|
10566
10858
|
|
|
10859
|
+
# Lists the point-in-time recoveries of a user pool, including the
|
|
10860
|
+
# active recovery and past recoveries. The response lists the most
|
|
10861
|
+
# recent recoveries first and doesn't include recovery previews. To get
|
|
10862
|
+
# the recovery preview of a recovery, make a request.
|
|
10863
|
+
#
|
|
10864
|
+
# <note markdown="1"> Amazon Cognito evaluates Identity and Access Management (IAM) policies
|
|
10865
|
+
# in requests for this API operation. For this operation, you must use
|
|
10866
|
+
# IAM credentials to authorize requests, and you must grant yourself the
|
|
10867
|
+
# corresponding IAM permission in a policy.
|
|
10868
|
+
#
|
|
10869
|
+
# **Learn more**
|
|
10870
|
+
#
|
|
10871
|
+
# * [Signing Amazon Web Services API Requests][1]
|
|
10872
|
+
#
|
|
10873
|
+
# * [Using the Amazon Cognito user pools API and user pool endpoints][2]
|
|
10874
|
+
#
|
|
10875
|
+
# </note>
|
|
10876
|
+
#
|
|
10877
|
+
#
|
|
10878
|
+
#
|
|
10879
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html
|
|
10880
|
+
# [2]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html
|
|
10881
|
+
#
|
|
10882
|
+
# @option params [required, String] :user_pool_id
|
|
10883
|
+
# The ID of the user pool where you want to list point-in-time
|
|
10884
|
+
# recoveries.
|
|
10885
|
+
#
|
|
10886
|
+
# @option params [String] :next_token
|
|
10887
|
+
# This API operation returns a limited number of results. The pagination
|
|
10888
|
+
# token is an identifier that you can present in an additional API
|
|
10889
|
+
# request with the same parameters. When you include the pagination
|
|
10890
|
+
# token, Amazon Cognito returns the next set of items after the current
|
|
10891
|
+
# list. Subsequent requests return a new pagination token. By use of
|
|
10892
|
+
# this token, you can paginate through the full list of items.
|
|
10893
|
+
#
|
|
10894
|
+
# @option params [Integer] :max_results
|
|
10895
|
+
# The maximum number of recoveries that you want Amazon Cognito to
|
|
10896
|
+
# return in the response. Valid values are 1 through 60. The default
|
|
10897
|
+
# value is 60.
|
|
10898
|
+
#
|
|
10899
|
+
# @return [Types::ListPointInTimeRecoveriesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
10900
|
+
#
|
|
10901
|
+
# * {Types::ListPointInTimeRecoveriesResponse#restorations #restorations} => Array<Types::RestorationDescriptionType>
|
|
10902
|
+
# * {Types::ListPointInTimeRecoveriesResponse#next_token #next_token} => String
|
|
10903
|
+
#
|
|
10904
|
+
# @example Request syntax with placeholder values
|
|
10905
|
+
#
|
|
10906
|
+
# resp = client.list_point_in_time_recoveries({
|
|
10907
|
+
# user_pool_id: "UserPoolIdType", # required
|
|
10908
|
+
# next_token: "PaginationKeyType",
|
|
10909
|
+
# max_results: 1,
|
|
10910
|
+
# })
|
|
10911
|
+
#
|
|
10912
|
+
# @example Response structure
|
|
10913
|
+
#
|
|
10914
|
+
# resp.restorations #=> Array
|
|
10915
|
+
# resp.restorations[0].restore_id #=> String
|
|
10916
|
+
# resp.restorations[0].restore_status #=> String, one of "PREVIEW_GENERATING", "PREVIEW_GENERATED", "PREVIEW_CANCELLED", "PREVIEW_GENERATION_FAILED", "PREVIEW_EXPIRED", "RESTORING", "RESTORE_COMPLETED", "TEMPORARY_INTERNAL_ERROR_SEE_SUPPORT_CASE", "AWS_ABORTED"
|
|
10917
|
+
# resp.restorations[0].restore_timestamp #=> Time
|
|
10918
|
+
# resp.next_token #=> String
|
|
10919
|
+
#
|
|
10920
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ListPointInTimeRecoveries AWS API Documentation
|
|
10921
|
+
#
|
|
10922
|
+
# @overload list_point_in_time_recoveries(params = {})
|
|
10923
|
+
# @param [Hash] params ({})
|
|
10924
|
+
def list_point_in_time_recoveries(params = {}, options = {})
|
|
10925
|
+
req = build_request(:list_point_in_time_recoveries, params)
|
|
10926
|
+
req.send_request(options)
|
|
10927
|
+
end
|
|
10928
|
+
|
|
10567
10929
|
# Given a user pool ID, returns all resource servers and their details.
|
|
10568
10930
|
# For more information about resource servers, see [Access control with
|
|
10569
10931
|
# resource servers][1].
|
|
@@ -13282,6 +13644,77 @@ module Aws::CognitoIdentityProvider
|
|
|
13282
13644
|
req.send_request(options)
|
|
13283
13645
|
end
|
|
13284
13646
|
|
|
13647
|
+
# Applies a point-in-time recovery to a user pool. Before you start a
|
|
13648
|
+
# recovery, review the recovery preview in the response to a request.
|
|
13649
|
+
# You can start a recovery when its status is `PREVIEW_GENERATED`.
|
|
13650
|
+
#
|
|
13651
|
+
# When you start a recovery, Amazon Cognito sets its status to
|
|
13652
|
+
# `RESTORING` and restores user data in the user pool to its state at
|
|
13653
|
+
# the recovery point. Write operations in the user pool remain paused
|
|
13654
|
+
# until the recovery is complete. Sign-in and read operations continue
|
|
13655
|
+
# to work. When the status of the recovery changes to
|
|
13656
|
+
# `RESTORE_COMPLETED`, Amazon Cognito resumes write operations.
|
|
13657
|
+
#
|
|
13658
|
+
# You can't cancel a recovery after you start it.
|
|
13659
|
+
#
|
|
13660
|
+
# <note markdown="1"> Amazon Cognito evaluates Identity and Access Management (IAM) policies
|
|
13661
|
+
# in requests for this API operation. For this operation, you must use
|
|
13662
|
+
# IAM credentials to authorize requests, and you must grant yourself the
|
|
13663
|
+
# corresponding IAM permission in a policy.
|
|
13664
|
+
#
|
|
13665
|
+
# **Learn more**
|
|
13666
|
+
#
|
|
13667
|
+
# * [Signing Amazon Web Services API Requests][1]
|
|
13668
|
+
#
|
|
13669
|
+
# * [Using the Amazon Cognito user pools API and user pool endpoints][2]
|
|
13670
|
+
#
|
|
13671
|
+
# </note>
|
|
13672
|
+
#
|
|
13673
|
+
#
|
|
13674
|
+
#
|
|
13675
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html
|
|
13676
|
+
# [2]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html
|
|
13677
|
+
#
|
|
13678
|
+
# @option params [required, String] :user_pool_id
|
|
13679
|
+
# The ID of the user pool that contains the recovery that you want to
|
|
13680
|
+
# start.
|
|
13681
|
+
#
|
|
13682
|
+
# @option params [required, String] :restore_id
|
|
13683
|
+
# The ID of the recovery that you want to start. Amazon Cognito returns
|
|
13684
|
+
# this ID in the response to an `InitiatePointInTimeRecovery` request.
|
|
13685
|
+
#
|
|
13686
|
+
# @return [Types::StartPointInTimeRecoveryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
13687
|
+
#
|
|
13688
|
+
# * {Types::StartPointInTimeRecoveryResponse#restoration #restoration} => Types::RestorationType
|
|
13689
|
+
#
|
|
13690
|
+
# @example Request syntax with placeholder values
|
|
13691
|
+
#
|
|
13692
|
+
# resp = client.start_point_in_time_recovery({
|
|
13693
|
+
# user_pool_id: "UserPoolIdType", # required
|
|
13694
|
+
# restore_id: "RestoreIdType", # required
|
|
13695
|
+
# })
|
|
13696
|
+
#
|
|
13697
|
+
# @example Response structure
|
|
13698
|
+
#
|
|
13699
|
+
# resp.restoration.restore_id #=> String
|
|
13700
|
+
# resp.restoration.restore_status #=> String, one of "PREVIEW_GENERATING", "PREVIEW_GENERATED", "PREVIEW_CANCELLED", "PREVIEW_GENERATION_FAILED", "PREVIEW_EXPIRED", "RESTORING", "RESTORE_COMPLETED", "TEMPORARY_INTERNAL_ERROR_SEE_SUPPORT_CASE", "AWS_ABORTED"
|
|
13701
|
+
# resp.restoration.restore_timestamp #=> Time
|
|
13702
|
+
# resp.restoration.trigger_timestamp #=> Time
|
|
13703
|
+
# resp.restoration.restore_preview #=> Array
|
|
13704
|
+
# resp.restoration.restore_preview[0].entity #=> String
|
|
13705
|
+
# resp.restoration.restore_preview[0].create_count #=> Integer
|
|
13706
|
+
# resp.restoration.restore_preview[0].update_count #=> Integer
|
|
13707
|
+
# resp.restoration.restore_preview[0].delete_count #=> Integer
|
|
13708
|
+
#
|
|
13709
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/StartPointInTimeRecovery AWS API Documentation
|
|
13710
|
+
#
|
|
13711
|
+
# @overload start_point_in_time_recovery(params = {})
|
|
13712
|
+
# @param [Hash] params ({})
|
|
13713
|
+
def start_point_in_time_recovery(params = {}, options = {})
|
|
13714
|
+
req = build_request(:start_point_in_time_recovery, params)
|
|
13715
|
+
req.send_request(options)
|
|
13716
|
+
end
|
|
13717
|
+
|
|
13285
13718
|
# Instructs your user pool to start importing users from a CSV file that
|
|
13286
13719
|
# contains their usernames and attributes. For more information about
|
|
13287
13720
|
# importing users from a CSV file, see [Importing users from a CSV
|
|
@@ -15742,7 +16175,7 @@ module Aws::CognitoIdentityProvider
|
|
|
15742
16175
|
tracer: tracer
|
|
15743
16176
|
)
|
|
15744
16177
|
context[:gem_name] = 'aws-sdk-cognitoidentityprovider'
|
|
15745
|
-
context[:gem_version] = '1.
|
|
16178
|
+
context[:gem_version] = '1.167.0'
|
|
15746
16179
|
Seahorse::Client::Request.new(handlers, context)
|
|
15747
16180
|
end
|
|
15748
16181
|
|