@pgarbe/cdk-ecr-sync 0.5.28 → 0.5.31

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.
Files changed (246) hide show
  1. package/.jsii +5 -5
  2. package/API.md +106 -50
  3. package/CHANGELOG.md +91 -1
  4. package/lib/ecr-sync.d.ts +0 -1
  5. package/lib/ecr-sync.js +4 -5
  6. package/lib/image.d.ts +0 -1
  7. package/lib/index.d.ts +0 -1
  8. package/lib/lambda/docker-adapter.d.ts +0 -1
  9. package/lib/lambda/docker-adapter.js +2 -3
  10. package/lib/lambda/ecr-adapter.d.ts +0 -1
  11. package/lib/lambda/get-image-tags-handler.d.ts +0 -1
  12. package/lib/lambda/get-image-tags-handler.js +3 -4
  13. package/node_modules/aws-sdk/CHANGELOG.md +109 -1
  14. package/node_modules/aws-sdk/README.md +1 -1
  15. package/node_modules/aws-sdk/apis/appflow-2020-08-23.min.json +76 -70
  16. package/node_modules/aws-sdk/apis/application-insights-2018-11-25.min.json +25 -24
  17. package/node_modules/aws-sdk/apis/appmesh-2019-01-25.min.json +129 -121
  18. package/node_modules/aws-sdk/apis/auditmanager-2017-07-25.min.json +4 -0
  19. package/node_modules/aws-sdk/apis/backup-gateway-2021-01-01.min.json +58 -8
  20. package/node_modules/aws-sdk/apis/budgets-2016-10-20.min.json +53 -53
  21. package/node_modules/aws-sdk/apis/ce-2017-10-25.min.json +79 -0
  22. package/node_modules/aws-sdk/apis/ce-2017-10-25.paginators.json +5 -0
  23. package/node_modules/aws-sdk/apis/chime-sdk-meetings-2021-07-15.min.json +126 -33
  24. package/node_modules/aws-sdk/apis/chime-sdk-messaging-2021-05-15.min.json +124 -53
  25. package/node_modules/aws-sdk/apis/chime-sdk-messaging-2021-05-15.paginators.json +5 -0
  26. package/node_modules/aws-sdk/apis/cloudformation-2010-05-15.min.json +10 -8
  27. package/node_modules/aws-sdk/apis/cognito-idp-2016-04-18.min.json +155 -127
  28. package/node_modules/aws-sdk/apis/connect-2017-08-08.min.json +637 -93
  29. package/node_modules/aws-sdk/apis/connect-2017-08-08.paginators.json +11 -0
  30. package/node_modules/aws-sdk/apis/connectcampaigns-2021-01-30.examples.json +5 -0
  31. package/node_modules/aws-sdk/apis/connectcampaigns-2021-01-30.min.json +767 -0
  32. package/node_modules/aws-sdk/apis/connectcampaigns-2021-01-30.paginators.json +10 -0
  33. package/node_modules/aws-sdk/apis/datasync-2018-11-09.min.json +80 -74
  34. package/node_modules/aws-sdk/apis/datasync-2018-11-09.paginators.json +10 -5
  35. package/node_modules/aws-sdk/apis/dms-2016-01-01.min.json +385 -52
  36. package/node_modules/aws-sdk/apis/dms-2016-01-01.paginators.json +25 -0
  37. package/node_modules/aws-sdk/apis/drs-2020-02-26.min.json +332 -205
  38. package/node_modules/aws-sdk/apis/drs-2020-02-26.paginators.json +12 -0
  39. package/node_modules/aws-sdk/apis/ec2-2016-11-15.min.json +17 -0
  40. package/node_modules/aws-sdk/apis/elasticache-2015-02-02.min.json +3 -0
  41. package/node_modules/aws-sdk/apis/emr-serverless-2021-07-13.examples.json +5 -0
  42. package/node_modules/aws-sdk/apis/emr-serverless-2021-07-13.min.json +860 -0
  43. package/node_modules/aws-sdk/apis/emr-serverless-2021-07-13.paginators.json +16 -0
  44. package/node_modules/aws-sdk/apis/finspace-data-2020-07-13.min.json +278 -73
  45. package/node_modules/aws-sdk/apis/forecast-2018-06-26.min.json +354 -68
  46. package/node_modules/aws-sdk/apis/forecast-2018-06-26.paginators.json +24 -0
  47. package/node_modules/aws-sdk/apis/fsx-2018-03-01.min.json +135 -116
  48. package/node_modules/aws-sdk/apis/gamesparks-2021-08-17.min.json +13 -0
  49. package/node_modules/aws-sdk/apis/greengrassv2-2020-11-30.min.json +37 -18
  50. package/node_modules/aws-sdk/apis/guardduty-2017-11-28.min.json +325 -98
  51. package/node_modules/aws-sdk/apis/iotevents-data-2018-10-23.min.json +45 -0
  52. package/node_modules/aws-sdk/apis/iotsitewise-2019-12-02.min.json +20 -15
  53. package/node_modules/aws-sdk/apis/kendra-2019-02-03.min.json +179 -61
  54. package/node_modules/aws-sdk/apis/lightsail-2016-11-28.min.json +155 -122
  55. package/node_modules/aws-sdk/apis/lookoutmetrics-2017-07-25.min.json +142 -56
  56. package/node_modules/aws-sdk/apis/m2-2021-04-28.examples.json +5 -0
  57. package/node_modules/aws-sdk/apis/m2-2021-04-28.min.json +1820 -0
  58. package/node_modules/aws-sdk/apis/m2-2021-04-28.paginators.json +58 -0
  59. package/node_modules/aws-sdk/apis/mediaconvert-2017-08-29.min.json +223 -143
  60. package/node_modules/aws-sdk/apis/metadata.json +13 -0
  61. package/node_modules/aws-sdk/apis/neptune-2014-10-31.min.json +293 -100
  62. package/node_modules/aws-sdk/apis/networkmanager-2019-07-05.min.json +72 -3
  63. package/node_modules/aws-sdk/apis/outposts-2019-12-03.min.json +67 -0
  64. package/node_modules/aws-sdk/apis/personalize-2018-05-22.min.json +14 -8
  65. package/node_modules/aws-sdk/apis/proton-2020-07-20.min.json +451 -139
  66. package/node_modules/aws-sdk/apis/proton-2020-07-20.paginators.json +16 -0
  67. package/node_modules/aws-sdk/apis/proton-2020-07-20.waiters2.json +33 -0
  68. package/node_modules/aws-sdk/apis/quicksight-2018-04-01.min.json +35 -1
  69. package/node_modules/aws-sdk/apis/redshift-2012-12-01.min.json +39 -5
  70. package/node_modules/aws-sdk/apis/redshift-data-2019-12-20.min.json +25 -16
  71. package/node_modules/aws-sdk/apis/redshiftserverless-2021-04-21.examples.json +5 -0
  72. package/node_modules/aws-sdk/apis/redshiftserverless-2021-04-21.min.json +1206 -0
  73. package/node_modules/aws-sdk/apis/redshiftserverless-2021-04-21.paginators.json +40 -0
  74. package/node_modules/aws-sdk/apis/route53-2013-04-01.min.json +333 -78
  75. package/node_modules/aws-sdk/apis/route53-2013-04-01.paginators.json +18 -0
  76. package/node_modules/aws-sdk/apis/sagemaker-2017-07-24.min.json +673 -649
  77. package/node_modules/aws-sdk/apis/securityhub-2018-10-26.min.json +841 -300
  78. package/node_modules/aws-sdk/apis/servicecatalog-appregistry-2020-06-24.min.json +45 -0
  79. package/node_modules/aws-sdk/apis/servicecatalog-appregistry-2020-06-24.paginators.json +6 -0
  80. package/node_modules/aws-sdk/apis/transcribe-2017-10-26.min.json +37 -11
  81. package/node_modules/aws-sdk/apis/transfer-2018-11-05.min.json +37 -36
  82. package/node_modules/aws-sdk/apis/voice-id-2021-09-27.min.json +73 -53
  83. package/node_modules/aws-sdk/apis/voice-id-2021-09-27.paginators.json +8 -4
  84. package/node_modules/aws-sdk/clients/all.d.ts +4 -0
  85. package/node_modules/aws-sdk/clients/all.js +5 -1
  86. package/node_modules/aws-sdk/clients/apigateway.d.ts +327 -324
  87. package/node_modules/aws-sdk/clients/appflow.d.ts +17 -7
  88. package/node_modules/aws-sdk/clients/applicationinsights.d.ts +38 -3
  89. package/node_modules/aws-sdk/clients/appmesh.d.ts +70 -51
  90. package/node_modules/aws-sdk/clients/apprunner.d.ts +2 -2
  91. package/node_modules/aws-sdk/clients/auditmanager.d.ts +7 -7
  92. package/node_modules/aws-sdk/clients/backupgateway.d.ts +77 -2
  93. package/node_modules/aws-sdk/clients/batch.d.ts +4 -4
  94. package/node_modules/aws-sdk/clients/budgets.d.ts +2 -1
  95. package/node_modules/aws-sdk/clients/chimesdkmeetings.d.ts +82 -1
  96. package/node_modules/aws-sdk/clients/chimesdkmessaging.d.ts +81 -5
  97. package/node_modules/aws-sdk/clients/cloudformation.d.ts +62 -53
  98. package/node_modules/aws-sdk/clients/cloudwatchlogs.d.ts +4 -4
  99. package/node_modules/aws-sdk/clients/codeartifact.d.ts +93 -93
  100. package/node_modules/aws-sdk/clients/cognitoidentityserviceprovider.d.ts +197 -162
  101. package/node_modules/aws-sdk/clients/comprehend.d.ts +22 -22
  102. package/node_modules/aws-sdk/clients/connect.d.ts +708 -11
  103. package/node_modules/aws-sdk/clients/connectcampaigns.d.ts +446 -0
  104. package/node_modules/aws-sdk/clients/connectcampaigns.js +18 -0
  105. package/node_modules/aws-sdk/clients/costexplorer.d.ts +219 -113
  106. package/node_modules/aws-sdk/clients/datasync.d.ts +41 -15
  107. package/node_modules/aws-sdk/clients/dms.d.ts +532 -2
  108. package/node_modules/aws-sdk/clients/drs.d.ts +173 -6
  109. package/node_modules/aws-sdk/clients/dynamodb.d.ts +18 -18
  110. package/node_modules/aws-sdk/clients/dynamodbstreams.d.ts +1 -1
  111. package/node_modules/aws-sdk/clients/ec2.d.ts +35 -15
  112. package/node_modules/aws-sdk/clients/elasticache.d.ts +12 -8
  113. package/node_modules/aws-sdk/clients/emrserverless.d.ts +890 -0
  114. package/node_modules/aws-sdk/clients/emrserverless.js +18 -0
  115. package/node_modules/aws-sdk/clients/finspacedata.d.ts +201 -4
  116. package/node_modules/aws-sdk/clients/forecastservice.d.ts +452 -24
  117. package/node_modules/aws-sdk/clients/frauddetector.d.ts +5 -5
  118. package/node_modules/aws-sdk/clients/fsx.d.ts +28 -3
  119. package/node_modules/aws-sdk/clients/gamesparks.d.ts +20 -0
  120. package/node_modules/aws-sdk/clients/greengrassv2.d.ts +49 -18
  121. package/node_modules/aws-sdk/clients/guardduty.d.ts +186 -4
  122. package/node_modules/aws-sdk/clients/iam.d.ts +2 -2
  123. package/node_modules/aws-sdk/clients/ioteventsdata.d.ts +50 -0
  124. package/node_modules/aws-sdk/clients/iotsitewise.d.ts +23 -3
  125. package/node_modules/aws-sdk/clients/ivschat.d.ts +1 -1
  126. package/node_modules/aws-sdk/clients/kendra.d.ts +157 -4
  127. package/node_modules/aws-sdk/clients/lightsail.d.ts +40 -0
  128. package/node_modules/aws-sdk/clients/lookoutmetrics.d.ts +126 -5
  129. package/node_modules/aws-sdk/clients/m2.d.ts +1840 -0
  130. package/node_modules/aws-sdk/clients/m2.js +18 -0
  131. package/node_modules/aws-sdk/clients/mediaconvert.d.ts +89 -9
  132. package/node_modules/aws-sdk/clients/neptune.d.ts +233 -0
  133. package/node_modules/aws-sdk/clients/networkmanager.d.ts +56 -10
  134. package/node_modules/aws-sdk/clients/outposts.d.ts +94 -0
  135. package/node_modules/aws-sdk/clients/personalize.d.ts +12 -8
  136. package/node_modules/aws-sdk/clients/proton.d.ts +492 -72
  137. package/node_modules/aws-sdk/clients/quicksight.d.ts +37 -5
  138. package/node_modules/aws-sdk/clients/redshift.d.ts +41 -1
  139. package/node_modules/aws-sdk/clients/redshiftdata.d.ts +51 -14
  140. package/node_modules/aws-sdk/clients/redshiftserverless.d.ts +1525 -0
  141. package/node_modules/aws-sdk/clients/redshiftserverless.js +18 -0
  142. package/node_modules/aws-sdk/clients/route53.d.ts +267 -7
  143. package/node_modules/aws-sdk/clients/sagemaker.d.ts +53 -24
  144. package/node_modules/aws-sdk/clients/secretsmanager.d.ts +7 -7
  145. package/node_modules/aws-sdk/clients/securityhub.d.ts +1020 -19
  146. package/node_modules/aws-sdk/clients/servicecatalogappregistry.d.ts +49 -2
  147. package/node_modules/aws-sdk/clients/transcribeservice.d.ts +479 -447
  148. package/node_modules/aws-sdk/clients/transfer.d.ts +9 -4
  149. package/node_modules/aws-sdk/clients/voiceid.d.ts +55 -24
  150. package/node_modules/aws-sdk/clients/workspaces.d.ts +10 -10
  151. package/node_modules/aws-sdk/dist/aws-sdk-core-react-native.js +737 -241
  152. package/node_modules/aws-sdk/dist/aws-sdk-react-native.js +2697 -1828
  153. package/node_modules/aws-sdk/dist/aws-sdk.js +2319 -517
  154. package/node_modules/aws-sdk/dist/aws-sdk.min.js +91 -91
  155. package/node_modules/aws-sdk/lib/config_service_placeholders.d.ts +8 -0
  156. package/node_modules/aws-sdk/lib/core.js +1 -1
  157. package/node_modules/aws-sdk/lib/dynamodb/document_client.d.ts +11 -11
  158. package/node_modules/aws-sdk/lib/event_listeners.js +18 -0
  159. package/node_modules/aws-sdk/lib/util.js +15 -7
  160. package/node_modules/aws-sdk/package.json +2 -2
  161. package/node_modules/jszip/.github/workflows/pr.yaml +5 -6
  162. package/node_modules/jszip/CHANGES.md +5 -0
  163. package/node_modules/jszip/README.markdown +1 -3
  164. package/node_modules/jszip/dist/jszip.js +194 -13
  165. package/node_modules/jszip/dist/jszip.min.js +4 -4
  166. package/node_modules/jszip/index.d.ts +1 -1
  167. package/node_modules/jszip/lib/index.js +1 -1
  168. package/node_modules/jszip/lib/license_header.js +2 -2
  169. package/node_modules/jszip/lib/utils.js +1 -1
  170. package/node_modules/jszip/package.json +2 -2
  171. package/node_modules/jszip/vendor/FileSaver.js +1 -1
  172. package/node_modules/setimmediate/LICENSE.txt +20 -0
  173. package/node_modules/setimmediate/package.json +30 -0
  174. package/node_modules/setimmediate/setImmediate.js +186 -0
  175. package/node_modules/uuid/CHANGELOG.md +132 -44
  176. package/node_modules/uuid/CONTRIBUTING.md +20 -0
  177. package/node_modules/uuid/LICENSE.md +1 -1
  178. package/node_modules/uuid/README.md +298 -152
  179. package/node_modules/uuid/dist/bin/uuid +2 -0
  180. package/node_modules/uuid/dist/bytesToUuid.js +26 -0
  181. package/node_modules/uuid/dist/esm-browser/bytesToUuid.js +18 -0
  182. package/node_modules/uuid/dist/esm-browser/index.js +4 -0
  183. package/node_modules/uuid/dist/esm-browser/md5.js +218 -0
  184. package/node_modules/uuid/dist/esm-browser/rng.js +15 -0
  185. package/node_modules/uuid/dist/esm-browser/sha1.js +91 -0
  186. package/node_modules/uuid/{v1.js → dist/esm-browser/v1.js} +34 -48
  187. package/node_modules/uuid/dist/esm-browser/v3.js +4 -0
  188. package/node_modules/uuid/dist/esm-browser/v35.js +56 -0
  189. package/node_modules/uuid/dist/esm-browser/v4.js +27 -0
  190. package/node_modules/uuid/dist/esm-browser/v5.js +4 -0
  191. package/node_modules/uuid/dist/esm-node/bytesToUuid.js +18 -0
  192. package/node_modules/uuid/dist/esm-node/index.js +4 -0
  193. package/node_modules/uuid/dist/esm-node/md5.js +13 -0
  194. package/node_modules/uuid/dist/esm-node/rng.js +4 -0
  195. package/node_modules/uuid/dist/esm-node/sha1.js +13 -0
  196. package/node_modules/uuid/dist/esm-node/v1.js +95 -0
  197. package/node_modules/uuid/dist/esm-node/v3.js +4 -0
  198. package/node_modules/uuid/{lib → dist/esm-node}/v35.js +21 -22
  199. package/node_modules/uuid/dist/esm-node/v4.js +27 -0
  200. package/node_modules/uuid/dist/esm-node/v5.js +4 -0
  201. package/node_modules/uuid/dist/index.js +39 -0
  202. package/node_modules/uuid/{lib → dist}/md5-browser.js +58 -50
  203. package/node_modules/uuid/dist/md5.js +23 -0
  204. package/node_modules/uuid/dist/rng-browser.js +21 -0
  205. package/node_modules/uuid/dist/rng.js +14 -0
  206. package/node_modules/uuid/dist/sha1-browser.js +95 -0
  207. package/node_modules/uuid/dist/sha1.js +23 -0
  208. package/node_modules/uuid/dist/umd/uuid.min.js +1 -0
  209. package/node_modules/uuid/dist/umd/uuidv1.min.js +1 -0
  210. package/node_modules/uuid/dist/umd/uuidv3.min.js +1 -0
  211. package/node_modules/uuid/dist/umd/uuidv4.min.js +1 -0
  212. package/node_modules/uuid/dist/umd/uuidv5.min.js +1 -0
  213. package/node_modules/uuid/dist/uuid-bin.js +67 -0
  214. package/node_modules/uuid/dist/v1.js +107 -0
  215. package/node_modules/uuid/dist/v3.js +16 -0
  216. package/node_modules/uuid/dist/v35.js +69 -0
  217. package/node_modules/uuid/dist/v4.js +40 -0
  218. package/node_modules/uuid/dist/v5.js +16 -0
  219. package/node_modules/uuid/package.json +92 -19
  220. package/node_modules/uuid/wrapper.mjs +5 -0
  221. package/package.json +15 -15
  222. package/lib/ecr-sync.d.ts.map +0 -1
  223. package/lib/image.d.ts.map +0 -1
  224. package/lib/index.d.ts.map +0 -1
  225. package/lib/lambda/docker-adapter.d.ts.map +0 -1
  226. package/lib/lambda/ecr-adapter.d.ts.map +0 -1
  227. package/lib/lambda/get-image-tags-handler.d.ts.map +0 -1
  228. package/node_modules/set-immediate-shim/index.js +0 -7
  229. package/node_modules/set-immediate-shim/package.json +0 -34
  230. package/node_modules/set-immediate-shim/readme.md +0 -31
  231. package/node_modules/uuid/.eslintrc.json +0 -47
  232. package/node_modules/uuid/AUTHORS +0 -5
  233. package/node_modules/uuid/README_js.md +0 -280
  234. package/node_modules/uuid/bin/uuid +0 -65
  235. package/node_modules/uuid/index.js +0 -8
  236. package/node_modules/uuid/lib/bytesToUuid.js +0 -24
  237. package/node_modules/uuid/lib/md5.js +0 -25
  238. package/node_modules/uuid/lib/rng-browser.js +0 -34
  239. package/node_modules/uuid/lib/rng.js +0 -8
  240. package/node_modules/uuid/lib/sha1-browser.js +0 -89
  241. package/node_modules/uuid/lib/sha1.js +0 -25
  242. package/node_modules/uuid/v3.js +0 -4
  243. package/node_modules/uuid/v4.js +0 -29
  244. package/node_modules/uuid/v5.js +0 -3
  245. package/releasetag.txt +0 -1
  246. package/version.txt +0 -1
