aws-sdk-cognitoidentityprovider 1.149.0 → 1.151.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 +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-cognitoidentityprovider/client.rb +269 -5
- data/lib/aws-sdk-cognitoidentityprovider/client_api.rb +80 -0
- data/lib/aws-sdk-cognitoidentityprovider/types.rb +168 -4
- data/lib/aws-sdk-cognitoidentityprovider.rb +1 -1
- data/sig/client.rbs +35 -0
- data/sig/types.rbs +41 -0
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: '0782fc580517572f1ed5f75d94d233eedf24f386ec72f769bc42576877e8def3'
|
|
4
|
+
data.tar.gz: 8a34fa2ebbd9c840b5108d75f70e6968d88e837a9f705d5f748a367bc088cf77
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 272b7102f4c3190658db9876e156467142bb387aa1906078f8830da83eae79af284d590005b57e50f25d7349e37881763db8e84b0f8d45324f955f4fe1027288
|
|
7
|
+
data.tar.gz: 336c40fda42f6acab013d6b3ffa0eb509d67ed3e1e98f696ffc3f69eb6f54a69d08f4f0238b56723baa1fb1d99f49f73769ebd5b35275df31adeb33e9bb97fd7
|
data/CHANGELOG.md
CHANGED
|
@@ -1,6 +1,16 @@
|
|
|
1
1
|
Unreleased Changes
|
|
2
2
|
------------------
|
|
3
3
|
|
|
4
|
+
1.151.0 (2026-08-28)
|
|
5
|
+
------------------
|
|
6
|
+
|
|
7
|
+
* Feature - Adds two new operations - GetClientToken which allows M2M auth through the SDK, and DescribeTermsByClient to find which Terms are associated with a user-pool client without knowing the Terms resource id.
|
|
8
|
+
|
|
9
|
+
1.150.0 (2026-08-27)
|
|
10
|
+
------------------
|
|
11
|
+
|
|
12
|
+
* Feature - Adds the AdminDeleteSoftwareToken API operation, enabling administrators to remove a user's registered TOTP (software token) MFA configuration from a user pool.
|
|
13
|
+
|
|
4
14
|
1.149.0 (2026-07-24)
|
|
5
15
|
------------------
|
|
6
16
|
|
data/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.
|
|
1
|
+
1.151.0
|
|
@@ -1113,6 +1113,61 @@ module Aws::CognitoIdentityProvider
|
|
|
1113
1113
|
req.send_request(options)
|
|
1114
1114
|
end
|
|
1115
1115
|
|
|
1116
|
+
# Deletes a user's registered time-based one-time password (TOTP)
|
|
1117
|
+
# multi-factor authentication (MFA) factor, also known as a software
|
|
1118
|
+
# token. After this operation, the user can no longer sign in with TOTP
|
|
1119
|
+
# MFA, and can register a new TOTP factor with `AssociateSoftwareToken`.
|
|
1120
|
+
# Use this operation when a user loses access to their TOTP-generating
|
|
1121
|
+
# device, for example, a lost or reset phone, and needs to register a
|
|
1122
|
+
# new one.
|
|
1123
|
+
#
|
|
1124
|
+
# <note markdown="1"> Amazon Cognito evaluates Identity and Access Management (IAM) policies
|
|
1125
|
+
# in requests for this API operation. For this operation, you must use
|
|
1126
|
+
# IAM credentials to authorize requests, and you must grant yourself the
|
|
1127
|
+
# corresponding IAM permission in a policy.
|
|
1128
|
+
#
|
|
1129
|
+
# **Learn more**
|
|
1130
|
+
#
|
|
1131
|
+
# * [Signing Amazon Web Services API Requests][1]
|
|
1132
|
+
#
|
|
1133
|
+
# * [Using the Amazon Cognito user pools API and user pool endpoints][2]
|
|
1134
|
+
#
|
|
1135
|
+
# </note>
|
|
1136
|
+
#
|
|
1137
|
+
#
|
|
1138
|
+
#
|
|
1139
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html
|
|
1140
|
+
# [2]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html
|
|
1141
|
+
#
|
|
1142
|
+
# @option params [required, String] :user_pool_id
|
|
1143
|
+
# The ID of the user pool where you want to delete the user's software
|
|
1144
|
+
# token.
|
|
1145
|
+
#
|
|
1146
|
+
# @option params [required, String] :username
|
|
1147
|
+
# The name of the user that you want to query or modify. The value of
|
|
1148
|
+
# this parameter is typically your user's username, but it can be any
|
|
1149
|
+
# of their alias attributes. If `username` isn't an alias attribute in
|
|
1150
|
+
# your user pool, this value must be the `sub` of a local user or the
|
|
1151
|
+
# username of a user from a third-party IdP.
|
|
1152
|
+
#
|
|
1153
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
1154
|
+
#
|
|
1155
|
+
# @example Request syntax with placeholder values
|
|
1156
|
+
#
|
|
1157
|
+
# resp = client.admin_delete_software_token({
|
|
1158
|
+
# user_pool_id: "UserPoolIdType", # required
|
|
1159
|
+
# username: "UsernameType", # required
|
|
1160
|
+
# })
|
|
1161
|
+
#
|
|
1162
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminDeleteSoftwareToken AWS API Documentation
|
|
1163
|
+
#
|
|
1164
|
+
# @overload admin_delete_software_token(params = {})
|
|
1165
|
+
# @param [Hash] params ({})
|
|
1166
|
+
def admin_delete_software_token(params = {}, options = {})
|
|
1167
|
+
req = build_request(:admin_delete_software_token, params)
|
|
1168
|
+
req.send_request(options)
|
|
1169
|
+
end
|
|
1170
|
+
|
|
1116
1171
|
# Deletes a user profile in your user pool.
|
|
1117
1172
|
#
|
|
1118
1173
|
# <note markdown="1"> Amazon Cognito evaluates Identity and Access Management (IAM) policies
|
|
@@ -2027,10 +2082,6 @@ module Aws::CognitoIdentityProvider
|
|
|
2027
2082
|
# The `ProviderName` should be set to `Cognito` for users in Cognito
|
|
2028
2083
|
# user pools.
|
|
2029
2084
|
#
|
|
2030
|
-
# All attributes in the DestinationUser profile must be mutable. If you
|
|
2031
|
-
# have assigned the user any immutable custom attributes, the operation
|
|
2032
|
-
# won't succeed.
|
|
2033
|
-
#
|
|
2034
2085
|
# @option params [required, Types::ProviderUserIdentifierType] :source_user
|
|
2035
2086
|
# An external IdP account for a user who doesn't exist yet in the user
|
|
2036
2087
|
# pool. This user must be a federated user (for example, a SAML or
|
|
@@ -7583,6 +7634,80 @@ module Aws::CognitoIdentityProvider
|
|
|
7583
7634
|
req.send_request(options)
|
|
7584
7635
|
end
|
|
7585
7636
|
|
|
7637
|
+
# Returns details for the terms documents that are associated with an
|
|
7638
|
+
# app client, identified by the app client ID, user pool ID, and terms
|
|
7639
|
+
# name. For more information, see [Terms documents][1].
|
|
7640
|
+
#
|
|
7641
|
+
# To call `DescribeTermsByClient`, you must have the
|
|
7642
|
+
# `cognito-idp:DescribeTermsByClient` Identity and Access Management
|
|
7643
|
+
# (IAM) permission. This operation additionally validates your
|
|
7644
|
+
# permission for `cognito-idp:DescribeTerms`, the action for . As a
|
|
7645
|
+
# result, an IAM policy that denies `cognito-idp:DescribeTerms` also
|
|
7646
|
+
# denies requests to `DescribeTermsByClient`.
|
|
7647
|
+
#
|
|
7648
|
+
# <note markdown="1"> Amazon Cognito evaluates Identity and Access Management (IAM) policies
|
|
7649
|
+
# in requests for this API operation. For this operation, you must use
|
|
7650
|
+
# IAM credentials to authorize requests, and you must grant yourself the
|
|
7651
|
+
# corresponding IAM permission in a policy.
|
|
7652
|
+
#
|
|
7653
|
+
# **Learn more**
|
|
7654
|
+
#
|
|
7655
|
+
# * [Signing Amazon Web Services API Requests][2]
|
|
7656
|
+
#
|
|
7657
|
+
# * [Using the Amazon Cognito user pools API and user pool endpoints][3]
|
|
7658
|
+
#
|
|
7659
|
+
# </note>
|
|
7660
|
+
#
|
|
7661
|
+
#
|
|
7662
|
+
#
|
|
7663
|
+
# [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html#managed-login-terms-documents
|
|
7664
|
+
# [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html
|
|
7665
|
+
# [3]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html
|
|
7666
|
+
#
|
|
7667
|
+
# @option params [required, String] :client_id
|
|
7668
|
+
# The ID of the app client that the terms documents are associated with.
|
|
7669
|
+
#
|
|
7670
|
+
# @option params [required, String] :user_pool_id
|
|
7671
|
+
# The ID of the user pool that contains the terms documents that you
|
|
7672
|
+
# want to describe.
|
|
7673
|
+
#
|
|
7674
|
+
# @option params [required, String] :terms_name
|
|
7675
|
+
# The name of the terms documents that you want to describe.
|
|
7676
|
+
#
|
|
7677
|
+
# @return [Types::DescribeTermsByClientResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
7678
|
+
#
|
|
7679
|
+
# * {Types::DescribeTermsByClientResponse#terms #terms} => Types::TermsType
|
|
7680
|
+
#
|
|
7681
|
+
# @example Request syntax with placeholder values
|
|
7682
|
+
#
|
|
7683
|
+
# resp = client.describe_terms_by_client({
|
|
7684
|
+
# client_id: "ClientIdType", # required
|
|
7685
|
+
# user_pool_id: "UserPoolIdType", # required
|
|
7686
|
+
# terms_name: "TermsNameType", # required
|
|
7687
|
+
# })
|
|
7688
|
+
#
|
|
7689
|
+
# @example Response structure
|
|
7690
|
+
#
|
|
7691
|
+
# resp.terms.terms_id #=> String
|
|
7692
|
+
# resp.terms.user_pool_id #=> String
|
|
7693
|
+
# resp.terms.client_id #=> String
|
|
7694
|
+
# resp.terms.terms_name #=> String
|
|
7695
|
+
# resp.terms.terms_source #=> String, one of "LINK"
|
|
7696
|
+
# resp.terms.enforcement #=> String, one of "NONE"
|
|
7697
|
+
# resp.terms.links #=> Hash
|
|
7698
|
+
# resp.terms.links["LanguageIdType"] #=> String
|
|
7699
|
+
# resp.terms.creation_date #=> Time
|
|
7700
|
+
# resp.terms.last_modified_date #=> Time
|
|
7701
|
+
#
|
|
7702
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DescribeTermsByClient AWS API Documentation
|
|
7703
|
+
#
|
|
7704
|
+
# @overload describe_terms_by_client(params = {})
|
|
7705
|
+
# @param [Hash] params ({})
|
|
7706
|
+
def describe_terms_by_client(params = {}, options = {})
|
|
7707
|
+
req = build_request(:describe_terms_by_client, params)
|
|
7708
|
+
req.send_request(options)
|
|
7709
|
+
end
|
|
7710
|
+
|
|
7586
7711
|
# Describes a user import job. For more information about user CSV
|
|
7587
7712
|
# import, see [Importing users from a CSV file][1].
|
|
7588
7713
|
#
|
|
@@ -7881,6 +8006,14 @@ module Aws::CognitoIdentityProvider
|
|
|
7881
8006
|
# Given a user pool domain name, returns information about the domain
|
|
7882
8007
|
# configuration.
|
|
7883
8008
|
#
|
|
8009
|
+
# <note markdown="1"> This operation doesn't return results when you query a prefix domain
|
|
8010
|
+
# in a secondary Region. Prefix domains are Region-specific and can only
|
|
8011
|
+
# be described in the Region where they were created. To describe a
|
|
8012
|
+
# prefix domain for a replica user pool, make the request to the primary
|
|
8013
|
+
# Region's endpoint.
|
|
8014
|
+
#
|
|
8015
|
+
# </note>
|
|
8016
|
+
#
|
|
7884
8017
|
# <note markdown="1"> Amazon Cognito evaluates Identity and Access Management (IAM) policies
|
|
7885
8018
|
# in requests for this API operation. For this operation, you must use
|
|
7886
8019
|
# IAM credentials to authorize requests, and you must grant yourself the
|
|
@@ -8203,6 +8336,137 @@ module Aws::CognitoIdentityProvider
|
|
|
8203
8336
|
req.send_request(options)
|
|
8204
8337
|
end
|
|
8205
8338
|
|
|
8339
|
+
# Issues an access token for machine-to-machine (M2M) authorization.
|
|
8340
|
+
# Your app client provides its client ID and secret, and receives an
|
|
8341
|
+
# access token that authorizes requests to your resource servers.
|
|
8342
|
+
# `GetClientToken` provides the same functionality as the OAuth2
|
|
8343
|
+
# client-credentials grant; both authorize an application rather than a
|
|
8344
|
+
# user.
|
|
8345
|
+
#
|
|
8346
|
+
# To use this operation, you must configure the app client with a client
|
|
8347
|
+
# secret and enable the `ALLOW_CLIENT_TOKEN_AUTH` authentication flow.
|
|
8348
|
+
# The `ALLOW_CLIENT_TOKEN_AUTH` flow is mutually exclusive with user
|
|
8349
|
+
# authentication flows. It must be the only authentication flow that you
|
|
8350
|
+
# configure for the app client. For more information, see [Scopes, M2M,
|
|
8351
|
+
# and resource servers][1].
|
|
8352
|
+
#
|
|
8353
|
+
# <note markdown="1"> Amazon Cognito doesn't evaluate Identity and Access Management (IAM)
|
|
8354
|
+
# policies in requests for this API operation. For this operation, you
|
|
8355
|
+
# can't use IAM credentials to authorize requests, and you can't grant
|
|
8356
|
+
# IAM permissions in policies. For more information about authorization
|
|
8357
|
+
# models in Amazon Cognito, see [Using the Amazon Cognito user pools API
|
|
8358
|
+
# and user pool endpoints][2].
|
|
8359
|
+
#
|
|
8360
|
+
# </note>
|
|
8361
|
+
#
|
|
8362
|
+
#
|
|
8363
|
+
#
|
|
8364
|
+
# [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-define-resource-servers.html
|
|
8365
|
+
# [2]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html
|
|
8366
|
+
#
|
|
8367
|
+
# @option params [required, String] :client_id
|
|
8368
|
+
# The ID of the app client that requests the access token. The app
|
|
8369
|
+
# client must have a client secret and the `ALLOW_CLIENT_TOKEN_AUTH`
|
|
8370
|
+
# authentication flow.
|
|
8371
|
+
#
|
|
8372
|
+
# @option params [required, String] :secret
|
|
8373
|
+
# An active secret for the app client.
|
|
8374
|
+
#
|
|
8375
|
+
# @option params [Array<String>] :scopes
|
|
8376
|
+
# The custom scopes to authorize in the access token, in the format
|
|
8377
|
+
# `resource-server-identifier/scope-name`. Each scope must belong to a
|
|
8378
|
+
# resource server in your user pool. If you don't specify any scopes,
|
|
8379
|
+
# Amazon Cognito authorizes the scopes that are configured for the app
|
|
8380
|
+
# client.
|
|
8381
|
+
#
|
|
8382
|
+
# @option params [Hash<String,String>] :client_metadata
|
|
8383
|
+
# A map of custom key-value pairs that you can provide as input for any
|
|
8384
|
+
# custom workflows that this action triggers. You create custom
|
|
8385
|
+
# workflows by assigning Lambda functions to user pool triggers.
|
|
8386
|
+
#
|
|
8387
|
+
# When Amazon Cognito invokes any of these functions, it passes a JSON
|
|
8388
|
+
# payload, which the function receives as input. This payload contains a
|
|
8389
|
+
# `clientMetadata` attribute that provides the data that you assigned to
|
|
8390
|
+
# the ClientMetadata parameter in your request. In your function code,
|
|
8391
|
+
# you can process the `clientMetadata` value to enhance your workflow
|
|
8392
|
+
# for your specific needs.
|
|
8393
|
+
#
|
|
8394
|
+
# To review the Lambda trigger types that Amazon Cognito invokes at
|
|
8395
|
+
# runtime with API requests, see [ Connecting API actions to Lambda
|
|
8396
|
+
# triggers][1] in the *Amazon Cognito Developer Guide*.
|
|
8397
|
+
#
|
|
8398
|
+
# <note markdown="1"> When you use the `ClientMetadata` parameter, note that Amazon Cognito
|
|
8399
|
+
# won't do the following:
|
|
8400
|
+
#
|
|
8401
|
+
# * Store the `ClientMetadata` value. This data is available only to
|
|
8402
|
+
# Lambda triggers that are assigned to a user pool to support custom
|
|
8403
|
+
# workflows. If your user pool configuration doesn't include
|
|
8404
|
+
# triggers, the `ClientMetadata` parameter serves no purpose.
|
|
8405
|
+
#
|
|
8406
|
+
# * Validate the `ClientMetadata` value.
|
|
8407
|
+
#
|
|
8408
|
+
# * Encrypt the `ClientMetadata` value. Don't send sensitive
|
|
8409
|
+
# information in this parameter.
|
|
8410
|
+
#
|
|
8411
|
+
# </note>
|
|
8412
|
+
#
|
|
8413
|
+
#
|
|
8414
|
+
#
|
|
8415
|
+
# [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-working-with-lambda-triggers.html#lambda-triggers-by-event
|
|
8416
|
+
#
|
|
8417
|
+
# @return [Types::GetClientTokenResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
8418
|
+
#
|
|
8419
|
+
# * {Types::GetClientTokenResponse#client_authentication_result #client_authentication_result} => Types::ClientAuthenticationResultType
|
|
8420
|
+
#
|
|
8421
|
+
#
|
|
8422
|
+
# @example Example: Example – Get an access token for machine-to-machine authorization
|
|
8423
|
+
#
|
|
8424
|
+
# # The following example gets an access token for the app client 1example23456789 with the custom scope
|
|
8425
|
+
# # solar-system-data/asteroids.add.
|
|
8426
|
+
#
|
|
8427
|
+
# resp = client.get_client_token({
|
|
8428
|
+
# client_id: "1example23456789",
|
|
8429
|
+
# scopes: [
|
|
8430
|
+
# "solar-system-data/asteroids.add",
|
|
8431
|
+
# ],
|
|
8432
|
+
# secret: "exampleClientSecret123EXAMPLE",
|
|
8433
|
+
# })
|
|
8434
|
+
#
|
|
8435
|
+
# resp.to_h outputs the following:
|
|
8436
|
+
# {
|
|
8437
|
+
# client_authentication_result: {
|
|
8438
|
+
# access_token: "eyJra456defEXAMPLE",
|
|
8439
|
+
# expires_in: 3600,
|
|
8440
|
+
# token_type: "Bearer",
|
|
8441
|
+
# },
|
|
8442
|
+
# }
|
|
8443
|
+
#
|
|
8444
|
+
# @example Request syntax with placeholder values
|
|
8445
|
+
#
|
|
8446
|
+
# resp = client.get_client_token({
|
|
8447
|
+
# client_id: "ClientIdType", # required
|
|
8448
|
+
# secret: "ClientSecretType", # required
|
|
8449
|
+
# scopes: ["ScopeType"],
|
|
8450
|
+
# client_metadata: {
|
|
8451
|
+
# "StringType" => "StringType",
|
|
8452
|
+
# },
|
|
8453
|
+
# })
|
|
8454
|
+
#
|
|
8455
|
+
# @example Response structure
|
|
8456
|
+
#
|
|
8457
|
+
# resp.client_authentication_result.access_token #=> String
|
|
8458
|
+
# resp.client_authentication_result.expires_in #=> Integer
|
|
8459
|
+
# resp.client_authentication_result.token_type #=> String
|
|
8460
|
+
#
|
|
8461
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/GetClientToken AWS API Documentation
|
|
8462
|
+
#
|
|
8463
|
+
# @overload get_client_token(params = {})
|
|
8464
|
+
# @param [Hash] params ({})
|
|
8465
|
+
def get_client_token(params = {}, options = {})
|
|
8466
|
+
req = build_request(:get_client_token, params)
|
|
8467
|
+
req.send_request(options)
|
|
8468
|
+
end
|
|
8469
|
+
|
|
8206
8470
|
# Given a device key, returns information about a remembered device for
|
|
8207
8471
|
# the current user. For more information about device authentication,
|
|
8208
8472
|
# see [Working with user devices in your user pool][1].
|
|
@@ -14418,7 +14682,7 @@ module Aws::CognitoIdentityProvider
|
|
|
14418
14682
|
tracer: tracer
|
|
14419
14683
|
)
|
|
14420
14684
|
context[:gem_name] = 'aws-sdk-cognitoidentityprovider'
|
|
14421
|
-
context[:gem_version] = '1.
|
|
14685
|
+
context[:gem_version] = '1.151.0'
|
|
14422
14686
|
Seahorse::Client::Request.new(handlers, context)
|
|
14423
14687
|
end
|
|
14424
14688
|
|
|
@@ -34,6 +34,8 @@ module Aws::CognitoIdentityProvider
|
|
|
34
34
|
AdminCreateUserRequest = Shapes::StructureShape.new(name: 'AdminCreateUserRequest')
|
|
35
35
|
AdminCreateUserResponse = Shapes::StructureShape.new(name: 'AdminCreateUserResponse')
|
|
36
36
|
AdminCreateUserUnusedAccountValidityDaysType = Shapes::IntegerShape.new(name: 'AdminCreateUserUnusedAccountValidityDaysType')
|
|
37
|
+
AdminDeleteSoftwareTokenRequest = Shapes::StructureShape.new(name: 'AdminDeleteSoftwareTokenRequest')
|
|
38
|
+
AdminDeleteSoftwareTokenResponse = Shapes::StructureShape.new(name: 'AdminDeleteSoftwareTokenResponse')
|
|
37
39
|
AdminDeleteUserAttributesRequest = Shapes::StructureShape.new(name: 'AdminDeleteUserAttributesRequest')
|
|
38
40
|
AdminDeleteUserAttributesResponse = Shapes::StructureShape.new(name: 'AdminDeleteUserAttributesResponse')
|
|
39
41
|
AdminDeleteUserRequest = Shapes::StructureShape.new(name: 'AdminDeleteUserRequest')
|
|
@@ -127,6 +129,7 @@ module Aws::CognitoIdentityProvider
|
|
|
127
129
|
ChallengeResponsesType = Shapes::MapShape.new(name: 'ChallengeResponsesType')
|
|
128
130
|
ChangePasswordRequest = Shapes::StructureShape.new(name: 'ChangePasswordRequest')
|
|
129
131
|
ChangePasswordResponse = Shapes::StructureShape.new(name: 'ChangePasswordResponse')
|
|
132
|
+
ClientAuthenticationResultType = Shapes::StructureShape.new(name: 'ClientAuthenticationResultType')
|
|
130
133
|
ClientIdType = Shapes::StringShape.new(name: 'ClientIdType')
|
|
131
134
|
ClientMetadataType = Shapes::MapShape.new(name: 'ClientMetadataType')
|
|
132
135
|
ClientNameType = Shapes::StringShape.new(name: 'ClientNameType')
|
|
@@ -218,6 +221,8 @@ module Aws::CognitoIdentityProvider
|
|
|
218
221
|
DescribeResourceServerResponse = Shapes::StructureShape.new(name: 'DescribeResourceServerResponse')
|
|
219
222
|
DescribeRiskConfigurationRequest = Shapes::StructureShape.new(name: 'DescribeRiskConfigurationRequest')
|
|
220
223
|
DescribeRiskConfigurationResponse = Shapes::StructureShape.new(name: 'DescribeRiskConfigurationResponse')
|
|
224
|
+
DescribeTermsByClientRequest = Shapes::StructureShape.new(name: 'DescribeTermsByClientRequest')
|
|
225
|
+
DescribeTermsByClientResponse = Shapes::StructureShape.new(name: 'DescribeTermsByClientResponse')
|
|
221
226
|
DescribeTermsRequest = Shapes::StructureShape.new(name: 'DescribeTermsRequest')
|
|
222
227
|
DescribeTermsResponse = Shapes::StructureShape.new(name: 'DescribeTermsResponse')
|
|
223
228
|
DescribeUserImportJobRequest = Shapes::StructureShape.new(name: 'DescribeUserImportJobRequest')
|
|
@@ -286,6 +291,8 @@ module Aws::CognitoIdentityProvider
|
|
|
286
291
|
GenerateSecret = Shapes::BooleanShape.new(name: 'GenerateSecret')
|
|
287
292
|
GetCSVHeaderRequest = Shapes::StructureShape.new(name: 'GetCSVHeaderRequest')
|
|
288
293
|
GetCSVHeaderResponse = Shapes::StructureShape.new(name: 'GetCSVHeaderResponse')
|
|
294
|
+
GetClientTokenRequest = Shapes::StructureShape.new(name: 'GetClientTokenRequest')
|
|
295
|
+
GetClientTokenResponse = Shapes::StructureShape.new(name: 'GetClientTokenResponse')
|
|
289
296
|
GetDeviceRequest = Shapes::StructureShape.new(name: 'GetDeviceRequest')
|
|
290
297
|
GetDeviceResponse = Shapes::StructureShape.new(name: 'GetDeviceResponse')
|
|
291
298
|
GetGroupRequest = Shapes::StructureShape.new(name: 'GetGroupRequest')
|
|
@@ -708,6 +715,12 @@ module Aws::CognitoIdentityProvider
|
|
|
708
715
|
AdminCreateUserResponse.add_member(:user, Shapes::ShapeRef.new(shape: UserType, location_name: "User"))
|
|
709
716
|
AdminCreateUserResponse.struct_class = Types::AdminCreateUserResponse
|
|
710
717
|
|
|
718
|
+
AdminDeleteSoftwareTokenRequest.add_member(:user_pool_id, Shapes::ShapeRef.new(shape: UserPoolIdType, required: true, location_name: "UserPoolId"))
|
|
719
|
+
AdminDeleteSoftwareTokenRequest.add_member(:username, Shapes::ShapeRef.new(shape: UsernameType, required: true, location_name: "Username"))
|
|
720
|
+
AdminDeleteSoftwareTokenRequest.struct_class = Types::AdminDeleteSoftwareTokenRequest
|
|
721
|
+
|
|
722
|
+
AdminDeleteSoftwareTokenResponse.struct_class = Types::AdminDeleteSoftwareTokenResponse
|
|
723
|
+
|
|
711
724
|
AdminDeleteUserAttributesRequest.add_member(:user_pool_id, Shapes::ShapeRef.new(shape: UserPoolIdType, required: true, location_name: "UserPoolId"))
|
|
712
725
|
AdminDeleteUserAttributesRequest.add_member(:username, Shapes::ShapeRef.new(shape: UsernameType, required: true, location_name: "Username"))
|
|
713
726
|
AdminDeleteUserAttributesRequest.add_member(:user_attribute_names, Shapes::ShapeRef.new(shape: AttributeNameListType, required: true, location_name: "UserAttributeNames"))
|
|
@@ -1010,6 +1023,11 @@ module Aws::CognitoIdentityProvider
|
|
|
1010
1023
|
|
|
1011
1024
|
ChangePasswordResponse.struct_class = Types::ChangePasswordResponse
|
|
1012
1025
|
|
|
1026
|
+
ClientAuthenticationResultType.add_member(:access_token, Shapes::ShapeRef.new(shape: TokenModelType, location_name: "AccessToken"))
|
|
1027
|
+
ClientAuthenticationResultType.add_member(:expires_in, Shapes::ShapeRef.new(shape: IntegerType, location_name: "ExpiresIn"))
|
|
1028
|
+
ClientAuthenticationResultType.add_member(:token_type, Shapes::ShapeRef.new(shape: StringType, location_name: "TokenType"))
|
|
1029
|
+
ClientAuthenticationResultType.struct_class = Types::ClientAuthenticationResultType
|
|
1030
|
+
|
|
1013
1031
|
ClientMetadataType.key = Shapes::ShapeRef.new(shape: StringType)
|
|
1014
1032
|
ClientMetadataType.value = Shapes::ShapeRef.new(shape: StringType)
|
|
1015
1033
|
|
|
@@ -1353,6 +1371,14 @@ module Aws::CognitoIdentityProvider
|
|
|
1353
1371
|
DescribeRiskConfigurationResponse.add_member(:risk_configuration, Shapes::ShapeRef.new(shape: RiskConfigurationType, required: true, location_name: "RiskConfiguration"))
|
|
1354
1372
|
DescribeRiskConfigurationResponse.struct_class = Types::DescribeRiskConfigurationResponse
|
|
1355
1373
|
|
|
1374
|
+
DescribeTermsByClientRequest.add_member(:client_id, Shapes::ShapeRef.new(shape: ClientIdType, required: true, location_name: "ClientId"))
|
|
1375
|
+
DescribeTermsByClientRequest.add_member(:user_pool_id, Shapes::ShapeRef.new(shape: UserPoolIdType, required: true, location_name: "UserPoolId"))
|
|
1376
|
+
DescribeTermsByClientRequest.add_member(:terms_name, Shapes::ShapeRef.new(shape: TermsNameType, required: true, location_name: "TermsName"))
|
|
1377
|
+
DescribeTermsByClientRequest.struct_class = Types::DescribeTermsByClientRequest
|
|
1378
|
+
|
|
1379
|
+
DescribeTermsByClientResponse.add_member(:terms, Shapes::ShapeRef.new(shape: TermsType, location_name: "Terms"))
|
|
1380
|
+
DescribeTermsByClientResponse.struct_class = Types::DescribeTermsByClientResponse
|
|
1381
|
+
|
|
1356
1382
|
DescribeTermsRequest.add_member(:terms_id, Shapes::ShapeRef.new(shape: TermsIdType, required: true, location_name: "TermsId"))
|
|
1357
1383
|
DescribeTermsRequest.add_member(:user_pool_id, Shapes::ShapeRef.new(shape: UserPoolIdType, required: true, location_name: "UserPoolId"))
|
|
1358
1384
|
DescribeTermsRequest.struct_class = Types::DescribeTermsRequest
|
|
@@ -1507,6 +1533,15 @@ module Aws::CognitoIdentityProvider
|
|
|
1507
1533
|
GetCSVHeaderResponse.add_member(:csv_header, Shapes::ShapeRef.new(shape: ListOfStringTypes, location_name: "CSVHeader"))
|
|
1508
1534
|
GetCSVHeaderResponse.struct_class = Types::GetCSVHeaderResponse
|
|
1509
1535
|
|
|
1536
|
+
GetClientTokenRequest.add_member(:client_id, Shapes::ShapeRef.new(shape: ClientIdType, required: true, location_name: "ClientId"))
|
|
1537
|
+
GetClientTokenRequest.add_member(:secret, Shapes::ShapeRef.new(shape: ClientSecretType, required: true, location_name: "Secret"))
|
|
1538
|
+
GetClientTokenRequest.add_member(:scopes, Shapes::ShapeRef.new(shape: ScopeListType, location_name: "Scopes"))
|
|
1539
|
+
GetClientTokenRequest.add_member(:client_metadata, Shapes::ShapeRef.new(shape: ClientMetadataType, location_name: "ClientMetadata"))
|
|
1540
|
+
GetClientTokenRequest.struct_class = Types::GetClientTokenRequest
|
|
1541
|
+
|
|
1542
|
+
GetClientTokenResponse.add_member(:client_authentication_result, Shapes::ShapeRef.new(shape: ClientAuthenticationResultType, location_name: "ClientAuthenticationResult"))
|
|
1543
|
+
GetClientTokenResponse.struct_class = Types::GetClientTokenResponse
|
|
1544
|
+
|
|
1510
1545
|
GetDeviceRequest.add_member(:device_key, Shapes::ShapeRef.new(shape: DeviceKeyType, required: true, location_name: "DeviceKey"))
|
|
1511
1546
|
GetDeviceRequest.add_member(:access_token, Shapes::ShapeRef.new(shape: TokenModelType, location_name: "AccessToken"))
|
|
1512
1547
|
GetDeviceRequest.struct_class = Types::GetDeviceRequest
|
|
@@ -2774,6 +2809,22 @@ module Aws::CognitoIdentityProvider
|
|
|
2774
2809
|
o.errors << Shapes::ShapeRef.new(shape: InternalErrorException)
|
|
2775
2810
|
end)
|
|
2776
2811
|
|
|
2812
|
+
api.add_operation(:admin_delete_software_token, Seahorse::Model::Operation.new.tap do |o|
|
|
2813
|
+
o.name = "AdminDeleteSoftwareToken"
|
|
2814
|
+
o.http_method = "POST"
|
|
2815
|
+
o.http_request_uri = "/"
|
|
2816
|
+
o.input = Shapes::ShapeRef.new(shape: AdminDeleteSoftwareTokenRequest)
|
|
2817
|
+
o.output = Shapes::ShapeRef.new(shape: AdminDeleteSoftwareTokenResponse)
|
|
2818
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
|
2819
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
|
|
2820
|
+
o.errors << Shapes::ShapeRef.new(shape: NotAuthorizedException)
|
|
2821
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
|
2822
|
+
o.errors << Shapes::ShapeRef.new(shape: UserNotFoundException)
|
|
2823
|
+
o.errors << Shapes::ShapeRef.new(shape: UserNotConfirmedException)
|
|
2824
|
+
o.errors << Shapes::ShapeRef.new(shape: OperationNotEnabledException)
|
|
2825
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalErrorException)
|
|
2826
|
+
end)
|
|
2827
|
+
|
|
2777
2828
|
api.add_operation(:admin_delete_user, Seahorse::Model::Operation.new.tap do |o|
|
|
2778
2829
|
o.name = "AdminDeleteUser"
|
|
2779
2830
|
o.http_method = "POST"
|
|
@@ -3793,6 +3844,20 @@ module Aws::CognitoIdentityProvider
|
|
|
3793
3844
|
o.errors << Shapes::ShapeRef.new(shape: InternalErrorException)
|
|
3794
3845
|
end)
|
|
3795
3846
|
|
|
3847
|
+
api.add_operation(:describe_terms_by_client, Seahorse::Model::Operation.new.tap do |o|
|
|
3848
|
+
o.name = "DescribeTermsByClient"
|
|
3849
|
+
o.http_method = "POST"
|
|
3850
|
+
o.http_request_uri = "/"
|
|
3851
|
+
o.input = Shapes::ShapeRef.new(shape: DescribeTermsByClientRequest)
|
|
3852
|
+
o.output = Shapes::ShapeRef.new(shape: DescribeTermsByClientResponse)
|
|
3853
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
|
3854
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
|
|
3855
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
|
3856
|
+
o.errors << Shapes::ShapeRef.new(shape: NotAuthorizedException)
|
|
3857
|
+
o.errors << Shapes::ShapeRef.new(shape: OperationNotEnabledException)
|
|
3858
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalErrorException)
|
|
3859
|
+
end)
|
|
3860
|
+
|
|
3796
3861
|
api.add_operation(:describe_user_import_job, Seahorse::Model::Operation.new.tap do |o|
|
|
3797
3862
|
o.name = "DescribeUserImportJob"
|
|
3798
3863
|
o.http_method = "POST"
|
|
@@ -3910,6 +3975,21 @@ module Aws::CognitoIdentityProvider
|
|
|
3910
3975
|
o.errors << Shapes::ShapeRef.new(shape: InternalErrorException)
|
|
3911
3976
|
end)
|
|
3912
3977
|
|
|
3978
|
+
api.add_operation(:get_client_token, Seahorse::Model::Operation.new.tap do |o|
|
|
3979
|
+
o.name = "GetClientToken"
|
|
3980
|
+
o.http_method = "POST"
|
|
3981
|
+
o.http_request_uri = "/"
|
|
3982
|
+
o.input = Shapes::ShapeRef.new(shape: GetClientTokenRequest)
|
|
3983
|
+
o.output = Shapes::ShapeRef.new(shape: GetClientTokenResponse)
|
|
3984
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
|
|
3985
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
|
3986
|
+
o.errors << Shapes::ShapeRef.new(shape: NotAuthorizedException)
|
|
3987
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
|
3988
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalErrorException)
|
|
3989
|
+
o.errors << Shapes::ShapeRef.new(shape: OperationNotEnabledException)
|
|
3990
|
+
o.errors << Shapes::ShapeRef.new(shape: ForbiddenException)
|
|
3991
|
+
end)
|
|
3992
|
+
|
|
3913
3993
|
api.add_operation(:get_device, Seahorse::Model::Operation.new.tap do |o|
|
|
3914
3994
|
o.name = "GetDevice"
|
|
3915
3995
|
o.http_method = "POST"
|
|
@@ -593,6 +593,32 @@ module Aws::CognitoIdentityProvider
|
|
|
593
593
|
include Aws::Structure
|
|
594
594
|
end
|
|
595
595
|
|
|
596
|
+
# @!attribute [rw] user_pool_id
|
|
597
|
+
# The ID of the user pool where you want to delete the user's
|
|
598
|
+
# software token.
|
|
599
|
+
# @return [String]
|
|
600
|
+
#
|
|
601
|
+
# @!attribute [rw] username
|
|
602
|
+
# The name of the user that you want to query or modify. The value of
|
|
603
|
+
# this parameter is typically your user's username, but it can be any
|
|
604
|
+
# of their alias attributes. If `username` isn't an alias attribute
|
|
605
|
+
# in your user pool, this value must be the `sub` of a local user or
|
|
606
|
+
# the username of a user from a third-party IdP.
|
|
607
|
+
# @return [String]
|
|
608
|
+
#
|
|
609
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminDeleteSoftwareTokenRequest AWS API Documentation
|
|
610
|
+
#
|
|
611
|
+
class AdminDeleteSoftwareTokenRequest < Struct.new(
|
|
612
|
+
:user_pool_id,
|
|
613
|
+
:username)
|
|
614
|
+
SENSITIVE = [:username]
|
|
615
|
+
include Aws::Structure
|
|
616
|
+
end
|
|
617
|
+
|
|
618
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminDeleteSoftwareTokenResponse AWS API Documentation
|
|
619
|
+
#
|
|
620
|
+
class AdminDeleteSoftwareTokenResponse < Aws::EmptyStructure; end
|
|
621
|
+
|
|
596
622
|
# Represents the request to delete user attributes as an administrator.
|
|
597
623
|
#
|
|
598
624
|
# @!attribute [rw] user_pool_id
|
|
@@ -1375,10 +1401,6 @@ module Aws::CognitoIdentityProvider
|
|
|
1375
1401
|
#
|
|
1376
1402
|
# The `ProviderName` should be set to `Cognito` for users in Cognito
|
|
1377
1403
|
# user pools.
|
|
1378
|
-
#
|
|
1379
|
-
# All attributes in the DestinationUser profile must be mutable. If
|
|
1380
|
-
# you have assigned the user any immutable custom attributes, the
|
|
1381
|
-
# operation won't succeed.
|
|
1382
1404
|
# @return [Types::ProviderUserIdentifierType]
|
|
1383
1405
|
#
|
|
1384
1406
|
# @!attribute [rw] source_user
|
|
@@ -3097,6 +3119,33 @@ module Aws::CognitoIdentityProvider
|
|
|
3097
3119
|
#
|
|
3098
3120
|
class ChangePasswordResponse < Aws::EmptyStructure; end
|
|
3099
3121
|
|
|
3122
|
+
# The access token and its metadata from a machine-to-machine (M2M)
|
|
3123
|
+
# client credentials grant.
|
|
3124
|
+
#
|
|
3125
|
+
# @!attribute [rw] access_token
|
|
3126
|
+
# The access token for the requested app client. Present this token to
|
|
3127
|
+
# a resource server to authorize a request, using the scopes granted
|
|
3128
|
+
# in the token.
|
|
3129
|
+
# @return [String]
|
|
3130
|
+
#
|
|
3131
|
+
# @!attribute [rw] expires_in
|
|
3132
|
+
# The number of seconds until the access token expires.
|
|
3133
|
+
# @return [Integer]
|
|
3134
|
+
#
|
|
3135
|
+
# @!attribute [rw] token_type
|
|
3136
|
+
# The type of the token. For example, `Bearer`.
|
|
3137
|
+
# @return [String]
|
|
3138
|
+
#
|
|
3139
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ClientAuthenticationResultType AWS API Documentation
|
|
3140
|
+
#
|
|
3141
|
+
class ClientAuthenticationResultType < Struct.new(
|
|
3142
|
+
:access_token,
|
|
3143
|
+
:expires_in,
|
|
3144
|
+
:token_type)
|
|
3145
|
+
SENSITIVE = [:access_token]
|
|
3146
|
+
include Aws::Structure
|
|
3147
|
+
end
|
|
3148
|
+
|
|
3100
3149
|
# Contains information about a client secret, including its unique
|
|
3101
3150
|
# identifier, value, and creation timestamp.
|
|
3102
3151
|
#
|
|
@@ -5601,6 +5650,43 @@ module Aws::CognitoIdentityProvider
|
|
|
5601
5650
|
include Aws::Structure
|
|
5602
5651
|
end
|
|
5603
5652
|
|
|
5653
|
+
# @!attribute [rw] client_id
|
|
5654
|
+
# The ID of the app client that the terms documents are associated
|
|
5655
|
+
# with.
|
|
5656
|
+
# @return [String]
|
|
5657
|
+
#
|
|
5658
|
+
# @!attribute [rw] user_pool_id
|
|
5659
|
+
# The ID of the user pool that contains the terms documents that you
|
|
5660
|
+
# want to describe.
|
|
5661
|
+
# @return [String]
|
|
5662
|
+
#
|
|
5663
|
+
# @!attribute [rw] terms_name
|
|
5664
|
+
# The name of the terms documents that you want to describe.
|
|
5665
|
+
# @return [String]
|
|
5666
|
+
#
|
|
5667
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DescribeTermsByClientRequest AWS API Documentation
|
|
5668
|
+
#
|
|
5669
|
+
class DescribeTermsByClientRequest < Struct.new(
|
|
5670
|
+
:client_id,
|
|
5671
|
+
:user_pool_id,
|
|
5672
|
+
:terms_name)
|
|
5673
|
+
SENSITIVE = [:client_id]
|
|
5674
|
+
include Aws::Structure
|
|
5675
|
+
end
|
|
5676
|
+
|
|
5677
|
+
# @!attribute [rw] terms
|
|
5678
|
+
# A summary of the requested terms documents. Includes a unique
|
|
5679
|
+
# identifier for later changes to the terms documents.
|
|
5680
|
+
# @return [Types::TermsType]
|
|
5681
|
+
#
|
|
5682
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DescribeTermsByClientResponse AWS API Documentation
|
|
5683
|
+
#
|
|
5684
|
+
class DescribeTermsByClientResponse < Struct.new(
|
|
5685
|
+
:terms)
|
|
5686
|
+
SENSITIVE = []
|
|
5687
|
+
include Aws::Structure
|
|
5688
|
+
end
|
|
5689
|
+
|
|
5604
5690
|
# @!attribute [rw] terms_id
|
|
5605
5691
|
# The ID of the terms documents that you want to describe.
|
|
5606
5692
|
# @return [String]
|
|
@@ -6643,6 +6729,84 @@ module Aws::CognitoIdentityProvider
|
|
|
6643
6729
|
include Aws::Structure
|
|
6644
6730
|
end
|
|
6645
6731
|
|
|
6732
|
+
# @!attribute [rw] client_id
|
|
6733
|
+
# The ID of the app client that requests the access token. The app
|
|
6734
|
+
# client must have a client secret and the `ALLOW_CLIENT_TOKEN_AUTH`
|
|
6735
|
+
# authentication flow.
|
|
6736
|
+
# @return [String]
|
|
6737
|
+
#
|
|
6738
|
+
# @!attribute [rw] secret
|
|
6739
|
+
# An active secret for the app client.
|
|
6740
|
+
# @return [String]
|
|
6741
|
+
#
|
|
6742
|
+
# @!attribute [rw] scopes
|
|
6743
|
+
# The custom scopes to authorize in the access token, in the format
|
|
6744
|
+
# `resource-server-identifier/scope-name`. Each scope must belong to a
|
|
6745
|
+
# resource server in your user pool. If you don't specify any scopes,
|
|
6746
|
+
# Amazon Cognito authorizes the scopes that are configured for the app
|
|
6747
|
+
# client.
|
|
6748
|
+
# @return [Array<String>]
|
|
6749
|
+
#
|
|
6750
|
+
# @!attribute [rw] client_metadata
|
|
6751
|
+
# A map of custom key-value pairs that you can provide as input for
|
|
6752
|
+
# any custom workflows that this action triggers. You create custom
|
|
6753
|
+
# workflows by assigning Lambda functions to user pool triggers.
|
|
6754
|
+
#
|
|
6755
|
+
# When Amazon Cognito invokes any of these functions, it passes a JSON
|
|
6756
|
+
# payload, which the function receives as input. This payload contains
|
|
6757
|
+
# a `clientMetadata` attribute that provides the data that you
|
|
6758
|
+
# assigned to the ClientMetadata parameter in your request. In your
|
|
6759
|
+
# function code, you can process the `clientMetadata` value to enhance
|
|
6760
|
+
# your workflow for your specific needs.
|
|
6761
|
+
#
|
|
6762
|
+
# To review the Lambda trigger types that Amazon Cognito invokes at
|
|
6763
|
+
# runtime with API requests, see [ Connecting API actions to Lambda
|
|
6764
|
+
# triggers][1] in the *Amazon Cognito Developer Guide*.
|
|
6765
|
+
#
|
|
6766
|
+
# <note markdown="1"> When you use the `ClientMetadata` parameter, note that Amazon
|
|
6767
|
+
# Cognito won't do the following:
|
|
6768
|
+
#
|
|
6769
|
+
# * Store the `ClientMetadata` value. This data is available only to
|
|
6770
|
+
# Lambda triggers that are assigned to a user pool to support custom
|
|
6771
|
+
# workflows. If your user pool configuration doesn't include
|
|
6772
|
+
# triggers, the `ClientMetadata` parameter serves no purpose.
|
|
6773
|
+
#
|
|
6774
|
+
# * Validate the `ClientMetadata` value.
|
|
6775
|
+
#
|
|
6776
|
+
# * Encrypt the `ClientMetadata` value. Don't send sensitive
|
|
6777
|
+
# information in this parameter.
|
|
6778
|
+
#
|
|
6779
|
+
# </note>
|
|
6780
|
+
#
|
|
6781
|
+
#
|
|
6782
|
+
#
|
|
6783
|
+
# [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-working-with-lambda-triggers.html#lambda-triggers-by-event
|
|
6784
|
+
# @return [Hash<String,String>]
|
|
6785
|
+
#
|
|
6786
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/GetClientTokenRequest AWS API Documentation
|
|
6787
|
+
#
|
|
6788
|
+
class GetClientTokenRequest < Struct.new(
|
|
6789
|
+
:client_id,
|
|
6790
|
+
:secret,
|
|
6791
|
+
:scopes,
|
|
6792
|
+
:client_metadata)
|
|
6793
|
+
SENSITIVE = [:client_id, :secret]
|
|
6794
|
+
include Aws::Structure
|
|
6795
|
+
end
|
|
6796
|
+
|
|
6797
|
+
# @!attribute [rw] client_authentication_result
|
|
6798
|
+
# The access token that Amazon Cognito issues for the app client, and
|
|
6799
|
+
# its metadata.
|
|
6800
|
+
# @return [Types::ClientAuthenticationResultType]
|
|
6801
|
+
#
|
|
6802
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/GetClientTokenResponse AWS API Documentation
|
|
6803
|
+
#
|
|
6804
|
+
class GetClientTokenResponse < Struct.new(
|
|
6805
|
+
:client_authentication_result)
|
|
6806
|
+
SENSITIVE = []
|
|
6807
|
+
include Aws::Structure
|
|
6808
|
+
end
|
|
6809
|
+
|
|
6646
6810
|
# Represents the request to get the device.
|
|
6647
6811
|
#
|
|
6648
6812
|
# @!attribute [rw] device_key
|
data/sig/client.rbs
CHANGED
|
@@ -150,6 +150,16 @@ module Aws
|
|
|
150
150
|
) -> _AdminCreateUserResponseSuccess
|
|
151
151
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _AdminCreateUserResponseSuccess
|
|
152
152
|
|
|
153
|
+
interface _AdminDeleteSoftwareTokenResponseSuccess
|
|
154
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::AdminDeleteSoftwareTokenResponse]
|
|
155
|
+
end
|
|
156
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#admin_delete_software_token-instance_method
|
|
157
|
+
def admin_delete_software_token: (
|
|
158
|
+
user_pool_id: ::String,
|
|
159
|
+
username: ::String
|
|
160
|
+
) -> _AdminDeleteSoftwareTokenResponseSuccess
|
|
161
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _AdminDeleteSoftwareTokenResponseSuccess
|
|
162
|
+
|
|
153
163
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#admin_delete_user-instance_method
|
|
154
164
|
def admin_delete_user: (
|
|
155
165
|
user_pool_id: ::String,
|
|
@@ -999,6 +1009,18 @@ module Aws
|
|
|
999
1009
|
) -> _DescribeTermsResponseSuccess
|
|
1000
1010
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeTermsResponseSuccess
|
|
1001
1011
|
|
|
1012
|
+
interface _DescribeTermsByClientResponseSuccess
|
|
1013
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DescribeTermsByClientResponse]
|
|
1014
|
+
def terms: () -> Types::TermsType
|
|
1015
|
+
end
|
|
1016
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#describe_terms_by_client-instance_method
|
|
1017
|
+
def describe_terms_by_client: (
|
|
1018
|
+
client_id: ::String,
|
|
1019
|
+
user_pool_id: ::String,
|
|
1020
|
+
terms_name: ::String
|
|
1021
|
+
) -> _DescribeTermsByClientResponseSuccess
|
|
1022
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeTermsByClientResponseSuccess
|
|
1023
|
+
|
|
1002
1024
|
interface _DescribeUserImportJobResponseSuccess
|
|
1003
1025
|
include ::Seahorse::Client::_ResponseSuccess[Types::DescribeUserImportJobResponse]
|
|
1004
1026
|
def user_import_job: () -> Types::UserImportJobType
|
|
@@ -1079,6 +1101,19 @@ module Aws
|
|
|
1079
1101
|
) -> _GetCSVHeaderResponseSuccess
|
|
1080
1102
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetCSVHeaderResponseSuccess
|
|
1081
1103
|
|
|
1104
|
+
interface _GetClientTokenResponseSuccess
|
|
1105
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetClientTokenResponse]
|
|
1106
|
+
def client_authentication_result: () -> Types::ClientAuthenticationResultType
|
|
1107
|
+
end
|
|
1108
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#get_client_token-instance_method
|
|
1109
|
+
def get_client_token: (
|
|
1110
|
+
client_id: ::String,
|
|
1111
|
+
secret: ::String,
|
|
1112
|
+
?scopes: Array[::String],
|
|
1113
|
+
?client_metadata: Hash[::String, ::String]
|
|
1114
|
+
) -> _GetClientTokenResponseSuccess
|
|
1115
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetClientTokenResponseSuccess
|
|
1116
|
+
|
|
1082
1117
|
interface _GetDeviceResponseSuccess
|
|
1083
1118
|
include ::Seahorse::Client::_ResponseSuccess[Types::GetDeviceResponse]
|
|
1084
1119
|
def device: () -> Types::DeviceType
|
data/sig/types.rbs
CHANGED
|
@@ -100,6 +100,15 @@ module Aws::CognitoIdentityProvider
|
|
|
100
100
|
SENSITIVE: []
|
|
101
101
|
end
|
|
102
102
|
|
|
103
|
+
class AdminDeleteSoftwareTokenRequest
|
|
104
|
+
attr_accessor user_pool_id: ::String
|
|
105
|
+
attr_accessor username: ::String
|
|
106
|
+
SENSITIVE: [:username]
|
|
107
|
+
end
|
|
108
|
+
|
|
109
|
+
class AdminDeleteSoftwareTokenResponse < Aws::EmptyStructure
|
|
110
|
+
end
|
|
111
|
+
|
|
103
112
|
class AdminDeleteUserAttributesRequest
|
|
104
113
|
attr_accessor user_pool_id: ::String
|
|
105
114
|
attr_accessor username: ::String
|
|
@@ -470,6 +479,13 @@ module Aws::CognitoIdentityProvider
|
|
|
470
479
|
class ChangePasswordResponse < Aws::EmptyStructure
|
|
471
480
|
end
|
|
472
481
|
|
|
482
|
+
class ClientAuthenticationResultType
|
|
483
|
+
attr_accessor access_token: ::String
|
|
484
|
+
attr_accessor expires_in: ::Integer
|
|
485
|
+
attr_accessor token_type: ::String
|
|
486
|
+
SENSITIVE: [:access_token]
|
|
487
|
+
end
|
|
488
|
+
|
|
473
489
|
class ClientSecretDescriptorType
|
|
474
490
|
attr_accessor client_secret_id: ::String
|
|
475
491
|
attr_accessor client_secret_value: ::String
|
|
@@ -928,6 +944,18 @@ module Aws::CognitoIdentityProvider
|
|
|
928
944
|
SENSITIVE: []
|
|
929
945
|
end
|
|
930
946
|
|
|
947
|
+
class DescribeTermsByClientRequest
|
|
948
|
+
attr_accessor client_id: ::String
|
|
949
|
+
attr_accessor user_pool_id: ::String
|
|
950
|
+
attr_accessor terms_name: ::String
|
|
951
|
+
SENSITIVE: [:client_id]
|
|
952
|
+
end
|
|
953
|
+
|
|
954
|
+
class DescribeTermsByClientResponse
|
|
955
|
+
attr_accessor terms: Types::TermsType
|
|
956
|
+
SENSITIVE: []
|
|
957
|
+
end
|
|
958
|
+
|
|
931
959
|
class DescribeTermsRequest
|
|
932
960
|
attr_accessor terms_id: ::String
|
|
933
961
|
attr_accessor user_pool_id: ::String
|
|
@@ -1144,6 +1172,19 @@ module Aws::CognitoIdentityProvider
|
|
|
1144
1172
|
SENSITIVE: []
|
|
1145
1173
|
end
|
|
1146
1174
|
|
|
1175
|
+
class GetClientTokenRequest
|
|
1176
|
+
attr_accessor client_id: ::String
|
|
1177
|
+
attr_accessor secret: ::String
|
|
1178
|
+
attr_accessor scopes: ::Array[::String]
|
|
1179
|
+
attr_accessor client_metadata: ::Hash[::String, ::String]
|
|
1180
|
+
SENSITIVE: [:client_id, :secret]
|
|
1181
|
+
end
|
|
1182
|
+
|
|
1183
|
+
class GetClientTokenResponse
|
|
1184
|
+
attr_accessor client_authentication_result: Types::ClientAuthenticationResultType
|
|
1185
|
+
SENSITIVE: []
|
|
1186
|
+
end
|
|
1187
|
+
|
|
1147
1188
|
class GetDeviceRequest
|
|
1148
1189
|
attr_accessor device_key: ::String
|
|
1149
1190
|
attr_accessor access_token: ::String
|