@@ -60,11 +60,11 @@ declare class CognitoIdentityServiceProvider extends Service {
60
60
  */
61
61
  adminDeleteUserAttributes(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminDeleteUserAttributesResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminDeleteUserAttributesResponse, AWSError>;
62
62
  /**
63
- * Prevents the user from signing in with the specified external (SAML or social) identity provider. If the user that you want to deactivate is a Amazon Cognito user pools native username + password user, they can't use their password to sign in. If the user to deactivate is a linked external identity provider (IdP) user, any link between that user and an existing user is removed. When the external user signs in again, and the user is no longer attached to the previously linked DestinationUser, the user must create a new user account. See AdminLinkProviderForUser. This action is enabled only for admin access and requires developer credentials. The ProviderName must match the value specified when creating an IdP for the pool. To deactivate a native username + password user, the ProviderName value must be Cognito and the ProviderAttributeName must be Cognito_Subject. The ProviderAttributeValue must be the name that is used in the user pool for the user. The ProviderAttributeName must always be Cognito_Subject for social identity providers. The ProviderAttributeValue must always be the exact subject that was used when the user was originally linked as a source user. For de-linking a SAML identity, there are two scenarios. If the linked identity has not yet been used to sign in, the ProviderAttributeName and ProviderAttributeValue must be the same values that were used for the SourceUser when the identities were originally linked using AdminLinkProviderForUser call. (If the linking was done with ProviderAttributeName set to Cognito_Subject, the same applies here). However, if the user has already signed in, the ProviderAttributeName must be Cognito_Subject and ProviderAttributeValue must be the subject of the SAML assertion.
63
+ * Prevents the user from signing in with the specified external (SAML or social) identity provider (IdP). If the user that you want to deactivate is a Amazon Cognito user pools native username + password user, they can't use their password to sign in. If the user to deactivate is a linked external IdP user, any link between that user and an existing user is removed. When the external user signs in again, and the user is no longer attached to the previously linked DestinationUser, the user must create a new user account. See AdminLinkProviderForUser. This action is enabled only for admin access and requires developer credentials. The ProviderName must match the value specified when creating an IdP for the pool. To deactivate a native username + password user, the ProviderName value must be Cognito and the ProviderAttributeName must be Cognito_Subject. The ProviderAttributeValue must be the name that is used in the user pool for the user. The ProviderAttributeName must always be Cognito_Subject for social IdPs. The ProviderAttributeValue must always be the exact subject that was used when the user was originally linked as a source user. For de-linking a SAML identity, there are two scenarios. If the linked identity has not yet been used to sign in, the ProviderAttributeName and ProviderAttributeValue must be the same values that were used for the SourceUser when the identities were originally linked using AdminLinkProviderForUser call. (If the linking was done with ProviderAttributeName set to Cognito_Subject, the same applies here). However, if the user has already signed in, the ProviderAttributeName must be Cognito_Subject and ProviderAttributeValue must be the subject of the SAML assertion.
64
64
  */
65
65
  adminDisableProviderForUser(params: CognitoIdentityServiceProvider.Types.AdminDisableProviderForUserRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminDisableProviderForUserResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminDisableProviderForUserResponse, AWSError>;
66
66
  /**
67
- * Prevents the user from signing in with the specified external (SAML or social) identity provider. If the user that you want to deactivate is a Amazon Cognito user pools native username + password user, they can't use their password to sign in. If the user to deactivate is a linked external identity provider (IdP) user, any link between that user and an existing user is removed. When the external user signs in again, and the user is no longer attached to the previously linked DestinationUser, the user must create a new user account. See AdminLinkProviderForUser. This action is enabled only for admin access and requires developer credentials. The ProviderName must match the value specified when creating an IdP for the pool. To deactivate a native username + password user, the ProviderName value must be Cognito and the ProviderAttributeName must be Cognito_Subject. The ProviderAttributeValue must be the name that is used in the user pool for the user. The ProviderAttributeName must always be Cognito_Subject for social identity providers. The ProviderAttributeValue must always be the exact subject that was used when the user was originally linked as a source user. For de-linking a SAML identity, there are two scenarios. If the linked identity has not yet been used to sign in, the ProviderAttributeName and ProviderAttributeValue must be the same values that were used for the SourceUser when the identities were originally linked using AdminLinkProviderForUser call. (If the linking was done with ProviderAttributeName set to Cognito_Subject, the same applies here). However, if the user has already signed in, the ProviderAttributeName must be Cognito_Subject and ProviderAttributeValue must be the subject of the SAML assertion.
67
+ * Prevents the user from signing in with the specified external (SAML or social) identity provider (IdP). If the user that you want to deactivate is a Amazon Cognito user pools native username + password user, they can't use their password to sign in. If the user to deactivate is a linked external IdP user, any link between that user and an existing user is removed. When the external user signs in again, and the user is no longer attached to the previously linked DestinationUser, the user must create a new user account. See AdminLinkProviderForUser. This action is enabled only for admin access and requires developer credentials. The ProviderName must match the value specified when creating an IdP for the pool. To deactivate a native username + password user, the ProviderName value must be Cognito and the ProviderAttributeName must be Cognito_Subject. The ProviderAttributeValue must be the name that is used in the user pool for the user. The ProviderAttributeName must always be Cognito_Subject for social IdPs. The ProviderAttributeValue must always be the exact subject that was used when the user was originally linked as a source user. For de-linking a SAML identity, there are two scenarios. If the linked identity has not yet been used to sign in, the ProviderAttributeName and ProviderAttributeValue must be the same values that were used for the SourceUser when the identities were originally linked using AdminLinkProviderForUser call. (If the linking was done with ProviderAttributeName set to Cognito_Subject, the same applies here). However, if the user has already signed in, the ProviderAttributeName must be Cognito_Subject and ProviderAttributeValue must be the subject of the SAML assertion.
68
68
  */
69
69
  adminDisableProviderForUser(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminDisableProviderForUserResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminDisableProviderForUserResponse, AWSError>;
70
70
  /**
@@ -116,11 +116,11 @@ declare class CognitoIdentityServiceProvider extends Service {
116
116
  */
117
117
  adminInitiateAuth(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminInitiateAuthResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminInitiateAuthResponse, AWSError>;
118
118
  /**
119
- * Links an existing user account in a user pool (DestinationUser) to an identity from an external identity provider (SourceUser) based on a specified attribute name and value from the external identity provider. This allows you to create a link from the existing user account to an external federated user identity that has not yet been used to sign in. You can then use the federated user identity to sign in as the existing user account. For example, if there is an existing user with a username and password, this API links that user to a federated user identity. When the user signs in with a federated user identity, they sign in as the existing user account. The maximum number of federated identities linked to a user is 5. Because this API allows a user with an external federated identity to sign in as an existing user in the user pool, it is critical that it only be used with external identity providers and provider attributes that have been trusted by the application owner. This action is administrative and requires developer credentials.
119
+ * Links an existing user account in a user pool (DestinationUser) to an identity from an external IdP (SourceUser) based on a specified attribute name and value from the external IdP. This allows you to create a link from the existing user account to an external federated user identity that has not yet been used to sign in. You can then use the federated user identity to sign in as the existing user account. For example, if there is an existing user with a username and password, this API links that user to a federated user identity. When the user signs in with a federated user identity, they sign in as the existing user account. The maximum number of federated identities linked to a user is five. Because this API allows a user with an external federated identity to sign in as an existing user in the user pool, it is critical that it only be used with external IdPs and provider attributes that have been trusted by the application owner. This action is administrative and requires developer credentials.
120
120
  */
121
121
  adminLinkProviderForUser(params: CognitoIdentityServiceProvider.Types.AdminLinkProviderForUserRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminLinkProviderForUserResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminLinkProviderForUserResponse, AWSError>;
122
122
  /**
123
- * Links an existing user account in a user pool (DestinationUser) to an identity from an external identity provider (SourceUser) based on a specified attribute name and value from the external identity provider. This allows you to create a link from the existing user account to an external federated user identity that has not yet been used to sign in. You can then use the federated user identity to sign in as the existing user account. For example, if there is an existing user with a username and password, this API links that user to a federated user identity. When the user signs in with a federated user identity, they sign in as the existing user account. The maximum number of federated identities linked to a user is 5. Because this API allows a user with an external federated identity to sign in as an existing user in the user pool, it is critical that it only be used with external identity providers and provider attributes that have been trusted by the application owner. This action is administrative and requires developer credentials.
123
+ * Links an existing user account in a user pool (DestinationUser) to an identity from an external IdP (SourceUser) based on a specified attribute name and value from the external IdP. This allows you to create a link from the existing user account to an external federated user identity that has not yet been used to sign in. You can then use the federated user identity to sign in as the existing user account. For example, if there is an existing user with a username and password, this API links that user to a federated user identity. When the user signs in with a federated user identity, they sign in as the existing user account. The maximum number of federated identities linked to a user is five. Because this API allows a user with an external federated identity to sign in as an existing user in the user pool, it is critical that it only be used with external IdPs and provider attributes that have been trusted by the application owner. This action is administrative and requires developer credentials.
124
124
  */
125
125
  adminLinkProviderForUser(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminLinkProviderForUserResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminLinkProviderForUserResponse, AWSError>;
126
126
  /**
@@ -220,19 +220,19 @@ declare class CognitoIdentityServiceProvider extends Service {
220
220
  */
221
221
  adminUpdateUserAttributes(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminUpdateUserAttributesResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminUpdateUserAttributesResponse, AWSError>;
222
222
  /**
223
- * Signs out users from all devices, as an administrator. It also invalidates all refresh tokens issued to a user. The user's current access and Id tokens remain valid until their expiry. Access and Id tokens expire one hour after they're issued. Calling this action requires developer credentials.
223
+ * Signs out a user from all devices. You must sign AdminUserGlobalSignOut requests with Amazon Web Services credentials. It also invalidates all refresh tokens that Amazon Cognito has issued to a user. The user's current access and ID tokens remain valid until they expire. By default, access and ID tokens expire one hour after they're issued. A user can still use a hosted UI cookie to retrieve new tokens for the duration of the cookie validity period of 1 hour. Calling this action requires developer credentials.
224
224
  */
225
225
  adminUserGlobalSignOut(params: CognitoIdentityServiceProvider.Types.AdminUserGlobalSignOutRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminUserGlobalSignOutResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminUserGlobalSignOutResponse, AWSError>;
226
226
  /**
227
- * Signs out users from all devices, as an administrator. It also invalidates all refresh tokens issued to a user. The user's current access and Id tokens remain valid until their expiry. Access and Id tokens expire one hour after they're issued. Calling this action requires developer credentials.
227
+ * Signs out a user from all devices. You must sign AdminUserGlobalSignOut requests with Amazon Web Services credentials. It also invalidates all refresh tokens that Amazon Cognito has issued to a user. The user's current access and ID tokens remain valid until they expire. By default, access and ID tokens expire one hour after they're issued. A user can still use a hosted UI cookie to retrieve new tokens for the duration of the cookie validity period of 1 hour. Calling this action requires developer credentials.
228
228
  */
229
229
  adminUserGlobalSignOut(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminUserGlobalSignOutResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminUserGlobalSignOutResponse, AWSError>;
230
230
  /**
231
- * Returns a unique generated shared secret key code for the user account. The request takes an access token or a session string, but not both. Calling AssociateSoftwareToken immediately disassociates the existing software token from the user account. If the user doesn't subsequently verify the software token, their account is set up to authenticate without MFA. If MFA config is set to Optional at the user pool level, the user can then log in without MFA. However, if MFA is set to Required for the user pool, the user is asked to set up a new software token MFA during sign-in.
231
+ * Begins setup of time-based one-time password multi-factor authentication (TOTP MFA) for a user, with a unique private key that Amazon Cognito generates and returns in the API response. You can authorize an AssociateSoftwareToken request with either the user's access token, or a session string from a challenge response that you received from Amazon Cognito. Amazon Cognito disassociates an existing software token when you verify the new token in a VerifySoftwareToken API request. If you don't verify the software token and your user pool doesn't require MFA, the user can then authenticate with user name and password credentials alone. If your user pool requires TOTP MFA, Amazon Cognito generates an MFA_SETUP or SOFTWARE_TOKEN_SETUP challenge each time your user signs. Complete setup with AssociateSoftwareToken and VerifySoftwareToken. After you set up software token MFA for your user, Amazon Cognito generates a SOFTWARE_TOKEN_MFA challenge when they authenticate. Respond to this challenge with your user's TOTP.
232
232
  */
233
233
  associateSoftwareToken(params: CognitoIdentityServiceProvider.Types.AssociateSoftwareTokenRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AssociateSoftwareTokenResponse) => void): Request<CognitoIdentityServiceProvider.Types.AssociateSoftwareTokenResponse, AWSError>;
234
234
  /**
235
- * Returns a unique generated shared secret key code for the user account. The request takes an access token or a session string, but not both. Calling AssociateSoftwareToken immediately disassociates the existing software token from the user account. If the user doesn't subsequently verify the software token, their account is set up to authenticate without MFA. If MFA config is set to Optional at the user pool level, the user can then log in without MFA. However, if MFA is set to Required for the user pool, the user is asked to set up a new software token MFA during sign-in.
235
+ * Begins setup of time-based one-time password multi-factor authentication (TOTP MFA) for a user, with a unique private key that Amazon Cognito generates and returns in the API response. You can authorize an AssociateSoftwareToken request with either the user's access token, or a session string from a challenge response that you received from Amazon Cognito. Amazon Cognito disassociates an existing software token when you verify the new token in a VerifySoftwareToken API request. If you don't verify the software token and your user pool doesn't require MFA, the user can then authenticate with user name and password credentials alone. If your user pool requires TOTP MFA, Amazon Cognito generates an MFA_SETUP or SOFTWARE_TOKEN_SETUP challenge each time your user signs. Complete setup with AssociateSoftwareToken and VerifySoftwareToken. After you set up software token MFA for your user, Amazon Cognito generates a SOFTWARE_TOKEN_MFA challenge when they authenticate. Respond to this challenge with your user's TOTP.
236
236
  */
237
237
  associateSoftwareToken(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AssociateSoftwareTokenResponse) => void): Request<CognitoIdentityServiceProvider.Types.AssociateSoftwareTokenResponse, AWSError>;
238
238
  /**
@@ -260,11 +260,11 @@ declare class CognitoIdentityServiceProvider extends Service {
260
260
  */
261
261
  confirmForgotPassword(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ConfirmForgotPasswordResponse) => void): Request<CognitoIdentityServiceProvider.Types.ConfirmForgotPasswordResponse, AWSError>;
262
262
  /**
263
- * Confirms registration of a user and handles the existing alias from a previous user.
263
+ * Confirms registration of a new user.
264
264
  */
265
265
  confirmSignUp(params: CognitoIdentityServiceProvider.Types.ConfirmSignUpRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ConfirmSignUpResponse) => void): Request<CognitoIdentityServiceProvider.Types.ConfirmSignUpResponse, AWSError>;
266
266
  /**
267
- * Confirms registration of a user and handles the existing alias from a previous user.
267
+ * Confirms registration of a new user.
268
268
  */
269
269
  confirmSignUp(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ConfirmSignUpResponse) => void): Request<CognitoIdentityServiceProvider.Types.ConfirmSignUpResponse, AWSError>;
270
270
  /**
@@ -276,11 +276,11 @@ declare class CognitoIdentityServiceProvider extends Service {
276
276
  */
277
277
  createGroup(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.CreateGroupResponse) => void): Request<CognitoIdentityServiceProvider.Types.CreateGroupResponse, AWSError>;
278
278
  /**
279
- * Creates an identity provider for a user pool.
279
+ * Creates an IdP for a user pool.
280
280
  */
281
281
  createIdentityProvider(params: CognitoIdentityServiceProvider.Types.CreateIdentityProviderRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.CreateIdentityProviderResponse) => void): Request<CognitoIdentityServiceProvider.Types.CreateIdentityProviderResponse, AWSError>;
282
282
  /**
283
- * Creates an identity provider for a user pool.
283
+ * Creates an IdP for a user pool.
284
284
  */
285
285
  createIdentityProvider(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.CreateIdentityProviderResponse) => void): Request<CognitoIdentityServiceProvider.Types.CreateIdentityProviderResponse, AWSError>;
286
286
  /**
@@ -332,11 +332,11 @@ declare class CognitoIdentityServiceProvider extends Service {
332
332
  */
333
333
  deleteGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
334
334
  /**
335
- * Deletes an identity provider for a user pool.
335
+ * Deletes an IdP for a user pool.
336
336
  */
337
337
  deleteIdentityProvider(params: CognitoIdentityServiceProvider.Types.DeleteIdentityProviderRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
338
338
  /**
339
- * Deletes an identity provider for a user pool.
339
+ * Deletes an IdP for a user pool.
340
340
  */
341
341
  deleteIdentityProvider(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
342
342
  /**
@@ -388,11 +388,11 @@ declare class CognitoIdentityServiceProvider extends Service {
388
388
  */
389
389
  deleteUserPoolDomain(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.DeleteUserPoolDomainResponse) => void): Request<CognitoIdentityServiceProvider.Types.DeleteUserPoolDomainResponse, AWSError>;
390
390
  /**
391
- * Gets information about a specific identity provider.
391
+ * Gets information about a specific IdP.
392
392
  */
393
393
  describeIdentityProvider(params: CognitoIdentityServiceProvider.Types.DescribeIdentityProviderRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.DescribeIdentityProviderResponse) => void): Request<CognitoIdentityServiceProvider.Types.DescribeIdentityProviderResponse, AWSError>;
394
394
  /**
395
- * Gets information about a specific identity provider.
395
+ * Gets information about a specific IdP.
396
396
  */
397
397
  describeIdentityProvider(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.DescribeIdentityProviderResponse) => void): Request<CognitoIdentityServiceProvider.Types.DescribeIdentityProviderResponse, AWSError>;
398
398
  /**
@@ -484,11 +484,11 @@ declare class CognitoIdentityServiceProvider extends Service {
484
484
  */
485
485
  getGroup(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.GetGroupResponse) => void): Request<CognitoIdentityServiceProvider.Types.GetGroupResponse, AWSError>;
486
486
  /**
487
- * Gets the specified identity provider.
487
+ * Gets the specified IdP.
488
488
  */
489
489
  getIdentityProviderByIdentifier(params: CognitoIdentityServiceProvider.Types.GetIdentityProviderByIdentifierRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.GetIdentityProviderByIdentifierResponse) => void): Request<CognitoIdentityServiceProvider.Types.GetIdentityProviderByIdentifierResponse, AWSError>;
490
490
  /**
491
- * Gets the specified identity provider.
491
+ * Gets the specified IdP.
492
492
  */
493
493
  getIdentityProviderByIdentifier(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.GetIdentityProviderByIdentifierResponse) => void): Request<CognitoIdentityServiceProvider.Types.GetIdentityProviderByIdentifierResponse, AWSError>;
494
494
  /**
@@ -516,11 +516,11 @@ declare class CognitoIdentityServiceProvider extends Service {
516
516
  */
517
517
  getUser(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.GetUserResponse) => void): Request<CognitoIdentityServiceProvider.Types.GetUserResponse, AWSError>;
518
518
  /**
519
- * Gets the user attribute verification code for the specified attribute name. This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in. If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
519
+ * Generates a user attribute verification code for the specified attribute name. Sends a message to a user with a code that they must return in a VerifyUserAttribute request. This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in. If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
520
520
  */
521
521
  getUserAttributeVerificationCode(params: CognitoIdentityServiceProvider.Types.GetUserAttributeVerificationCodeRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.GetUserAttributeVerificationCodeResponse) => void): Request<CognitoIdentityServiceProvider.Types.GetUserAttributeVerificationCodeResponse, AWSError>;
522
522
  /**
523
- * Gets the user attribute verification code for the specified attribute name. This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in. If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
523
+ * Generates a user attribute verification code for the specified attribute name. Sends a message to a user with a code that they must return in a VerifyUserAttribute request. This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in. If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
524
524
  */
525
525
  getUserAttributeVerificationCode(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.GetUserAttributeVerificationCodeResponse) => void): Request<CognitoIdentityServiceProvider.Types.GetUserAttributeVerificationCodeResponse, AWSError>;
526
526
  /**
@@ -532,27 +532,27 @@ declare class CognitoIdentityServiceProvider extends Service {
532
532
  */
533
533
  getUserPoolMfaConfig(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.GetUserPoolMfaConfigResponse) => void): Request<CognitoIdentityServiceProvider.Types.GetUserPoolMfaConfigResponse, AWSError>;
534
534
  /**
535
- * Signs out users from all devices. It also invalidates all refresh tokens issued to a user. The user's current access and ID tokens remain valid until their expiry. Access and Id tokens expire one hour after they're issued.
535
+ * Signs out users from all devices. It also invalidates all refresh tokens that Amazon Cognito has issued to a user. The user's current access and ID tokens remain valid until their expiry. By default, access and ID tokens expire one hour after Amazon Cognito issues them. A user can still use a hosted UI cookie to retrieve new tokens for the duration of the cookie validity period of 1 hour.
536
536
  */
537
537
  globalSignOut(params: CognitoIdentityServiceProvider.Types.GlobalSignOutRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.GlobalSignOutResponse) => void): Request<CognitoIdentityServiceProvider.Types.GlobalSignOutResponse, AWSError>;
538
538
  /**
539
- * Signs out users from all devices. It also invalidates all refresh tokens issued to a user. The user's current access and ID tokens remain valid until their expiry. Access and Id tokens expire one hour after they're issued.
539
+ * Signs out users from all devices. It also invalidates all refresh tokens that Amazon Cognito has issued to a user. The user's current access and ID tokens remain valid until their expiry. By default, access and ID tokens expire one hour after Amazon Cognito issues them. A user can still use a hosted UI cookie to retrieve new tokens for the duration of the cookie validity period of 1 hour.
540
540
  */
541
541
  globalSignOut(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.GlobalSignOutResponse) => void): Request<CognitoIdentityServiceProvider.Types.GlobalSignOutResponse, AWSError>;
542
542
  /**
543
- * Initiates the authentication flow. This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in. If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
543
+ * Initiates sign-in for a user in the Amazon Cognito user directory. You can't sign in a user with a federated IdP with InitiateAuth. For more information, see Adding user pool sign-in through a third party. This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in. If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
544
544
  */
545
545
  initiateAuth(params: CognitoIdentityServiceProvider.Types.InitiateAuthRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.InitiateAuthResponse) => void): Request<CognitoIdentityServiceProvider.Types.InitiateAuthResponse, AWSError>;
546
546
  /**
547
- * Initiates the authentication flow. This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in. If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
547
+ * Initiates sign-in for a user in the Amazon Cognito user directory. You can't sign in a user with a federated IdP with InitiateAuth. For more information, see Adding user pool sign-in through a third party. This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in. If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
548
548
  */
549
549
  initiateAuth(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.InitiateAuthResponse) => void): Request<CognitoIdentityServiceProvider.Types.InitiateAuthResponse, AWSError>;
550
550
  /**
551
- * Lists the devices.
551
+ * Lists the sign-in devices that Amazon Cognito has registered to the current user.
552
552
  */
553
553
  listDevices(params: CognitoIdentityServiceProvider.Types.ListDevicesRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ListDevicesResponse) => void): Request<CognitoIdentityServiceProvider.Types.ListDevicesResponse, AWSError>;
554
554
  /**
555
- * Lists the devices.
555
+ * Lists the sign-in devices that Amazon Cognito has registered to the current user.
556
556
  */
557
557
  listDevices(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ListDevicesResponse) => void): Request<CognitoIdentityServiceProvider.Types.ListDevicesResponse, AWSError>;
558
558
  /**
@@ -564,11 +564,11 @@ declare class CognitoIdentityServiceProvider extends Service {
564
564
  */
565
565
  listGroups(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ListGroupsResponse) => void): Request<CognitoIdentityServiceProvider.Types.ListGroupsResponse, AWSError>;
566
566
  /**
567
- * Lists information about all identity providers for a user pool.
567
+ * Lists information about all IdPs for a user pool.
568
568
  */
569
569
  listIdentityProviders(params: CognitoIdentityServiceProvider.Types.ListIdentityProvidersRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ListIdentityProvidersResponse) => void): Request<CognitoIdentityServiceProvider.Types.ListIdentityProvidersResponse, AWSError>;
570
570
  /**
571
- * Lists information about all identity providers for a user pool.
571
+ * Lists information about all IdPs for a user pool.
572
572
  */
573
573
  listIdentityProviders(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ListIdentityProvidersResponse) => void): Request<CognitoIdentityServiceProvider.Types.ListIdentityProvidersResponse, AWSError>;
574
574
  /**
@@ -756,11 +756,11 @@ declare class CognitoIdentityServiceProvider extends Service {
756
756
  */
757
757
  updateGroup(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.UpdateGroupResponse) => void): Request<CognitoIdentityServiceProvider.Types.UpdateGroupResponse, AWSError>;
758
758
  /**
759
- * Updates identity provider information for a user pool.
759
+ * Updates IdP information for a user pool.
760
760
  */
761
761
  updateIdentityProvider(params: CognitoIdentityServiceProvider.Types.UpdateIdentityProviderRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.UpdateIdentityProviderResponse) => void): Request<CognitoIdentityServiceProvider.Types.UpdateIdentityProviderResponse, AWSError>;
762
762
  /**
763
- * Updates identity provider information for a user pool.
763
+ * Updates IdP information for a user pool.
764
764
  */
765
765
  updateIdentityProvider(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.UpdateIdentityProviderResponse) => void): Request<CognitoIdentityServiceProvider.Types.UpdateIdentityProviderResponse, AWSError>;
766
766
  /**
@@ -780,11 +780,11 @@ declare class CognitoIdentityServiceProvider extends Service {
780
780
  */
781
781
  updateUserAttributes(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.UpdateUserAttributesResponse) => void): Request<CognitoIdentityServiceProvider.Types.UpdateUserAttributesResponse, AWSError>;
782
782
  /**
783
- * Updates the specified user pool with the specified attributes. You can get a list of the current user pool settings using DescribeUserPool. If you don't provide a value for an attribute, it will be set to the default value. This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in. If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
783
+ * Updates the specified user pool with the specified attributes. You can get a list of the current user pool settings using DescribeUserPool. If you don't provide a value for an attribute, it will be set to the default value. This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in. If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
784
784
  */
785
785
  updateUserPool(params: CognitoIdentityServiceProvider.Types.UpdateUserPoolRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.UpdateUserPoolResponse) => void): Request<CognitoIdentityServiceProvider.Types.UpdateUserPoolResponse, AWSError>;
786
786
  /**
787
- * Updates the specified user pool with the specified attributes. You can get a list of the current user pool settings using DescribeUserPool. If you don't provide a value for an attribute, it will be set to the default value. This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in. If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
787
+ * Updates the specified user pool with the specified attributes. You can get a list of the current user pool settings using DescribeUserPool. If you don't provide a value for an attribute, it will be set to the default value. This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in. If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
788
788
  */
789
789
  updateUserPool(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.UpdateUserPoolResponse) => void): Request<CognitoIdentityServiceProvider.Types.UpdateUserPoolResponse, AWSError>;
790
790
  /**
@@ -812,11 +812,11 @@ declare class CognitoIdentityServiceProvider extends Service {
812
812
  */
813
813
  verifySoftwareToken(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.VerifySoftwareTokenResponse) => void): Request<CognitoIdentityServiceProvider.Types.VerifySoftwareTokenResponse, AWSError>;
814
814
  /**
815
- * Verifies the specified user attributes in the user pool.
815
+ * Verifies the specified user attributes in the user pool. If your user pool requires verification before Amazon Cognito updates the attribute value, VerifyUserAttribute updates the affected attribute to its pending value. For more information, see UserAttributeUpdateSettingsType.
816
816
  */
817
817
  verifyUserAttribute(params: CognitoIdentityServiceProvider.Types.VerifyUserAttributeRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.VerifyUserAttributeResponse) => void): Request<CognitoIdentityServiceProvider.Types.VerifyUserAttributeResponse, AWSError>;
818
818
  /**
819
- * Verifies the specified user attributes in the user pool.
819
+ * Verifies the specified user attributes in the user pool. If your user pool requires verification before Amazon Cognito updates the attribute value, VerifyUserAttribute updates the affected attribute to its pending value. For more information, see UserAttributeUpdateSettingsType.
820
820
  */
821
821
  verifyUserAttribute(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.VerifyUserAttributeResponse) => void): Request<CognitoIdentityServiceProvider.Types.VerifyUserAttributeResponse, AWSError>;
822
822
  }
@@ -836,7 +836,7 @@ declare namespace CognitoIdentityServiceProvider {
836
836
  */
837
837
  Notify: AccountTakeoverActionNotifyType;
838
838
  /**
839
- * The action to take in response to the account takeover action. Valid values are: BLOCK Choosing this action will block the request. MFA_IF_CONFIGURED Present an MFA challenge if user has configured it, else allow the request. MFA_REQUIRED Present an MFA challenge if user has configured it, else block the request. NO_ACTION Allow the user to sign in.
839
+ * The action to take in response to the account takeover action. Valid values are as follows: BLOCK Choosing this action will block the request. MFA_IF_CONFIGURED Present an MFA challenge if user has configured it, else allow the request. MFA_REQUIRED Present an MFA challenge if user has configured it, else block the request. NO_ACTION Allow the user to sign in.
840
840
  */
841
841
  EventAction: AccountTakeoverEventActionType;
842
842
  }
@@ -913,7 +913,7 @@ declare namespace CognitoIdentityServiceProvider {
913
913
  */
914
914
  AllowAdminCreateUserOnly?: BooleanType;
915
915
  /**
916
- * The user account expiration limit, in days, after which the account is no longer usable. To reset the account after that time limit, you must call AdminCreateUser again, specifying "RESEND" for the MessageAction parameter. The default value for this parameter is 7. If you set a value for TemporaryPasswordValidityDays in PasswordPolicy, that value will be used, and UnusedAccountValidityDays will be no longer be an available parameter for that user pool.
916
+ * The user account expiration limit, in days, after which a new account that hasn't signed in is no longer usable. To reset the account after that time limit, you must call AdminCreateUser again, specifying "RESEND" for the MessageAction parameter. The default value for this parameter is 7. If you set a value for TemporaryPasswordValidityDays in PasswordPolicy, that value will be used, and UnusedAccountValidityDays will be no longer be an available parameter for that user pool.
917
917
  */
918
918
  UnusedAccountValidityDays?: AdminCreateUserUnusedAccountValidityDaysType;
919
919
  /**
@@ -1136,13 +1136,13 @@ declare namespace CognitoIdentityServiceProvider {
1136
1136
  */
1137
1137
  AnalyticsMetadata?: AnalyticsMetadataType;
1138
1138
  /**
1139
- * Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
1139
+ * Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
1140
1140
  */
1141
1141
  ContextData?: ContextDataType;
1142
1142
  }
1143
1143
  export interface AdminInitiateAuthResponse {
1144
1144
  /**
1145
- * The name of the challenge that you're responding to with this call. This is returned in the AdminInitiateAuth response if you must pass another challenge. MFA_SETUP: If MFA is required, users who don't have at least one of the MFA methods set up are presented with an MFA_SETUP challenge. The user must set up at least one MFA type to continue to authenticate. SELECT_MFA_TYPE: Selects the MFA type. Valid MFA options are SMS_MFA for text SMS MFA, and SOFTWARE_TOKEN_MFA for time-based one-time password (TOTP) software token MFA. SMS_MFA: Next challenge is to supply an SMS_MFA_CODE, delivered via SMS. PASSWORD_VERIFIER: Next challenge is to supply PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP after the client-side SRP calculations. CUSTOM_CHALLENGE: This is returned if your custom authentication flow determines that the user should pass another challenge before tokens are issued. DEVICE_SRP_AUTH: If device tracking was activated in your user pool and the previous challenges were passed, this challenge is returned so that Amazon Cognito can start tracking this device. DEVICE_PASSWORD_VERIFIER: Similar to PASSWORD_VERIFIER, but for devices only. ADMIN_NO_SRP_AUTH: This is returned if you must authenticate with USERNAME and PASSWORD directly. An app client must be enabled to use this flow. NEW_PASSWORD_REQUIRED: For users who are required to change their passwords after successful first login. This challenge should be passed with NEW_PASSWORD and any other required attributes. MFA_SETUP: For users who are required to set up an MFA factor before they can sign in. The MFA types activated for the user pool will be listed in the challenge parameters MFA_CAN_SETUP value. To set up software token MFA, use the session returned here from InitiateAuth as an input to AssociateSoftwareToken, and use the session returned by VerifySoftwareToken as an input to RespondToAuthChallenge with challenge name MFA_SETUP to complete sign-in. To set up SMS MFA, users will need help from an administrator to add a phone number to their account and then call InitiateAuth again to restart sign-in.
1145
+ * The name of the challenge that you're responding to with this call. This is returned in the AdminInitiateAuth response if you must pass another challenge. MFA_SETUP: If MFA is required, users who don't have at least one of the MFA methods set up are presented with an MFA_SETUP challenge. The user must set up at least one MFA type to continue to authenticate. SELECT_MFA_TYPE: Selects the MFA type. Valid MFA options are SMS_MFA for text SMS MFA, and SOFTWARE_TOKEN_MFA for time-based one-time password (TOTP) software token MFA. SMS_MFA: Next challenge is to supply an SMS_MFA_CODE, delivered via SMS. PASSWORD_VERIFIER: Next challenge is to supply PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP after the client-side SRP calculations. CUSTOM_CHALLENGE: This is returned if your custom authentication flow determines that the user should pass another challenge before tokens are issued. DEVICE_SRP_AUTH: If device tracking was activated in your user pool and the previous challenges were passed, this challenge is returned so that Amazon Cognito can start tracking this device. DEVICE_PASSWORD_VERIFIER: Similar to PASSWORD_VERIFIER, but for devices only. ADMIN_NO_SRP_AUTH: This is returned if you must authenticate with USERNAME and PASSWORD directly. An app client must be enabled to use this flow. NEW_PASSWORD_REQUIRED: For users who are required to change their passwords after successful first login. Respond to this challenge with NEW_PASSWORD and any required attributes that Amazon Cognito returned in the requiredAttributes parameter. You can also set values for attributes that aren't required by your user pool and that your app client can write. For more information, see AdminRespondToAuthChallenge. In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value. In AdminRespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the requiredAttributes parameter, then use the AdminUpdateUserAttributes API operation to modify the value of any additional attributes. MFA_SETUP: For users who are required to set up an MFA factor before they can sign in. The MFA types activated for the user pool will be listed in the challenge parameters MFA_CAN_SETUP value. To set up software token MFA, use the session returned here from InitiateAuth as an input to AssociateSoftwareToken, and use the session returned by VerifySoftwareToken as an input to RespondToAuthChallenge with challenge name MFA_SETUP to complete sign-in. To set up SMS MFA, users will need help from an administrator to add a phone number to their account and then call InitiateAuth again to restart sign-in.
1146
1146
  */
1147
1147
  ChallengeName?: ChallengeNameType;
1148
1148
  /**
@@ -1164,11 +1164,11 @@ declare namespace CognitoIdentityServiceProvider {
1164
1164
  */
1165
1165
  UserPoolId: StringType;
1166
1166
  /**
1167
- * The existing user in the user pool that you want to assign to the external identity provider user account. This user can be a native (Username + Password) Amazon Cognito user pools user or a federated user (for example, a SAML or Facebook user). If the user doesn't exist, Amazon Cognito generates an exception. Amazon Cognito returns this user when the new user (with the linked identity provider attribute) signs in. For a native username + password user, the ProviderAttributeValue for the DestinationUser should be the username in the user pool. For a federated user, it should be the provider-specific user_id. The ProviderAttributeName of the DestinationUser is ignored. The ProviderName should be set to Cognito for users in Cognito user pools. All attributes in the DestinationUser profile must be mutable. If you have assigned the user any immutable custom attributes, the operation won't succeed.
1167
+ * The existing user in the user pool that you want to assign to the external IdP user account. This user can be a native (Username + Password) Amazon Cognito user pools user or a federated user (for example, a SAML or Facebook user). If the user doesn't exist, Amazon Cognito generates an exception. Amazon Cognito returns this user when the new user (with the linked IdP attribute) signs in. For a native username + password user, the ProviderAttributeValue for the DestinationUser should be the username in the user pool. For a federated user, it should be the provider-specific user_id. The ProviderAttributeName of the DestinationUser is ignored. The ProviderName should be set to Cognito for users in Cognito user pools. All attributes in the DestinationUser profile must be mutable. If you have assigned the user any immutable custom attributes, the operation won't succeed.
1168
1168
  */
1169
1169
  DestinationUser: ProviderUserIdentifierType;
1170
1170
  /**
1171
- * An external identity provider account for a user who doesn't exist yet in the user pool. This user must be a federated user (for example, a SAML or Facebook user), not another native user. If the SourceUser is using a federated social identity provider, such as Facebook, Google, or Login with Amazon, you must set the ProviderAttributeName to Cognito_Subject. For social identity providers, the ProviderName will be Facebook, Google, or LoginWithAmazon, and Amazon Cognito will automatically parse the Facebook, Google, and Login with Amazon tokens for id, sub, and user_id, respectively. The ProviderAttributeValue for the user must be the same value as the id, sub, or user_id value found in the social identity provider token. For SAML, the ProviderAttributeName can be any value that matches a claim in the SAML assertion. If you want to link SAML users based on the subject of the SAML assertion, you should map the subject to a claim through the SAML identity provider and submit that claim name as the ProviderAttributeName. If you set ProviderAttributeName to Cognito_Subject, Amazon Cognito will automatically parse the default unique identifier found in the subject from the SAML token.
1171
+ * An external IdP account for a user who doesn't exist yet in the user pool. This user must be a federated user (for example, a SAML or Facebook user), not another native user. If the SourceUser is using a federated social IdP, such as Facebook, Google, or Login with Amazon, you must set the ProviderAttributeName to Cognito_Subject. For social IdPs, the ProviderName will be Facebook, Google, or LoginWithAmazon, and Amazon Cognito will automatically parse the Facebook, Google, and Login with Amazon tokens for id, sub, and user_id, respectively. The ProviderAttributeValue for the user must be the same value as the id, sub, or user_id value found in the social IdP token. For SAML, the ProviderAttributeName can be any value that matches a claim in the SAML assertion. If you want to link SAML users based on the subject of the SAML assertion, you should map the subject to a claim through the SAML IdP and submit that claim name as the ProviderAttributeName. If you set ProviderAttributeName to Cognito_Subject, Amazon Cognito will automatically parse the default unique identifier found in the subject from the SAML token.
1172
1172
  */
1173
1173
  SourceUser: ProviderUserIdentifierType;
1174
1174
  }
@@ -1302,7 +1302,7 @@ declare namespace CognitoIdentityServiceProvider {
1302
1302
  */
1303
1303
  ChallengeName: ChallengeNameType;
1304
1304
  /**
1305
- * The challenge responses. These are inputs corresponding to the value of ChallengeName, for example: SMS_MFA: SMS_MFA_CODE, USERNAME, SECRET_HASH (if app client is configured with client secret). PASSWORD_VERIFIER: PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, TIMESTAMP, USERNAME, SECRET_HASH (if app client is configured with client secret). PASSWORD_VERIFIER requires DEVICE_KEY when signing in with a remembered device. ADMIN_NO_SRP_AUTH: PASSWORD, USERNAME, SECRET_HASH (if app client is configured with client secret). NEW_PASSWORD_REQUIRED: NEW_PASSWORD, any other required attributes, USERNAME, SECRET_HASH (if app client is configured with client secret). MFA_SETUP requires USERNAME, plus you must use the session value returned by VerifySoftwareToken in the Session parameter. The value of the USERNAME attribute must be the user's actual username, not an alias (such as an email address or phone number). To make this simpler, the AdminInitiateAuth response includes the actual username value in the USERNAMEUSER_ID_FOR_SRP attribute. This happens even if you specified an alias in your call to AdminInitiateAuth.
1305
+ * The challenge responses. These are inputs corresponding to the value of ChallengeName, for example: SMS_MFA: SMS_MFA_CODE, USERNAME, SECRET_HASH (if app client is configured with client secret). PASSWORD_VERIFIER: PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, TIMESTAMP, USERNAME, SECRET_HASH (if app client is configured with client secret). PASSWORD_VERIFIER requires DEVICE_KEY when signing in with a remembered device. ADMIN_NO_SRP_AUTH: PASSWORD, USERNAME, SECRET_HASH (if app client is configured with client secret). NEW_PASSWORD_REQUIRED: NEW_PASSWORD, USERNAME, SECRET_HASH (if app client is configured with client secret). To set any required attributes that Amazon Cognito returned as requiredAttributes in the AdminInitiateAuth response, add a userAttributes.attributename parameter. This parameter can also set values for writable attributes that aren't required by your user pool. In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value. In AdminRespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the requiredAttributes parameter, then use the AdminUpdateUserAttributes API operation to modify the value of any additional attributes. MFA_SETUP requires USERNAME, plus you must use the session value returned by VerifySoftwareToken in the Session parameter. The value of the USERNAME attribute must be the user's actual username, not an alias (such as an email address or phone number). To make this simpler, the AdminInitiateAuth response includes the actual username value in the USERNAMEUSER_ID_FOR_SRP attribute. This happens even if you specified an alias in your call to AdminInitiateAuth.
1306
1306
  */
1307
1307
  ChallengeResponses?: ChallengeResponsesType;
1308
1308
  /**
@@ -1314,7 +1314,7 @@ declare namespace CognitoIdentityServiceProvider {
1314
1314
  */
1315
1315
  AnalyticsMetadata?: AnalyticsMetadataType;
1316
1316
  /**
1317
- * Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
1317
+ * Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
1318
1318
  */
1319
1319
  ContextData?: ContextDataType;
1320
1320
  /**
@@ -1446,7 +1446,7 @@ declare namespace CognitoIdentityServiceProvider {
1446
1446
  */
1447
1447
  Username: UsernameType;
1448
1448
  /**
1449
- * An array of name-value pairs representing user attributes. For custom attributes, you must prepend the custom: prefix to the attribute name.
1449
+ * An array of name-value pairs representing user attributes. For custom attributes, you must prepend the custom: prefix to the attribute name. If your user pool requires verification before Amazon Cognito updates an attribute value that you specify in this request, Amazon Cognito doesn’t immediately update the value of that attribute. After your user receives and responds to a verification message to verify the new value, Amazon Cognito updates the attribute value. Your user can sign in and receive messages with the original attribute value until they verify the new value. To update the value of an attribute that requires verification in the same API request, include the email_verified or phone_number_verified attribute, with a value of true. If you set the email_verified or phone_number_verified value for an email or phone_number attribute that requires verification to true, Amazon Cognito doesn’t send a verification message to your user.
1450
1450
  */
1451
1451
  UserAttributes: AttributeListType;
1452
1452
  /**
@@ -1477,7 +1477,7 @@ declare namespace CognitoIdentityServiceProvider {
1477
1477
  */
1478
1478
  ApplicationId?: HexStringType;
1479
1479
  /**
1480
- * The Amazon Resource Name (ARN) of an Amazon Pinpoint project. You can use the Amazon Pinpoint project to integrate with the chosen user pool Client. Amazon Cognito publishes events to the Amazon Pinpointproject declared by the app ARN.
1480
+ * The Amazon Resource Name (ARN) of an Amazon Pinpoint project. You can use the Amazon Pinpoint project to integrate with the chosen user pool Client. Amazon Cognito publishes events to the Amazon Pinpoint project that the app ARN declares.
1481
1481
  */
1482
1482
  ApplicationArn?: ArnType;
1483
1483
  /**
@@ -1489,7 +1489,7 @@ declare namespace CognitoIdentityServiceProvider {
1489
1489
  */
1490
1490
  ExternalId?: StringType;
1491
1491
  /**
1492
- * If UserDataShared is true, Amazon Cognito will include user data in the events it publishes to Amazon Pinpoint analytics.
1492
+ * If UserDataShared is true, Amazon Cognito includes user data in the events that it publishes to Amazon Pinpoint analytics.
1493
1493
  */
1494
1494
  UserDataShared?: BooleanType;
1495
1495
  }
@@ -1502,7 +1502,7 @@ declare namespace CognitoIdentityServiceProvider {
1502
1502
  export type ArnType = string;
1503
1503
  export interface AssociateSoftwareTokenRequest {
1504
1504
  /**
1505
- * The access token.
1505
+ * A valid access token that Amazon Cognito issued to the user whose software token you want to generate.
1506
1506
  */
1507
1507
  AccessToken?: TokenModelType;
1508
1508
  /**
@@ -1537,6 +1537,7 @@ declare namespace CognitoIdentityServiceProvider {
1537
1537
  Value?: AttributeValueType;
1538
1538
  }
1539
1539
  export type AttributeValueType = string;
1540
+ export type AttributesRequireVerificationBeforeUpdateType = VerifiedAttributeType[];
1540
1541
  export interface AuthEventType {
1541
1542
  /**
1542
1543
  * The event ID.
@@ -1576,7 +1577,7 @@ declare namespace CognitoIdentityServiceProvider {
1576
1577
  export type AuthParametersType = {[key: string]: StringType};
1577
1578
  export interface AuthenticationResultType {
1578
1579
  /**
1579
- * The access token.
1580
+ * A valid access token that Amazon Cognito issued to the user who you want to authenticate.
1580
1581
  */
1581
1582
  AccessToken?: TokenModelType;
1582
1583
  /**
@@ -1631,7 +1632,7 @@ declare namespace CognitoIdentityServiceProvider {
1631
1632
  */
1632
1633
  ProposedPassword: PasswordType;
1633
1634
  /**
1634
- * The access token.
1635
+ * A valid access token that Amazon Cognito issued to the user whose password you want to change.
1635
1636
  */
1636
1637
  AccessToken: TokenModelType;
1637
1638
  }
@@ -1646,15 +1647,15 @@ declare namespace CognitoIdentityServiceProvider {
1646
1647
  export type CodeDeliveryDetailsListType = CodeDeliveryDetailsType[];
1647
1648
  export interface CodeDeliveryDetailsType {
1648
1649
  /**
1649
- * The destination for the code delivery details.
1650
+ * The email address or phone number destination where Amazon Cognito sent the code.
1650
1651
  */
1651
1652
  Destination?: StringType;
1652
1653
  /**
1653
- * The delivery medium (email message or phone number).
1654
+ * The method that Amazon Cognito used to send the code.
1654
1655
  */
1655
1656
  DeliveryMedium?: DeliveryMediumType;
1656
1657
  /**
1657
- * The attribute name.
1658
+ * The name of the attribute that Amazon Cognito verifies with the code.
1658
1659
  */
1659
1660
  AttributeName?: AttributeNameType;
1660
1661
  }
@@ -1678,7 +1679,7 @@ declare namespace CognitoIdentityServiceProvider {
1678
1679
  }
1679
1680
  export interface ConfirmDeviceRequest {
1680
1681
  /**
1681
- * The access token.
1682
+ * A valid access token that Amazon Cognito issued to the user whose device you want to confirm.
1682
1683
  */
1683
1684
  AccessToken: TokenModelType;
1684
1685
  /**
@@ -1726,7 +1727,7 @@ declare namespace CognitoIdentityServiceProvider {
1726
1727
  */
1727
1728
  AnalyticsMetadata?: AnalyticsMetadataType;
1728
1729
  /**
1729
- * Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
1730
+ * Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
1730
1731
  */
1731
1732
  UserContextData?: UserContextDataType;
1732
1733
  /**
@@ -1762,7 +1763,7 @@ declare namespace CognitoIdentityServiceProvider {
1762
1763
  */
1763
1764
  AnalyticsMetadata?: AnalyticsMetadataType;
1764
1765
  /**
1765
- * Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
1766
+ * Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
1766
1767
  */
1767
1768
  UserContextData?: UserContextDataType;
1768
1769
  /**
@@ -1775,7 +1776,7 @@ declare namespace CognitoIdentityServiceProvider {
1775
1776
  export type ConfirmationCodeType = string;
1776
1777
  export interface ContextDataType {
1777
1778
  /**
1778
- * Source IP address of your user.
1779
+ * The source IP address of your user's device.
1779
1780
  */
1780
1781
  IpAddress: StringType;
1781
1782
  /**
@@ -1791,7 +1792,7 @@ declare namespace CognitoIdentityServiceProvider {
1791
1792
  */
1792
1793
  HttpHeaders: HttpHeaderList;
1793
1794
  /**
1794
- * Encoded data containing device fingerprinting details collected using the Amazon Cognito context data collection library.
1795
+ * Encoded device-fingerprint details that your app collected with the Amazon Cognito context data collection library. For more information, see Adding user device and session data to API requests.
1795
1796
  */
1796
1797
  EncodedData?: StringType;
1797
1798
  }
@@ -1813,7 +1814,7 @@ declare namespace CognitoIdentityServiceProvider {
1813
1814
  */
1814
1815
  RoleArn?: ArnType;
1815
1816
  /**
1816
- * A non-negative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. Zero is the highest precedence value. Groups with lower Precedence values take precedence over groups with higher ornull Precedence values. If a user belongs to two or more groups, it is the group with the lowest precedence value whose role ARN is given in the user's tokens for the cognito:roles and cognito:preferred_role claims. Two groups can have the same Precedence value. If this happens, neither group takes precedence over the other. If two groups with the same Precedence have the same role ARN, that role is used in the cognito:preferred_role claim in tokens for users in each group. If the two groups have different role ARNs, the cognito:preferred_role claim isn't set in users' tokens. The default Precedence value is null.
1817
+ * A non-negative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. Zero is the highest precedence value. Groups with lower Precedence values take precedence over groups with higher or null Precedence values. If a user belongs to two or more groups, it is the group with the lowest precedence value whose role ARN is given in the user's tokens for the cognito:roles and cognito:preferred_role claims. Two groups can have the same Precedence value. If this happens, neither group takes precedence over the other. If two groups with the same Precedence have the same role ARN, that role is used in the cognito:preferred_role claim in tokens for users in each group. If the two groups have different role ARNs, the cognito:preferred_role claim isn't set in users' tokens. The default Precedence value is null. The maximum Precedence value is 2^31-1.
1817
1818
  */
1818
1819
  Precedence?: PrecedenceType;
1819
1820
  }
@@ -1829,29 +1830,29 @@ declare namespace CognitoIdentityServiceProvider {
1829
1830
  */
1830
1831
  UserPoolId: UserPoolIdType;
1831
1832
  /**
1832
- * The identity provider name.
1833
+ * The IdP name.
1833
1834
  */
1834
1835
  ProviderName: ProviderNameTypeV1;
1835
1836
  /**
1836
- * The identity provider type.
1837
+ * The IdP type.
1837
1838
  */
1838
1839
  ProviderType: IdentityProviderTypeType;
1839
1840
  /**
1840
- * The identity provider details. The following list describes the provider detail keys for each identity provider type. For Google and Login with Amazon: client_id client_secret authorize_scopes For Facebook: client_id client_secret authorize_scopes api_version For Sign in with Apple: client_id team_id key_id private_key authorize_scopes For OpenID Connect (OIDC) providers: client_id client_secret attributes_request_method oidc_issuer authorize_scopes authorize_url if not available from discovery URL specified by oidc_issuer key token_url if not available from discovery URL specified by oidc_issuer key attributes_url if not available from discovery URL specified by oidc_issuer key jwks_uri if not available from discovery URL specified by oidc_issuer key attributes_url_add_attributes a read-only property that is set automatically For SAML providers: MetadataFile OR MetadataURL IDPSignout (optional)
1841
+ * The IdP details. The following list describes the provider detail keys for each IdP type. For Google and Login with Amazon: client_id client_secret authorize_scopes For Facebook: client_id client_secret authorize_scopes api_version For Sign in with Apple: client_id team_id key_id private_key authorize_scopes For OpenID Connect (OIDC) providers: client_id client_secret attributes_request_method oidc_issuer authorize_scopes The following keys are only present if Amazon Cognito didn't discover them at the oidc_issuer URL. authorize_url token_url attributes_url jwks_uri Amazon Cognito sets the value of the following keys automatically. They are read-only. attributes_url_add_attributes For SAML providers: MetadataFile or MetadataURL IDPSignout optional
1841
1842
  */
1842
1843
  ProviderDetails: ProviderDetailsType;
1843
1844
  /**
1844
- * A mapping of identity provider attributes to standard and custom user pool attributes.
1845
+ * A mapping of IdP attributes to standard and custom user pool attributes.
1845
1846
  */
1846
1847
  AttributeMapping?: AttributeMappingType;
1847
1848
  /**
1848
- * A list of identity provider identifiers.
1849
+ * A list of IdP identifiers.
1849
1850
  */
1850
1851
  IdpIdentifiers?: IdpIdentifiersListType;
1851
1852
  }
1852
1853
  export interface CreateIdentityProviderResponse {
1853
1854
  /**
1854
- * The newly created identity provider object.
1855
+ * The newly created IdP object.
1855
1856
  */
1856
1857
  IdentityProvider: IdentityProviderType;
1857
1858
  }
@@ -1913,19 +1914,19 @@ declare namespace CognitoIdentityServiceProvider {
1913
1914
  */
1914
1915
  GenerateSecret?: GenerateSecret;
1915
1916
  /**
1916
- * The time limit, in days, after which the refresh token is no longer valid and can't be used.
1917
+ * The refresh token time limit. After this limit expires, your user can't use their refresh token. To specify the time unit for RefreshTokenValidity as seconds, minutes, hours, or days, set a TokenValidityUnits value in your API request. For example, when you set RefreshTokenValidity as 10 and TokenValidityUnits as days, your user can refresh their session and retrieve new access and ID tokens for 10 days. The default time unit for RefreshTokenValidity in an API request is days. You can't set RefreshTokenValidity to 0. If you do, Amazon Cognito overrides the value with the default value of 30 days. Valid range is displayed below in seconds.
1917
1918
  */
1918
1919
  RefreshTokenValidity?: RefreshTokenValidityType;
1919
1920
  /**
1920
- * The time limit, between 5 minutes and 1 day, after which the access token is no longer valid and can't be used. If you supply a TokenValidityUnits value, you will override the default time unit.
1921
+ * The access token time limit. After this limit expires, your user can't use their access token. To specify the time unit for AccessTokenValidity as seconds, minutes, hours, or days, set a TokenValidityUnits value in your API request. For example, when you set AccessTokenValidity to 10 and TokenValidityUnits to hours, your user can authorize access with their access token for 10 hours. The default time unit for AccessTokenValidity in an API request is hours. Valid range is displayed below in seconds.
1921
1922
  */
1922
1923
  AccessTokenValidity?: AccessTokenValidityType;
1923
1924
  /**
1924
- * The time limit, between 5 minutes and 1 day, after which the access token is no longer valid and can't be used. If you supply a TokenValidityUnits value, you will override the default time unit.
1925
+ * The ID token time limit. After this limit expires, your user can't use their ID token. To specify the time unit for IdTokenValidity as seconds, minutes, hours, or days, set a TokenValidityUnits value in your API request. For example, when you set IdTokenValidity as 10 and TokenValidityUnits as hours, your user can authenticate their session with their ID token for 10 hours. The default time unit for AccessTokenValidity in an API request is hours. Valid range is displayed below in seconds.
1925
1926
  */
1926
1927
  IdTokenValidity?: IdTokenValidityType;
1927
1928
  /**
1928
- * The units in which the validity times are represented. Default for RefreshToken is days, and default for ID and access tokens are hours.
1929
+ * The units in which the validity times are represented. The default unit for RefreshToken is days, and default for ID and access tokens are hours.
1929
1930
  */
1930
1931
  TokenValidityUnits?: TokenValidityUnitsType;
1931
1932
  /**
@@ -1933,23 +1934,23 @@ declare namespace CognitoIdentityServiceProvider {
1933
1934
  */
1934
1935
  ReadAttributes?: ClientPermissionListType;
1935
1936
  /**
1936
- * The user pool attributes that the app client can write to. If your app client allows users to sign in through an identity provider, this array must include all attributes that you have mapped to identity provider attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an identity provider. If your app client does not have write access to a mapped attribute, Amazon Cognito throws an error when it tries to update the attribute. For more information, see Specifying Identity Provider Attribute Mappings for Your user pool.
1937
+ * The user pool attributes that the app client can write to. If your app client allows users to sign in through an IdP, this array must include all attributes that you have mapped to IdP attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If your app client does not have write access to a mapped attribute, Amazon Cognito throws an error when it tries to update the attribute. For more information, see Specifying IdP Attribute Mappings for Your user pool.
1937
1938
  */
1938
1939
  WriteAttributes?: ClientPermissionListType;
1939
1940
  /**
1940
- * The authentication flows that are supported by the user pool clients. Flow names without the ALLOW_ prefix are no longer supported, in favor of new names with the ALLOW_ prefix. Values with ALLOW_ prefix must be used only along with the ALLOW_ prefix. Valid values include: ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication flow ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH setting. With this authentication flow, Amazon Cognito receives the password in the request instead of using the Secure Remote Password (SRP) protocol to verify passwords. ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication. ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Amazon Cognito receives the password in the request instead of using the SRP protocol to verify passwords. ALLOW_USER_SRP_AUTH: Enable SRP-based authentication. ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.
1941
+ * The authentication flows that are supported by the user pool clients. Flow names without the ALLOW_ prefix are no longer supported, in favor of new names with the ALLOW_ prefix. Values with ALLOW_ prefix must be used only along with the ALLOW_ prefix. Valid values include: ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication flow ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH setting. With this authentication flow, Amazon Cognito receives the password in the request instead of using the Secure Remote Password (SRP) protocol to verify passwords. ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication. ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Amazon Cognito receives the password in the request instead of using the SRP protocol to verify passwords. ALLOW_USER_SRP_AUTH: Enable SRP-based authentication. ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens. If you don't specify a value for ExplicitAuthFlows, your app client activates the ALLOW_USER_SRP_AUTH and ALLOW_CUSTOM_AUTH authentication flows.
1941
1942
  */
1942
1943
  ExplicitAuthFlows?: ExplicitAuthFlowsListType;
1943
1944
  /**
1944
- * A list of provider names for the identity providers that are supported on this client. The following are supported: COGNITO, Facebook, Google and LoginWithAmazon.
1945
+ * A list of provider names for the IdPs that this client supports. The following are supported: COGNITO, Facebook, Google LoginWithAmazon, and the names of your own SAML and OIDC providers.
1945
1946
  */
1946
1947
  SupportedIdentityProviders?: SupportedIdentityProvidersListType;
1947
1948
  /**
1948
- * A list of allowed redirect (callback) URLs for the identity providers. A redirect URI must: Be an absolute URI. Be registered with the authorization server. Not include a fragment component. See OAuth 2.0 - Redirection Endpoint. Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only. App callback URLs such as myapp://example are also supported.
1949
+ * A list of allowed redirect (callback) URLs for the IdPs. A redirect URI must: Be an absolute URI. Be registered with the authorization server. Not include a fragment component. See OAuth 2.0 - Redirection Endpoint. Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only. App callback URLs such as myapp://example are also supported.
1949
1950
  */
1950
1951
  CallbackURLs?: CallbackURLsListType;
1951
1952
  /**
1952
- * A list of allowed logout URLs for the identity providers.
1953
+ * A list of allowed logout URLs for the IdPs.
1953
1954
  */
1954
1955
  LogoutURLs?: LogoutURLsListType;
1955
1956
  /**
@@ -1957,11 +1958,11 @@ declare namespace CognitoIdentityServiceProvider {
1957
1958
  */
1958
1959
  DefaultRedirectURI?: RedirectUrlType;
1959
1960
  /**
1960
- * The allowed OAuth flows. Set to code to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint. Set to implicit to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly. Set to client_credentials to specify that the client should get the access token (and, optionally, ID token, based on scopes) from the token endpoint using a combination of client and client_secret.
1961
+ * The allowed OAuth flows. code Use a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the /oauth2/token endpoint. implicit Issue the access token (and, optionally, ID token, based on scopes) directly to your user. client_credentials Issue the access token from the /oauth2/token endpoint directly to a non-person user using a combination of the client ID and client secret.
1961
1962
  */
1962
1963
  AllowedOAuthFlows?: OAuthFlowsType;
1963
1964
  /**
1964
- * The allowed OAuth scopes. Possible values provided by OAuth are: phone, email, openid, and profile. Possible values provided by Amazon Web Services are: aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are also supported.
1965
+ * The allowed OAuth scopes. Possible values provided by OAuth are phone, email, openid, and profile. Possible values provided by Amazon Web Services are aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are also supported.
1965
1966
  */
1966
1967
  AllowedOAuthScopes?: ScopeListType;
1967
1968
  /**
@@ -1980,6 +1981,10 @@ declare namespace CognitoIdentityServiceProvider {
1980
1981
  * Activates or deactivates token revocation. For more information about revoking tokens, see RevokeToken. If you don't include this parameter, token revocation is automatically activated for the new user pool client.
1981
1982
  */
1982
1983
  EnableTokenRevocation?: WrappedBooleanType;
1984
+ /**
1985
+ * Activates the propagation of additional user context data. For more information about propagation of user context data, see Adding advanced security to a user pool. If you don’t include this parameter, you can't send device fingerprint information, including source IP address, to Amazon Cognito advanced security. You can only activate EnablePropagateAdditionalUserContextData in an app client that has a client secret.
1986
+ */
1987
+ EnablePropagateAdditionalUserContextData?: WrappedBooleanType;
1983
1988
  }
1984
1989
  export interface CreateUserPoolClientResponse {
1985
1990
  /**
@@ -2056,6 +2061,10 @@ declare namespace CognitoIdentityServiceProvider {
2056
2061
  * Specifies MFA configuration details.
2057
2062
  */
2058
2063
  MfaConfiguration?: UserPoolMfaType;
2064
+ /**
2065
+ * The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see Verifying updates to to email addresses and phone numbers.
2066
+ */
2067
+ UserAttributeUpdateSettings?: UserAttributeUpdateSettingsType;
2059
2068
  /**
2060
2069
  * The device configuration.
2061
2070
  */
@@ -2147,7 +2156,7 @@ declare namespace CognitoIdentityServiceProvider {
2147
2156
  */
2148
2157
  UserPoolId: UserPoolIdType;
2149
2158
  /**
2150
- * The identity provider name.
2159
+ * The IdP name.
2151
2160
  */
2152
2161
  ProviderName: ProviderNameType;
2153
2162
  }
@@ -2167,7 +2176,7 @@ declare namespace CognitoIdentityServiceProvider {
2167
2176
  */
2168
2177
  UserAttributeNames: AttributeNameListType;
2169
2178
  /**
2170
- * The access token used in the request to delete user attributes.
2179
+ * A valid access token that Amazon Cognito issued to the user whose attributes you want to delete.
2171
2180
  */
2172
2181
  AccessToken: TokenModelType;
2173
2182
  }
@@ -2203,7 +2212,7 @@ declare namespace CognitoIdentityServiceProvider {
2203
2212
  }
2204
2213
  export interface DeleteUserRequest {
2205
2214
  /**
2206
- * The access token from a request to delete a user.
2215
+ * A valid access token that Amazon Cognito issued to the user whose user profile you want to delete.
2207
2216
  */
2208
2217
  AccessToken: TokenModelType;
2209
2218
  }
@@ -2215,13 +2224,13 @@ declare namespace CognitoIdentityServiceProvider {
2215
2224
  */
2216
2225
  UserPoolId: UserPoolIdType;
2217
2226
  /**
2218
- * The identity provider name.
2227
+ * The IdP name.
2219
2228
  */
2220
2229
  ProviderName: ProviderNameType;
2221
2230
  }
2222
2231
  export interface DescribeIdentityProviderResponse {
2223
2232
  /**
2224
- * The identity provider that was deleted.
2233
+ * The IdP that was deleted.
2225
2234
  */
2226
2235
  IdentityProvider: IdentityProviderType;
2227
2236
  }
@@ -2334,7 +2343,7 @@ declare namespace CognitoIdentityServiceProvider {
2334
2343
  */
2335
2344
  PasswordVerifier?: StringType;
2336
2345
  /**
2337
- * The salt.
2346
+ * The salt
2338
2347
  */
2339
2348
  Salt?: StringType;
2340
2349
  }
@@ -2408,7 +2417,7 @@ declare namespace CognitoIdentityServiceProvider {
2408
2417
  */
2409
2418
  ReplyToEmailAddress?: EmailAddressType;
2410
2419
  /**
2411
- * Specifies whether Amazon Cognito uses its built-in functionality to send your users email messages, or uses your Amazon Simple Email Service email configuration. Specify one of the following values: COGNITO_DEFAULT When Amazon Cognito emails your users, it uses its built-in email functionality. When you use the default option, Amazon Cognito allows only a limited number of emails each day for your user pool. For typical production environments, the default email limit is less than the required delivery volume. To achieve a higher delivery volume, specify DEVELOPER to use your Amazon SES email configuration. To look up the email delivery limit for the default option, see Limits in in the Developer Guide. The default FROM address is no-reply@verificationemail.com. To customize the FROM address, provide the Amazon Resource Name (ARN) of an Amazon SES verified email address for the SourceArn parameter. If EmailSendingAccount is COGNITO_DEFAULT, you can't use the following parameters: EmailVerificationMessage EmailVerificationSubject InviteMessageTemplate.EmailMessage InviteMessageTemplate.EmailSubject VerificationMessageTemplate.EmailMessage VerificationMessageTemplate.EmailMessageByLink VerificationMessageTemplate.EmailSubject, VerificationMessageTemplate.EmailSubjectByLink DEVELOPER EmailSendingAccount is required. DEVELOPER When Amazon Cognito emails your users, it uses your Amazon SES configuration. Amazon Cognito calls Amazon SES on your behalf to send email from your verified email address. When you use this option, the email delivery limits are the same limits that apply to your Amazon SES verified email address in your Amazon Web Services account. If you use this option, you must provide the ARN of an Amazon SES verified email address for the SourceArn parameter. Before Amazon Cognito can email your users, it requires additional permissions to call Amazon SES on your behalf. When you update your user pool with this option, Amazon Cognito creates a service-linked role, which is a type of role, in your Amazon Web Services account. This role contains the permissions that allow to access Amazon SES and send email messages with your address. For more information about the service-linked role that Amazon Cognito creates, see Using Service-Linked Roles for Amazon Cognito in the Amazon Cognito Developer Guide.
2420
+ * Specifies whether Amazon Cognito uses its built-in functionality to send your users email messages, or uses your Amazon Simple Email Service email configuration. Specify one of the following values: COGNITO_DEFAULT When Amazon Cognito emails your users, it uses its built-in email functionality. When you use the default option, Amazon Cognito allows only a limited number of emails each day for your user pool. For typical production environments, the default email limit is less than the required delivery volume. To achieve a higher delivery volume, specify DEVELOPER to use your Amazon SES email configuration. To look up the email delivery limit for the default option, see Limits in in the Developer Guide. The default FROM address is no-reply@verificationemail.com. To customize the FROM address, provide the Amazon Resource Name (ARN) of an Amazon SES verified email address for the SourceArn parameter. DEVELOPER When Amazon Cognito emails your users, it uses your Amazon SES configuration. Amazon Cognito calls Amazon SES on your behalf to send email from your verified email address. When you use this option, the email delivery limits are the same limits that apply to your Amazon SES verified email address in your Amazon Web Services account. If you use this option, provide the ARN of an Amazon SES verified email address for the SourceArn parameter. Before Amazon Cognito can email your users, it requires additional permissions to call Amazon SES on your behalf. When you update your user pool with this option, Amazon Cognito creates a service-linked role, which is a type of role, in your Amazon Web Services account. This role contains the permissions that allow to access Amazon SES and send email messages with your address. For more information about the service-linked role that Amazon Cognito creates, see Using Service-Linked Roles for Amazon Cognito in the Amazon Cognito Developer Guide.
2412
2421
  */
2413
2422
  EmailSendingAccount?: EmailSendingAccountType;
2414
2423
  /**
@@ -2429,7 +2438,7 @@ declare namespace CognitoIdentityServiceProvider {
2429
2438
  export type EmailVerificationSubjectType = string;
2430
2439
  export interface EventContextDataType {
2431
2440
  /**
2432
- * The user's IP address.
2441
+ * The source IP address of your user's device.
2433
2442
  */
2434
2443
  IpAddress?: StringType;
2435
2444
  /**
@@ -2488,7 +2497,7 @@ declare namespace CognitoIdentityServiceProvider {
2488
2497
  export type ForceAliasCreation = boolean;
2489
2498
  export interface ForgetDeviceRequest {
2490
2499
  /**
2491
- * The access token for the forgotten device request.
2500
+ * A valid access token that Amazon Cognito issued to the user whose registered device you want to forget.
2492
2501
  */
2493
2502
  AccessToken?: TokenModelType;
2494
2503
  /**
@@ -2506,7 +2515,7 @@ declare namespace CognitoIdentityServiceProvider {
2506
2515
  */
2507
2516
  SecretHash?: SecretHashType;
2508
2517
  /**
2509
- * Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
2518
+ * Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
2510
2519
  */
2511
2520
  UserContextData?: UserContextDataType;
2512
2521
  /**
@@ -2514,7 +2523,7 @@ declare namespace CognitoIdentityServiceProvider {
2514
2523
  */
2515
2524
  Username: UsernameType;
2516
2525
  /**
2517
- * The Amazon Pinpoint analytics metadata for collecting metrics for ForgotPassword calls.
2526
+ * The Amazon Pinpoint analytics metadata that contributes to your metrics for ForgotPassword calls.
2518
2527
  */
2519
2528
  AnalyticsMetadata?: AnalyticsMetadataType;
2520
2529
  /**
@@ -2551,7 +2560,7 @@ declare namespace CognitoIdentityServiceProvider {
2551
2560
  */
2552
2561
  DeviceKey: DeviceKeyType;
2553
2562
  /**
2554
- * The access token.
2563
+ * A valid access token that Amazon Cognito issued to the user whose device information you want to request.
2555
2564
  */
2556
2565
  AccessToken?: TokenModelType;
2557
2566
  }
@@ -2583,13 +2592,13 @@ declare namespace CognitoIdentityServiceProvider {
2583
2592
  */
2584
2593
  UserPoolId: UserPoolIdType;
2585
2594
  /**
2586
- * The identity provider ID.
2595
+ * The IdP identifier.
2587
2596
  */
2588
2597
  IdpIdentifier: IdpIdentifierType;
2589
2598
  }
2590
2599
  export interface GetIdentityProviderByIdentifierResponse {
2591
2600
  /**
2592
- * The identity provider object.
2601
+ * The IdP object.
2593
2602
  */
2594
2603
  IdentityProvider: IdentityProviderType;
2595
2604
  }
@@ -2623,7 +2632,7 @@ declare namespace CognitoIdentityServiceProvider {
2623
2632
  }
2624
2633
  export interface GetUserAttributeVerificationCodeRequest {
2625
2634
  /**
2626
- * The access token returned by the server response to get the user attribute verification code.
2635
+ * A non-expired access token for the user whose attribute verification code you want to generate.
2627
2636
  */
2628
2637
  AccessToken: TokenModelType;
2629
2638
  /**
@@ -2663,7 +2672,7 @@ declare namespace CognitoIdentityServiceProvider {
2663
2672
  }
2664
2673
  export interface GetUserRequest {
2665
2674
  /**
2666
- * The access token returned by the server response to get information about the user.
2675
+ * A non-expired access token for the user whose information you want to query.
2667
2676
  */
2668
2677
  AccessToken: TokenModelType;
2669
2678
  }
@@ -2691,7 +2700,7 @@ declare namespace CognitoIdentityServiceProvider {
2691
2700
  }
2692
2701
  export interface GlobalSignOutRequest {
2693
2702
  /**
2694
- * The access token.
2703
+ * A valid access token that Amazon Cognito issued to the user who you want to sign out.
2695
2704
  */
2696
2705
  AccessToken: TokenModelType;
2697
2706
  }
@@ -2748,31 +2757,31 @@ declare namespace CognitoIdentityServiceProvider {
2748
2757
  */
2749
2758
  UserPoolId?: UserPoolIdType;
2750
2759
  /**
2751
- * The identity provider name.
2760
+ * The IdP name.
2752
2761
  */
2753
2762
  ProviderName?: ProviderNameType;
2754
2763
  /**
2755
- * The identity provider type.
2764
+ * The IdP type.
2756
2765
  */
2757
2766
  ProviderType?: IdentityProviderTypeType;
2758
2767
  /**
2759
- * The identity provider details. The following list describes the provider detail keys for each identity provider type. For Google and Login with Amazon: client_id client_secret authorize_scopes For Facebook: client_id client_secret authorize_scopes api_version For Sign in with Apple: client_id team_id key_id private_key authorize_scopes For OIDC providers: client_id client_secret attributes_request_method oidc_issuer authorize_scopes authorize_url if not available from discovery URL specified by oidc_issuer key token_url if not available from discovery URL specified by oidc_issuer key attributes_url if not available from discovery URL specified by oidc_issuer key jwks_uri if not available from discovery URL specified by oidc_issuer key attributes_url_add_attributes a read-only property that is set automatically For SAML providers: MetadataFile or MetadataURL IDPSignOut optional
2768
+ * The IdP details. The following list describes the provider detail keys for each IdP type. For Google and Login with Amazon: client_id client_secret authorize_scopes For Facebook: client_id client_secret authorize_scopes api_version For Sign in with Apple: client_id team_id key_id private_key You can submit a private_key when you add or update an IdP. Describe operations don't return the private key. authorize_scopes For OIDC providers: client_id client_secret attributes_request_method oidc_issuer authorize_scopes The following keys are only present if Amazon Cognito didn't discover them at the oidc_issuer URL. authorize_url token_url attributes_url jwks_uri Amazon Cognito sets the value of the following keys automatically. They are read-only. attributes_url_add_attributes For SAML providers: MetadataFile or MetadataURL IDPSignout optional
2760
2769
  */
2761
2770
  ProviderDetails?: ProviderDetailsType;
2762
2771
  /**
2763
- * A mapping of identity provider attributes to standard and custom user pool attributes.
2772
+ * A mapping of IdP attributes to standard and custom user pool attributes.
2764
2773
  */
2765
2774
  AttributeMapping?: AttributeMappingType;
2766
2775
  /**
2767
- * A list of identity provider identifiers.
2776
+ * A list of IdP identifiers.
2768
2777
  */
2769
2778
  IdpIdentifiers?: IdpIdentifiersListType;
2770
2779
  /**
2771
- * The date the identity provider was last modified.
2780
+ * The date the IdP was last modified.
2772
2781
  */
2773
2782
  LastModifiedDate?: DateType;
2774
2783
  /**
2775
- * The date the identity provider was created.
2784
+ * The date the IdP was created.
2776
2785
  */
2777
2786
  CreationDate?: DateType;
2778
2787
  }
@@ -2783,7 +2792,7 @@ declare namespace CognitoIdentityServiceProvider {
2783
2792
  export type ImageUrlType = string;
2784
2793
  export interface InitiateAuthRequest {
2785
2794
  /**
2786
- * The authentication flow for this call to run. The API action will depend on this value. For example: REFRESH_TOKEN_AUTH takes in a valid refresh token and returns new tokens. USER_SRP_AUTH takes in USERNAME and SRP_A and returns the SRP variables to be used for next challenge execution. USER_PASSWORD_AUTH takes in USERNAME and PASSWORD and returns the next challenge or tokens. Valid values include: USER_SRP_AUTH: Authentication flow for the Secure Remote Password (SRP) protocol. REFRESH_TOKEN_AUTH/REFRESH_TOKEN: Authentication flow for refreshing the access token and ID token by supplying a valid refresh token. CUSTOM_AUTH: Custom authentication flow. USER_PASSWORD_AUTH: Non-SRP authentication flow; USERNAME and PASSWORD are passed directly. If a user migration Lambda trigger is set, this flow will invoke the user migration Lambda if it doesn't find the USERNAME in the user pool. ADMIN_NO_SRP_AUTH isn't a valid value.
2795
+ * The authentication flow for this call to run. The API action will depend on this value. For example: REFRESH_TOKEN_AUTH takes in a valid refresh token and returns new tokens. USER_SRP_AUTH takes in USERNAME and SRP_A and returns the SRP variables to be used for next challenge execution. USER_PASSWORD_AUTH takes in USERNAME and PASSWORD and returns the next challenge or tokens. Valid values include: USER_SRP_AUTH: Authentication flow for the Secure Remote Password (SRP) protocol. REFRESH_TOKEN_AUTH/REFRESH_TOKEN: Authentication flow for refreshing the access token and ID token by supplying a valid refresh token. CUSTOM_AUTH: Custom authentication flow. USER_PASSWORD_AUTH: Non-SRP authentication flow; user name and password are passed directly. If a user migration Lambda trigger is set, this flow will invoke the user migration Lambda if it doesn't find the user name in the user pool. ADMIN_NO_SRP_AUTH isn't a valid value.
2787
2796
  */
2788
2797
  AuthFlow: AuthFlowType;
2789
2798
  /**
@@ -2799,17 +2808,17 @@ declare namespace CognitoIdentityServiceProvider {
2799
2808
  */
2800
2809
  ClientId: ClientIdType;
2801
2810
  /**
2802
- * The Amazon Pinpoint analytics metadata for collecting metrics for InitiateAuth calls.
2811
+ * The Amazon Pinpoint analytics metadata that contributes to your metrics for InitiateAuth calls.
2803
2812
  */
2804
2813
  AnalyticsMetadata?: AnalyticsMetadataType;
2805
2814
  /**
2806
- * Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
2815
+ * Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
2807
2816
  */
2808
2817
  UserContextData?: UserContextDataType;
2809
2818
  }
2810
2819
  export interface InitiateAuthResponse {
2811
2820
  /**
2812
- * The name of the challenge that you're responding to with this call. This name is returned in the AdminInitiateAuth response if you must pass another challenge. Valid values include the following: All of the following challenges require USERNAME and SECRET_HASH (if applicable) in the parameters. SMS_MFA: Next challenge is to supply an SMS_MFA_CODE, delivered via SMS. PASSWORD_VERIFIER: Next challenge is to supply PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP after the client-side SRP calculations. CUSTOM_CHALLENGE: This is returned if your custom authentication flow determines that the user should pass another challenge before tokens are issued. DEVICE_SRP_AUTH: If device tracking was activated on your user pool and the previous challenges were passed, this challenge is returned so that Amazon Cognito can start tracking this device. DEVICE_PASSWORD_VERIFIER: Similar to PASSWORD_VERIFIER, but for devices only. NEW_PASSWORD_REQUIRED: For users who are required to change their passwords after successful first login. This challenge should be passed with NEW_PASSWORD and any other required attributes. MFA_SETUP: For users who are required to setup an MFA factor before they can sign in. The MFA types activated for the user pool will be listed in the challenge parameters MFA_CAN_SETUP value. To set up software token MFA, use the session returned here from InitiateAuth as an input to AssociateSoftwareToken. Use the session returned by VerifySoftwareToken as an input to RespondToAuthChallenge with challenge name MFA_SETUP to complete sign-in. To set up SMS MFA, an administrator should help the user to add a phone number to their account, and then the user should call InitiateAuth again to restart sign-in.
2821
+ * The name of the challenge that you're responding to with this call. This name is returned in the AdminInitiateAuth response if you must pass another challenge. Valid values include the following: All of the following challenges require USERNAME and SECRET_HASH (if applicable) in the parameters. SMS_MFA: Next challenge is to supply an SMS_MFA_CODE, delivered via SMS. PASSWORD_VERIFIER: Next challenge is to supply PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP after the client-side SRP calculations. CUSTOM_CHALLENGE: This is returned if your custom authentication flow determines that the user should pass another challenge before tokens are issued. DEVICE_SRP_AUTH: If device tracking was activated on your user pool and the previous challenges were passed, this challenge is returned so that Amazon Cognito can start tracking this device. DEVICE_PASSWORD_VERIFIER: Similar to PASSWORD_VERIFIER, but for devices only. NEW_PASSWORD_REQUIRED: For users who are required to change their passwords after successful first login. Respond to this challenge with NEW_PASSWORD and any required attributes that Amazon Cognito returned in the requiredAttributes parameter. You can also set values for attributes that aren't required by your user pool and that your app client can write. For more information, see RespondToAuthChallenge. In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value. In RespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the requiredAttributes parameter, then use the UpdateUserAttributes API operation to modify the value of any additional attributes. MFA_SETUP: For users who are required to setup an MFA factor before they can sign in. The MFA types activated for the user pool will be listed in the challenge parameters MFA_CAN_SETUP value. To set up software token MFA, use the session returned here from InitiateAuth as an input to AssociateSoftwareToken. Use the session returned by VerifySoftwareToken as an input to RespondToAuthChallenge with challenge name MFA_SETUP to complete sign-in. To set up SMS MFA, an administrator should help the user to add a phone number to their account, and then the user should call InitiateAuth again to restart sign-in.
2813
2822
  */
2814
2823
  ChallengeName?: ChallengeNameType;
2815
2824
  /**
@@ -2882,7 +2891,7 @@ declare namespace CognitoIdentityServiceProvider {
2882
2891
  }
2883
2892
  export interface ListDevicesRequest {
2884
2893
  /**
2885
- * The access tokens for the request to list devices.
2894
+ * A valid access token that Amazon Cognito issued to the user whose list of devices you want to view.
2886
2895
  */
2887
2896
  AccessToken: TokenModelType;
2888
2897
  /**
@@ -2934,7 +2943,7 @@ declare namespace CognitoIdentityServiceProvider {
2934
2943
  */
2935
2944
  UserPoolId: UserPoolIdType;
2936
2945
  /**
2937
- * The maximum number of identity providers to return.
2946
+ * The maximum number of IdPs to return.
2938
2947
  */
2939
2948
  MaxResults?: ListProvidersLimitType;
2940
2949
  /**
@@ -2944,7 +2953,7 @@ declare namespace CognitoIdentityServiceProvider {
2944
2953
  }
2945
2954
  export interface ListIdentityProvidersResponse {
2946
2955
  /**
2947
- * A list of identity provider objects.
2956
+ * A list of IdP objects.
2948
2957
  */
2949
2958
  Providers: ProvidersListType;
2950
2959
  /**
@@ -3083,7 +3092,7 @@ declare namespace CognitoIdentityServiceProvider {
3083
3092
  */
3084
3093
  Users?: UsersListType;
3085
3094
  /**
3086
- * An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
3095
+ * An identifier that you can use in a later request to return the next set of items in the list.
3087
3096
  */
3088
3097
  NextToken?: PaginationKey;
3089
3098
  }
@@ -3105,7 +3114,7 @@ declare namespace CognitoIdentityServiceProvider {
3105
3114
  */
3106
3115
  PaginationToken?: SearchPaginationTokenType;
3107
3116
  /**
3108
- * A filter string of the form "AttributeName Filter-Type "AttributeValue"". Quotation marks within the filter string must be escaped using the backslash (\) character. For example, "family_name = \"Reddy\"". AttributeName: The name of the attribute to search for. You can only search for one attribute at a time. Filter-Type: For an exact match, use =, for example, "given_name = \"Jon\"". For a prefix ("starts with") match, use ^=, for example, "given_name ^= \"Jon\"". AttributeValue: The attribute value that must be matched for each user. If the filter string is empty, ListUsers returns all users in the user pool. You can only search for the following standard attributes: username (case-sensitive) email phone_number name given_name family_name preferred_username cognito:user_status (called Status in the Console) (case-insensitive) status (called Enabled in the Console) (case-sensitive) sub Custom attributes aren't searchable. You can also list users with a client-side filter. The server-side filter matches no more than 1 attribute. For an advanced search, use a client-side filter with the --query parameter of the list-users action in the CLI. When you use a client-side filter, ListUsers returns a paginated list of zero or more users. You can receive multiple pages in a row with zero results. Repeat the query with each pagination token that is returned until you receive a null pagination token value, and then review the combined result. For more information about server-side and client-side filtering, see FilteringCLI output in the Command Line Interface User Guide. For more information, see Searching for Users Using the ListUsers API and Examples of Using the ListUsers API in the Amazon Cognito Developer Guide.
3117
+ * A filter string of the form "AttributeName Filter-Type "AttributeValue"". Quotation marks within the filter string must be escaped using the backslash (\) character. For example, "family_name = \"Reddy\"". AttributeName: The name of the attribute to search for. You can only search for one attribute at a time. Filter-Type: For an exact match, use =, for example, "given_name = \"Jon\"". For a prefix ("starts with") match, use ^=, for example, "given_name ^= \"Jon\"". AttributeValue: The attribute value that must be matched for each user. If the filter string is empty, ListUsers returns all users in the user pool. You can only search for the following standard attributes: username (case-sensitive) email phone_number name given_name family_name preferred_username cognito:user_status (called Status in the Console) (case-insensitive) status (called Enabled in the Console) (case-sensitive) sub Custom attributes aren't searchable. You can also list users with a client-side filter. The server-side filter matches no more than one attribute. For an advanced search, use a client-side filter with the --query parameter of the list-users action in the CLI. When you use a client-side filter, ListUsers returns a paginated list of zero or more users. You can receive multiple pages in a row with zero results. Repeat the query with each pagination token that is returned until you receive a null pagination token value, and then review the combined result. For more information about server-side and client-side filtering, see FilteringCLI output in the Command Line Interface User Guide. For more information, see Searching for Users Using the ListUsers API and Examples of Using the ListUsers API in the Amazon Cognito Developer Guide.
3109
3118
  */
3110
3119
  Filter?: UserFilterType;
3111
3120
  }
@@ -3234,7 +3243,7 @@ declare namespace CognitoIdentityServiceProvider {
3234
3243
  */
3235
3244
  RequireSymbols?: BooleanType;
3236
3245
  /**
3237
- * The number of days a temporary password is valid in the password policy. If the user doesn't sign in during this time, an administrator must reset their password. When you set TemporaryPasswordValidityDays for a user pool, you can no longer set the deprecated UnusedAccountValidityDays value for that user pool.
3246
+ * The number of days a temporary password is valid in the password policy. If the user doesn't sign in during this time, an administrator must reset their password. When you set TemporaryPasswordValidityDays for a user pool, you can no longer set a value for the legacy UnusedAccountValidityDays parameter in that user pool.
3238
3247
  */
3239
3248
  TemporaryPasswordValidityDays?: TemporaryPasswordValidityDaysType;
3240
3249
  }
@@ -3246,11 +3255,11 @@ declare namespace CognitoIdentityServiceProvider {
3246
3255
  export type PriorityType = number;
3247
3256
  export interface ProviderDescription {
3248
3257
  /**
3249
- * The identity provider name.
3258
+ * The IdP name.
3250
3259
  */
3251
3260
  ProviderName?: ProviderNameType;
3252
3261
  /**
3253
- * The identity provider type.
3262
+ * The IdP type.
3254
3263
  */
3255
3264
  ProviderType?: IdentityProviderTypeType;
3256
3265
  /**
@@ -3307,7 +3316,7 @@ declare namespace CognitoIdentityServiceProvider {
3307
3316
  */
3308
3317
  SecretHash?: SecretHashType;
3309
3318
  /**
3310
- * Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
3319
+ * Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
3311
3320
  */
3312
3321
  UserContextData?: UserContextDataType;
3313
3322
  /**
@@ -3315,7 +3324,7 @@ declare namespace CognitoIdentityServiceProvider {
3315
3324
  */
3316
3325
  Username: UsernameType;
3317
3326
  /**
3318
- * The Amazon Pinpoint analytics metadata for collecting metrics for ResendConfirmationCode calls.
3327
+ * The Amazon Pinpoint analytics metadata that contributes to your metrics for ResendConfirmationCode calls.
3319
3328
  */
3320
3329
  AnalyticsMetadata?: AnalyticsMetadataType;
3321
3330
  /**
@@ -3377,15 +3386,15 @@ declare namespace CognitoIdentityServiceProvider {
3377
3386
  */
3378
3387
  Session?: SessionType;
3379
3388
  /**
3380
- * The challenge responses. These are inputs corresponding to the value of ChallengeName, for example: SECRET_HASH (if app client is configured with client secret) applies to all of the inputs that follow (including SOFTWARE_TOKEN_MFA). SMS_MFA: SMS_MFA_CODE, USERNAME. PASSWORD_VERIFIER: PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, TIMESTAMP, USERNAME. PASSWORD_VERIFIER requires DEVICE_KEY when signing in with a remembered device. NEW_PASSWORD_REQUIRED: NEW_PASSWORD, any other required attributes, USERNAME. SOFTWARE_TOKEN_MFA: USERNAME and SOFTWARE_TOKEN_MFA_CODE are required attributes. DEVICE_SRP_AUTH requires USERNAME, DEVICE_KEY, SRP_A (and SECRET_HASH). DEVICE_PASSWORD_VERIFIER requires everything that PASSWORD_VERIFIER requires, plus DEVICE_KEY. MFA_SETUP requires USERNAME, plus you must use the session value returned by VerifySoftwareToken in the Session parameter.
3389
+ * The challenge responses. These are inputs corresponding to the value of ChallengeName, for example: SECRET_HASH (if app client is configured with client secret) applies to all of the inputs that follow (including SOFTWARE_TOKEN_MFA). SMS_MFA: SMS_MFA_CODE, USERNAME. PASSWORD_VERIFIER: PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, TIMESTAMP, USERNAME. PASSWORD_VERIFIER requires DEVICE_KEY when you sign in with a remembered device. NEW_PASSWORD_REQUIRED: NEW_PASSWORD, USERNAME, SECRET_HASH (if app client is configured with client secret). To set any required attributes that Amazon Cognito returned as requiredAttributes in the InitiateAuth response, add a userAttributes.attributename parameter. This parameter can also set values for writable attributes that aren't required by your user pool. In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value. In RespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the requiredAttributes parameter, then use the UpdateUserAttributes API operation to modify the value of any additional attributes. SOFTWARE_TOKEN_MFA: USERNAME and SOFTWARE_TOKEN_MFA_CODE are required attributes. DEVICE_SRP_AUTH requires USERNAME, DEVICE_KEY, SRP_A (and SECRET_HASH). DEVICE_PASSWORD_VERIFIER requires everything that PASSWORD_VERIFIER requires, plus DEVICE_KEY. MFA_SETUP requires USERNAME, plus you must use the session value returned by VerifySoftwareToken in the Session parameter.
3381
3390
  */
3382
3391
  ChallengeResponses?: ChallengeResponsesType;
3383
3392
  /**
3384
- * The Amazon Pinpoint analytics metadata for collecting metrics for RespondToAuthChallenge calls.
3393
+ * The Amazon Pinpoint analytics metadata that contributes to your metrics for RespondToAuthChallenge calls.
3385
3394
  */
3386
3395
  AnalyticsMetadata?: AnalyticsMetadataType;
3387
3396
  /**
3388
- * Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
3397
+ * Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
3389
3398
  */
3390
3399
  UserContextData?: UserContextDataType;
3391
3400
  /**
@@ -3491,7 +3500,7 @@ declare namespace CognitoIdentityServiceProvider {
3491
3500
  */
3492
3501
  DeveloperOnlyAttribute?: BooleanType;
3493
3502
  /**
3494
- * Specifies whether the value of the attribute can be changed. For any user pool attribute that is mapped to an identity provider attribute, you must set this parameter to true. Amazon Cognito updates mapped attributes when users sign in to your application through an identity provider. If an attribute is immutable, Amazon Cognito throws an error when it attempts to update the attribute. For more information, see Specifying Identity Provider Attribute Mappings for Your User Pool.
3503
+ * Specifies whether the value of the attribute can be changed. For any user pool attribute that is mapped to an IdP attribute, you must set this parameter to true. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If an attribute is immutable, Amazon Cognito throws an error when it attempts to update the attribute. For more information, see Specifying Identity Provider Attribute Mappings for Your User Pool.
3495
3504
  */
3496
3505
  Mutable?: BooleanType;
3497
3506
  /**
@@ -3577,7 +3586,7 @@ declare namespace CognitoIdentityServiceProvider {
3577
3586
  */
3578
3587
  SoftwareTokenMfaSettings?: SoftwareTokenMfaSettingsType;
3579
3588
  /**
3580
- * The access token for the user.
3589
+ * A valid access token that Amazon Cognito issued to the user whose MFA preference you want to set.
3581
3590
  */
3582
3591
  AccessToken: TokenModelType;
3583
3592
  }
@@ -3617,7 +3626,7 @@ declare namespace CognitoIdentityServiceProvider {
3617
3626
  }
3618
3627
  export interface SetUserSettingsRequest {
3619
3628
  /**
3620
- * The access token for the set user settings request.
3629
+ * A valid access token that Amazon Cognito issued to the user whose user settings you want to configure.
3621
3630
  */
3622
3631
  AccessToken: TokenModelType;
3623
3632
  /**
@@ -3653,11 +3662,11 @@ declare namespace CognitoIdentityServiceProvider {
3653
3662
  */
3654
3663
  ValidationData?: AttributeListType;
3655
3664
  /**
3656
- * The Amazon Pinpoint analytics metadata for collecting metrics for SignUp calls.
3665
+ * The Amazon Pinpoint analytics metadata that contributes to your metrics for SignUp calls.
3657
3666
  */
3658
3667
  AnalyticsMetadata?: AnalyticsMetadataType;
3659
3668
  /**
3660
- * Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
3669
+ * Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
3661
3670
  */
3662
3671
  UserContextData?: UserContextDataType;
3663
3672
  /**
@@ -3786,15 +3795,15 @@ declare namespace CognitoIdentityServiceProvider {
3786
3795
  export type TokenModelType = string;
3787
3796
  export interface TokenValidityUnitsType {
3788
3797
  /**
3789
- * A time unit in seconds”, minutes”, hours”, or days for the value in AccessTokenValidity, defaulting to hours.
3798
+ * A time unit of seconds, minutes, hours, or days for the value that you set in the AccessTokenValidity parameter. The default AccessTokenValidity time unit is hours.
3790
3799
  */
3791
3800
  AccessToken?: TimeUnitsType;
3792
3801
  /**
3793
- * A time unit in seconds”, minutes”, hours”, or days for the value in IdTokenValidity, defaulting to hours.
3802
+ * A time unit of seconds, minutes, hours, or days for the value that you set in the IdTokenValidity parameter. The default IdTokenValidity time unit is hours.
3794
3803
  */
3795
3804
  IdToken?: TimeUnitsType;
3796
3805
  /**
3797
- * A time unit in seconds”, minutes”, hours”, or days for the value in RefreshTokenValidity, defaulting to days.
3806
+ * A time unit of seconds, minutes, hours, or days for the value that you set in the RefreshTokenValidity parameter. The default RefreshTokenValidity time unit is days.
3798
3807
  */
3799
3808
  RefreshToken?: TimeUnitsType;
3800
3809
  }
@@ -3866,7 +3875,7 @@ declare namespace CognitoIdentityServiceProvider {
3866
3875
  }
3867
3876
  export interface UpdateDeviceStatusRequest {
3868
3877
  /**
3869
- * The access token.
3878
+ * A valid access token that Amazon Cognito issued to the user whose device status you want to update.
3870
3879
  */
3871
3880
  AccessToken: TokenModelType;
3872
3881
  /**
@@ -3914,25 +3923,25 @@ declare namespace CognitoIdentityServiceProvider {
3914
3923
  */
3915
3924
  UserPoolId: UserPoolIdType;
3916
3925
  /**
3917
- * The identity provider name.
3926
+ * The IdP name.
3918
3927
  */
3919
3928
  ProviderName: ProviderNameType;
3920
3929
  /**
3921
- * The identity provider details to be updated, such as MetadataURL and MetadataFile.
3930
+ * The IdP details to be updated, such as MetadataURL and MetadataFile.
3922
3931
  */
3923
3932
  ProviderDetails?: ProviderDetailsType;
3924
3933
  /**
3925
- * The identity provider attribute mapping to be changed.
3934
+ * The IdP attribute mapping to be changed.
3926
3935
  */
3927
3936
  AttributeMapping?: AttributeMappingType;
3928
3937
  /**
3929
- * A list of identity provider identifiers.
3938
+ * A list of IdP identifiers.
3930
3939
  */
3931
3940
  IdpIdentifiers?: IdpIdentifiersListType;
3932
3941
  }
3933
3942
  export interface UpdateIdentityProviderResponse {
3934
3943
  /**
3935
- * The identity provider object.
3944
+ * The IdP object.
3936
3945
  */
3937
3946
  IdentityProvider: IdentityProviderType;
3938
3947
  }
@@ -3962,11 +3971,11 @@ declare namespace CognitoIdentityServiceProvider {
3962
3971
  }
3963
3972
  export interface UpdateUserAttributesRequest {
3964
3973
  /**
3965
- * An array of name-value pairs representing user attributes. For custom attributes, you must prepend the custom: prefix to the attribute name.
3974
+ * An array of name-value pairs representing user attributes. For custom attributes, you must prepend the custom: prefix to the attribute name. If you have set an attribute to require verification before Amazon Cognito updates its value, this request doesn’t immediately update the value of that attribute. After your user receives and responds to a verification message to verify the new value, Amazon Cognito updates the attribute value. Your user can sign in and receive messages with the original attribute value until they verify the new value.
3966
3975
  */
3967
3976
  UserAttributes: AttributeListType;
3968
3977
  /**
3969
- * The access token for the request to update user attributes.
3978
+ * A valid access token that Amazon Cognito issued to the user whose user attributes you want to update.
3970
3979
  */
3971
3980
  AccessToken: TokenModelType;
3972
3981
  /**
@@ -3994,19 +4003,19 @@ declare namespace CognitoIdentityServiceProvider {
3994
4003
  */
3995
4004
  ClientName?: ClientNameType;
3996
4005
  /**
3997
- * The time limit, in days, after which the refresh token is no longer valid and can't be used.
4006
+ * The refresh token time limit. After this limit expires, your user can't use their refresh token. To specify the time unit for RefreshTokenValidity as seconds, minutes, hours, or days, set a TokenValidityUnits value in your API request. For example, when you set RefreshTokenValidity as 10 and TokenValidityUnits as days, your user can refresh their session and retrieve new access and ID tokens for 10 days. The default time unit for RefreshTokenValidity in an API request is days. You can't set RefreshTokenValidity to 0. If you do, Amazon Cognito overrides the value with the default value of 30 days. Valid range is displayed below in seconds.
3998
4007
  */
3999
4008
  RefreshTokenValidity?: RefreshTokenValidityType;
4000
4009
  /**
4001
- * The time limit after which the access token is no longer valid and can't be used.
4010
+ * The access token time limit. After this limit expires, your user can't use their access token. To specify the time unit for AccessTokenValidity as seconds, minutes, hours, or days, set a TokenValidityUnits value in your API request. For example, when you set AccessTokenValidity to 10 and TokenValidityUnits to hours, your user can authorize access with their access token for 10 hours. The default time unit for AccessTokenValidity in an API request is hours. Valid range is displayed below in seconds.
4002
4011
  */
4003
4012
  AccessTokenValidity?: AccessTokenValidityType;
4004
4013
  /**
4005
- * The time limit after which the ID token is no longer valid and can't be used.
4014
+ * The ID token time limit. After this limit expires, your user can't use their ID token. To specify the time unit for IdTokenValidity as seconds, minutes, hours, or days, set a TokenValidityUnits value in your API request. For example, when you set IdTokenValidity as 10 and TokenValidityUnits as hours, your user can authenticate their session with their ID token for 10 hours. The default time unit for AccessTokenValidity in an API request is hours. Valid range is displayed below in seconds.
4006
4015
  */
4007
4016
  IdTokenValidity?: IdTokenValidityType;
4008
4017
  /**
4009
- * The units in which the validity times are represented. Default for RefreshToken is days, and default for ID and access tokens is hours.
4018
+ * The units in which the validity times are represented. The default unit for RefreshToken is days, and the default for ID and access tokens is hours.
4010
4019
  */
4011
4020
  TokenValidityUnits?: TokenValidityUnitsType;
4012
4021
  /**
@@ -4022,15 +4031,15 @@ declare namespace CognitoIdentityServiceProvider {
4022
4031
  */
4023
4032
  ExplicitAuthFlows?: ExplicitAuthFlowsListType;
4024
4033
  /**
4025
- * A list of provider names for the identity providers that are supported on this client.
4034
+ * A list of provider names for the IdPs that this client supports. The following are supported: COGNITO, Facebook, Google LoginWithAmazon, and the names of your own SAML and OIDC providers.
4026
4035
  */
4027
4036
  SupportedIdentityProviders?: SupportedIdentityProvidersListType;
4028
4037
  /**
4029
- * A list of allowed redirect (callback) URLs for the identity providers. A redirect URI must: Be an absolute URI. Be registered with the authorization server. Not include a fragment component. See OAuth 2.0 - Redirection Endpoint. Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only. App callback URLs such as myapp://example are also supported.
4038
+ * A list of allowed redirect (callback) URLs for the IdPs. A redirect URI must: Be an absolute URI. Be registered with the authorization server. Not include a fragment component. See OAuth 2.0 - Redirection Endpoint. Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only. App callback URLs such as myapp://example are also supported.
4030
4039
  */
4031
4040
  CallbackURLs?: CallbackURLsListType;
4032
4041
  /**
4033
- * A list of allowed logout URLs for the identity providers.
4042
+ * A list of allowed logout URLs for the IdPs.
4034
4043
  */
4035
4044
  LogoutURLs?: LogoutURLsListType;
4036
4045
  /**
@@ -4038,11 +4047,11 @@ declare namespace CognitoIdentityServiceProvider {
4038
4047
  */
4039
4048
  DefaultRedirectURI?: RedirectUrlType;
4040
4049
  /**
4041
- * The allowed OAuth flows. Set to code to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint. Set to implicit to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly. Set to client_credentials to specify that the client should get the access token (and, optionally, ID token, based on scopes) from the token endpoint using a combination of client and client_secret.
4050
+ * The allowed OAuth flows. code Use a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the /oauth2/token endpoint. implicit Issue the access token (and, optionally, ID token, based on scopes) directly to your user. client_credentials Issue the access token from the /oauth2/token endpoint directly to a non-person user using a combination of the client ID and client secret.
4042
4051
  */
4043
4052
  AllowedOAuthFlows?: OAuthFlowsType;
4044
4053
  /**
4045
- * The allowed OAuth scopes. Possible values provided by OAuth are: phone, email, openid, and profile. Possible values provided by Amazon Web Services are: aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are also supported.
4054
+ * The allowed OAuth scopes. Possible values provided by OAuth are phone, email, openid, and profile. Possible values provided by Amazon Web Services are aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are also supported.
4046
4055
  */
4047
4056
  AllowedOAuthScopes?: ScopeListType;
4048
4057
  /**
@@ -4050,7 +4059,7 @@ declare namespace CognitoIdentityServiceProvider {
4050
4059
  */
4051
4060
  AllowedOAuthFlowsUserPoolClient?: BooleanType;
4052
4061
  /**
4053
- * The Amazon Pinpoint analytics configuration for collecting metrics for this user pool. In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.
4062
+ * The Amazon Pinpoint analytics configuration necessary to collect metrics for this user pool. In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.
4054
4063
  */
4055
4064
  AnalyticsConfiguration?: AnalyticsConfigurationType;
4056
4065
  /**
@@ -4061,6 +4070,10 @@ declare namespace CognitoIdentityServiceProvider {
4061
4070
  * Activates or deactivates token revocation. For more information about revoking tokens, see RevokeToken.
4062
4071
  */
4063
4072
  EnableTokenRevocation?: WrappedBooleanType;
4073
+ /**
4074
+ * Activates the propagation of additional user context data. For more information about propagation of user context data, see Adding advanced security to a user pool. If you don’t include this parameter, you can't send device fingerprint information, including source IP address, to Amazon Cognito advanced security. You can only activate EnablePropagateAdditionalUserContextData in an app client that has a client secret.
4075
+ */
4076
+ EnablePropagateAdditionalUserContextData?: WrappedBooleanType;
4064
4077
  }
4065
4078
  export interface UpdateUserPoolClientResponse {
4066
4079
  /**
@@ -4126,7 +4139,11 @@ declare namespace CognitoIdentityServiceProvider {
4126
4139
  */
4127
4140
  SmsAuthenticationMessage?: SmsVerificationMessageType;
4128
4141
  /**
4129
- * Can be one of the following values: OFF - MFA tokens aren't required and can't be specified during user registration. ON - MFA tokens are required for all user registrations. You can only specify ON when you're initially creating a user pool. You can use the SetUserPoolMfaConfig API operation to turn MFA "ON" for existing user pools. OPTIONAL - Users have the option when registering to create an MFA token.
4142
+ * The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see Verifying updates to to email addresses and phone numbers.
4143
+ */
4144
+ UserAttributeUpdateSettings?: UserAttributeUpdateSettingsType;
4145
+ /**
4146
+ * Possible values include: OFF - MFA tokens aren't required and can't be specified during user registration. ON - MFA tokens are required for all user registrations. You can only specify ON when you're initially creating a user pool. You can use the SetUserPoolMfaConfig API operation to turn MFA "ON" for existing user pools. OPTIONAL - Users have the option when registering to create an MFA token.
4130
4147
  */
4131
4148
  MfaConfiguration?: UserPoolMfaType;
4132
4149
  /**
@@ -4160,9 +4177,19 @@ declare namespace CognitoIdentityServiceProvider {
4160
4177
  }
4161
4178
  export interface UpdateUserPoolResponse {
4162
4179
  }
4180
+ export interface UserAttributeUpdateSettingsType {
4181
+ /**
4182
+ * Requires that your user verifies their email address, phone number, or both before Amazon Cognito updates the value of that attribute. When you update a user attribute that has this option activated, Amazon Cognito sends a verification message to the new phone number or email address. Amazon Cognito doesn’t change the value of the attribute until your user responds to the verification message and confirms the new value. You can verify an updated email address or phone number with a VerifyUserAttribute API request. You can also call the UpdateUserAttributes or AdminUpdateUserAttributes API and set email_verified or phone_number_verified to true. When AttributesRequireVerificationBeforeUpdate is false, your user pool doesn't require that your users verify attribute changes before Amazon Cognito updates them. In a user pool where AttributesRequireVerificationBeforeUpdate is false, API operations that change attribute values can immediately update a user’s email or phone_number attribute.
4183
+ */
4184
+ AttributesRequireVerificationBeforeUpdate?: AttributesRequireVerificationBeforeUpdateType;
4185
+ }
4163
4186
  export interface UserContextDataType {
4164
4187
  /**
4165
- * Contextual data, such as the user's device fingerprint, IP address, or location, used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
4188
+ * The source IP address of your user's device.
4189
+ */
4190
+ IpAddress?: StringType;
4191
+ /**
4192
+ * Encoded device-fingerprint details that your app collected with the Amazon Cognito context data collection library. For more information, see Adding user device and session data to API requests.
4166
4193
  */
4167
4194
  EncodedData?: StringType;
4168
4195
  }
@@ -4273,19 +4300,19 @@ declare namespace CognitoIdentityServiceProvider {
4273
4300
  */
4274
4301
  CreationDate?: DateType;
4275
4302
  /**
4276
- * The time limit, in days, after which the refresh token is no longer valid and can't be used.
4303
+ * The refresh token time limit. After this limit expires, your user can't use their refresh token. To specify the time unit for RefreshTokenValidity as seconds, minutes, hours, or days, set a TokenValidityUnits value in your API request. For example, when you set RefreshTokenValidity as 10 and TokenValidityUnits as days, your user can refresh their session and retrieve new access and ID tokens for 10 days. The default time unit for RefreshTokenValidity in an API request is days. You can't set RefreshTokenValidity to 0. If you do, Amazon Cognito overrides the value with the default value of 30 days. Valid range is displayed below in seconds.
4277
4304
  */
4278
4305
  RefreshTokenValidity?: RefreshTokenValidityType;
4279
4306
  /**
4280
- * The time limit, specified by tokenValidityUnits, defaulting to hours, after which the access token is no longer valid and can't be used.
4307
+ * The access token time limit. After this limit expires, your user can't use their access token. To specify the time unit for AccessTokenValidity as seconds, minutes, hours, or days, set a TokenValidityUnits value in your API request. For example, when you set AccessTokenValidity to 10 and TokenValidityUnits to hours, your user can authorize access with their access token for 10 hours. The default time unit for AccessTokenValidity in an API request is hours. Valid range is displayed below in seconds.
4281
4308
  */
4282
4309
  AccessTokenValidity?: AccessTokenValidityType;
4283
4310
  /**
4284
- * The time limit specified by tokenValidityUnits, defaulting to hours, after which the refresh token is no longer valid and can't be used.
4311
+ * The ID token time limit. After this limit expires, your user can't use their ID token. To specify the time unit for IdTokenValidity as seconds, minutes, hours, or days, set a TokenValidityUnits value in your API request. For example, when you set IdTokenValidity as 10 and TokenValidityUnits as hours, your user can authenticate their session with their ID token for 10 hours. The default time unit for AccessTokenValidity in an API request is hours. Valid range is displayed below in seconds.
4285
4312
  */
4286
4313
  IdTokenValidity?: IdTokenValidityType;
4287
4314
  /**
4288
- * The time units used to specify the token validity times of their respective token.
4315
+ * The time units used to specify the token validity times of each token type: ID, access, and refresh.
4289
4316
  */
4290
4317
  TokenValidityUnits?: TokenValidityUnitsType;
4291
4318
  /**
@@ -4301,15 +4328,15 @@ declare namespace CognitoIdentityServiceProvider {
4301
4328
  */
4302
4329
  ExplicitAuthFlows?: ExplicitAuthFlowsListType;
4303
4330
  /**
4304
- * A list of provider names for the identity providers that are supported on this client.
4331
+ * A list of provider names for the IdPs that this client supports. The following are supported: COGNITO, Facebook, Google LoginWithAmazon, and the names of your own SAML and OIDC providers.
4305
4332
  */
4306
4333
  SupportedIdentityProviders?: SupportedIdentityProvidersListType;
4307
4334
  /**
4308
- * A list of allowed redirect (callback) URLs for the identity providers. A redirect URI must: Be an absolute URI. Be registered with the authorization server. Not include a fragment component. See OAuth 2.0 - Redirection Endpoint. Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only. App callback URLs such as myapp://example are also supported.
4335
+ * A list of allowed redirect (callback) URLs for the IdPs. A redirect URI must: Be an absolute URI. Be registered with the authorization server. Not include a fragment component. See OAuth 2.0 - Redirection Endpoint. Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only. App callback URLs such as myapp://example are also supported.
4309
4336
  */
4310
4337
  CallbackURLs?: CallbackURLsListType;
4311
4338
  /**
4312
- * A list of allowed logout URLs for the identity providers.
4339
+ * A list of allowed logout URLs for the IdPs.
4313
4340
  */
4314
4341
  LogoutURLs?: LogoutURLsListType;
4315
4342
  /**
@@ -4317,11 +4344,11 @@ declare namespace CognitoIdentityServiceProvider {
4317
4344
  */
4318
4345
  DefaultRedirectURI?: RedirectUrlType;
4319
4346
  /**
4320
- * The allowed OAuth flows. Set to code to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint. Set to implicit to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly. Set to client_credentials to specify that the client should get the access token (and, optionally, ID token, based on scopes) from the token endpoint using a combination of client and client_secret.
4347
+ * The allowed OAuth flows. code Use a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the /oauth2/token endpoint. implicit Issue the access token (and, optionally, ID token, based on scopes) directly to your user. client_credentials Issue the access token from the /oauth2/token endpoint directly to a non-person user using a combination of the client ID and client secret.
4321
4348
  */
4322
4349
  AllowedOAuthFlows?: OAuthFlowsType;
4323
4350
  /**
4324
- * The allowed OAuth scopes. Possible values provided by OAuth are: phone, email, openid, and profile. Possible values provided by Amazon Web Services are: aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are also supported.
4351
+ * The OAuth scopes that your app client supports. Possible values that OAuth provides are phone, email, openid, and profile. Possible values that Amazon Web Services provides are aws.cognito.signin.user.admin. Amazon Cognito also supports custom scopes that you create in Resource Servers.
4325
4352
  */
4326
4353
  AllowedOAuthScopes?: ScopeListType;
4327
4354
  /**
@@ -4333,13 +4360,17 @@ declare namespace CognitoIdentityServiceProvider {
4333
4360
  */
4334
4361
  AnalyticsConfiguration?: AnalyticsConfigurationType;
4335
4362
  /**
4336
- * Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and password recovery when the user doesn't exist in the user pool. When set to ENABLED and the user doesn't exist, authentication returns an error indicating either the username or password was incorrect. Account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to LEGACY, those APIs return a UserNotFoundException exception if the user doesn't exist in the user pool. Valid values include: ENABLED - This prevents user existence-related errors. LEGACY - This represents the old behavior of Cognito where user existence related errors aren't prevented.
4363
+ * Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and password recovery when the user doesn't exist in the user pool. When set to ENABLED and the user doesn't exist, authentication returns an error indicating either the username or password was incorrect. Account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to LEGACY, those APIs return a UserNotFoundException exception if the user doesn't exist in the user pool. Valid values include: ENABLED - This prevents user existence-related errors. LEGACY - This represents the old behavior of Amazon Cognito where user existence related errors aren't prevented.
4337
4364
  */
4338
4365
  PreventUserExistenceErrors?: PreventUserExistenceErrorTypes;
4339
4366
  /**
4340
4367
  * Indicates whether token revocation is activated for the user pool client. When you create a new user pool client, token revocation is activated by default. For more information about revoking tokens, see RevokeToken.
4341
4368
  */
4342
4369
  EnableTokenRevocation?: WrappedBooleanType;
4370
+ /**
4371
+ * When EnablePropagateAdditionalUserContextData is true, Amazon Cognito accepts an IpAddress value that you send in the UserContextData parameter. The UserContextData parameter sends information to Amazon Cognito advanced security for risk analysis. You can send UserContextData when you sign in Amazon Cognito native users with the InitiateAuth and RespondToAuthChallenge API operations. When EnablePropagateAdditionalUserContextData is false, you can't send your user's source IP address to Amazon Cognito advanced security with unauthenticated API operations. EnablePropagateAdditionalUserContextData doesn't affect whether you can send a source IP address in a ContextData parameter with the authenticated API operations AdminInitiateAuth and AdminRespondToAuthChallenge. You can only activate EnablePropagateAdditionalUserContextData in an app client that has a client secret. For more information about propagation of user context data, see Adding user device and session data to API requests.
4372
+ */
4373
+ EnablePropagateAdditionalUserContextData?: WrappedBooleanType;
4343
4374
  }
4344
4375
  export interface UserPoolDescriptionType {
4345
4376
  /**
@@ -4444,6 +4475,10 @@ declare namespace CognitoIdentityServiceProvider {
4444
4475
  * The contents of the SMS authentication message.
4445
4476
  */
4446
4477
  SmsAuthenticationMessage?: SmsVerificationMessageType;
4478
+ /**
4479
+ * The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see Verifying updates to to email addresses and phone numbers.
4480
+ */
4481
+ UserAttributeUpdateSettings?: UserAttributeUpdateSettingsType;
4447
4482
  /**
4448
4483
  * Can be one of the following values: OFF - MFA tokens aren't required and can't be specified during user registration. ON - MFA tokens are required for all user registrations. You can only specify required when you're initially creating a user pool. OPTIONAL - Users have the option when registering to create an MFA token.
4449
4484
  */
@@ -4528,7 +4563,7 @@ declare namespace CognitoIdentityServiceProvider {
4528
4563
  */
4529
4564
  Enabled?: BooleanType;
4530
4565
  /**
4531
- * The user status. This can be one of the following: UNCONFIRMED - User has been created but not confirmed. CONFIRMED - User has been confirmed. ARCHIVED - User is no longer active. UNKNOWN - User status isn't known. RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they can sign in. FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change their password to a new value before doing anything else.
4566
+ * The user status. This can be one of the following: UNCONFIRMED - User has been created but not confirmed. CONFIRMED - User has been confirmed. EXTERNAL_PROVIDER - User signed in with a third-party IdP. ARCHIVED - User is no longer active. UNKNOWN - User status isn't known. RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they can sign in. FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change their password to a new value before doing anything else.
4532
4567
  */
4533
4568
  UserStatus?: UserStatusType;
4534
4569
  /**
@@ -4540,7 +4575,7 @@ declare namespace CognitoIdentityServiceProvider {
4540
4575
  export type UsernameAttributesListType = UsernameAttributeType[];
4541
4576
  export interface UsernameConfigurationType {
4542
4577
  /**
4543
- * Specifies whether username case sensitivity will be applied for all users in the user pool through Amazon Cognito APIs. Valid values include: True Enables case sensitivity for all username input. When this option is set to True, users must sign in using the exact capitalization of their given username, such as “UserName”. This is the default value. False Enables case insensitivity for all username input. For example, when this option is set to False, users can sign in using either "username" or "Username". This option also enables both preferred_username and email alias to be case insensitive, in addition to the username attribute.
4578
+ * Specifies whether user name case sensitivity will be applied for all users in the user pool through Amazon Cognito APIs. Valid values include: True Enables case sensitivity for all username input. When this option is set to True, users must sign in using the exact capitalization of their given username, such as “UserName”. This is the default value. False Enables case insensitivity for all username input. For example, when this option is set to False, users can sign in using either "username" or "Username". This option also enables both preferred_username and email alias to be case insensitive, in addition to the username attribute.
4544
4579
  */
4545
4580
  CaseSensitive: WrappedBooleanType;
4546
4581
  }
@@ -4548,23 +4583,23 @@ declare namespace CognitoIdentityServiceProvider {
4548
4583
  export type UsersListType = UserType[];
4549
4584
  export interface VerificationMessageTemplateType {
4550
4585
  /**
4551
- * The SMS message template.
4586
+ * The template for SMS messages that Amazon Cognito sends to your users.
4552
4587
  */
4553
4588
  SmsMessage?: SmsVerificationMessageType;
4554
4589
  /**
4555
- * The email message template. EmailMessage is allowed only if EmailSendingAccount is DEVELOPER.
4590
+ * The template for email messages that Amazon Cognito sends to your users. You can set an EmailMessage template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
4556
4591
  */
4557
4592
  EmailMessage?: EmailVerificationMessageType;
4558
4593
  /**
4559
- * The subject line for the email message template. EmailSubject is allowed only if EmailSendingAccount is DEVELOPER.
4594
+ * The subject line for the email message template. You can set an EmailSubject template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
4560
4595
  */
4561
4596
  EmailSubject?: EmailVerificationSubjectType;
4562
4597
  /**
4563
- * The email message template for sending a confirmation link to the user. EmailMessageByLink is allowed only if EmailSendingAccount is DEVELOPER.
4598
+ * The email message template for sending a confirmation link to the user. You can set an EmailMessageByLink template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
4564
4599
  */
4565
4600
  EmailMessageByLink?: EmailVerificationMessageByLinkType;
4566
4601
  /**
4567
- * The subject line for the email message template for sending a confirmation link to the user. EmailSubjectByLink is allowed only EmailSendingAccount is DEVELOPER.
4602
+ * The subject line for the email message template for sending a confirmation link to the user. You can set an EmailSubjectByLink template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
4568
4603
  */
4569
4604
  EmailSubjectByLink?: EmailVerificationSubjectByLinkType;
4570
4605
  /**
@@ -4576,7 +4611,7 @@ declare namespace CognitoIdentityServiceProvider {
4576
4611
  export type VerifiedAttributesListType = VerifiedAttributeType[];
4577
4612
  export interface VerifySoftwareTokenRequest {
4578
4613
  /**
4579
- * The access token.
4614
+ * A valid access token that Amazon Cognito issued to the user whose software token you want to verify.
4580
4615
  */
4581
4616
  AccessToken?: TokenModelType;
4582
4617
  /**
@@ -4605,7 +4640,7 @@ declare namespace CognitoIdentityServiceProvider {
4605
4640
  export type VerifySoftwareTokenResponseType = "SUCCESS"|"ERROR"|string;
4606
4641
  export interface VerifyUserAttributeRequest {
4607
4642
  /**
4608
- * The access token of the request to verify user attributes.
4643
+ * A valid access token that Amazon Cognito issued to the user whose user attributes you want to verify.
4609
4644
  */
4610
4645
  AccessToken: TokenModelType;
4611
4646
  /**